このドキュメントでは、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 |
Google Chat アプリがチャットを表示し、メッセージを送信できるようにします。Chat アプリで利用可能なすべての機能にアクセスできます。 | 非機密 | ||
https://www.googleapis.com/auth/chat.memberships |
Google Chat の会話のメンバーを参照、追加、削除する。 | センシティブ |
||
https://www.googleapis.com/auth/chat.memberships.readonly |
Google Chat での会話のメンバーの参照。 | センシティブ |
||
https://www.googleapis.com/auth/chat.spaces |
Google Chat での会話やスペースの作成、メタデータの参照、更新（履歴の設定を含む） | デリケートなコンテンツ | ||
https://www.googleapis.com/auth/chat.spaces.readonly |
Google Chat でチャットとスペースを表示します。 | センシティブ |
||
https://www.googleapis.com/auth/chat.messages.reaction 秒 |
Chat でメッセージに対するリアクションを表示、追加、削除する。 | センシティブ |
||
https://www.googleapis.com/auth/chat.messages.reactions.readonly |
Chat でメッセージへのリアクションを表示する。 | センシティブ |
||
https://www.googleapis.com/auth/chat.messages |
メッセージを表示、作成、送信、更新、削除し、メッセージに対するリアクションを追加、表示、削除する。 | 制限付き | ||
https://www.googleapis.com/auth/chat.messages.readonly |
Google Chat のメッセージとリアクションを表示する。 | 制限付き |
||
| Google Meet | ||||
https://www.googleapis.com/auth/meetings.space.created |
アプリが作成した会議スペースに関するメタデータの作成、変更、読み取りをアプリに許可します。 | センシティブ |
||
https://www.googleapis.com/auth/meetings.space.readonly |
ユーザーがアクセスできる会議スペースに関するメタデータをアプリが読み取れるようにします。 | センシティブ |
||
上の表の [使用状況] 列は、次の定義に従って各スコープの感度を示しています。
非機密 - これらのスコープは、承認アクセスの最も小さいスコープを提供し、基本的なアプリの確認のみを必要とします。この要件については、確認の準備手順をご覧ください。
機密性の高いデータ - これらのスコープは、アプリに対してユーザーが承認した特定の Google ユーザーデータへのアクセス権を付与します。追加のアプリ確認が必要になります。この要件については、機密性の高いスコープをリクエストするアプリの手順をご覧ください。
制限付き - これらのスコープは Google のユーザーデータへの幅広いアクセスを可能にします。制限付きスコープの検証プロセスを完了する必要があります。この要件について詳しくは、Google API サービス: ユーザーデータ ポリシーと特定の API スコープの追加要件をご覧ください。制限付きスコープのデータをサーバーに保存（または送信）する場合は、セキュリティ評価を受ける必要があります。
アプリが他の Google API へのアクセスを必要とする場合は、それらのスコープも追加できます。Google API スコープの詳細については、OAuth 2.0 を使用した Google API へのアクセスをご覧ください。
特定の OAuth 2.0 スコープの詳細については、Google API の OAuth 2.0 スコープをご覧ください。
OAuth の確認
特定の OAuth スコープを使用する場合、アプリは Google の OAuth 確認プロセスを完了する必要があります。OAuth API の確認に関するよくある質問を読んで、アプリの確認が必要なタイミングと、必要な確認の種類を確認してください。Google ドライブ追加利用規約もご覧ください。
必要な認証の種類
このセクションでは、必要な認証の種類とサポートされている認証の種類について説明します。また、Google Workspace Events API の各メソッドでサポートされているスコープについても説明します。
Google Chat イベントのサブスクリプションの場合、Google Workspace Events API は、一部のメソッドを呼び出すためにユーザー認証とアプリ認証の両方をサポートしています。API メソッドが両方の認証情報をサポートしている場合、呼び出しで使用される認証情報のタイプが返される結果に影響します。たとえば、ユーザー認証で subscriptions.list() メソッドを呼び出すと、API は認証済みユーザーがアクセスできる定期購入のリストを返します。アプリ認証を使用する場合、API はアプリがアクセスできるサブスクリプションのリストを返します。Chat 認証の種類について詳しくは、Chat アプリと Google Chat API リクエストの認証と承認をご覧ください。
次の表に、Google Workspace Events API の各メソッドで必要な認証スコープと認証の種類を示します。
| メソッド | ユーザー認証が必須またはサポートされている | アプリ認証がサポートされている（Google Chat アプリのみ） | サポートされている認可スコープ | |
|---|---|---|---|---|
| サブスクリプションを作成する | — |
各イベントタイプでサポートされているスコープが必要です。
|
||
| サブスクリプションを購入する |
ユーザー認証を使用する場合、この方法では、サブスクリプションの少なくとも 1 つのイベントタイプをサポートするスコープが必要です。 アプリ認証を使用（Google Chat アプリのみ）:
|
|||
| サブスクリプションの一覧表示 |
ユーザー認証を使用する場合、この方法では、サブスクリプションの少なくとも 1 つのイベントタイプをサポートするスコープが必要です。 アプリ認証を使用（Google Chat アプリのみ）:
|
|||
| 定期購入を更新する | — |
各イベントタイプでサポートされているスコープが必要です。
|
||
| サブスクリプションを再び有効にする | — |
各イベントタイプでサポートされているスコープが必要です。
|
||
| サブスクリプションを削除する |
ユーザー認証を使用する場合、この方法では、サブスクリプションの少なくとも 1 つのイベントタイプをサポートするスコープが必要です。 アプリ認証を使用（Google Chat アプリのみ）:
|
|||
イベントタイプ別のスコープ
ユーザー認証を使用して Google Workspace Events API を呼び出す場合は、サブスクリプションのイベントタイプに対応する 1 つ以上のスコープを指定する必要があります。
次の表に、イベントタイプごとにサポートされている認可スコープを示します。
| イベント | イベントの種類 | サポートされている認可スコープ | ||||||
|---|---|---|---|---|---|---|---|---|
| Google Chat | ||||||||
| メッセージが投稿または更新された。 |
|
|
||||||
| リアクションが追加または削除された、または複数のリアクションが変更された。 |
|
|
||||||
| メンバーシップが作成、更新、削除された、または複数のメンバーシップが変更された。 |
|
|
||||||
| スペースが更新または削除された。 |
|
|
||||||
| Google Meet | ||||||||
| 会議の開始または終了。 |
|
|
||||||
| 参加者が会議に参加または退出する。 |
|
|
||||||
| 録画が生成されました。 |
|
|
||||||
| 文字起こしが生成されました。 |
|
|
||||||