オプションや一括コマンドの使用
オプションや一括コマンドの使用
オプション
オプションは、CLIコマンドで使用する追加のオプション機能を提供します。また、オプションはフラグまたは引数とも呼ばれる場合があります。前の手順で説明したように、--helpはオプションの一例です。
コマンドに有効なすべてのオプションを確認するには、GitHubリポジトリを参照してください。
たとえば、フォルダの削除に関するコマンドのドキュメントを参照すると、--recursiveや--forceなど、このコマンドで使用するオプションのリストを確認できます。
as-userヘッダー
as-userヘッダーを使用するには、コマンドの末尾に--as-user=USERIDオプションを追加します。
たとえば、次のコマンドでは、ユーザーID 123456のアカウントのルートレベルにExample_Folderというフォルダが作成されます。
box folders:create 0 Example_Folder --as-user=123456
一括コマンド
CSVファイルを使用すると、コマンドを一括して実行できます。このスプレッドシートの各行が個別のAPIコールとして処理されます。
一括コマンドを実行するには、--bulk-file-path=<PATH_TO_CSV>オプションを使用します。ここで、<PATH_TO_CSV>は、必要な情報が記載されているCSVファイルのローカルパスになります。
たとえば、コマンドbox folders:create --bulk-file-path=pathtoacsvを使用して、フォルダを作成してみましょう。
CSVファイルの列名を指定する際は、GitHubリポジトリのドキュメントを参照し、引数名を確認するか--helpオプションを使用します。この場合、列名はPARENTIDとNAMEとなり、大文字と小文字は区別されません。このフォルダの一括作成コマンドの例では、こちらのCSVテンプレートを使用することもできます。
以下のコマンドを実行すると、サービスアカウントのフォルダツリーのルートレベル (0) に3つのフォルダが作成されます。
box folders:create --bulk-file-path=/Users/ExampleUser/Desktop/bulkcreatefolders.csv
オプションを使用した一括コマンド
コマンドでオプションを渡すと、そのオプションがCSVファイルの各行に自動的に適用されます。たとえば、box folders:collaborations:create --bulk-file-path=pathtocsv --role=editorを実行すると、CSV内の各ユーザーに編集者としてコラボレーションが作成されます。
ただし、CSVファイルでオプションを使用することもできます。前の例を基に、コマンド自体で--role=editorオプションを使用する代わりに、CSVでroleという名前の列を指定することができます。コマンド自体は次のようになります。
box folders:collaborations:create --bulk-file-path=pathtocsv
一括コマンドの詳細については、このドキュメントを参照してください。
まとめ
- コマンドや一括コマンドとともにオプションを使用しました。