Google Workspace Events API のスコープの選択

このドキュメントでは、Google Workspace Events API 固有の承認と 認証情報です。このドキュメントを読む前に、 Google Workspace の一般的な認証と認可情報については、 認証と認可について学習する

認可用に OAuth 2.0 を構成する

OAuth 同意画面を構成してスコープを選択する ユーザーやアプリのレビュアーに表示する情報を定義して、 有効にして後で公開できます

Google Workspace Events API のスコープ

アプリに付与するアクセスのレベルを定義するには、 認可スコープを宣言します。認可スコープは OAuth 2.0 URI 文字列で Google Workspace アプリの名前、アクセスするデータの種類 制御できます。スコープとは、以下を含む Google Workspace データを操作するためのアプリのリクエストです。 ユーザーGoogle アカウントのデータ。

アプリのインストール時に、ユーザーは使用するスコープを検証するよう求められます。 管理できます。通常は、最も絞り込んだ対象範囲を選択すべきです アプリで不要なスコープをリクエストしないようにします。ユーザー数の増加 明確に記述された制限付きのスコープへのアクセス権をすぐに付与する。

可能であれば、ファイルごとに付与されるため、機密性の低いスコープを使用することをおすすめします。 アクセス スコープを設定して、アプリに必要な特定の機能にのみアクセスできるようにします。

Google Workspace Events API は Google Workspace のスコープを使用します サポートしています。アプリですでにスコープを使用している場合 追加する必要はありません。 スコープについて説明します

次の表に、Cloud Storage の 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 ユーザーがアクセス可能な会議スペースのメタデータの読み取りをアプリに許可します。
センシティブ

上の表の [使用状況] 列は、各スコープの機密性を示しています。 定義します。

  • Non-sensitive - このスコープは、プロジェクト アクセスでき、必要なのは基本的なアプリ確認だけです。対象 詳しくは、試験準備の手順 確認します

  • 機密データ - 特定の Google ユーザーデータにアクセスできるスコープです。 権限があることを確認します。そのためには 追加アプリの確認を行います。この要件について詳しくは、手順 アプリの機密情報を スコープ

  • 制限付き - Google ユーザーデータに幅広くアクセスできます。 制限付きスコープの検証プロセスを受ける必要があります。対象 この要件の詳細については、Google API サービス: ユーザーデータ ポリシー および特定の API の追加要件 スコープ。 制限付きデータをサーバーに保存する(または転送する)場合は、 セキュリティ診断を受けます

アプリで他の Google API にアクセスする必要がある場合は、それらのスコープを追加できます できます。Google API スコープの詳細については、OAuth 2.0 を使用した OAuth 2.0 の使用をご覧ください。 Google API にアクセスする

特定の OAuth 2.0 スコープについて詳しくは、OAuth 2.0 スコープの Google API

OAuth の確認

特定の OAuth スコープを使用するには、アプリで Google の OAuth 検証 プロセスをご覧ください。 詳細については、OAuth API の確認 よくある質問 アプリの検証をいつ行うべきか、またどのような種類の 確認が必要です。Google ドライブ追加利用規約 Service です。

必要な認証の種類

このセクションでは、必須またはサポートされている認証の種類について説明します。 各メソッドのサポートされるスコープも示します。 Google Workspace Events API。

Google Chat のイベントのサブスクリプションでは、Google Workspace Events API は、ユーザー認証とアプリ認証の両方をサポートしています。API が メソッドは、すべての認証情報(呼び出しで使用される認証情報のタイプ)を は、返される結果に影響します。たとえば、 subscriptions.list() メソッドを呼び出すと、API は、ユーザー認証が有効なサブスクリプションのリストを 認証済みユーザーがアクセスできます。アプリの認証を使用する場合、API は app がアクセスできるサブスクリプションのリストを返します。詳細情報 チャット認証の種類について詳しくは、認証と認可 Chat アプリと Google Chat API リクエストできます

次の表に、VM のスコープとタイプを示します。 Google Workspace Events API ごとに認証が必須またはサポートされています メソッド:

メソッド ユーザー認証が必要またはサポートされている アプリの認証に対応(Google Chat アプリのみ) サポートされている認可スコープ
サブスクリプションを作成する

イベントタイプごとにサポートされているスコープが必要です。

  • chat.messages
  • chat.messages.readonly
  • chat.messages.reactions
  • chat.messages.reactions.readonly
  • chat.memberships
  • chat.memberships.readonly
  • chat.spaces
  • chat.spaces.readonly
  • meetings.space.created
  • meetings.space.readonly
サブスクリプションを取得する ユーザー認証を使用する場合、このメソッドでは、サブスクリプションの少なくとも 1 つのイベントタイプをサポートするスコープが必要です。

アプリの認証を使用する場合(Google Chat アプリのみ):

  • chat.bot
サブスクリプションを一覧表示する ユーザー認証を使用する場合、このメソッドでは、サブスクリプションの少なくとも 1 つのイベントタイプをサポートするスコープが必要です。

アプリの認証を使用する場合(Google Chat アプリのみ):

  • chat.bot
サブスクリプションを更新する

イベントタイプごとにサポートされているスコープが必要です。

  • chat.messages
  • chat.messages.readonly
  • chat.messages.reactions
  • chat.messages.reactions.readonly
  • chat.memberships
  • chat.memberships.readonly
  • chat.spaces
  • chat.spaces.readonly
  • meetings.space.created
  • meetings.space.readonly
定期購入を再開する

イベントタイプごとにサポートされているスコープが必要です。

  • chat.messages
  • chat.messages.readonly
  • chat.messages.reactions
  • chat.messages.reactions.readonly
  • chat.memberships
  • chat.memberships.readonly
  • chat.spaces
  • chat.spaces.readonly
  • meetings.space.created
  • meetings.space.readonly
サブスクリプションを削除する ユーザー認証を使用する場合、このメソッドでは、サブスクリプションの少なくとも 1 つのイベントタイプをサポートするスコープが必要です。

アプリの認証を使用する場合(Google Chat アプリのみ):

  • chat.bot

イベントタイプ別のスコープ

ユーザー認証を使用して Google Workspace Events API を呼び出すと、 イベントのイベントタイプに対応するスコープを 1 つ以上指定する必要があります。 。

次の表に、それぞれでサポートされている認可スコープを示します。 イベントタイプ:

イベント イベントタイプ サポートされている認可スコープ
Google Chat  
メッセージが投稿または更新された。
  • google.workspace.chat.message.v1.created
  • google.workspace.chat.message.v1.updated
  • chat.messages
  • chat.messages.readonly
リアクションが追加または削除されたか、複数のリアクションが変更された。
  • google.workspace.chat.reaction.v1.created
  • google.workspace.chat.reaction.v1.deleted
  • google.workspace.chat.reaction.v1.batchChanged
  • chat.messages.reactions
  • chat.messages.reactions.readonly
  • chat.messages
  • chat.messages.readonly
メンバーシップ または複数のメンバーシップが作成、更新、削除された場合 変更されます。
  • google.workspace.chat.membership.v1.created
  • google.workspace.chat.membership.v1.updated
  • google.workspace.chat.membership.v1.deleted
  • google.workspace.chat.membership.v1.batchChanged
  • chat.memberships
  • chat.memberships.readonly
スペースが更新または削除された場合。
  • google.workspace.chat.space.v1.updated
  • google.workspace.chat.space.v1.deleted
  • chat.spaces
  • chat.spaces.readonly
Google Meet  
会議の開始時と終了時。
  • google.workspace.meet.conference.v2.started
  • google.workspace.meet.conference.v2.ended
  • meetings.space.created
  • meetings.space.readonly
参加者が会議に参加または退出したとき。
  • google.workspace.meet.participant.v2.joined
  • google.workspace.meet.participant.v2.left
  • meetings.space.created
  • meetings.space.readonly
録音が生成されています。
  • google.workspace.meet.recording.v2.fileGenerated
  • meetings.space.created
  • meetings.space.readonly
文字起こしが生成されました。
  • google.workspace.meet.transcript.v2.fileGenerated
  • meetings.space.created
  • meetings.space.readonly