Drive Labels API の概要

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

  • 情報ガバナンス戦略に従ってコンテンツを分類する - 特別な処理が必要な機密性の高いコンテンツやデータを識別するためのラベルを作成します。たとえば、「Sensitivity」というタイトルのバッジラベル（色分けされたオプション値を含むラベル）を作成し、値に「Top Secret」、「Confidential」、「Public」を設定します。

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

  • ファイルのキュレートと検索 - ラベルを作成すると、組織内のユーザーがラベルとそのフィールドに基づいてアイテムを検索できるようになるため、会社のコンテンツの検索が容易になります。たとえば、組織内のユーザーは、ドライブの検索オプションを使用して、特定の日付までに署名待ちのすべての契約を検索できます。

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

ラベル

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

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

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

バッジラベル

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

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

標準ラベル

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

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

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

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

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

ラベルのタイプ

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

アカウントとユーザーの管理

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

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

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

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

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

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

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

ラベルの分類

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

ラベルの分類の例:

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

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

ラベルのリビジョン

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

下書きのリビジョン
ラベルの現在のドラフト インスタンスのリビジョン番号。ラベルに対して複数の更新を行い、それぞれで下書きのリビジョン番号を増分できます。公開済みのリビジョンには影響しません。下書きラベルを使用できるため、ラベルの更新を公開前にテストできます。
公開済みのリビジョン
公開バージョンのラベルのリビジョン番号。公開ラベルは、ユーザーが現在利用できるラベルのインスタンスです。