Box Developerドキュメント

メタデータ

ガイド メタデータ

メタデータ

メタデータを使用すると、ユーザーやアプリケーションは、ファイルやフォルダに関連付けられたカスタムデータを定義、格納できます。

文字列フィールド

メタデータは、ファイルまたはフォルダに割り当てられているキー/値ペアで構成されます。たとえば、重要な契約には、clientNumber: 820183clientName: bioMedicalCorpのキー/値ペアが使用されている場合があります。

メタデータの用語

メタデータを操作するには、開発者は異なる数種類のリソースを使用する必要があります。

  • テンプレート: メタデータテンプレートには、ファイルに割り当てることができる再利用可能な一連のキー/値ペアが記載されています。たとえば、invoiceDataテンプレートでは、請求書に関するデータを保持するため、請求書IDと顧客IDのフィールドが設定されています。
  • フィールド: メタデータテンプレートフィールドには、メタデータテンプレート内の特定のデータが記載されています。たとえば、請求書のIDをinvoiceDataテンプレートのidフィールドとして表すことができます。
  • インスタンス: メタデータインスタンスには、各フィールドに割り当てられている値など、テンプレートとファイルやフォルダ間の関係が記載されています。たとえば、ユーザーは、invoiceDataメタデータテンプレートをファイルに割り当て、2つの値を指定しています (1つは請求書ID、もう1つは顧客ID)。特定のファイルまたはフォルダには最大100個のテンプレートを割り当てることができます。
  • カスケードポリシー: メタデータカスケードポリシーには、フォルダに適用されているメタデータインスタンスを、そのフォルダ内の項目にどのように適用するかが記載されています。たとえば、ユーザーは、同じinvoiceDataメタデータテンプレートをプロジェクトフォルダに割り当てると (2つの値を含む)、そのプロジェクトフォルダ内のすべてのファイルとフォルダに自動的に適用できます。
  • クエリ: メタデータクエリを使用すると、ファイルやフォルダに設定されているメタデータを検索して、そのファイルやフォルダを見つけることができます。たとえば、特定のIDが付いた請求書についてすべてのファイルを検索するには、クエリで、その請求書に適用されているinvoiceDataテンプレートと値id = :id (ここで、:idは請求書の値) が設定されたすべてのファイルとフォルダを検索することができます。

メタデータの目的

メタデータは多くの目的で使用できます。会社がマーケティングチーム向けにデジタルアセットを効率よく編成する場合もあれば、開発者がワークフローや承認の促進のような高度なコンテンツ機能を提供する場合もあります。

たとえば、marketingCollateralテンプレートでは、特定のマーケティングコンテンツを使用する状況とタイミングを定義できます。ユーザーは、Boxウェブアプリでテンプレートのレプリゼンテーションを確認すると同時に、ファイルのプレビューに移動できます。

詳細については、Boxコミュニティの記事を参照してください。