このページは Cloud Translation API によって翻訳されました。

Google Chat アプリを Webhook として作成する

このページでは、外部トリガーを使用して Chat スペースに非同期メッセージを送信するように Webhook を設定する方法について説明します。たとえば、サーバーがダウンしたときに Chat でオンコール担当者に通知するようにモニタリングアプリケーションを構成できます。Chat アプリで同期メッセージを送信するには、メッセージを送信するをご覧ください。

このタイプのアーキテクチャ設計では、通信が一方向であるため、ユーザーは Webhook や接続された外部アプリケーションを操作できません。Webhook は会話型ではありません。ユーザーからのメッセージやチャットアプリのインタラクションイベントに応答したり、受信したりすることはできません。メッセージに応答するには、Webhook ではなく、Chat アプリを作成します。

Webhook は厳密には Chat アプリではありませんが、Webhook は標準の HTTP リクエストを使用してアプリケーションを接続するものですが、このページでは簡素化のために Chat アプリと呼んでいます。各 Webhook は、それが登録されている Chat スペースでのみ機能します。着信 Webhook はダイレクトメッセージで機能しますが、すべてのユーザーがチャットアプリを有効にしている場合に限ります。Google Workspace Marketplace に Webhook を公開できません。

次の図は、Chat に接続された Webhook のアーキテクチャを示しています。

Chat に非同期メッセージを送信するための着信 Webhook のアーキテクチャ。

上の図では、チャットアプリに次のような情報フローがあります。

Chat アプリのロジックは、プロジェクト管理システムやチケット発行ツールなどの外部のサードパーティサービスから情報を受け取ります。
Chat アプリのロジックは、Webhook URL を使用して特定の Chat スペースにメッセージを送信できるクラウドまたはオンプレミスのシステムでホストされます。
ユーザーは、その特定の Chat スペースで Chat アプリからメッセージを受信できますが、Chat アプリを操作することはできません。

前提条件

Python

Python 3.10.7 以降。
Chat へのアクセス権を持つ Google Workspace アカウント。
Google Cloud プロジェクト。
Cloud プロジェクトの課金がオンになっていることを確認します。プロジェクトの課金ステータスを確認する方法を学習する。
既存の Chat スペース。
httplib2 ライブラリ。必要に応じて、次のコマンドラインインターフェース（CLI）コマンドを実行し、pip を使用してライブラリをインストールします。
```
pip install httplib2
```

Node.js

Node.js と npm がインストールされていること。
Chat へのアクセス権を持つ Google Workspace アカウント。
Google Cloud プロジェクト。
Cloud プロジェクトの課金がオンになっていることを確認します。プロジェクトの課金ステータスを確認する方法を学習する。
既存の Chat スペース。

Java

Java 11 以降。
Apache Maven
Chat へのアクセス権を持つ Google Workspace アカウント。
Google Cloud プロジェクト。
Cloud プロジェクトの課金がオンになっていることを確認します。プロジェクトの課金ステータスを確認する方法を学習する。
既存の Chat スペース。

Apps Script

Chat へのアクセス権を持つ Google Workspace アカウント。
既存の Chat スペース。

Webhook を作成する

Webhook を作成するには、メッセージを受信する Chat スペースに登録し、メッセージを送信するスクリプトを作成します。

着信 Webhook を登録する

ブラウザで Chat を開きます。Chat モバイルアプリでは Webhook を構成できません。
Webhook を追加するスペースに移動します。
スペースのタイトルの横にある展開矢印をクリックしてから、[アプリと統合] をクリックします。
[Webhook を追加] をクリックします。
[名前] フィールドに「Quickstart Webhook」と入力します。
[アバターの URL] フィールドに「https://developers.google.com/chat/images/chat-product-icon.png」と入力します。
[保存] をクリックします。
Webhook URL をコピーするには、 [その他] をクリックし、[リンクをコピー] をクリックします。

Webhook スクリプトを作成する

サンプルの Webhook スクリプトは、POST リクエストを Webhook URL に送信して、Webhook が登録されているスペースにメッセージを送信します。Chat API は Message のインスタンスを返します。

言語を選択して、Webhook スクリプトの作成方法をご確認ください。

Python

作業ディレクトリに quickstart.py という名前のファイルを作成します。

quickstart.py に、次のコードを貼り付けます。

python/webhook/quickstart.py

GitHub で表示

from json import dumps
from httplib2 import Http


def main():
    """Google Chat incoming webhook quickstart."""
    url = "https://chat.googleapis.com/v1/spaces/SPACE_ID/messages"
    app_message = {"text": "Hello from a Python script!"}
    message_headers = {"Content-Type": "application/json; charset=UTF-8"}
    http_obj = Http()
    response = http_obj.request(
        uri=url,
        method="POST",
        headers=message_headers,
        body=dumps(app_message),
    )
    print(response)


if __name__ == "__main__":
    main()

WEBHOOK_URL 変数の値は、Webhook の登録時にコピーした Webhook URL に置き換えます。

Node.js

作業ディレクトリに index.js という名前のファイルを作成します。
index.js に、次のコードを貼り付けます。

node/webhook/index.js

GitHub で表示
```
/**
 * Sends asynchronous message to Google Chat
 * @return {Object} response
 */
async function webhook() {
  const url = "https://chat.googleapis.com/v1/spaces/SPACE_ID/messages"
  const res = await fetch(url, {
    method: "POST",
    headers: {"Content-Type": "application/json; charset=UTF-8"},
    body: JSON.stringify({text: "Hello from a Node script!"})
  });
  return await res.json();
}

webhook().then(res => console.log(res));
```
webhookURL 変数の値は、Webhook の登録時にコピーした Webhook URL に置き換えます。

Java

作業ディレクトリに pom.xml という名前のファイルを作成します。

pom.xml に、次のコードをコピーして貼り付けます。

java/webhook/pom.xml

GitHub で表示

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  <modelVersion>4.0.0</modelVersion>

  <groupId>com.google.chat.webhook</groupId>
  <artifactId>java-webhook-app</artifactId>
  <version>0.1.0</version>

  <name>java-webhook-app</name>
  <url>https://github.com/googleworkspace/google-chat-samples/tree/main/java/webhook</url>

  <properties>
    <maven.compiler.target>11</maven.compiler.target>
    <maven.compiler.source>11</maven.compiler.source>
  </properties>

  <dependencies>
    <dependency>
        <groupId>com.google.code.gson</groupId>
        <artifactId>gson</artifactId>
        <version>2.9.1</version>
    </dependency>
  </dependencies>

  <build>
    <pluginManagement>
      <plugins>
        <plugin>
          <artifactId>maven-compiler-plugin</artifactId>
          <version>3.8.0</version>
        </plugin>
      </plugins>
    </pluginManagement>
  </build>
</project>

作業ディレクトリに、次のディレクトリ構造 src/main/java を作成します。
src/main/java ディレクトリに App.java という名前のファイルを作成します。

App.java に、次のコードを貼り付けます。

java/webhook/src/main/java/com/google/chat/webhook/App.java

GitHub で表示

import com.google.gson.Gson;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.util.Map;
import java.net.URI;

public class App {
  private static final String URL = "https://chat.googleapis.com/v1/spaces/AAAAGCYeSRY/messages";
  private static final Gson gson = new Gson();
  private static final HttpClient client = HttpClient.newHttpClient();

  public static void main(String[] args) throws Exception {
    String message = gson.toJson(Map.of("text", "Hello from Java!"));

    HttpRequest request = HttpRequest.newBuilder(
        URI.create(URL))
        .header("accept", "application/json; charset=UTF-8")
        .POST(HttpRequest.BodyPublishers.ofString(message))
        .build();

    HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());

    System.out.println(response.body());
  }
}

URL 変数の値は、Webhook の登録時にコピーした Webhook URL に置き換えます。

Apps Script

ブラウザで Apps Script にアクセスします。
[新しいプロジェクト] をクリックします。
次のコードを貼り付けます。

apps-script/webhook/webhook.gs

GitHub で表示
```
function webhook() {
  const url = "https://chat.googleapis.com/v1/spaces/SPACE_ID/messages"
  const options = {
    "method": "post",
    "headers": {"Content-Type": "application/json; charset=UTF-8"},
    "payload": JSON.stringify({"text": "Hello from Apps Script!"})
  };
  const response = UrlFetchApp.fetch(url, options);
  console.log(response);
}
```
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

[実行] をクリックします。

コードを実行すると、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 をご覧ください。

次のコードサンプルでは、メッセージスレッドを開始または返信します。

Python

python/webhook/thread-reply.py

GitHub で表示

from json import dumps
from httplib2 import Http

# Copy the webhook URL from the Chat space where the webhook is registered.
# The values for SPACE_ID, KEY, and TOKEN are set by Chat, and are included
# when you copy the webhook URL.
#
# Then, append messageReplyOption=REPLY_MESSAGE_FALLBACK_TO_NEW_THREAD to the
# webhook URL.


def main():
    """Google Chat incoming webhook that starts or replies to a message thread."""
    url = "https://chat.googleapis.com/v1/spaces/SPACE_ID/messages?key=KEY&token=TOKEN&messageReplyOption=REPLY_MESSAGE_FALLBACK_TO_NEW_THREAD"
    app_message = {
        "text": "Hello from a Python script!",
        # To start a thread, set threadKey to an arbitratry string.
        # To reply to a thread, specify that thread's threadKey value.
        "thread": {"threadKey": "THREAD_KEY_VALUE"},
    }
    message_headers = {"Content-Type": "application/json; charset=UTF-8"}
    http_obj = Http()
    response = http_obj.request(
        uri=url,
        method="POST",
        headers=message_headers,
        body=dumps(app_message),
    )
    print(response)


if __name__ == "__main__":
    main()

Node.js

node/webhook/thread-reply.js

GitHub で表示

/**
 * Sends asynchronous message to Google Chat
 * @return {Object} response
 */
async function webhook() {
  const url = "https://chat.googleapis.com/v1/spaces/SPACE_ID/messages?key=KEY&token=TOKEN&messageReplyOption=REPLY_MESSAGE_FALLBACK_TO_NEW_THREAD"
  const res = await fetch(url, {
    method: "POST",
    headers: {"Content-Type": "application/json; charset=UTF-8"},
    body: JSON.stringify({
      text: "Hello from a Node script!",
      thread: {threadKey: "THREAD_KEY_VALUE"}
    })
  });
  return await res.json();
}

webhook().then(res => console.log(res));

Apps Script

apps-script/webhook/thread-reply.gs

GitHub で表示

function webhook() {
  const url = "https://chat.googleapis.com/v1/spaces/SPACE_ID/messages?key=KEY&token=TOKEN&messageReplyOption=REPLY_MESSAGE_FALLBACK_TO_NEW_THREAD"
  const options = {
    "method": "post",
    "headers": {"Content-Type": "application/json; charset=UTF-8"},
    "payload": JSON.stringify({
      "text": "Hello from Apps Script!",
      "thread": {"threadKey": "THREAD_KEY_VALUE"}
    })
  };
  const response = UrlFetchApp.fetch(url, options);
  console.log(response);
}

Google Chat アプリを Webhook として作成する

前提条件

Python

Node.js

Java

Apps Script

Webhook を作成する

着信 Webhook を登録する

Webhook スクリプトを作成する

Python

Node.js

Java

Apps Script

Webhook スクリプトを実行する

Python

Node.js

Java

Apps Script

メッセージ スレッドを開始または返信する

Python

Node.js

Apps Script

関連トピック

メッセージスレッドを開始または返信する