このドキュメントには、Google Workspace Events API 固有の認可と認証の情報が記載されています。このドキュメントを読む前に、認証と認可について学習するで、Google Workspace の一般的な認証と認可の情報を必ずお読みください。
認可用に OAuth 2.0 を構成する
OAuth 同意画面を構成し、スコープを選択して、ユーザーとアプリの審査担当者に表示する情報を定義し、後で公開できるようにアプリを登録します。
Google Workspace Events API スコープ
アプリに付与されるアクセスレベルを定義するには、認可スコープを特定して宣言する必要があります。認可スコープは OAuth 2.0 URI 文字列で、Google Workspace アプリ名、アクセスするデータの種類、アクセスレベルが含まれます。スコープとは、ユーザーの 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 |
メッセージを表示、作成、送信、更新、削除し、メッセージに対するリアクションを追加、表示、削除する。 | 制限されています | ||
https://www.googleapis.com/auth/chat.messages.readonly |
Google Chat でメッセージとリアクションを表示できます。 | 制限付き |
||
https://www.googleapis.com/auth/chat.messages.reaction 秒 |
Chat でメッセージへのリアクションを表示、追加、削除する。 | 制限付き |
||
https://www.googleapis.com/auth/chat.messages.reactions.readonly |
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 | ||||||||
| 会議の開始と終了。 |
|
|
||||||
| 参加者が会議に参加または会議から退出した場合。 |
|
|
||||||
| 録音が生成されました。 |
|
|
||||||
| 文字起こしが生成されました。 |
|
|
||||||