このドキュメントには、Google Workspace Events API 固有の認可と認証に関する情報が記載されています。このドキュメントを読む前に、認証と認可についてで Google Workspace の認証と認可に関する一般的な情報を必ずお読みください。
認可用に OAuth 2.0 を構成する
OAuth 同意画面を構成し、スコープを選択して、ユーザーとアプリの審査担当者に表示される情報を定義し、後でアプリを公開できるようにアプリを登録します。
Google Workspace Events API のスコープ
アプリに付与するアクセスレベルを定義するには、承認スコープを特定して宣言する必要があります。認証スコープは、Google Workspace アプリ名、アクセスするデータの種類、アクセスレベルを含む OAuth 2.0 URI 文字列です。スコープとは、ユーザーの Google アカウントのデータを含む Google Workspace データを操作するためのアプリのリクエストのことです。
アプリがインストールされると、ユーザーはアプリで使用されるスコープの検証を求められます。一般に、できる限り狭い範囲のスコープを選択し、アプリで必要ないスコープはリクエストしないようにします。ユーザーは、明確に説明された限定的なスコープに対してアクセス権限を付与する傾向があります。
Google Workspace Events API は、サブスクリプションをサポートする Google Workspace アプリケーションのスコープを使用します。アプリですでに定期購入に必要なスコープを使用している場合は、Google Workspace Events API を使用するためにスコープを追加する必要はありません。スコープを追加する場合は、アプリが機能する範囲で最も機密性の低いスコープを選択してください。スコープ カテゴリの詳細については、スコープ カテゴリをご覧ください。
次の表に、Google Workspace Events API でサポートされているスコープを示します。
| スコープコード | 説明 | 用途 | ||
|---|---|---|---|---|
| Google Chat | ||||
https://www.googleapis.com/auth/chat.bot |
Chat 用アプリがチャットを表示してメッセージを送信できるようにします。Chat 用アプリで利用可能なすべての機能へのアクセス権を付与します。 | 機密情報ではない | ||
https://www.googleapis.com/auth/chat.memberships |
Chat での会話のメンバーの参照、追加、削除。 | Sensitive |
||
https://www.googleapis.com/auth/chat.memberships.readonly |
Chat の会話のメンバーを表示する。 | Sensitive |
||
https://www.googleapis.com/auth/chat.app.memberships |
Chat アプリとして、Chat の会話やスペースのメンバーを表示、追加、更新、削除します。 管理者の承認が必要です。 このスコープは、サービス アカウントを使用したアプリ認証のみをサポートします。このスコープを使用して、ユーザー認証情報またはドメイン全体の委任で認証することはできません。 |
Sensitive |
||
https://www.googleapis.com/auth/chat.spaces |
Chat での会話やスペースの作成、メタデータの参照、更新（履歴の設定を含む）。 | デリケートなコンテンツ | ||
https://www.googleapis.com/auth/chat.spaces.readonly |
Chat でチャットとスペースを表示します。 | Sensitive |
||
https://www.googleapis.com/auth/chat.app.spaces |
Chat 用アプリとして、Chat での会話やスペースの作成、メタデータ（履歴の設定を含む）の参照、更新。 管理者の承認が必要です。 このスコープは、サービス アカウントを使用したアプリ認証のみをサポートします。このスコープを使用して、ユーザー認証情報またはドメイン全体の委任で認証することはできません。 |
Sensitive |
||
https://www.googleapis.com/auth/chat.messages.reaction 秒 |
Chat でのメッセージに対するリアクションの参照、追加、削除。 | Sensitive |
||
https://www.googleapis.com/auth/chat.messages.reactions.readonly |
Chat でメッセージへのリアクションを表示する。 | Sensitive |
||
https://www.googleapis.com/auth/chat.messages |
メッセージの参照、作成、送信、更新、削除、メッセージに対するリアクションの追加、参照、削除。 | 制限付き | ||
https://www.googleapis.com/auth/chat.messages.readonly |
Chat のメッセージとリアクションを表示します。 | 制限付き |
||
https://www.googleapis.com/auth/chat.app.messages.readonly |
Chat アプリとして Chat のメッセージとリアクションを表示します。 管理者の承認が必要です。 このスコープは、サービス アカウントを使用したアプリ認証のみをサポートします。このスコープを使用して、ユーザー認証情報またはドメイン全体の委任で認証することはできません。 |
制限付き |
||
| Google ドライブ | ||||
https://www.googleapis.com/auth/drive.file |
Google Picker API またはアプリのファイル選択ツールを使用して、アプリで開いたファイルやユーザーがアプリと共有したファイルに対して、新しいドライブ ファイルを作成したり、既存のファイルを変更したりできます。 | 機密情報ではない | ||
https://www.googleapis.com/auth/drive |
ドライブのすべてのファイルを表示、管理できます。 | 制限付き | ||
https://www.googleapis.com/auth/drive.readonly |
ドライブのすべてのファイルを表示、ダウンロードできます。 | 制限付き | ||
https://www.googleapis.com/auth/drive.metadata |
ドライブ内のファイルのメタデータを表示、管理します。 | 制限付き | ||
https://www.googleapis.com/auth/drive.metadata.readonly |
ドライブ内のファイルのメタデータを表示できます。 | 制限付き | ||
| Google Meet | ||||
https://www.googleapis.com/auth/meetings.space.created |
アプリで作成した会議スペースに関するメタデータの作成、変更、読み取りをアプリに許可します。 | Sensitive |
||
https://www.googleapis.com/auth/meetings.space.readonly |
ユーザーがアクセスできる会議スペースに関するメタデータをアプリが読み取れるようにします。 | Sensitive |
||
上の表の [Usage] 列は、各スコープの機密性を示しています。
センシティブでない: これらのスコープは、最小限の認可アクセスを提供し、基本的なアプリの確認のみを必要とします。この要件については、確認の要件をご覧ください。
機密情報: これらのスコープは、ユーザーがアプリに対して承認した特定の Google ユーザーデータへのアクセスを提供します。追加のアプリの確認を受ける必要があります。この要件については、機密情報と制限付きスコープの要件をご覧ください。
制限付き: これらのスコープは Google ユーザーデータへの広範なアクセスを提供するため、制限付きスコープの確認プロセスを完了する必要があります。この要件について詳しくは、Google API サービス: ユーザーデータに関するポリシーと特定の API スコープに関する追加要件をご覧ください。制限付きスコープのデータをサーバーに保存（または送信）する場合は、セキュリティ評価を受ける必要があります。
アプリが他の Google API へのアクセスを必要とする場合は、それらのスコープも追加できます。Google API スコープの詳細については、OAuth 2.0 を使用して Google API にアクセスするをご覧ください。
特定の OAuth 2.0 スコープの詳細については、Google API の OAuth 2.0 スコープをご覧ください。
OAuth の確認
特定の OAuth スコープを使用するには、アプリが OAuth アプリの確認に関するヘルプセンターの手続きを行う必要がある場合があります。OAuth アプリに関するよくある質問を読んで、アプリの確認が必要になるタイミングと、必要な確認の種類を確認してください。ドライブの利用規約もご覧ください。
必要な認証の種類
このセクションでは、必要な認証またはサポートされている認証の種類について説明し、Google Workspace Events API の各メソッドでサポートされているスコープを示します。
Chat イベントのサブスクリプションの場合、Google Workspace Events API は、一部のメソッドを呼び出すためのユーザー認証とアプリ認証の両方をサポートしています。API メソッドが両方の認証情報をサポートしている場合、呼び出しで使用される認証情報のタイプによって、返される結果が異なります。たとえば、ユーザー認証で subscriptions.list メソッドを呼び出すと、API は認証済みユーザーがアクセスできる定期購入のリストを返します。アプリ認証を使用している場合、API はアプリがアクセスできる定期購入のリストを返します。Chat 認証のタイプについて詳しくは、Chat アプリと Chat API リクエストの認証と認可をご覧ください。
次の表に、各 Google Workspace Events API メソッドで必要な認証のスコープとタイプを示します。
| メソッド | ユーザー認証が必要またはサポートされている | アプリ認証がサポートされている（Chat 用アプリのみ） | サポートされている認可スコープ | |
|---|---|---|---|---|
| 定期購入の作成 | — |
ユーザー認証の場合、イベントタイプごとにサポートされているスコープが必要です。
デベロッパー プレビュー: アプリの認証と管理者の承認（Chat 用アプリのみ）が必要です。各イベントタイプのサポート対象スコープが必要です。
|
||
| サブスクリプションを取得する |
ユーザー認証の場合、このメソッドには、サブスクリプションで少なくとも 1 つのイベントタイプをサポートするスコープが必要です。 アプリ認証（Chat 用アプリのみ）:
|
|||
| サブスクリプションの一覧表示 |
ユーザー認証の場合、このメソッドには、サブスクリプションで少なくとも 1 つのイベントタイプをサポートするスコープが必要です。 アプリ認証（Chat 用アプリのみ）:
|
|||
| サブスクリプションを更新する | — |
ユーザー認証の場合、イベントタイプごとにサポートされているスコープが必要です。
デベロッパー プレビュー: アプリの認証と管理者の承認（Chat 用アプリのみ）が必要です。また、各イベントタイプのサポート対象スコープが必要です。
|
||
| サブスクリプションを再有効化する | — |
ユーザー認証の場合、イベントタイプごとにサポートされているスコープが必要です。
デベロッパー プレビュー: アプリの認証と管理者の承認（Chat 用アプリのみ）が必要です。各イベントタイプのサポート対象スコープが必要です。
|
||
| 定期購入を削除する |
ユーザー認証の場合、このメソッドには、サブスクリプションで少なくとも 1 つのイベントタイプをサポートするスコープが必要です。 アプリ認証（Chat 用アプリのみ）:
|
|||
イベントタイプ別のスコープ
ユーザー認証を使用して Google Workspace Events API を呼び出す場合は、サブスクリプションのイベントタイプに対応する 1 つ以上のスコープを指定する必要があります。
次の表に、各イベントタイプでサポートされている認可スコープを示します。
| イベント | イベントタイプ | サポートされている認証スコープ | ||||||
|---|---|---|---|---|---|---|---|---|
| チャット | ||||||||
| メッセージが投稿または更新された。 |
|
ユーザー認証の場合:
|
||||||
| リアクションが追加または削除された場合、または複数のリアクションが変更された場合。 |
|
|
||||||
| メンバーシップが作成、更新、削除された場合、または複数のメンバーシップが変更された場合。 |
|
ユーザー認証の場合:
|
||||||
| スペースが更新または削除された。 |
|
ユーザー認証の場合:
|
||||||
| ドライブ | ||||||||
| ファイルが作成、変更、移動、削除、名前変更、ゴミ箱への移動、ゴミ箱からの削除された。 |
|
|
||||||
| ファイルに対するアクセス提案が作成または解決された。 |
|
|
||||||
| ファイルの承認がキャンセル、完了、作成、リセットされた場合、またはレビュー担当者が変更された場合、またはレビュー担当者がファイルに応答した場合。 |
|
|
||||||
| ファイルに対するコメントが作成、削除、編集、再開、解決された。 |
|
|
||||||
| ファイルに対する返信が作成、削除、編集された。 |
|
|
||||||
| ファイルに対する権限が作成、削除、編集された。 |
|
|
||||||
| Meet | ||||||||
| 会議が開始または終了した。 |
|
|
||||||
| 参加者が会議に参加または退出します。 |
|
|
||||||
| 録画が生成されました。 |
|
|
||||||
| 文字起こしが生成されました。 |
|
|
||||||