このページでは、Google Chat アプリでの受信と応答の仕組みについて説明します。 Google Chat で管理できます。
Google Chat のイベントは、Chat のアクティビティまたは変更を表します。 新着メッセージの通知を受け取ります。Chat 用アプリは 発生したイベントを把握し、有意義に 提供できます
イベントの使い方の例を次に示します。
- キーの確認など、スペース内の新しいメッセージのモニタリングと対応 単語やフレーズを使用します。
- ユーザーがスペースに参加したときに、スペースについて説明するウェルカム メッセージを送信します ルールを効果的に使用するためのヒントを紹介したり、 Chat アプリ。
- Chat のアクティビティを追跡、分析する。たとえば、 新規メンバーや、特に効果の高いメッセージに関する月次レポート 返信文を作成することもできます。
- 複数のメッセージング プラットフォーム間でのコミュニケーション。たとえば、ユーザーは 別のメッセージング プラットフォームでユーザーからのメッセージを受信できます。 終了です。
イベントの仕組み
Google Chat で何かが発生すると、Google Chat API リソースが 自動的に作成されます。Chat では、イベントを使用して メッセージの種類に関する情報を Chat アプリに 影響を受けた Chat API リソースを確認できます。
Message リソースが作成されます。
その後、新しいイベントに関するデータを含むイベントが作成され、
説明します。Chat ではイベントが種類別に分類されます。イベントタイプを使用すると、 必要な情報のみを受け取り、同様の内容 できます。
次の表は、Chat のアクティビティが 関連する Chat API リソースと、そのイベントのタイプを Chat アプリは以下を受信します。
| アクティビティ | Chat API リソース | イベントの種類 |
|---|---|---|
| ユーザーが Chat スペースにメッセージを投稿しました | Message リソースが作成されます。 |
新しいメッセージ |
| ユーザーがスペースの管理者になります。 | Membership リソースが更新されました。 |
メンバーシップを更新しました |
| ユーザーがメッセージにリアクションしました。 | Reaction リソースが作成されます。 |
新しいリアクション |
| ユーザーがスペースから退出した場合。 | Membership リソースが削除された。 |
メンバーシップを削除しました |
Google Chat からの予定を受信する
イベントを受信するには、Chat 用アプリで次のいずれかの操作を行います。 次のとおりです。
- Google Workspace Events API を使用してイベントに登録してイベントを受信する 発生します。
- Chat API を呼び出して、最近のイベントをクエリします。
次の表で、クエリまたは変換を行う必要がある場合の違いとその理由を イベントへの登録:
| イベントに登録する | イベントのクエリ | |
|---|---|---|
| ユースケース |
|
|
| API | Google Workspace Events API | チャット API |
| イベントのソース | スペースとユーザー | スペースのみ |
| サポートされるイベント |
サポートされているイベントタイプの一覧については、をご覧ください。 サブスクリプションを作成するためのイベントタイプ Google Workspace Events API のドキュメントをご覧ください。 |
サポートされているイベントタイプの一覧については、 Chat API の spaceEvents リソース
ご覧ください。
|
| イベントの形式 | Google Cloud Pub/Sub メッセージ。 CloudEvent の仕様。詳しくは、 Google Workspace イベントの構造。 |
Chat API リソース
(
spaces.spaceEvent)
|
| イベントデータ | リソースデータの有無にかかわらず、Base64 でエンコードされた文字列。ペイロードの例については、イベントデータをご覧ください。 | リソースデータを含む JSON ペイロード。一部のイベントタイプには、特定のリソース フィールドのみが含まれます。ペイロードの例については、このモジュールの <ph type="x-smartling-placeholder"></ph> リファレンス ドキュメントをご覧ください。 |
例: スペースのメンバーシップに関するイベントをクエリまたはサブスクライブする
この例では、Chat 用アプリが Chat スペースのメンバーに対する変更に関する情報。イン スペースに参加すると、次のメンバーシップ アクティビティが発生します。
- ユーザーがスペースに参加すると、
Membershipリソースが作成されて イベントです。 - ユーザーはスペースの管理者になり、スペースの
Membershipリソースが更新されます 更新されたメンバー イベントをトリガーします。 - ユーザーがスペースから退出すると、そのスペースの
Membershipリソースが削除されます。 メンバー削除イベントをトリガーします。
メンバーシップ イベントに登録する
イベントをリアルタイムで受け取るには、
Chat アプリが Google Workspace Events API を呼び出す
subscriptions.create()
メソッドを使って、あらゆる種類のメンバーシップ イベント用にスペースをサブスクライブできます。変更後
サブスクリプションを作成すると、Chat アプリは
イベントを受信できます。
図 2 では、Chat 用アプリに有効なサブスクリプションがあり、 スペースのメンバーになると、アプリはイベントを受信します。 できます。これにより、Chat アプリは 限定公開のウェルカム メッセージを投稿するなど、 メンバーに表示されます。
Google Workspace Events API を使用してサブスクリプションを作成する方法について詳しくは、 詳しくは、Google Workspace Events API のドキュメントをご覧ください。
最近のメンバーシップ イベントに関するクエリ
メンバーシップ イベントが発生したときにそれを受け取るのではなく、 Chat アプリは Chat API を呼び出して、 最近のスペース イベントが表示されます。
図 3 では、Chat アプリが Chat API を呼び出し、
spaces.spaceEvents.list()
メソッドを実行し、クエリをフィルタします。
新しいメンバー、更新、削除されたメンバーシップ イベントを確認します。Chat API から
各メンバーシップの変更を表す spaceEvent リソースのリスト。
Chat アプリは、送信されたメッセージに基づいて、
たとえば、毎週のメッセージを投稿し、その内容を要約した
過去 7 日間のスペースのメンバーシップ アクティビティを確認できます。
Chat API を使用してイベントをクエリするには、以下をご覧ください。 Google Chat スペースのイベントを一覧表示する
制限事項
-
ユーザーの登録、ダイレクト メッセージまたは名前のないグループ チャットの新規メンバーに関するイベント（
google.workspace.chat.membership.v1.created） 最初のメッセージが投稿された後にのみトリガーされます。 - メンバーシップ イベントを受け取るには、スペースに直接参加しているメンバーである必要があります。ユーザーを追加すると Google グループを通じてスペースへの間接的な更新、削除された場合、サブスクリプションは イベントを受け取りますGoogle グループ メンバーの仕組みについては、以下をご覧ください。 スペースに Google グループを追加する
関連トピック
- Google Workspace Events API の概要
- 定期購入の作成
- Google Chat スペースのイベントの詳細を確認する
- Google Chat スペースのイベントを一覧表示する
- イベントの使用例については、チュートリアル: 質問に基づいて スペースで会話を楽しみましょう。 Chat アプリ 問題管理の包括性ヘルプ機能 Codelab の Chat アプリ Gemini を使用して Google Chat 用アプリを構築する。