このドキュメントでは、Drive Labels API 固有の認可と認証情報について説明します。このドキュメントを読む前に、認証と認可についてで Google Workspace の認証と認可に関する一般的な情報を確認してください。
認可用に OAuth 2.0 を構成する
OAuth 同意画面を構成し、スコープを選択することで、ユーザーとアプリの審査担当者に表示される情報を定義し、後でアプリを公開できるようにアプリを登録します。
Google Drive Labels API スコープ
アプリに付与するアクセスレベルを定義するには、承認スコープを特定して宣言する必要があります。認証スコープは、Google Workspace アプリ名、アクセスするデータの種類、アクセスレベルを含む OAuth 2.0 URI 文字列です。スコープとは、ユーザーの Google アカウント データを含む Google Workspace データを操作するためのアプリのリクエストのことです。
アプリがインストールされると、アプリで使用されるスコープの検証を求めるメッセージがユーザーに表示されます。一般に、できる限り狭い範囲のスコープを選択し、アプリで必要ないスコープはリクエストしないようにします。ユーザーは、明確に説明された限定的なスコープに対してアクセス権限を付与する傾向があります。
可能な場合は、機密性の低いスコープを使用することをおすすめします。これにより、ファイルごとのアクセス スコープが付与され、アプリに必要な特定の機能へのアクセスが制限されます。
次の 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 ロールを持つユーザーに対してのみ許可されます。
詳細については、アクセス認証情報を作成するをご覧ください。