このドキュメントには、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 ロールを持つユーザーにのみ、書き込みリクエストが許可されます。
詳細については、アクセス認証情報を作成するをご覧ください。