このドキュメントでは、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 での会話のメンバーの参照、追加、削除 | 機密 |
||
https://www.googleapis.com/auth/chat.memberships.readonly |
Chat の会話のメンバーを表示します。 | 機密 |
||
https://www.googleapis.com/auth/chat.app.memberships |
Chat 用アプリとして、Chat の会話やスペースのメンバーを表示、追加、更新、削除します。 管理者の承認が必要です。 このスコープは、サービス アカウントを使用したアプリ認証のみをサポートしています。このスコープを使用して、ユーザー認証情報またはドメイン全体の委任で認証することはできません。 |
機密 |
||
https://www.googleapis.com/auth/chat.app.memberships.readonly |
Google Chat での会話やスペースのメンバーを Chat アプリとして表示します。 管理者の承認が必要です。 このスコープは、サービス アカウントを使用したアプリ認証のみをサポートしています。このスコープを使用して、ユーザー認証情報またはドメイン全体の委任で認証することはできません。 |
機密 |
||
https://www.googleapis.com/auth/chat.spaces |
Chat での会話やスペースの作成、メタデータの参照、更新（履歴の設定を含む）。 | デリケートなコンテンツ | ||
https://www.googleapis.com/auth/chat.spaces.readonly |
Chat でチャットとスペースを参照する。 | 機密 |
||
https://www.googleapis.com/auth/chat.app.spaces |
Chat 用アプリとして、Chat での会話やスペースの作成、メタデータの参照、更新（履歴の設定を含む）を行います。 管理者の承認が必要です。 このスコープは、サービス アカウントを使用したアプリ認証のみをサポートしています。このスコープを使用して、ユーザー認証情報またはドメイン全体の委任で認証することはできません。 |
機密 |
||
https://www.googleapis.com/auth/chat.app.spaces.readonly |
Google Chat で Chat 用アプリとしてメタデータ（履歴設定を含む）を表示します。 管理者の承認が必要です。 このスコープは、サービス アカウントを使用したアプリ認証のみをサポートしています。このスコープを使用して、ユーザー認証情報またはドメイン全体の委任で認証することはできません。 |
機密 |
||
https://www.googleapis.com/auth/chat.messages.reactions |
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 |
Chat でメッセージとリアクションを表示する。 | 制限付き |
||
https://www.googleapis.com/auth/chat.app.messages.readonly |
Chat 用アプリとして Chat のメッセージとリアクションを表示します。 管理者の承認が必要です。 このスコープは、サービス アカウントを使用したアプリ認証のみをサポートしています。このスコープを使用して、ユーザー認証情報またはドメイン全体の委任で認証することはできません。 |
制限付き |
||
https://www.googleapis.com/auth/chat.users.readstate |
Chat でユーザーの既読状態を表示、更新する。 | 機密 |
||
https://www.googleapis.com/auth/chat.users.readstate.readonly |
Chat でユーザーの既読ステータスを表示する。 | 機密 |
||
https://www.googleapis.com/auth/chat.users.availability |
Chat でオンライン ステータスを表示、変更する。 | 機密 |
||
https://www.googleapis.com/auth/chat.users.availability.readonly |
Chat でオンライン ステータスを確認する。 | 機密 |
||
https://www.googleapis.com/auth/chat.app.all.spaces.readonly |
Chat アプリがメンバーでない場合でも、Google Workspace 組織全体の Google Chat のすべてのスペースと会話に関するメタデータを参照する。 このスコープは、お客様のサブスクリプションでのみサポートされています。 管理者の承認が必要です。 このスコープは、サービス アカウントを使用したアプリ認証のみをサポートしています。このスコープを使用して、ユーザー認証情報またはドメイン全体の委任で認証することはできません。 |
制限付き | ||
https://www.googleapis.com/auth/chat.app.all.memberships.readonly |
Chat アプリがメンバーでない場合でも、Google Workspace 組織全体の Google Chat スペースと会話のすべてのメンバーを参照する。 このスコープは、お客様のサブスクリプションでのみサポートされています。 管理者の承認が必要です。 このスコープは、サービス アカウントを使用したアプリ認証のみをサポートしています。このスコープを使用して、ユーザー認証情報またはドメイン全体の委任で認証することはできません。 |
制限付き | ||
https://www.googleapis.com/auth/chat.app.all.messages.readonly |
Chat 用アプリがスペースや会話のメンバーでない場合でも、Google Workspace 組織全体のすべてのメッセージとリアクションを参照する。 このスコープは、お客様のサブスクリプションでのみサポートされています。 管理者の承認が必要です。 このスコープは、サービス アカウントを使用したアプリ認証のみをサポートしています。このスコープを使用して、ユーザー認証情報またはドメイン全体の委任で認証することはできません。 |
制限付き | ||
https://www.googleapis.com/auth/chat.app.all.users.readstate.readonly |
Chat 用アプリがメンバーでない場合でも、Google Workspace 組織全体のすべてのスペースと会話におけるすべてのユーザーの最終閲覧時刻を参照します。 このスコープは、お客様のサブスクリプションでのみサポートされています。 管理者の承認が必要です。 このスコープは、サービス アカウントを使用したアプリ認証のみをサポートしています。このスコープを使用して、ユーザー認証情報またはドメイン全体の委任で認証することはできません。 |
制限付き | ||
| 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 |
アプリで作成した会議スペースに関するメタデータの作成、変更、読み取りをアプリに許可します。 | 機密 |
||
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 スコープを使用する場合、アプリは 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 アプリのみ） | サポートされている承認スコープ | |
|---|---|---|---|---|
| サブスクリプションを作成する | — |
ユーザー認証では、イベントタイプごとにサポートされているスコープが必要です。
アプリ認証と管理者による承認（Google Chat アプリのみ）では、イベントタイプごとにサポートされているスコープが必要です。
|
||
| サブスクリプションを取得する |
ユーザー認証の場合、このメソッドには、サブスクリプションの少なくとも 1 つのイベントタイプをサポートするスコープが必要です。 アプリ認証（Chat 用アプリのみ）:
|
|||
| サブスクリプションの一覧表示 |
ユーザー認証の場合、このメソッドには、サブスクリプションの少なくとも 1 つのイベントタイプをサポートするスコープが必要です。 アプリ認証（Chat 用アプリのみ）:
|
|||
| サブスクリプションを更新する | — |
ユーザー認証では、イベントタイプごとにサポートされているスコープが必要です。
アプリ認証と管理者による承認（Google Chat アプリのみ）では、イベントタイプごとにサポートされているスコープが必要です。
|
||
| サブスクリプションを再開する | — |
ユーザー認証では、イベントタイプごとにサポートされているスコープが必要です。
アプリ認証と管理者による承認（Chat 用アプリのみ）では、イベントタイプごとにサポートされているスコープが必要です。
|
||
| サブスクリプションを削除する |
ユーザー認証の場合、このメソッドには、サブスクリプションの少なくとも 1 つのイベントタイプをサポートするスコープが必要です。 アプリ認証（Chat 用アプリのみ）:
|
|||
イベントタイプ別のスコープ
ユーザー認証を使用して Google Workspace Events API を呼び出す場合は、サブスクリプションのイベントタイプに対応する 1 つ以上のスコープを指定する必要があります。
次の表に、各イベントタイプでサポートされている認可スコープを示します。
| イベント | イベントタイプ | サポートされている認可スコープ | ||||||
|---|---|---|---|---|---|---|---|---|
| チャット | ||||||||
| メッセージが投稿または更新された。 |
|
ユーザー認証の場合:
|
||||||
| リアクションが追加または削除された場合、または複数のリアクションが変更された場合。 |
|
ユーザー認証の場合:
|
||||||
| メンバーシップが作成、更新、削除されるか、複数のメンバーシップが変更されます。 |
|
ユーザー認証の場合:
|
||||||
| スペースが更新または削除された。 |
|
ユーザー認証の場合:
|
||||||
| ユーザーのスペースの既読状態またはスレッドの既読状態が更新された。 |
|
ユーザー認証の場合:
|
||||||
| 空き状況が更新された。 |
|
ユーザー認証の場合:
|
||||||
| ドライブ | ||||||||
| ファイルが作成、変更、移動、削除、名前変更、ゴミ箱への移動、ゴミ箱からの削除が行われた。 |
|
|
||||||
| ファイルに対するアクセス提案が作成または解決された。 |
|
|
||||||
| ファイルに対する承認がキャンセル、完了、作成、リセットされた、レビュー担当者が変更された、またはレビュー担当者が応答した。 |
|
|
||||||
| ファイルに対してコメントが作成、削除、編集、再開、解決された。 |
|
|
||||||
| ファイルに対する返信が作成、削除、編集された。 |
|
|
||||||
| ファイルに対する権限が作成、削除、編集された。 |
|
|
||||||
| Meet | ||||||||
| 会議が開始または終了した。 |
|
|
||||||
| 参加者が会議に参加または退出した。 |
|
|
||||||
| 録画が生成された。 |
|
|
||||||
| 文字起こしが生成されました。 |
|
|
||||||