このページでは、外部トリガーを使用して非同期メッセージを Chat スペースに送信するように Webhook を設定する方法について説明します。たとえば、サーバーがダウンしたときに Chat のオンコール担当者に通知するようにモニタリング アプリケーションを構成できます。Chat アプリで同期メッセージを送信するには、メッセージを送信するをご覧ください。
このタイプのアーキテクチャ設計では、通信は一方向であるため、ユーザーは Webhook や接続された外部アプリケーションにアクセスできません。Webhook は会話型ではありません。ユーザーまたは Chat アプリのインタラクション イベントに返信したり、メッセージを受信したりすることはできません。メッセージに応答するには、Webhook ではなく Chat アプリを作成します。
Webhook は厳密には Chat アプリではありませんが、Webhook は標準の HTTP リクエストを使用してアプリケーションを接続するものですが、このページでは便宜上 Chat アプリと呼んでいます。各 Webhook は、その Webhook が登録されている Chat スペースでのみ機能します。着信 Webhook はダイレクト メッセージで機能しますが、すべてのユーザーが Chat アプリを有効にしている場合に限ります。Google Workspace Marketplace に Webhook を公開できません。
次の図は、Chat に接続された Webhook のアーキテクチャを示しています。
上の図では、Chat アプリに次の情報フローがあります。
- Chat アプリのロジックは、プロジェクト管理システムやチケット発行ツールなどの外部のサードパーティ サービスから情報を受け取ります。
- Chat アプリのロジックは、Webhook URL を使用して特定の Chat スペースにメッセージを送信できるクラウドまたはオンプレミスのシステムでホストされます。
- ユーザーは、その特定の Chat スペースで Chat アプリからメッセージを受信できますが、Chat アプリを操作することはできません。
前提条件
Python
- Chat へのアクセス権を持つ Google Workspace アカウント。Google Workspace 組織で、ユーザーに着信 Webhook の追加と使用を許可する必要があります。
- Python 3.10.7 以降。
httplib2
ライブラリ。必要に応じて、pip
を使用して次のコマンドライン インターフェース(CLI)コマンドを実行し、ライブラリをインストールします。pip install httplib2
既存の Chat スペース。
Node.js
- Chat へのアクセス権を持つ Google Workspace アカウント。Google Workspace 組織で、ユーザーに着信 Webhook の追加と使用を許可する必要があります。
- Node.js と npm がインストールされていること。
- 既存の Chat スペース。
Java
- Chat へのアクセス権を持つ Google Workspace アカウント。Google Workspace 組織では、ユーザーは着信 Webhook を追加して使用できます。
- Java 11 以降。
- Apache Maven
- 既存の Chat スペース。
Apps Script
- Chat へのアクセス権を持つ Google Workspace アカウント。Google Workspace 組織では、ユーザーは着信 Webhook を追加して使用できます。
- 既存の Chat スペース。
Webhook を作成する
Webhook を作成するには、メッセージを受信する Chat スペースに登録し、メッセージを送信するスクリプトを作成します。
着信 Webhook を登録する
- ブラウザで Chat を開きます。Webhook は、Chat モバイルアプリからは構成できません。
- Webhook を追加するスペースに移動します。
- スペースのタイトルの横にある をクリックして展開矢印をクリックし、[アプリと統合] をクリックします。
[
Add webhooks] をクリックします。[名前] フィールドに「
Quickstart Webhook
」と入力します。[アバターの URL] フィールドに「
https://developers.google.com/chat/images/chat-product-icon.png
」と入力します。[保存] をクリックします。
Webhook URL をコピーするには、
[その他] をクリックし、[ リンクをコピー] をクリックします。
Webhook スクリプトを作成する
サンプルの Webhook スクリプトは、Webhook URL に POST
リクエストを送信して、Webhook が登録されているスペースにメッセージを送信します。Chat API は Message
のインスタンスを返します。
言語を選択して、Webhook スクリプトの作成方法をご確認ください。
Python
作業ディレクトリに、
quickstart.py
という名前のファイルを作成します。quickstart.py
に、次のコードを貼り付けます。url
変数の値は、Webhook の登録時にコピーした Webhook URL に置き換えます。
Node.js
作業ディレクトリに、
index.js
という名前のファイルを作成します。index.js
に、次のコードを貼り付けます。url
変数の値は、Webhook の登録時にコピーした Webhook URL に置き換えます。
Java
作業ディレクトリに、
pom.xml
という名前のファイルを作成します。次のコードを
pom.xml
にコピーして貼り付けます。作業ディレクトリに、次のディレクトリ構造
src/main/java
を作成します。src/main/java
ディレクトリにApp.java
という名前のファイルを作成します。App.java
に、次のコードを貼り付けます。URL
変数の値は、Webhook の登録時にコピーした Webhook URL に置き換えます。
Apps Script
ブラウザで Apps Script に移動します。
[新しいプロジェクト] をクリックします。
次のコードを貼り付けます。
url
変数の値は、Webhook の登録時にコピーした Webhook URL に置き換えます。
Webhook スクリプトを実行する
CLI でスクリプトを実行します。
Python
python3 quickstart.py
Node.js
node index.js
Java
mvn compile exec:java -Dexec.mainClass=App
Apps Script
- [Run] をクリックします。
コードを実行すると、Webhook はコードを登録したスペースにメッセージを送信します。
メッセージ スレッドを開始する、スレッドに返信する
メッセージ リクエストの本文の一部として
spaces.messages.thread.threadKey
を指定します。スレッドを開始するか返信するかに応じて、threadKey
に次の値を使用します。スレッドを開始する場合は、
threadKey
を任意の文字列に設定しますが、スレッドに返信を投稿するには、この値をメモしておきます。スレッドに返信する場合は、スレッドの開始時に設定された
threadKey
を指定します。たとえば、最初のメッセージでMY-THREAD
が使用されたスレッドに返信を投稿するには、MY-THREAD
を設定します。
指定された
threadKey
が見つからない場合のスレッドの動作を定義します。スレッドに返信するか、新しいスレッドを開始します。
messageReplyOption=REPLY_MESSAGE_FALLBACK_TO_NEW_THREAD
パラメータを Webhook URL に追加します。この URL パラメータを渡すと、Chat は指定されたthreadKey
を使用して既存のスレッドを検索します。見つかった場合、そのメッセージはそのスレッドへの返信として投稿されます。見つからない場合、メッセージはそのthreadKey
に対応する新しいスレッドを開始します。スレッドに返信するか、何もしない。
messageReplyOption=REPLY_MESSAGE_OR_FAIL
パラメータを Webhook URL に追加します。この URL パラメータを渡すと、Chat は指定されたthreadKey
を使用して既存のスレッドを検索します。見つかった場合、そのメッセージはそのスレッドへの返信として投稿されます。見つからない場合、メッセージは送信されません。
詳しくは、
messageReplyOption
をご覧ください。
次のコードサンプルでは、メッセージ スレッドを開始または返信します。