このドキュメントでは、Drive Labels API 固有の認可と認証について説明します。このドキュメントを読む前に、 認証と認可について で Google Workspace の一般的な認証と認可についてお読みください。
認可用に OAuth 2.0 を構成する
OAuth 同意画面を構成し、スコープを選択 して、ユーザーとアプリの審査担当者に表示される情報を定義し、 後で公開できるようにアプリを登録します。
Google ドライブ ラベル 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 ロールを持つユーザーに対してのみ許可されます。
詳細については、アクセス認証情報 を作成するをご覧ください。