Drive Labels API の概要

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

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

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

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

ドライブ ラベル 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

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

ラベルの分類

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

ラベル分類の例:

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

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

ラベルの改訂

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

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