このドキュメントでは、Drive Labels API に固有の認可と認証情報について説明します。このドキュメントを読む前に、認証と認可の詳細で Google Workspace の一般的な認証と認可の情報を必ずお読みください。
認可用に OAuth 2.0 を構成する
OAuth 同意画面を構成し、スコープを選択して、ユーザーとアプリの審査担当者に表示する情報を定義し、後で公開できるようにアプリを登録します。
Google Drive Labels API スコープ
アプリに付与されるアクセスレベルを定義するには、認可スコープを特定して宣言する必要があります。認可スコープは、Google Workspace アプリ名、アクセスするデータの種類、アクセスレベルを含む OAuth 2.0 URI 文字列です。スコープとは、アプリが Google Workspace データ（ユーザーの Google アカウント データなど）を操作するためのリクエストです。
アプリのインストール時に、ユーザーはアプリで使用するスコープを検証するように求められます。通常は、できる限り狭い範囲にフォーカスしたスコープを選択し、アプリで不要なスコープをリクエストしないようにします。ユーザーは、明確に記述された制限付きのスコープへのアクセス権を簡単に付与できます。
可能であれば、機密性の低いスコープを使用することをおすすめします。これを使用すると、ファイルごとのアクセス スコープが付与され、アプリが必要とする特定の機能へのアクセスが絞り込まれます。
次の OAuth 2.0 スコープを使用して、ラベル メタデータが適用されたドライブ アイテムの読み取り、検索、変更を行うことができます。
| 範囲 | 意味 |
|---|---|
|
ドライブのアイテムに適用されるラベル メタデータの読み取り、検索、変更。 |
|
アプリケーションで承認されたドライブのアイテムに適用されるラベル メタデータの読み取りと検索を行います。 |
詳細については、Drive API OAuth 2.0 スコープと Drive API 固有の承認をご覧ください。
ラベルのスコープ
ラベルの表示と管理には、次の OAuth スコープを使用できます。
| 範囲 | 意味 |
|---|---|
https://www.googleapis.com/auth/drive.labels
|
ドライブのラベルを表示、使用、管理します。
|
https://www.googleapis.com/auth/drive.labels.readonly
|
ドライブのラベルの表示と使用。
|
https://www.googleapis.com/auth/drive.admin.labels
|
組織内のすべてのドライブラベルを表示、編集、作成、削除し、組織のラベル関連の管理ポリシーを表示します。
|
https://www.googleapis.com/auth/drive.admin.labels.readonly
|
組織内のすべてのドライブのラベルとラベル関連の管理ポリシーを表示します。
|
管理者アクセス
ADMIN ラベルを管理するには、次の項目を指定する必要があります。
- ユーザーの管理者認証情報を使用する場合、
useAdminAccessはtrueです。 - ラベルの管理権限を持つアカウント管理者。
useAdminAccess
管理者は、管理者権限を呼び出すように useAdminAccess パラメータを設定する必要があります。useAdminAccess を設定すると、顧客が所有するラベルの表示と編集が可能になります。これには、ADMIN ラベルと SHARED ラベルの両方が含まれます。
useAdminAccess が設定されていない場合、書き込みリクエストは、SHARED label type を持つラベルと、このラベルに対して適切な EDITOR ロールを持つユーザーにのみ許可されます。
詳細については、アクセス認証情報を作成するをご覧ください。