メインコンテンツへスキップ

一括コマンド

CSVファイルを使用すると、コマンドを一括して実行できます。このスプレッドシートの各行が個別のAPIコールとして処理されます。 一括コマンドを実行するには、--bulk-file-path=<PATH_TO_CSV>オプションを使用します。ここで、<PATH_TO_CSV>は、必要な情報が記載されているCSVファイルのローカルパスになります。 たとえば、コマンドbox folders:create --bulk-file-path=path/to/file.csvを使用して、フォルダを作成できます。
Finderウィンドウ/エクスプローラからターミナル/コマンドラインウィンドウにCSVファイルをドラッグすると、パスが自動で入力されます。
CSVファイルの列名を指定する際は、GitHubリポジトリを参照し、引数名を確認するか--helpオプションを使用します。この場合、列名はPARENTIDNAMEとなり、大文字と小文字は区別されません。このフォルダの一括作成コマンドの例では、こちらのCSVテンプレートを使用することもできます。 以下のコマンドを実行すると、サービスアカウントのフォルダツリーのルートレベル (0) に3つのフォルダが作成されます。
box folders:create --bulk-file-path=/Users/ExampleUser/Desktop/bulkcreatefolders.csv

一括コマンドの設定と使用

  1. boxcli GitHubリポジトリを複製するか、Bulk actionsディレクトリからファイルをダウンロードします。
    git clone https://github.com/box/boxcli.git
    
  2. 必要に応じて.csvテンプレートを調整します。たとえば、複数のフォルダを作成する場合は、出発点としてfolders-create.csvテンプレートを使用できます。
  3. コマンドを実行します。
    box folders:create --bulk-file-path <PATH_TO_CSV>/folders-create.csv
    

オプションを使用した一括コマンド

コマンドにオプションを含めると、そのオプションがCSVファイルのすべての行に適用されます。たとえば、box folders:collaborations:create --bulk-file-path=path/to/file.csv --role=editorを実行すると、CSV内の各ユーザーに編集者としてコラボレーションが作成されます。 CSVファイルでオプションを使用することもできます。前の例を基に、コマンド自体で--role=editorオプションを使用する代わりに、CSVでroleという名前の列を指定できます。このコマンドはbox folders:collaborations:create --bulk-file-path=pathtocsvとなります。

CSVテンプレート

あらかじめ定義されたCSVテンプレートを使用すると、一括で管理したいデータを構造化できます。テンプレートはBulk actionsディレクトリにあり、複数のフォルダに分類されています。現在利用できるテンプレートは、以下の表に示すとおりです。
テンプレート説明
box collaborationsコラボレーションを作成、削除、更新します。
box filesファイルをダウンロード、更新、アップロードします。
box foldersフォルダの作成と更新、フォルダへのメタデータの追加を行います。
box groupsグループの作成とメンバーシップの追加を行います。
box metadata-templatesメタデータテンプレートと、フォルダのメタデータカスケードポリシーを作成します。
box shared-links共有リンクを削除します。
box usersユーザーの作成と更新、あるユーザーから別のユーザーへのコンテンツの移動を行います。
box webhooksWebhookを削除します。