Drive Labels API の概要

ラベルは、ユーザーが Google ドライブ内のファイルを整理、検索、ポリシーを適用できるように定義するメタデータです。Drive Labels API は、ドライブ ファイルにメタデータを添付することでビジネス プロセスをサポートする RESTful API です。この API の一般的な用途は次のとおりです。

  • 情報ガバナンス戦略に沿ってコンテンツを分類する - ラベルを作成して、特別な処理が必要な機密性の高いコンテンツやデータを識別します。たとえば、「機密性」という名前のバジ付きラベル（オプション値が色分けされたラベル）を作成して、値を「極秘」、「機密」、「公開」に設定できます。

  • ドライブのアイテムにポリシーを適用する - ラベルを作成してドライブのコンテンツをライフサイクル全体で管理し、組織の記録保持の慣行に準拠させます。たとえば、ラベルを使用してデータ損失防止ポリシー（DLP）を管理し、「機密性」ラベルが「極秘」に設定されているファイルをコンピュータにダウンロードできないようにします。

  • ファイルの管理と検索 - ラベルを作成して、組織内のユーザーがラベルとそのフィールドに基づいてアイテムを検索できるようにすることで、会社のコンテンツの検索可能性を高めることができます。たとえば、ドライブの検索オプションを使用して、「署名待ちで期限が特定の日付のすべての契約書」を見つけるといったことが可能になります。

Drive Labels API で使用される一般的な用語を以下に示します。

ラベル

ドライブ ファイルに配置された構造化メタデータ。ドライブのユーザーは、ファイルにラベルを割り当て、ラベル フィールドの値を設定できます。ラベルは次の要素で構成されます。

ラベル名
ラベルのリソース名。ラベル ID はラベル名の一部を構成します。リクエストに応じて、名前は labels/{id} または labels/{id}@{revisionId} の形式になります。詳細については、以下のラベルのリビジョンをご覧ください。
ラベル ID
ラベルのグローバルに一意の識別子。ID はラベル名の一部を構成しますが、名前とは異なり、リビジョン間で一貫しています。

ラベルには次の 2 つのスタイルがあります。

バッジラベル

SelectionOptions フィールド型のラベル。重要度を示すために色分けできる選択肢が含まれています。これを行うには、Choice の Properties を介して badgeConfig を設定します。

ドライブでは、ファイルごとに選択したオプションの色が表示されるため、ファイルのステータスや分類などをユーザーが明確に把握できます。たとえば、「機密性」バッジ付きラベルの「最高機密」オプションは赤色で表示されます。一度にバッジを付けることができるラベルは 1 つだけです。

標準ラベル

0 個以上のフィールドタイプを含むラベル。標準ラベルには、「プロジェクト ムーンショット」などのラベルのタイトルがあり、プロジェクトに関連するすべてのファイルを示します。標準ラベルには、複数の構造化フィールドが含まれている場合もあります。たとえば、タイトルが「契約」のラベルには、「会社」、「期限」、「ステータス」、「署名者」のフィールドが含まれる場合があります。各フィールドは特定のタイプ（テキスト、日付、選択、ユーザー）です。

バッジラベルの図。
図 1. バッジラベル
標準ラベルの図。
図 2. 標準ラベル
フィールド

ラベルの個別の型付き設定可能なコンポーネント。ラベルには、0 個以上のフィールドを関連付けることができます。

フィールド タイプ
フィールドに関連付けられた値のデータ型。テキスト、整数、日付、ユーザー、選択として構成できます。ListOptions を使用してフィールドを構成する場合は、ユーザー フィールドと選択フィールドに複数の値を設定できます。選択したタイプは、ドライブのアイテムに適用される有効な値と、使用可能な検索クエリ オプションの両方に影響します。
Choice

ユーザーが SelectionOptions フィールド内で選択できる複数のオプションの 1 つ。

ラベルタイプ

すべてのラベルに LabelType が含まれています。ラベルには次の 2 つの種類があります。

管理者

管理者が所有するラベルを作成、編集するには、ラベルの管理権限を持つアカウント管理者である必要があります。

管理者は、管理ラベルを任意のユーザーと共有して、そのユーザーにラベルの表示とドライブ アイテムへの適用を許可できます。ドライブのアイテムのラベル値を変更または読み取るには、次の権限が必要です。

  • 変更 - 特定のラベルに関連するドライブ アイテムのメタデータを変更するには、ユーザーに適切な権限レベルが必要です。

    • ドライブのアイテム: EDITOR
    • ラベル: APPLIER

  • 読み取り - 特定のラベルに関連するドライブ アイテムのメタデータを読み取ったり検索したりするには、ユーザーに適切な権限レベルが必要です。

    • ドライブ アイテム: READER
    • ラベル: READER
Shared

管理者以外のユーザーは、他のユーザーがドライブのアイテムに適用できる共有ラベルを作成できます。チームは、管理者を必要とせずに、チーム内で使用する独自のラベルを作成して整理できます。

ラベル分類

ユーザーがドライブ ファイルに適用できる、現在構成されているラベルフィールド。ラベルスキーマとも呼ばれます。

ラベル分類の例:

  • 感度 - 赤、オレンジ、黄、緑
  • ステータス - 未開始、下書き、レビュー中、最終版
  • コンテンツ タイプ - 契約書、設計書、モックアップ
  • 部門 - マーケティング、財務、人事、セールス
ラベルのライフサイクル

ラベルは、作成、公開、更新などのライフサイクルを経ます。ラベルがライフサイクルを経るにつれて、そのラベル リビジョンが増加します。詳細については、ラベルのライフサイクルをご覧ください。

ラベルのリビジョン

ラベルのインスタンス。ラベルが作成、更新、公開、非推奨になるたびに、ラベルのリビジョンが増分されます。

下書きのリビジョン
ラベルの現在のドラフト インスタンスのリビジョン番号。公開済みのリビジョンに影響を与えることなく、ラベルに複数の更新を加え、下書きのリビジョン番号をそれぞれ増やすことができます。ドラフトラベルを使用すると、公開前にラベルの更新をテストできます。
公開済みのリビジョン
ラベルの公開バージョンのリビジョン番号。公開済みラベルは、現在ユーザーが利用できるラベルのインスタンスです。