5 分鐘了嗎？填寫這份簡短的問卷調查，協助我們改善 Google Chat 開發人員說明文件。

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

Switch to English

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

本頁面說明如何使用 Google Cloud Functions 建立 Google Chat 應用程式並與其互動。

如要建構 Chat 應用程式，您可以編寫及部署 Cloud 函式，Chat 應用程式會使用這個函式來回應使用者的訊息。Chat 應用程式的回應包含資訊卡訊息，其中顯示傳送者的名稱和顯示圖片，如下圖所示：

Chat 應用程式會在回應資訊卡，顯示傳送者的顯示名稱和顯示圖片

目標

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

必要條件

Google Workspace 帳戶，在允許未經驗證的 Google Cloud 函式叫用的 Google Workspace 機構中存取 Google Chat。

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。

啟用 API

建立及部署 Cloud 函式

建立及部署 Cloud 函式，以便產生含有傳送者顯示名稱和顯示圖片的 Chat 資訊卡。當 Chat 應用程式收到訊息時，就會執行函式並傳送資訊卡回應。

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

Node.js

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

前往 Cloud Functions 頁面

請確認已選取 Chat 應用程式的專案。
按一下「Create Function」(建立函式)。
在「Create function」(建立函式) 頁面中設定函式：
1. 在「函式名稱」中輸入「QuickStartChatApp」。
2. 在「Trigger type」(觸發條件類型) 中，選取「HTTP」。
3. 選取「驗證」下方的「允許未經驗證的叫用」。
  
  如要進一步瞭解 Google Workspace 中的驗證程序，請參閱「驗證及授權 Chat 專用應用程式和 API 要求」。
4. 按一下「儲存」。
5. 點選「下一步」。
在「執行階段」中，選取「Node.js 10」。
在「Source code」(原始碼) 中，選取「Inline Editor」(內嵌編輯器)。
在「進入點」中刪除預設文字並輸入 helloChat。

將 index.js 的內容替換為下列程式碼：

節點/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],
      }
    }],
  };
}

按一下「部署」。

Python

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

前往 Cloud Functions 頁面

請確認已選取 Chat 應用程式的專案。
按一下「Create Function」(建立函式)。
在「Create function」(建立函式) 頁面中設定函式：
1. 在「函式名稱」中輸入「QuickStartChatApp」。
2. 在「Trigger type」(觸發條件類型) 中，選取「HTTP」。
3. 選取「驗證」下方的「允許未經驗證的叫用」。
  
  如要進一步瞭解 Google Workspace 中的驗證程序，請參閱「驗證及授權 Chat 專用應用程式和 API 要求」。
4. 按一下「儲存」。
5. 點選「下一步」。
在「Runtime」中，選取「Python 3.10」。
在「Source code」(原始碼) 中，選取「Inline Editor」(內嵌編輯器)。
在「進入點」中刪除預設文字並輸入 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

按一下「部署」。

Java

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

前往 Cloud Functions 頁面

請確認已選取 Chat 應用程式的專案。
按一下「Create Function」(建立函式)。
在「Create function」(建立函式) 頁面中設定函式：
1. 在「函式名稱」中輸入「QuickStartChatApp」。
2. 在「Trigger type」(觸發條件類型) 中，選取「HTTP」。
3. 選取「驗證」下方的「允許未經驗證的叫用」。
  
  如要進一步瞭解 Google Workspace 中的驗證程序，請參閱「驗證及授權 Chat 應用程式和 API 要求」。
4. 按一下「儲存」。
5. 點選「下一步」。
在「Runtime」中，選取「Java 11」。
在「Source code」(原始碼) 中，選取「Inline Editor」(內嵌編輯器)。
在「進入點」中刪除預設文字並輸入 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>

按一下「部署」。

Cloud Functions 頁面會開啟，且您的函式會顯示在函式名稱旁邊。進度指標消失後，如果顯示勾號，即代表部署函式。

將應用程式發布到 Google Chat

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

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

前往 Cloud Functions 頁面

請確保已選取已啟用 Cloud Functions 的專案。
在函式清單中，按一下「QuickStartChatApp」。
在「函式詳細資料」頁面中，按一下「觸發條件」。
複製「觸發條件網址」底下的網址。
搜尋「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 訊息」、「加入聊天室和群組對話」和「將錯誤記錄至 Cloud Logging」。
5. 在「連線設定」下方選取「應用程式網址」，然後將 Cloud 函式觸發條件的網址貼到方塊中。
6. 在「權限」之下，選取「您網域中的特定使用者和群組」，然後輸入您的電子郵件地址。
按一下「儲存」。

應用程式已準備好透過 Google Chat 接收及回覆訊息。

測試 Chat 應用程式

如要測試 Chat 應用程式，請傳送即時訊息給應用程式：

開啟 Google Chat。
如要傳送即時訊息至應用程式，請按一下「發起即時通訊」圖示，然後在隨即顯示的視窗中按一下「尋找應用程式」。
在「Find apps」對話方塊中，搜尋「quickstart App」。
如要使用應用程式開啟即時訊息，請找到「quickstart App」，然後依序點選「Add」>「Chat」。
在即時訊息中輸入 Hello，然後按下 enter 鍵。

應用程式會傳回含有顯示名稱和顯示圖片的資訊卡。

排解錯誤

如要排解 Chat 專用應用程式的問題並進行偵錯，請參閱「疑難排解及修正 Google Chat 應用程式錯誤」。

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

目標

必要條件

設定環境

建立及部署 Cloud 函式

Node.js

Python

Java

將應用程式發布到 Google Chat

測試 Chat 應用程式

排解錯誤

相關主題