Drive Labels API の概要

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

  • 情報ガバナンス戦略に従ってコンテンツを分類する - 特別な処理が必要な機密コンテンツやデータを識別するラベルを作成します。たとえば、「機密」「機密」「一般公開」の値を持つバッジラベル（色分けされたオプション値を含むラベル）を作成できます。

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

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

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

ラベル

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

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

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

バッジラベル

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

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

標準ラベル

0 個以上のフィールド タイプを含むラベル。標準ラベルには、「Project Moonshot」などのラベルタイトルを付け、プロジェクトに関連するすべてのファイルを示します。標準ラベルには、複数の構造化フィールドがある場合もあります。たとえば、「Contract」というタイトルのラベルには、「Company」、「Due Date」、「Status」、「Signatories」などのフィールドが含まれます。各フィールドは、特定のタイプ（テキスト、日付、選択、ユーザー）です。

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

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

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

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

ラベルタイプ

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

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

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

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

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

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

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

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

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

ラベルの分類

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

ラベルの分類の例:

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

ラベルは、作成、公開、更新などのライフサイクルに従います。ラベルを使ってライフサイクルを遂行すると、そのラベルのリビジョンがインクリメントされます。詳細については、ラベルのライフサイクルをご覧ください。

ラベルのリビジョン

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

リビジョンの下書き
ラベルの現在のドラフト インスタンスのリビジョン番号。ラベルにいくつかの更新を行うことができます。その場合、公開済みのリビジョンに影響を与えることなく、それぞれで下書きのリビジョン番号をインクリメントできます。下書きラベルを使用する機能は、公開前にラベルの更新をテストできます。
公開済みの版
ラベルの公開済みバージョンのリビジョン番号。公開されたラベルは、現在ユーザーが利用できるラベルのインスタンスです。