Box開発者向けドキュメントポータル
ログイン

メタデータの抽出

ガイド CLI CLIサンプルスクリプト メタデータの抽出

required_guides

メタデータの抽出

このスクリプトでは、任意のBoxフォルダ内のすべてのファイルとフォルダのメタデータの詳細を抽出し、その結果を各メタデータテンプレートのCSVスプレッドシートに保存します。

前提条件

Windows

.NET Coreの最新バージョンのインストール

MacOSおよびLinux

PowerShellをインストールします。pwshコマンドを実行して、インストール結果をテストします。

pwsh

どのディレクトリでこのコマンドを実行するかに応じて、出力が異なる場合があります。以下に例を示します。

PowerShell 7.2.5
Copyright (c) Microsoft Corporation.

https://aka.ms/powershell
Type 'help' to get help.
  
PS /Users/user/repos/boxcli/examples>

問題が発生する場合は、.NET CoreとPowerShellの両方をインストールしたかどうか確認してください。

Boxアプリケーション

スクリプトを使用するには、OAuth 2.0認証を使用するBoxアプリケーションが必要です。該当するアプリケーションがない場合は、開発者コンソールに移動して、OAuth 2.0を使用した設定ガイドに従ってください。

スクリプトの構成

  1. boxcli GitHubリポジトリを複製するか、examplesディレクトリからファイルをダウンロードします。

    git clone https://github.com/box/boxcli.git

2. Specify the `folderID` and `userID` parameters to tell the script which
   folder to scan, and who is the user running the script.

   ```bash
   [string]$FolderID = "",
   [string]$UserID = "",

パラメータをスクリプトで直接指定しない場合は、フラグとして渡すか、スクリプトで入力を求めるプロンプトを表示することができます。フラグを使用したコマンドのサンプルは次のようになります。

./Metadata-extraction.ps1 -folderId 123456789 -userId 123456789

スクリプトの実行

  1. ディレクトリを、スクリプトが格納されているフォルダに変更します。この例では、Metadata Extractionフォルダになります。

    rvb@lab:~/box-cli/examples/Metadata Extraction$ pwsh
PowerShell 7.2.4
Copyright (c) Microsoft Corporation.
https://aka.ms/powershell
Type 'help' to get help.
PS /home/rvb/box-cli/examples/Metadata Extraction>

  2. スクリプトを実行します。

    ./Metadata-extraction.ps1 -folderId 123456789 -userId 123456789

    スクリプトが終了すると、以下のような出力が表示されます。

    Pulling data from Folder ID: 173961139760
metadata as user ID: 20718545815
Reading Item ID: 1016853559790
Metadata saved to: MetadataTemplate_properties.csv

ログ

ログは、メインフォルダ内のlogsフォルダに格納されます。以下のログファイルにアクセスできます。

  • Metadata-extraction_all.txt: すべてのログエントリが含まれています。
  • Metadata-extraction_errors.txt: エラーのみが含まれています。