ラベルは、ユーザーが 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 個以上のフィールド タイプを含むラベル。標準ラベルには、「Project Moonshot」などのラベルタイトルが付けられ、プロジェクトに関連するすべてのファイルが示されている場合があります。標準ラベルには複数の構造化フィールドが存在することもあります。たとえば、「契約」というタイトルのラベルに、「会社」、「期限」、「ステータス」、「署名者」のフィールドが含まれているとします。各フィールドは、特定のタイプ(テキスト、日付、選択、またはユーザー)を持ちます。
- フィールド
個別に入力される設定可能なラベルのコンポーネント。ラベルには 0 個以上のフィールドを関連付けることができます。
- フィールド タイプ
- フィールドに関連付けられた値のデータ型。テキスト、整数、日付、ユーザー、選択として構成できます。このフィールドを
ListOptions
で構成すると、user フィールドと選択フィールドに複数の値を設定できます。選択したタイプは、ドライブのアイテムに適用される有効な値と、使用可能な検索クエリオプションの両方に影響します。
- 選択肢
ユーザーが
SelectionOptions
フィールド内で選択できるオプションのうちの 1 つ。- ラベルタイプ
すべてのラベルに
LabelType
が含まれています。ラベルには次の 2 種類があります。- アカウントとユーザーの管理
管理者が所有するラベルを作成および編集するには、ラベルの管理権限を持つアカウント管理者である必要があります。
管理者は任意のユーザーと管理ラベルを共有して、ドライブのアイテムの表示と適用権限をそのユーザーに付与できます。ドライブのアイテムのラベル値を変更または読み取るには、次の権限が必要です。
変更 - 特定のラベルに関連付けられたドライブ アイテムのメタデータをユーザーが変更するには、適切な権限レベルが必要です。
- ドライブのアイテム:
EDITOR
- ラベル:
APPLIER
- ドライブのアイテム:
読み取り - 特定のラベルに関連付けられたドライブ アイテムのメタデータをユーザーが読み取りまたは検索するには、適切な権限レベルを持っている必要があります。
- ドライブのアイテム:
READER
- ラベル:
READER
- ドライブのアイテム:
管理者以外のユーザーは、他のユーザーがドライブのアイテムに適用できる共有ラベルを作成できます。チームは、管理者を必要とせずに、チーム内で使用する独自のラベルを作成して整理できます。
- ラベルの分類
現在構成されているラベル フィールドは、ユーザーがドライブ ファイルに適用できます。ラベルスキーマとも呼ばれます。
ラベルの分類の例:
- 感度 - 赤、オレンジ、黄、緑
- ステータス - 未開始、下書き、審査中、最終
- コンテンツ タイプ - 契約、設計書、モックアップ
- 部門 - マーケティング、財務、人事、営業
- ラベルのライフサイクル
ラベルは、作成、公開、更新などのライフサイクルを通過します。ラベルがライフサイクルを経過すると、ラベルのリビジョンが増分されます。詳細については、ラベルのライフサイクルをご覧ください。
- ラベルのリビジョン
ラベルのインスタンス。ラベルが作成、更新、公開、非推奨になると、ラベルのリビジョンが増分します。
- 下書きの改訂
- ラベルの現在のドラフト インスタンスのリビジョン番号。公開済みのリビジョンに影響を与えることなく、ラベルに複数の更新を行うことができます。そのたびにドラフトのリビジョン番号が増えます。ドラフトラベルを使用すると、公開前にラベルの更新をテストできます。
- 公開済みのリビジョン
- 公開済みのラベルのリビジョン番号。公開ラベルは、ユーザーが現在利用できるラベルのインスタンスです。
関連トピック
認証や認可の処理など、Google Workspace API を使用した開発については、Google Workspace デベロッパーとして利用を開始するをご覧ください。
シンプルな Labels API アプリを構成して実行する方法については、Python クイックスタートをお試しください。