承認と管理者権限の情報

このドキュメントでは、API 固有の承認情報について説明します。このドキュメントを読む前に、認証と認可の詳細で Google Workspace の一般的な認証と認可の情報を必ずお読みください。

OAuth スコープ

アプリに付与されるアクセスレベルを定義するには、認可スコープを特定して宣言する必要があります。認可スコープは、Google Workspace アプリ名、アクセスするデータの種類、アクセスレベルなどの OAuth 2.0 URI 文字列です。

ラベルとその Google ドライブ アイテム メタデータを操作するリクエストには、正しい OAuth スコープが必要です。

スコープの詳細については、アプリのスコープを選択する方法をご覧ください。

ドライブ アイテムのラベル メタデータ用のスコープ

次の OAuth スコープを使用して、ラベルのメタデータが適用されたドライブ アイテムの読み取り、検索、変更を行うことができます。

スコープ 意味
  • 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 が設定されている場合の読み取りオペレーションに必要です。
  • このスコープが設定された書き込みオペレーションは、ラベルタイプSHARED または ADMIN のラベルに対して有効です。

管理者アクセス

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

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

useAdminAccess

管理者が管理者権限を呼び出すには、useAdminAccess パラメータを設定する必要があります。useAdminAccess を設定すると、顧客が所有するラベルの表示と編集が可能になります。これには、ADMIN ラベルと SHARED ラベルの両方が含まれます。

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

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