Drive Labels API の概要

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

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

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

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

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

ラベル

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

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

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

バッジラベル

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

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

標準のラベル

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

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

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

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

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

ラベルタイプ

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

管理者

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

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

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

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

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

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

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

ラベル分類

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

ラベル分類の例:

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

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

ラベルのリビジョン

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

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