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 を使用してフィールドを構成すると、ユーザー フィールドと選択フィールドに複数の値を設定できます。選択した種類は、ドライブのアイテムに適用される有効な値と、使用可能な検索クエリ オプションの両方に影響します。
選択肢

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

ラベルタイプ

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

管理者

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

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

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

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

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

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

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

ラベルの分類

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

ラベル分類の例:

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

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

ラベルのリビジョン

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

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