本頁面由 Cloud Translation API 翻譯而成。

使用 Cloud Functions 建構 HTTP Google Chat 應用程式

本頁面說明如何建立 HTTP Chat 應用程式。實作此架構的方式有很多種。在 Google Cloud 上，您可以使用 Cloud Functions、Cloud Run 和 App Engine。在本快速入門導覽課程中，您將編寫及部署 Cloud 函式，供 Chat 應用程式用來回應使用者訊息。

透過這個架構，您可以使用 HTTP 將 Chat 設定為與 Google Cloud 或內部部署伺服器整合，如下圖所示：

使用地端部署伺服器中的網路服務的 Chat 應用程式架構。

在上圖中，使用者與 HTTP Chat 應用程式互動時會看到下列資訊流：

使用者透過即時訊息或 Chat 聊天室，在 Chat 中將訊息傳送至 Chat 應用程式。
系統會將 HTTP 要求傳送至包含 Chat 應用程式邏輯的雲端或內部部署系統的網路伺服器。
您也可以視需要將 Chat 擴充應用程式邏輯與 Google Workspace 服務 (例如日曆和試算表)、其他 Google 服務 (例如地圖、YouTube 和 Vertex AI) 或其他網路服務 (例如專案管理系統或支援單工具) 整合。
網路伺服器將 HTTP 回應傳回 Chat 中的 Chat 應用程式服務。
回應會傳送給使用者。
Chat 應用程式也可以視需要呼叫 Chat API，以非同步方式發布訊息或執行其他作業。

這個架構可讓您靈活運用系統中現有的程式庫和元件，因為這些 Chat 應用程式可以使用不同的程式設計語言進行設計。

目標

設定環境。
建立及部署 Cloud 函式。
將應用程式發布到 Chat。
測試應用程式。

先備知識

可存取 Google Chat 和 Google Cloud Functions 的 Google Workspace 帳戶。
Google Cloud 專案。
請確認您已啟用 Cloud 專案的計費功能。瞭解如何驗證專案的帳單狀態。

設定環境

使用 Google API 前，您必須先在 Google Cloud 專案中啟用 API。您可以在單一 Google Cloud 專案中啟用一或多個 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 函式。Chat 應用程式收到訊息時，會執行函式，並以資訊卡回應。

如要為 Chat 應用程式建立及部署函式，請完成下列步驟：

Node.js

前往 Google Cloud 控制台中的「Cloud Functions」頁面。

前往 Cloud Functions 頁面

請務必選取 Chat 應用程式的專案。
按一下「Create Function」。
在「建立函式」頁面中設定函式：
1. 在「環境」中，選取「第 2 代」。
2. 在「Function name」(函式名稱) 中輸入 QuickStartChatApp。
3. 在「Region」(區域) 中，選取區域。
4. 選取「驗證」下方的「需要驗證」。
5. 點選「下一步」。
在「執行階段」中，選取最新版本的 Node.js。
在「原始碼」中，選取「內嵌編輯器」。
在「進入點」中刪除預設文字並輸入 helloChat。

使用下列程式碼取代 index.js 的內容：

node/avatar-app/index.js

前往 GitHub 查看

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

  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} imageUrl the URL for the sender's avatar
 * @return {Object} a card with the user's avatar.
 */
function createMessage(displayName, imageUrl) {
  const cardHeader = {
    title: `Hello ${displayName}!`,
  };

  const avatarWidget = {
    textParagraph: {text: 'Your avatar picture: '},
  };

  const avatarImageWidget = {
    image: {imageUrl},
  };

  const avatarSection = {
    widgets: [
      avatarWidget,
      avatarImageWidget,
    ],
  };

  return {
    text: 'Here\'s your avatar',
    cardsV2: [{
      cardId: 'avatarCard',
      card: {
        name: 'Avatar Card',
        header: cardHeader,
        sections: [avatarSection],
      }
    }],
  };
}

點選「Deploy」。

Python

前往 Google Cloud 控制台中的「Cloud Functions」頁面。

前往 Cloud Functions 頁面

請務必選取 Chat 應用程式的專案。
按一下「Create Function」。
在「建立函式」頁面中設定函式：
1. 在「環境」中，選取「第 2 代」。
2. 在「Function name」(函式名稱) 中輸入 QuickStartChatApp。
3. 在「Region」(區域) 中，選取區域。
4. 選取「驗證」下方的「需要驗證」。
5. 點選「下一步」。
在「Runtime」(執行階段) 中，選取最新版本的 Python。
在「原始碼」中，選取「內嵌編輯器」。
在「進入點」中刪除預設文字並輸入 hello_chat。

使用下列程式碼取代 main.py 的內容：

python/avatar-app/main.py

前往 GitHub 查看

from typing import Any, Mapping

import flask
import functions_framework


# Google Cloud Function that responds to messages sent in
# Google Chat.
#
# @param {Object} req Request sent from Google Chat.
# @param {Object} res Response to send back.
@functions_framework.http
def hello_chat(req: flask.Request) -> Mapping[str, Any]:
  if req.method == "GET":
    return "Hello! This function must be called from Google Chat."

  request_json = req.get_json(silent=True)

  display_name = request_json["message"]["sender"]["displayName"]
  avatar = request_json["message"]["sender"]["avatarUrl"]

  response = create_message(name=display_name, image_url=avatar)

  return response


# Creates a card with two widgets.
# @param {string} name the sender's display name.
# @param {string} image_url the URL for the sender's avatar.
# @return {Object} a card with the user's avatar.
def create_message(name: str, image_url: str) -> Mapping[str, Any]:
  avatar_image_widget = {"image": {"imageUrl": image_url}}
  avatar_text_widget = {"textParagraph": {"text": "Your avatar picture:"}}
  avatar_section = {"widgets": [avatar_text_widget, avatar_image_widget]}

  header = {"title": f"Hello {name}!"}

  cards = {
      "text": "Here's your avatar",
      "cardsV2": [
          {
              "cardId": "avatarCard",
              "card": {
                  "name": "Avatar Card",
                  "header": header,
                  "sections": [avatar_section],
              },
          }
      ]
  }

  return cards

點選「Deploy」。

Java

前往 Google Cloud 控制台中的「Cloud Functions」頁面。

前往 Cloud Functions 頁面

請務必選取 Chat 應用程式的專案。
按一下「Create Function」。
在「建立函式」頁面中設定函式：
1. 在「環境」中，選取「第 2 代」。
2. 在「Function name」(函式名稱) 中輸入 QuickStartChatApp。
3. 在「Region」(區域) 中，選取區域。
4. 選取「驗證」下方的「需要驗證」。
5. 點選「下一步」。
在「Runtime」(執行階段) 中，選取最新版本的 Java。
在「原始碼」中，選取「內嵌編輯器」。
在「進入點」中刪除預設文字並輸入 HelloChat。
將 src/main/java/com/example/Example.java 重新命名為 src/main/java/HelloChat.java。

使用下列程式碼取代 HelloChat.java 的內容：

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

前往 GitHub 查看

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;
import java.util.List;

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

  @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;
    }

    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>cloudfunctions</groupId>
  <artifactId>http-function</artifactId>
  <version>1.0-SNAPSHOT</version>

  <properties>
    <maven.compiler.target>11</maven.compiler.target>
    <maven.compiler.source>11</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>

點選「Deploy」。

Cloud Functions 詳細資料頁面隨即會開啟，並顯示您的函式和兩個進度指標：一個用於建構，另一個用於服務。當兩個進度指標都消失，並以勾號取代時，表示函式現已部署完成且準備就緒。

授權 Google Chat 叫用函式

如要授權 Google Chat 叫用您的函式，請新增 Google Chat 服務帳戶具備 Cloud Run 叫用者角色。

前往 Google Cloud 控制台中的 Cloud Run 頁面。

前往 Cloud Run
在 Cloud Run 服務清單中，選取接收函式旁的核取方塊。(不要點選函式本身)。
按一下 [權限]，「Permissions」(權限) 面板隨即開啟。
按一下「新增主體」。
在「New principals」(新增主體) 中輸入 chat@system.gserviceaccount.com。
在「請選擇角色」中，依序選取「Cloud Run」 >「Cloud Run 叫用者」。
點選「儲存」。

將應用程式發布到 Google Chat

部署 Cloud 函式後，請按照下列步驟將其轉換為 Google Chat 應用程式：

在 Google Cloud 控制台中，依序點選「選單」圖示 >「Cloud Functions」。

前往 Cloud Functions 頁面

請確保選取的是已啟用 Cloud Functions 的專案。
在函式清單中，按一下「QuickStartChatApp」QuickStartChatApp。
按一下「觸發條件」分頁標籤。
在「HTTPS」下方複製網址。
搜尋「Google Chat API」，然後依序點選「Google Chat API」和「管理」。

前往 Chat API
按一下「設定」，然後設定 Google Chat 應用程式：
1. 在「App name」(應用程式名稱) 中輸入 Quickstart App。
2. 在「Avatar URL」(顯示圖片) 中輸入 https://developers.google.com/chat/images/quickstart-app-avatar.png。
3. 在「Description」(說明) 中輸入 Quickstart app。
4. 在「功能」下方，選取「接收 1:1 訊息」和「加入聊天室和群組對話」。
5. 在「Connection settings」下方，選取「App URL」，然後將 Cloud 函式觸發條件的網址貼到方塊中。
6. 在「驗證目標對象」中，選取「應用程式網址」。
7. 在「Visibility」(顯示設定) 下方，選取「Make this Google Chat app available for people and groups」(與網域中的特定使用者和群組共用)，然後輸入您的電子郵件地址。
8. 在「記錄」底下，選取 [將錯誤記錄至 Logging]。
點選「儲存」。

Chat 應用程式已準備好接收及回覆 Chat 上的訊息。

測試 Chat 應用程式

如要測試 Chat 應用程式，請透過 Chat 應用程式開啟即時訊息聊天室，並傳送訊息：

使用當初將自己新增為信任的測試人員時提供的 Google Workspace 帳戶開啟 Google Chat。

前往 Google Chat
按一下「新的即時通訊」圖示。
在「新增 1 或多位使用者」欄位中，輸入 Chat 應用程式的名稱。
從搜尋結果中選取 Chat 應用程式。系統隨即會開啟即時訊息。

注意：如果結果清單中沒有您的 Chat 應用程式，請確認您已在 Google Cloud 控制台中前往「Chat API 設定」頁面，並在「瀏覽權限」設定中加入自己的 Google Workspace 帳戶。
開啟與應用程式互傳的新即時訊息，輸入 Hello，然後按下 enter。

Chat 應用程式的回應包含資訊卡訊息，其中顯示寄件者的姓名和顯示圖片，如下圖所示：

即時通訊應用程式使用含有傳送者顯示名稱和顯示圖片的卡片回應

如要新增信任的測試人員，並進一步瞭解如何測試互動功能，請參閱「測試 Google Chat 應用程式的互動功能」。

疑難排解

當 Google Chat 應用程式或資訊卡傳回錯誤時，Chat 介面會顯示「發生錯誤」的訊息。或「無法處理你的要求」。Chat UI 有時不會顯示任何錯誤訊息，但 Chat 應用程式或資訊卡卻產生非預期的結果，例如資訊卡可能不會顯示。

雖然 Chat UI 可能不會顯示錯誤訊息，但可以在啟用 Chat 擴充應用程式的錯誤記錄功能時，查看描述性的錯誤訊息和記錄資料，協助您修正錯誤。如要瞭解如何查看、偵錯及修正錯誤，請參閱「疑難排解及修正 Google Chat 錯誤」。

清除所用資源

如要避免系統向您的 Google Cloud 帳戶收取您在本教學課程中使用資源的相關費用，建議您刪除 Cloud 專案。

在 Google Cloud 控制台中，前往「管理資源」頁面。依序點選「Menu」圖示 >「IAM & Admin」(IAM 與管理) >「Manage Resources」(管理資源)。
前往 Resource Manager
在專案清單中選取要刪除的專案，然後按一下「Delete」圖示。
在對話方塊中輸入專案 ID，然後按一下「Shut down」(關閉) 即可刪除專案。

使用 Cloud Functions 建構 HTTP Google Chat 應用程式

目標

先備知識

設定環境

建立及部署 Cloud 函式

Node.js

Python

Java

授權 Google Chat 叫用函式

將應用程式發布到 Google Chat

測試 Chat 應用程式

疑難排解

清除所用資源

相關主題