オプションや一括コマンドの使用

ガイド ツール CLI Box CLIの使い方 オプションや一括コマンドの使用

オプションや一括コマンドの使用

オプション

オプションは、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

as-userヘッダーを使用できるのは、サービスアカウントと管理者のみです。必要なスコープでアプリケーションが承認されていない場合、または別のユーザーのデフォルトのトークンを取得するようCLIを構成した場合は、この呼び出しが失敗する可能性があります。詳細なエラーログを確認するには、コマンドに-vまたは--verboseを追加してください。

一括コマンド

csvファイルを使用すると、コマンドを一括して実行できます。このスプレッドシートの各行が個別のAPI呼び出しとして処理されます。

一括コマンドを実行するには、--bulk-file-path=pathtoacsvオプションを使用します。ここでは、pathtoacsvを、必要な情報が記載されているcsvファイルのローカルパスに置き換えます。

たとえば、コマンドbox folders:create --bulk-file-path=pathtoacsvを使用して、フォルダを作成してみましょう。

Finderウィンドウ/エクスプローラからターミナル/コマンドラインウィンドウにcsvファイルをドラッグすると、パスを自動で入力できます。

csvの列名を決める際は、GitHubリポジトリのドキュメントを参照し、引数名を確認するか--helpオプションを使用します。この場合、列名はPARENTIDNAMEとなり、大文字と小文字は区別されません。このフォルダの一括作成コマンドの例では、こちらの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.

まとめ

  • コマンドや一括コマンドとともにオプションを使用しました。