Google Drive Labels API スコープの選択

このドキュメントでは、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 スコープを使用します。

範囲 意味
  • https://www.googleapis.com/auth/drive
  • https://www.googleapis.com/auth/drive.file
  • https://www.googleapis.com/auth/drive.metadata
ドライブのアイテムに適用されたラベル メタデータを読み取り、検索、変更します。
  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive.metadata.readonly
アプリケーションに対して承認されているドライブ アイテムに適用されているラベル メタデータを読み取り、検索します。

詳細については、Drive API OAuth 2.0 スコープDrive API 固有の認可をご覧ください。

ラベルのスコープ

ラベルの表示と管理には、次の OAuth スコープを使用できます。

範囲 意味
https://www.googleapis.com/auth/drive.labels ドライブのラベルを表示、使用、管理します。
  • このスコープはユーザー アクセスを許可し、use_admin_access が設定されていない書き込みオペレーションに必要です。
  • このスコープの書き込みオペレーションは、SHARED ラベルタイプのラベルで有効です。
https://www.googleapis.com/auth/drive.labels.readonly ドライブのラベルを表示して使用する。
  • このスコープはユーザー アクセスを許可し、use_admin_access が設定されていない場合の読み取りオペレーションに必要です。
https://www.googleapis.com/auth/drive.admin.labels 組織内のすべてのドライブラベルの表示、編集、作成、削除、組織のラベル関連の管理ポリシーの表示を行えます。
  • このスコープは管理者アクセスを許可し、use_admin_access が設定されている場合の書き込みオペレーションに必要です。このスコープには読み取りアクセス権も付与されます。
  • このスコープの書き込みオペレーションは、SHARED または ADMINラベルタイプを持つラベルに対して有効です。
https://www.googleapis.com/auth/drive.admin.labels.readonly 組織内のすべてのドライブのラベルと、ラベルに関する管理者ポリシーを表示します。
  • このスコープでは管理者アクセスが許可され、use_admin_access が設定されている場合の読み取りオペレーションに必要です。

管理者アクセス

ADMIN ラベルを管理するには、次のものを指定する必要があります。

  • useAdminAccess は、ユーザーの管理者認証情報を使用する場合は true です。
  • ラベルの管理権限を持つアカウント管理者。

useAdminAccess

管理者は、管理者権限を呼び出すように useAdminAccess パラメータを設定する必要があります。useAdminAccess を設定すると、お客様が所有するすべてのラベルを表示、編集できます。これには、ADMIN ラベルと SHARED ラベルの両方が含まれます。

useAdminAccess が設定されていない場合、書き込みリクエストは、SHARED label type の両方を持つラベルと、このラベルに適切な EDITOR ロールを持つユーザーに対してのみ許可されます。

詳細については、アクセス認証情報を作成するをご覧ください。