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

HTTP Google Chat アプリを作成する

このページでは、HTTP Chat アプリを作成する方法について説明します。このアーキテクチャを実装するには、さまざまな方法があります。Google Cloud では、Cloud Functions、Cloud Run、App Engine を使用できます。このクイックスタートでは、コードを書いてデプロイする Cloud Functions の関数メッセージに返信するために Google Chat アプリが使用するもの。

このアーキテクチャでは、Google Chat を Google Chat と HTTP を使用して Google Cloud またはオンプレミスサーバーと通信します。次の図をご覧ください。

オンプレミスサーバーでウェブサービスを使用している Chat アプリのアーキテクチャ。

上の図では、HTTP HTTPS サーバーを操作しているユーザー Chat アプリには、次のような情報の流れがあります。

ユーザーが、ダイレクトメッセージまたは Chat スペースで Chat アプリにメッセージを送信します。
HTTP リクエストが、Chat アプリのロジックを含むクラウドまたはオンプレミスシステムであるウェブサーバーに送信されます。
必要に応じて、Chat 用アプリのロジックを Google Workspace サービス（カレンダー、スプレッドシートなど）、その他の Google サービス（Google マップ、YouTube、Vertex AI など）、またはその他のウェブサービス（プロジェクトなど）チケット発行ツールなど）を使用することです。
ウェブサーバーが HTTP レスポンスを Chat での Chat アプリサービス。
レスポンスがユーザーに配信されます。
必要に応じて、Chat アプリは Chat API を使用して、メッセージを非同期で投稿したり、必要があります。

これらの Chat アプリはさまざまなプログラミング言語を使用して設計できるため、このアーキテクチャでは、システムにすでに存在する既存のライブラリとコンポーネントを柔軟に使用できます。

目標

環境を設定する。
Cloud Functions の関数を作成してデプロイします。
アプリを Chat に公開します。
アプリをテストします。

前提条件

Google Chat へのアクセス権を持つビジネスまたはエンタープライズ向け Google Workspace アカウント。
課金を有効にした Google Cloud プロジェクト。既存のプロジェクトで課金が有効になっていることを確認するには、プロジェクトの課金ステータスを確認するをご覧ください。プロジェクトを作成して課金を設定するには、以下をご覧ください。 Google Cloud プロジェクトを作成します。

環境を設定する

Google API を使用する前に、Google Cloud プロジェクトで有効にする必要があります。 1 つの Google Cloud プロジェクトで 1 つ以上の API を有効にできます。

Google Cloud コンソールで、Google Chat API、Cloud Build API、Cloud Functions API、Cloud Pub/Sub API、Cloud Logging API、Artifact Registry API、Cloud Run API を有効にします。

API を有効にする

Cloud 関数を作成してデプロイする

Chat カードを生成する Cloud Functions の関数を作成してデプロイする送信者の表示名とアバター画像が表示されます。Chat アプリがメッセージを受信すると、関数を実行してカードで応答します。

Chat アプリの関数を作成してデプロイする手順は次のとおりです。

Node.js

Google Cloud コンソールで、[Cloud Functions] ページに移動します。

Cloud Functions に移動

Chat アプリのプロジェクトが選択されていることを確認します。
[関数を作成] をクリックします。
[関数の作成] ページで、関数を設定します。
1. [環境] で [第 2 世代] を選択します。
2. [関数名] に「QuickStartChatApp」と入力します。
3. [リージョン] でリージョンを選択します。
4. [認証] で [認証が必要] を選択します。
5. [次へ] をクリックします。
[ランタイム] で、最新バージョンの Node.js を選択します。
[ソースコード] で [インラインエディタ] を選択します。
[エントリポイント] でデフォルトのテキストを削除し、「avatarApp」と入力します。

index.js の内容を次のコードに置き換えます。

node/avatar-app/index.js

GitHub で表示

// The ID of the slash command "/about".
// It's not enabled by default, set to the actual ID to enable it. You need to
// use the same ID as set in the Google Chat API configuration.
const ABOUT_COMMAND_ID = "";

/**
 * Google Cloud Function that responds to messages sent from a
 * Google Chat space.
 *
 * @param {Object} req Request sent from Google Chat space
 * @param {Object} res Response to send back
 */
exports.avatarApp = function avatarApp(req, res) {
  if (req.method === 'GET' || !req.body.message) {
    return res.send('Hello! This function is meant to be used ' +
      'in a Google Chat Space.');
  }

  // Stores the Google Chat event as a variable.
  const event = req.body;

  // Checks for the presence of a slash command in the message.
  if (event.message.slashCommand) {
    // Executes the slash command logic based on its ID.
    // Slash command IDs are set in the Google Chat API configuration.
    switch (event.message.slashCommand.commandId) {
      case ABOUT_COMMAND_ID:
        return res.send({
          privateMessageViewer: event.user,
          text: 'The Avatar app replies to Google Chat messages.'
        });
    }
  }

  const sender = req.body.message.sender.displayName;
  const image = req.body.message.sender.avatarUrl;
  const data = createMessage(sender, image);
  res.send(data);
};

/**
 * Creates a card with two widgets.
 * 
 * @param {string} displayName the sender's display name
 * @param {string} avatarUrl the URL for the sender's avatar
 * @return {Object} a card with the user's avatar.
 */
function createMessage(displayName, avatarUrl) {
  return {
    text: 'Here\'s your avatar',
    cardsV2: [{
      cardId: 'avatarCard',
      card: {
        name: 'Avatar Card',
        header: {
          title: `Hello ${displayName}!`,
        },
        sections: [{ widgets: [{
          textParagraph: { text: 'Your avatar picture: ' }
        }, {
          image: { imageUrl: avatarUrl }
        }]}]
      }
    }]
  };
}

[デプロイ] をクリックします。

Python

Google Cloud コンソールで、[Cloud Functions] ページに移動します。

Cloud Functions に移動

Chat アプリのプロジェクトが選択されていることを確認します。
[関数を作成] をクリックします。
[関数の作成] ページで、関数を設定します。
1. [環境] で [第 2 世代] を選択します。
2. [関数名] に「QuickStartChatApp」と入力します。
3. [リージョン] でリージョンを選択します。
4. [認証] で [認証が必要] を選択します。
5. [次へ] をクリックします。
[ランタイム] で、最新バージョンの Python を選択します。
[ソースコード] で [インラインエディタ] を選択します。
[エントリポイント] で、デフォルトのテキストを削除して avatar_app と入力します。

main.py の内容を次のコードに置き換えます。

python/avatar-app/main.py

GitHub で表示

from typing import Any, Mapping

import flask
import functions_framework

# The ID of the slash command "/about".
# It's not enabled by default, set to the actual ID to enable it. You need to
# use the same ID as set in the Google Chat API configuration.
ABOUT_COMMAND_ID = ""

@functions_framework.http
def avatar_app(req: flask.Request) -> Mapping[str, Any]:
  """Google Cloud Function that handles requests from Google Chat

  Args:
      flask.Request: the request

  Returns:
      Mapping[str, Any]: the response
  """
  if req.method == "GET":
    return "Hello! This function must be called from Google Chat."

  request_json = req.get_json(silent=True)

  # Checks for the presence of a slash command in the message.
  if "slashCommand" in request_json["message"]:
    # Executes the slash command logic based on its ID.
    # Slash command IDs are set in the Google Chat API configuration.
    if request_json["message"]["slashCommand"]["commandId"] == ABOUT_COMMAND_ID:
      return {
        "privateMessageViewer": request_json["user"],
        "text": 'The Avatar app replies to Google Chat messages.'
      }

  display_name = request_json["message"]["sender"]["displayName"]
  avatar = request_json["message"]["sender"]["avatarUrl"]
  response = create_message(name=display_name, image_url=avatar)
  return response


def create_message(name: str, image_url: str) -> Mapping[str, Any]:
  """Google Cloud Function that handles requests from Google Chat

  Args:
      str name: the sender's display name.
      str image_url: the URL for the sender's avatar.

  Returns:
      Mapping[str, Any]: a card with the user's avatar.
  """
  return {
    "text": "Here's your avatar",
    "cardsV2": [{
      "cardId": "avatarCard",
      "card": {
          "name": "Avatar Card",
          "header": { "title": f"Hello {name}!" },
          "sections": [{
            "widgets": [{
              "textParagraph": { "text": "Your avatar picture:" }
            }, {
              "image": { "imageUrl": image_url }
            }]
          }]
      }
    }]
  }

[デプロイ] をクリックします。

Java

Google Cloud コンソールで、[Cloud Functions] ページに移動します。

Cloud Functions に移動

Chat 用アプリのプロジェクトが選択済みです。
[関数を作成] をクリックします。
[関数の作成] ページで、関数を設定します。
1. [環境] で [第 2 世代] を選択します。
2. [関数名] に「QuickStartChatApp」と入力します。
3. [リージョン] でリージョンを選択します。
4. [認証] で [認証が必要] を選択します。
5. [次へ] をクリックします。
[ランタイム] で、最新バージョンの Java を選択します。
[ソースコード] で [インラインエディタ] を選択します。
[エントリポイント] でデフォルトのテキストを削除し、「App」と入力します。
src/main/java/com/example/Example.java を src/main/java/App.java に名前変更します。

App.java の内容を次のコードに置き換えます。

java/avatar-app/src/main/java/App.java

GitHub で表示

import java.util.List;

import com.google.api.services.chat.v1.model.CardWithId;
import com.google.api.services.chat.v1.model.GoogleAppsCardV1Card;
import com.google.api.services.chat.v1.model.GoogleAppsCardV1CardHeader;
import com.google.api.services.chat.v1.model.GoogleAppsCardV1Image;
import com.google.api.services.chat.v1.model.GoogleAppsCardV1Section;
import com.google.api.services.chat.v1.model.GoogleAppsCardV1TextParagraph;
import com.google.api.services.chat.v1.model.GoogleAppsCardV1Widget;
import com.google.api.services.chat.v1.model.Message;
import com.google.cloud.functions.HttpFunction;
import com.google.cloud.functions.HttpRequest;
import com.google.cloud.functions.HttpResponse;
import com.google.gson.Gson;
import com.google.gson.JsonObject;

public class App implements HttpFunction {
  private static final Gson gson = new Gson();

  // The ID of the slash command "/about".
  // It's not enabled by default, set to the actual ID to enable it. You need to
  // use the same ID as set in the Google Chat API configuration.
  private static final String ABOUT_COMMAND_ID = "";

  @Override
  public void service(HttpRequest request, HttpResponse response) throws Exception {
    JsonObject body = gson.fromJson(request.getReader(), JsonObject.class);

    if (request.getMethod().equals("GET") || !body.has("message")) {
      response.getWriter().write("Hello! This function must be called from Google Chat.");
      return;
    }

    // Checks for the presence of a slash command in the message.
    if (body.getAsJsonObject("message").has("slashCommand")) {
      // Executes the slash command logic based on its ID.
      // Slash command IDs are set in the Google Chat API configuration.
      JsonObject slashCommand = body.getAsJsonObject("message").getAsJsonObject("slashCommand");
      switch (slashCommand.get("commandId").getAsString()) {
        case ABOUT_COMMAND_ID:
        JsonObject aboutMessage = new JsonObject();
        aboutMessage.addProperty("text", "The Avatar app replies to Google Chat messages.");
        aboutMessage.add("privateMessageViewer", body.getAsJsonObject("user"));
          response.getWriter().write(gson.toJson(aboutMessage));
          return;
      }
    }

    JsonObject sender = body.getAsJsonObject("message").getAsJsonObject("sender");
    String displayName = sender.has("displayName") ? sender.get("displayName").getAsString() : "";
    String avatarUrl = sender.has("avatarUrl") ? sender.get("avatarUrl").getAsString() : "";
    Message message = createMessage(displayName, avatarUrl);
    response.getWriter().write(gson.toJson(message));
  }

  Message createMessage(String displayName, String avatarUrl) {
    GoogleAppsCardV1CardHeader cardHeader = new GoogleAppsCardV1CardHeader();
    cardHeader.setTitle(String.format("Hello %s!", displayName));

    GoogleAppsCardV1TextParagraph textParagraph = new GoogleAppsCardV1TextParagraph();
    textParagraph.setText("Your avatar picture: ");

    GoogleAppsCardV1Widget avatarWidget = new GoogleAppsCardV1Widget();
    avatarWidget.setTextParagraph(textParagraph);

    GoogleAppsCardV1Image image = new GoogleAppsCardV1Image();
    image.setImageUrl(avatarUrl);

    GoogleAppsCardV1Widget avatarImageWidget = new GoogleAppsCardV1Widget();
    avatarImageWidget.setImage(image);

    GoogleAppsCardV1Section section = new GoogleAppsCardV1Section();
    section.setWidgets(List.of(avatarWidget, avatarImageWidget));

    GoogleAppsCardV1Card card = new GoogleAppsCardV1Card();
    card.setName("Avatar Card");
    card.setHeader(cardHeader);
    card.setSections(List.of(section));

    CardWithId cardWithId = new CardWithId();
    cardWithId.setCardId("previewLink");
    cardWithId.setCard(card);

    Message message = new Message();
    message.setText("Here's your avatar");
    message.setCardsV2(List.of(cardWithId));

    return message;
  }
}

pom.xml の内容を次のコードに置き換えます。

java/avatar-app/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</groupId>
  <artifactId>avatar-app</artifactId>
  <version>1.0-SNAPSHOT</version>

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

  <dependencies>
    <dependency>
      <groupId>com.google.cloud.functions</groupId>
      <artifactId>functions-framework-api</artifactId>
      <version>1.0.1</version>
    </dependency>

    <!-- https://mvnrepository.com/artifact/com.google.code.gson/gson -->
    <dependency>
        <groupId>com.google.code.gson</groupId>
        <artifactId>gson</artifactId>
        <version>2.9.1</version>
    </dependency>

    <!-- https://mvnrepository.com/artifact/com.google.apis/google-api-services-chat -->
    <dependency>
      <groupId>com.google.apis</groupId>
      <artifactId>google-api-services-chat</artifactId>
      <version>v1-rev20230115-2.0.0</version>
    </dependency>
  </dependencies>

  <!-- Required for Java 11 functions in the inline editor -->
  <build>
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-compiler-plugin</artifactId>
        <version>3.8.1</version>
        <configuration>
          <excludes>
            <exclude>.google/</exclude>
          </excludes>
        </configuration>
      </plugin>
    </plugins>
  </build>
</project>

[デプロイ] をクリックします。

Cloud Functions の詳細ページが開き、関数と 2 つの関数が表示されます。進行状況インジケーター: 1 つはビルド用で、もう 1 つはサービス用です。両方の進行状況インジケーターが消えてチェックマークに置き換えられると、関数はデプロイされ、準備が整います。

関数の呼び出しを Google Chat に許可する

Google Chat が関数を呼び出すことを許可するには、Cloud Run 起動元ロールを持つ Google Chat サービスアカウントを追加します。

Google Cloud コンソールで [Cloud Run] ページに移動します。

Cloud Run に移動します。
Cloud Run サービスのリストで、受信側使用します。（関数自体はクリックしないでください）。
[権限] をクリックします。[権限] パネルが開きます。
[プリンシパルを追加] をクリックします。
[新しいプリンシパル] に「chat@system.gserviceaccount.com」と入力します。
[ロールを選択] で、[Cloud Run] > [Cloud Run 起動元] を選択します。
[保存] をクリックします。

アプリを Google Chat に公開する

Cloud Functions の関数をデプロイしたら、以下の手順で関数を Google Chat アプリ:

Google Cloud コンソールでメニューアイコンをクリック > [Cloud Functions] を選択します。

Cloud Functions に移動

Cloud Functions を有効にしたプロジェクトが選択されていることを確認します。
関数のリストで、[QuickStartChatApp] をクリックします。
[トリガー] タブをクリックします。
[HTTPS] の下の URL をコピーします。
「Google Chat API」を検索する[Google Chat API]、[管理] の順にクリックします。

Chat API に移動
[Configuration] をクリックし、Google Chat アプリを設定します。
1. [アプリ名] に「Quickstart App」と入力します。
2. [アバターの URL] に「https://developers.google.com/chat/images/quickstart-app-avatar.png」と入力します。
3. [説明] に「Quickstart app」と入力します。
4. [機能] で [1:1 のメッセージを受信する] を選択し、 スペースやグループの会話に参加する
5. [接続設定] で [HTTP エンドポイント URL] を選択し、Cloud Functions トリガーの URL をボックスに貼り付けます。
6. [Authentication Audience] で、[HTTP endpoint URL] を選択します。
7. [公開設定] で [ この Google Chat アプリを特定のユーザーやグループを選択してメールアドレスを入力します。
8. [ログ] で [エラーを Logging にロギング] を選択します。
[保存] をクリックします。

Chat アプリが受信して応答する準備が整いました表示されます。

Chat 用アプリをテストする

Chat アプリをテストするには、Chat アプリでダイレクトメッセージスペースを開き、メッセージを送信します。

信頼できるテスターとして自分自身を追加したときに指定した Google Workspace アカウントを使用して Google Chat を開きます。

Google Chat にアクセス
[ 新しいチャット] をクリックします。
[1 人以上のユーザーを追加] フィールドに、招待する Chat アプリ。
結果から Chat 用アプリを選択します。ダイレクトというメッセージが開きます。

注: 結果のリストに Chat アプリが表示されない場合は、Google Cloud コンソールの Chat API の構成ページの [公開設定] で Google Workspace アカウントが含まれていることを確認してください。
そのアプリの新しいダイレクトメッセージに、「Hello」と入力して enter を押します。

Chat アプリのレスポンスには、カードメッセージが表示されます。送信者の名前とアバター画像が表示されます（以下の画像を参照）。

送信者の表示名とアバター画像を表示したカードで応答する Chat アプリ

Trusted Tester を追加し、インタラクティブ機能のテストについて詳しくは、以下をご覧ください。インタラクティブ機能のテスト Google Chat アプリ。

トラブルシューティング

Google Chat アプリまたはカードからエラーが返されると、Chat インターフェースに「エラーが発生しました」というメッセージが表示されます。または「リクエストを処理できません」が表示されます。場合によっては、Chat の UI がエラーメッセージは表示されませんが、Chat 用アプリまたは予期しない結果が生じた場合たとえば、カードメッセージに表示されます。

Chat UI にエラーメッセージが表示されない場合がありますが、エラーの修正に役立つ、わかりやすいエラーメッセージとログデータ Chat 用アプリのエラーロギングが有効になっている場合。表示のヘルプについては、エラーの修正について詳しくは、このモジュールの Google Chat のエラーのトラブルシューティングと修正

クリーンアップ

サービスアカウントに対する Google Cloud アカウントへの課金を回避するために、リソースがある場合は、その Terraform Registry にできます。

注意: プロジェクトを削除すると、次のような影響があります。

プロジェクト内のすべてのものが削除されます。このチュートリアルで既存のプロジェクトを使用した場合、それを削除すると、そのプロジェクトで行った他の作業もすべて削除されます。
カスタムプロジェクト ID が失われます。このプロジェクトを作成したときに、将来使用するカスタムプロジェクト ID を作成した可能性があります。appspot.com 上の URL など、プロジェクト ID を使用する URL を保持するには、プロジェクト全体を削除するのではなく、プロジェクト内の選択したリソースを削除します。

複数のチュートリアルとクイックスタートを実施する予定がある場合は、プロジェクトを再利用すると、プロジェクトの割り当て上限を超えないようにできます。

Google Cloud コンソールで、[リソースの管理] ページに移動します。[ メニュー > IAM と管理者 > [リソースの管理] をクリックします。
<ph type="x-smartling-placeholder"></ph> Resource Manager に移動
プロジェクトリストで、削除するプロジェクトを選択し、[ を削除します。
ダイアログでプロジェクト ID を入力し、[シャットダウン] をクリックして削除します。できます。

HTTP Google Chat アプリを作成する

目標

前提条件

環境を設定する

Cloud 関数を作成してデプロイする

Node.js

Python

Java

関数の呼び出しを Google Chat に許可する

アプリを Google Chat に公開する

Chat 用アプリをテストする

トラブルシューティング

クリーンアップ

関連トピック