Google 會運用 AI 技術將內容翻譯成你偏好的語言，但可能會出錯。

使用 Pub/Sub 建立設有防火牆的 Google Chat 應用程式

本頁說明如何建立 Chat 應用程式，透過 Pub/Sub 接收 Chat 的事件。如果貴機構有防火牆，可能會導致 Chat 無法將訊息傳送至 Chat 應用程式，或是您想透過 Google Workspace Events API 傳送或接收有關 Chat 聊天室或使用者的事件，這種 Chat 應用程式架構就非常實用。不過，由於這些 Chat 應用程式只能傳送及接收非同步訊息，因此這種架構有下列限制：

無法在訊息中使用對話方塊。請改用訊息卡片。
無法透過同步回應更新個別資訊卡。請改為呼叫 patch 方法，更新整則訊息。

下圖顯示以 Pub/Sub 建構的即時通訊應用程式架構：

透過 Pub/Sub 實作的 Chat 應用程式架構。

在上圖中，使用者與 Pub/Sub Chat 應用程式互動時，資訊流如下：

使用者與 Chat 應用程式互動，例如傳送訊息給應用程式、發出指令、在 Chat 聊天室中新增或移除應用程式，或 Chat 聊天室發生事件，而 Chat 應用程式已訂閱該事件。
Chat 會將訊息傳送至 Pub/Sub 主題。
應用程式伺服器 (雲端或地端部署系統，內含 Chat 應用程式邏輯) 會訂閱 Pub/Sub 主題，以便透過防火牆接收訊息。
Chat 應用程式也可以選擇呼叫 Chat API，以非同步方式發布訊息或執行其他作業。

必要條件

Node.js

公司或企業專用 Google Workspace 帳戶，且可存取 Google Chat。
已啟用計費功能的 Google Cloud 專案。如要確認現有專案是否已啟用計費功能，請參閱「確認專案的帳單狀態」。如要建立專案及設定帳單，請參閱「建立 Google Cloud 專案」。
Node.js 14 以上版本
npm 套件管理工具
已初始化的 Node.js 專案。如要初始化新專案，請建立並切換至新資料夾，然後在指令列介面中執行下列指令：
```
npm init
```

Python

公司或企業專用 Google Workspace 帳戶，且可存取 Google Chat。
已啟用計費功能的 Google Cloud 專案。如要確認現有專案是否已啟用計費功能，請參閱「確認專案的帳單狀態」。如要建立專案及設定帳單，請參閱「建立 Google Cloud 專案」。
Python 3.6 以上版本
pip 套件管理工具

Java

公司或企業專用 Google Workspace 帳戶，且可存取 Google Chat。
已啟用計費功能的 Google Cloud 專案。如要確認現有專案是否已啟用計費功能，請參閱「確認專案的帳單狀態」。如要建立專案及設定帳單，請參閱「建立 Google Cloud 專案」。
Java 11 以上版本
Maven 套件管理工具

設定環境

使用 Google API 前，您需要在 Google Cloud 專案中啟用這些 API。您可以在單一 Google Cloud 專案中啟用一或多個 API。

在 Google Cloud 控制台中，啟用 Google Chat API 和 Pub/Sub API。

啟用 API

設定 Pub/Sub

建立 Pub/Sub 主題，供 Chat API 傳送訊息。建議您為每個 Chat 應用程式使用單一主題。
建立服務帳戶，授權 Chat 應用程式使用 Pub/Sub 和 Chat，並將私密金鑰檔案儲存至目前使用的目錄。
建立主題的提取訂閱項目。
在訂閱項目上為先前建立的服務帳戶指派 Pub/Sub 訂閱者角色。

注意：如果您使用 VPC Service Controls，可能需要在服務範圍中設定輸入規則，允許服務帳戶存取 Pub/Sub。詳情請參閱「輸入和輸出規則」。

編寫指令碼

在本節中，您將定義 Chat 應用程式的應用程式邏輯。您會編寫指令碼，向 Google Cloud 進行驗證，並訂閱 Pub/Sub 主題，接收來自 Chat 的事件，例如使用者傳送訊息給 Chat 應用程式時。

指令碼收到訊息時，會處理事件資料，並使用 Google Chat API 將回覆訊息發布給使用者或聊天室。完成這項設定後，您的 Chat 擴充應用程式就能在防火牆後方運作，同時與 Chat 使用者互動。

Node.js

在 CLI 中提供服務帳戶憑證：

export GOOGLE_APPLICATION_CREDENTIALS=SERVICE_ACCOUNT_FILE_PATH

在 CLI 中提供 Google Cloud 雲端專案 ID：
```
export PROJECT_ID=PROJECT_ID
```
在 CLI 中，提供您先前建立的 Pub/Sub 訂閱項目的訂閱 ID：
```
export SUBSCRIPTION_ID=SUBSCRIPTION_ID
```
在目前使用的目錄中，建立名為 package.json 的檔案。

在 package.json 檔案中貼上下列程式碼：

{
  "name": "pub-sub-app",
  "version": "1.0.0",
  "description": "Google Chat App that listens for messages via Cloud Pub/Sub",
  "main": "index.js",
  "scripts": {
    "start": "node index.js",
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "dependencies": {
    "@google-apps/chat": "^0.4.0",
    "@google-cloud/pubsub": "^4.5.0"
  },
  "license": "Apache-2.0"
}

在目前使用的目錄中，建立名為 index.js 的檔案。

在 index.js 中貼上下列程式碼：

const {ChatServiceClient} = require('@google-apps/chat');
const {MessageReplyOption} = require('@google-apps/chat').protos.google.chat.v1.CreateMessageRequest;
const {PubSub} = require('@google-cloud/pubsub');
const {SubscriberClient} = require('@google-cloud/pubsub/build/src/v1');

// Receives messages from a pull subscription.
function receiveMessages() {
  const chat = new ChatServiceClient({
    keyFile: process.env.GOOGLE_APPLICATION_CREDENTIALS,
    scopes: ['https://www.googleapis.com/auth/chat.bot'],
  });

  const subscriptionPath = new SubscriberClient()
    .subscriptionPath(process.env.PROJECT_ID, process.env.SUBSCRIPTION_ID)
  const subscription = new PubSub()
    .subscription(subscriptionPath);

  // Handle incoming message, then acknowledge the received message
  const messageHandler = message => {
    console.log(`Id : ${message.id}`);
    const event = JSON.parse(message.data);
    console.log(`Data : ${JSON.stringify(event)}`);

    // Post the response to Google Chat.
    const request = formatRequest(event);
    if (request != null) {
      chat.createMessage(request);
    }

    // Acknowledge the message.
    message.ack();
  }

  subscription.on('message', messageHandler);
  console.log(`Listening for messages on ${subscriptionPath}`);

  // Keep main thread from exiting while waiting for messages
  setTimeout(() => {
    subscription.removeListener('message', messageHandler);
    console.log(`Stopped listening for messages.`);
  }, 60 * 1000);
}

// Send message to Google Chat based on the type of event
function formatRequest(event) {
  const chatEvent = event.chat || {};

  // If the app was removed, we don't respond.
  if (chatEvent.removedFromSpacePayload) {
    console.log(`App removed from space.`);
    return null;
  }

  const payload = chatEvent.messagePayload || chatEvent.addedToSpacePayload;
  const spaceName = payload?.space?.name;

  if (!spaceName) {
    console.log('No space name in event.');
    return null;
  }

  if (chatEvent.addedToSpacePayload) {
    // An app can also be added to a space by @mentioning it in a
    // message. In that case, we fall through to the message case
    // and let the app respond. If the app was added using the
    // invite flow, we just post a thank you message in the space.
    return {
      parent: spaceName,
      message: { text: 'Thank you for adding me!' },
    };
  } else if (chatEvent.messagePayload) {
    // In case of message, post the response in the same thread.
    const message = chatEvent.messagePayload.message;
    return {
      parent: spaceName,
      messageReplyOption: MessageReplyOption.REPLY_MESSAGE_FALLBACK_TO_NEW_THREAD,
      message: {
        text: 'You said: `' + message.text + '`',
        thread: { name: message.thread.name },
      },
    };
  }
}

if (!process.env.PROJECT_ID) {
  console.log('Missing PROJECT_ID env var.');
  process.exit(1);
}
if (!process.env.SUBSCRIPTION_ID) {
  console.log('Missing SUBSCRIPTION_ID env var.');
  process.exit(1);
}
if (!process.env.GOOGLE_APPLICATION_CREDENTIALS) {
  console.log('Missing GOOGLE_APPLICATION_CREDENTIALS env var.');
  process.exit(1);
}

receiveMessages();

Python

在 CLI 中提供服務帳戶憑證：

export GOOGLE_APPLICATION_CREDENTIALS=SERVICE_ACCOUNT_FILE_PATH

在 CLI 中提供 Google Cloud 雲端專案 ID：
```
export PROJECT_ID=PROJECT_ID
```
在 CLI 中，提供您先前建立的 Pub/Sub 訂閱項目的訂閱 ID：
```
export SUBSCRIPTION_ID=SUBSCRIPTION_ID
```
在目前使用的目錄中，建立名為 requirements.txt 的檔案。

在 requirements.txt 檔案中貼上下列程式碼：

google-cloud-pubsub>=2.23.0
google-apps-chat==0.1.9

在目前使用的目錄中，建立名為 app.py 的檔案。

在 app.py 中貼上下列程式碼：

import json
import logging
import os
import sys
import time
from google.apps import chat_v1 as google_chat
from google.cloud import pubsub_v1
from google.oauth2.service_account import Credentials

def receive_messages():
  """Receives messages from a pull subscription."""

  scopes = ['https://www.googleapis.com/auth/chat.bot']
  service_account_key_path = os.environ.get('GOOGLE_APPLICATION_CREDENTIALS')
  creds = Credentials.from_service_account_file(service_account_key_path)
  chat = google_chat.ChatServiceClient(
      credentials=creds, client_options={'scopes': scopes}
  )

  project_id = os.environ.get('PROJECT_ID')
  subscription_id = os.environ.get('SUBSCRIPTION_ID')
  subscriber = pubsub_v1.SubscriberClient()
  subscription_path = subscriber.subscription_path(project_id, subscription_id)

  # Handle incoming message, then acknowledge the received message
  def callback(message):
    event = json.loads(message.data)
    logging.info('Data : %s', event)

    # Post the response to Google Chat.
    request = format_request(event)
    if request is not None:
      chat.create_message(request)

    # Acknowledge the message.
    message.ack()

  subscriber.subscribe(subscription_path, callback = callback)
  logging.info('Listening for messages on %s', subscription_path)

  # Keep main thread from exiting while waiting for messages
  while True:
    time.sleep(60)

def format_request(event):
  """Send message to Google Chat based on the type of event.
  Args:
    event: A dictionary with the event data.
  """
  chat_event = event.get('chat', {})

  # If the app was removed, we don't respond.
  if 'removedFromSpacePayload' in chat_event:
    logging.info('App removed from space.')
    return

  payload = chat_event.get('messagePayload') or chat_event.get(
      'addedToSpacePayload'
  )
  space_name = payload.get('space', {}).get('name') if payload else None

  if not space_name:
    logging.warning('No space name in event.')
    return

  if 'addedToSpacePayload' in chat_event:
    # An app can also be added to a space by @mentioning it in a
    # message. In that case, we fall through to the message case
    # and let the app respond. If the app was added using the
    # invite flow, we just post a thank you message in the space.
    return google_chat.CreateMessageRequest(
        parent = space_name,
        message = {
          'text': 'Thank you for adding me!'
        }
    )
  elif 'messagePayload' in chat_event:
    # In case of message, post the response in the same thread.
    message = chat_event['messagePayload']['message']
    return google_chat.CreateMessageRequest(
        parent = space_name,
        message_reply_option = google_chat.CreateMessageRequest.MessageReplyOption.REPLY_MESSAGE_FALLBACK_TO_NEW_THREAD,
        message = {
          'text': 'You said: `' + message['text'] + '`',
          'thread': {
            'name': message['thread']['name']
          }
        }
    )

if __name__ == '__main__':
  if 'PROJECT_ID' not in os.environ:
    logging.error('Missing PROJECT_ID env var.')
    sys.exit(1)

  if 'SUBSCRIPTION_ID' not in os.environ:
    logging.error('Missing SUBSCRIPTION_ID env var.')
    sys.exit(1)

  if 'GOOGLE_APPLICATION_CREDENTIALS' not in os.environ:
    logging.error('Missing GOOGLE_APPLICATION_CREDENTIALS env var.')
    sys.exit(1)

  logging.basicConfig(
      level=logging.INFO,
      style='{',
      format='{levelname:.1}{asctime} {filename}:{lineno}] {message}')
  receive_messages()

Java

在 CLI 中提供服務帳戶憑證：

export GOOGLE_APPLICATION_CREDENTIALS=SERVICE_ACCOUNT_FILE_PATH

在 CLI 中提供 Google Cloud 雲端專案 ID：
```
export PROJECT_ID=PROJECT_ID
```
在 CLI 中，提供您先前建立的 Pub/Sub 訂閱項目的訂閱 ID：
```
export SUBSCRIPTION_ID=SUBSCRIPTION_ID
```
在目前使用的目錄中，建立名為 pom.xml 的檔案。

在 pom.xml 檔案中貼上下列程式碼：

<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.addon</groupId>
 <artifactId>pubsub-addon-chat-app</artifactId>
 <version>0.1.0</version>

 <name>pubsub-addon-chat-app-java</name>

 <properties>
   <maven.compiler.release>11</maven.compiler.release>
   <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
 </properties>

 <dependencyManagement>
   <dependencies>
     <dependency>
       <groupId>com.google.cloud</groupId>
       <artifactId>libraries-bom</artifactId>
       <version>26.41.0</version> <!-- Use a recent BOM version -->
       <type>pom</type>
       <scope>import</scope>
     </dependency>
   </dependencies>
 </dependencyManagement>

 <dependencies>
   <!-- Google Chat GAPIC library -->
   <dependency>
     <groupId>com.google.cloud</groupId>
     <artifactId>google-cloud-chat</artifactId>
   </dependency>
   <!-- Google Cloud Pub/Sub library -->
   <dependency>
     <groupId>com.google.cloud</groupId>
     <artifactId>google-cloud-pubsub</artifactId>
   </dependency>
   <!-- Google Apps Add-ons Event Object -->
   <dependency>
     <groupId>com.google.apps.addons.v1</groupId>
     <artifactId>google-apps-addons-v1-java</artifactId>
     <version>0.2.0</version> <!-- Check for latest version -->
   </dependency>
   <!-- Protobuf JSON utility -->
   <dependency>
     <groupId>com.google.protobuf</groupId>
     <artifactId>protobuf-java-util</artifactId>
   </dependency>
   <!-- Google Auth Library -->
   <dependency>
     <groupId>com.google.auth</groupId>
     <artifactId>google-auth-library-oauth2-http</artifactId>
   </dependency>
   <dependency>
     <groupId>com.google.api</groupId>
     <artifactId>gax</artifactId>
   </dependency>
   <!-- JSON utilities for PubSub message (if needed, though protobuf-java-util is primary for EventObject) -->
   <dependency>
     <groupId>com.fasterxml.jackson.core</groupId>
     <artifactId>jackson-databind</artifactId>
     <version>2.14.2</version>
   </dependency>
   <dependency>
     <groupId>org.slf4j</groupId>
     <artifactId>slf4j-jdk14</artifactId>
     <version>1.7.36</version>
     <scope>runtime</scope>
   </dependency>
 </dependencies>

 <build>
   <plugins>
     <plugin>
       <groupId>org.apache.maven.plugins</groupId>
       <artifactId>maven-compiler-plugin</artifactId>
       <version>3.13.0</version>
       <configuration>
         <source>11</source>
         <target>11</target>
       </configuration>
     </plugin>
     <plugin>
       <groupId>org.codehaus.mojo</groupId>
       <artifactId>exec-maven-plugin</artifactId>
       <version>3.3.0</version>
       <configuration>
         <mainClass>Main</mainClass>
       </configuration>
     </plugin>
   </plugins>
 </build>
</project>

在目前使用的目錄中，建立 src/main/java 目錄結構。
在 src/main/java 目錄中，建立名為 Main.java 的檔案。

在 Main.java 中貼上下列程式碼：

import com.fasterxml.jackson.databind.JsonNode;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.google.api.gax.core.FixedCredentialsProvider;
import com.google.auth.oauth2.GoogleCredentials;
import com.google.chat.v1.ChatServiceClient;
import com.google.chat.v1.ChatServiceSettings;
import com.google.chat.v1.CreateMessageRequest;
import com.google.chat.v1.CreateMessageRequest.MessageReplyOption;
import com.google.chat.v1.Message;
import com.google.chat.v1.Thread;
import com.google.cloud.pubsub.v1.AckReplyConsumer;
import com.google.cloud.pubsub.v1.MessageReceiver;
import com.google.cloud.pubsub.v1.Subscriber;
import com.google.pubsub.v1.ProjectSubscriptionName;
import com.google.pubsub.v1.PubsubMessage;
import java.io.FileInputStream;
import java.util.Collections;

public class Main {

  public static final String PROJECT_ID_ENV_PROPERTY = "PROJECT_ID";
  public static final String SUBSCRIPTION_ID_ENV_PROPERTY = "SUBSCRIPTION_ID";
  public static final String CREDENTIALS_PATH_ENV_PROPERTY = "GOOGLE_APPLICATION_CREDENTIALS";

  public static void main(String[] args) throws Exception {
    ProjectSubscriptionName subscriptionName =
        ProjectSubscriptionName.of(
            System.getenv(Main.PROJECT_ID_ENV_PROPERTY),
            System.getenv(Main.SUBSCRIPTION_ID_ENV_PROPERTY));

    // Instantiate app, which implements an asynchronous message receiver.
    EchoApp echoApp = new EchoApp();

    // Create a subscriber for <var>SUBSCRIPTION_ID</var> bound to the message receiver
    final Subscriber subscriber = Subscriber.newBuilder(subscriptionName, echoApp).build();
    System.out.println("Subscriber is listening to events...");
    subscriber.startAsync();

    // Wait for termination
    subscriber.awaitTerminated();
  }
}

/**
 * A demo app which implements {@link MessageReceiver} to receive messages.
 * It echoes incoming messages.
 */
class EchoApp implements MessageReceiver {

  // Path to the private key JSON file of the service account to be used for posting response
  // messages to Google Chat.
  // In this demo, we are using the same service account for authorizing with Cloud Pub/Sub to
  // receive messages and authorizing with Google Chat to post messages. If you are using
  // different service accounts, set the path to the private key JSON file of the service
  // account used to post messages to Google Chat here.
  private static final String SERVICE_ACCOUNT_KEY_PATH =
    System.getenv(Main.CREDENTIALS_PATH_ENV_PROPERTY);

  // Developer code for Google Chat API scope.
  private static final String GOOGLE_CHAT_API_SCOPE = "https://www.googleapis.com/auth/chat.bot";

  private static final String ADDED_RESPONSE = "Thank you for adding me!";

  ChatServiceClient chatServiceClient;

  EchoApp() throws Exception {
    GoogleCredentials credential =
        GoogleCredentials.fromStream(new FileInputStream(SERVICE_ACCOUNT_KEY_PATH))
            .createScoped(Collections.singleton(GOOGLE_CHAT_API_SCOPE));

    // Create the ChatServiceSettings with the app credentials
    ChatServiceSettings chatServiceSettings =
        ChatServiceSettings.newBuilder()
            .setCredentialsProvider(FixedCredentialsProvider.create(credential))
            .build();

    // Set the Chat service client
    chatServiceClient = ChatServiceClient.create(chatServiceSettings);
  }

  // Called when a message is received by the subscriber.
  @Override
  public void receiveMessage(PubsubMessage pubsubMessage, AckReplyConsumer consumer) {
    System.out.println("Id : " + pubsubMessage.getMessageId());
    // Handle incoming message, then acknowledge the received message
    try {
      ObjectMapper mapper = new ObjectMapper();
      JsonNode dataJson = mapper.readTree(pubsubMessage.getData().toStringUtf8());
      System.out.println("Data : " + dataJson.toString());
      handle(dataJson);
      consumer.ack();
    } catch (Exception e) {
      System.out.println(e);
      // Negative acknowledgement makes Pub/Sub redeliver the message.
      consumer.nack();
    }
  }

  // Send message to Google Chat based on the type of event.
  public void handle(JsonNode eventJson) throws Exception {
    // Google Chat events for add-ons are wrapped in a 'chat' object.
    if (!eventJson.has("chat")) {
      System.out.println("Ignored: Not a Chat event (missing 'chat' field).");
      return;
    }

    JsonNode chatNode = eventJson.get("chat");
    CreateMessageRequest createMessageRequest = null;

    if (chatNode.has("messagePayload")) {
      // HANDLE MESSAGE
      JsonNode messagePayload = chatNode.get("messagePayload");
      JsonNode message = messagePayload.get("message");
      JsonNode space = messagePayload.get("space");

      String spaceName = space.get("name").asText();
      String userText = message.has("text") ? message.get("text").asText() : "";
      String threadName = message.has("thread") ? message.get("thread").get("name").asText() : "";

      System.out.println("Received message in " + spaceName + ": " + userText);

      createMessageRequest =
          CreateMessageRequest.newBuilder()
              .setParent(spaceName)
              .setMessageReplyOption(MessageReplyOption.REPLY_MESSAGE_FALLBACK_TO_NEW_THREAD)
              .setMessage(
                  Message.newBuilder()
                      .setText("You said: `" + userText + "`")
                      .setThread(Thread.newBuilder().setName(threadName).build())
                      .build())
              .build();

    } else if (chatNode.has("addedToSpacePayload")) {
      // HANDLE ADDED TO SPACE
      JsonNode addedPayload = chatNode.get("addedToSpacePayload");
      JsonNode space = addedPayload.get("space");
      String spaceName = space.get("name").asText();

      System.out.println("Added to space: " + spaceName);

      createMessageRequest =
          CreateMessageRequest.newBuilder()
              .setParent(spaceName)
              .setMessage(Message.newBuilder().setText(ADDED_RESPONSE).build())
              .build();

    } else if (chatNode.has("removedFromSpacePayload")) {
      System.out.println("Removed from space.");
      return;
    } else {
      System.out.println("Ignored: Unhandled Chat event type.");
      return;
    }

    if (createMessageRequest != null) {
      // Post the response to Google Chat.
      chatServiceClient.createMessage(createMessageRequest);
      System.out.println("Sent reply.");
    }
  }
}

設定 Chat 應用程式

在 Google Cloud 控制台中設定 Chat 應用程式，提供名稱和虛擬人偶等詳細資料，並設定與 Pub/Sub 主題的連線。

連結至 Pub/Sub 主題後，Chat 就能將事件傳送至應用程式。訂閱該主題的指令碼隨後會收到這些事件，並回應使用者。

在 Google Cloud 控制台中，依序前往「選單」 >「API 和服務」 >「已啟用的 API 和服務」 >「Google Chat API」 >「設定」。

前往 Chat API 設定
設定 Chat 應用程式的 Pub/Sub：
1. 在「應用程式名稱」中輸入 Quickstart App。
2. 在「顯示圖片網址」中輸入 https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png。
3. 在「Description」(說明) 中輸入 Quickstart app。
4. 在「功能」下方，選取「加入聊天室和群組對話」。
5. 在「連線設定」下方，選取「Cloud Pub/Sub」，然後貼上您先前建立的 Pub/Sub 主題名稱。
6. 在「可見度」下方，選取「將這個 Google Chat 應用程式提供給網域中的特定使用者和群組」，然後輸入電子郵件地址。
7. 在「記錄」下方，選取「將錯誤記錄至 Logging」。
按一下 [儲存]。

設定 Chat 應用程式後，您必須更新 Pub/Sub 設定。

在「Chat API configuration」(Chat API 設定) 頁面的「Connection settings」(連線設定) 下方，複製「Service account email」(服務帳戶電子郵件地址)，這是為 Google 雲端專案產生的專屬電子郵件地址。
將先前複製的服務帳戶電子郵件地址指派為「Pub/Sub 發布者」角色，授予 Chat 發布至主題的權限。

注意：如果您使用 VPC Service Controls，可能需要在服務範圍中設定輸入規則，允許服務帳戶存取 Pub/Sub。詳情請參閱「輸入和輸出規則」。

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

執行指令碼

在 CLI 中，切換至目前使用的目錄並執行指令碼：

Node.js

npm install
npm start

Python

python -m venv env
source env/bin/activate
pip install -r requirements.txt -U
python app.py

Java

mvn compile exec:java -Dexec.mainClass=Main

執行程式碼後，應用程式就會開始監聽發布至 Pub/Sub 主題的訊息。

測試 Chat 應用程式

如要測試 Chat 應用程式，請開啟與 Chat 應用程式互傳的即時訊息聊天室，然後傳送訊息：

使用您在新增為早鳥測試者時提供的 Google Workspace 帳戶，開啟 Google Chat。

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

注意：如果結果清單中沒有顯示 Chat 應用程式，請確認您已在 Google Cloud 控制台的「Chat API Configuration」頁面中，將 Google Workspace 帳戶納入「Visibility」設定。
在與應用程式互傳的新即時訊息中，輸入 Hello 並按下 enter。

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

疑難排解

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

即使 Chat 使用者介面可能不會顯示錯誤訊息，但只要開啟 Chat 應用程式的錯誤記錄功能，就能取得說明性錯誤訊息和記錄資料，協助修正錯誤。如需查看、偵錯及修正錯誤的相關協助，請參閱「排解及修正 Google Chat 錯誤」。

清除所用資源

為避免系統向您的 Google Cloud 帳戶收取本教學課程所用資源的費用，建議您刪除雲端專案。

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

如要為 Chat 應用程式新增更多功能，請參閱下列文章：
- 接收及回應使用者互動
- 回應指令
選擇 Chat 擴充應用程式架構

非外掛程式的 Chat 擴充應用程式：使用 Pub/Sub 建構 Google Chat 擴充應用程式

如要使用 Pub/Sub 建構非 Google Workspace 外掛程式的 Chat 應用程式，請按照下列步驟授予 Pub/Sub 發布權限、編寫指令碼，以及設定非外掛程式的 Chat 應用程式。

授予 Chat 發布至主題的權限

授予 Chat 發布權限：將 Pub/Sub 發布者角色指派給下列服務帳戶，即可授予 Chat 發布權限：

chat-api-push@system.gserviceaccount.com

為非外掛程式的 Chat 應用程式編寫指令碼

Node.js

在 CLI 中提供服務帳戶憑證：

export GOOGLE_APPLICATION_CREDENTIALS=SERVICE_ACCOUNT_FILE_PATH

在 CLI 中提供 Google Cloud 雲端專案 ID：
```
export PROJECT_ID=PROJECT_ID
```
在 CLI 中，提供您先前建立的 Pub/Sub 訂閱項目的訂閱 ID：
```
export SUBSCRIPTION_ID=SUBSCRIPTION_ID
```
在目前使用的目錄中，建立名為 package.json 的檔案。
在 package.json 檔案中貼上下列程式碼：

node/pub-sub-app/package.json

前往 GitHub 查看
```
{
  "name": "pub-sub-app",
  "version": "1.0.0",
  "description": "Google Chat App that listens for messages via Cloud Pub/Sub",
  "main": "index.js",
  "scripts": {
    "start": "node index.js",
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "dependencies": {
    "@google-apps/chat": "^0.4.0",
    "@google-cloud/pubsub": "^4.5.0"
  },
  "license": "Apache-2.0"
}
```
在目前使用的目錄中，建立名為 index.js 的檔案。

在 index.js 中貼上下列程式碼：

node/pub-sub-app/index.js

前往 GitHub 查看

const {ChatServiceClient} = require('@google-apps/chat');
const {MessageReplyOption} = require('@google-apps/chat').protos.google.chat.v1.CreateMessageRequest;
const {PubSub} = require('@google-cloud/pubsub');
const {SubscriberClient} = require('@google-cloud/pubsub/build/src/v1');

// Receives messages from a pull subscription.
function receiveMessages() {
  const chat = new ChatServiceClient({
    keyFile: process.env.GOOGLE_APPLICATION_CREDENTIALS,
    scopes: ['https://www.googleapis.com/auth/chat.bot'],
  });

  const subscriptionPath = new SubscriberClient()
    .subscriptionPath(process.env.PROJECT_ID, process.env.SUBSCRIPTION_ID)
  const subscription = new PubSub()
    .subscription(subscriptionPath);

  // Handle incoming message, then ack/nack the received message
  const messageHandler = message => {
    console.log(`Id : ${message.id}`);
    const event = JSON.parse(message.data);
    console.log(`Data : ${JSON.stringify(event)}`);

    // Post the response to Google Chat.
    const request = formatRequest(event);
    if (request != null) {
      chat.createMessage(request);
    }

    // Ack the message.
    message.ack();
  }

  subscription.on('message', messageHandler);
  console.log(`Listening for messages on ${subscriptionPath}`);

  // Keep main thread from exiting while waiting for messages
  setTimeout(() => {
    subscription.removeListener('message', messageHandler);
    console.log(`Stopped listening for messages.`);
  }, 60 * 1000);
}

// Send message to Google Chat based on the type of event
function formatRequest(event) {
  const spaceName = event.space.name;
  const eventType = event.type;

  // If the app was removed, we don't respond.
  if (event.type == 'REMOVED_FROM_SPACE') {
    console.log(`App removed rom space ${spaceName}`);
    return null;
  } else if (eventType == 'ADDED_TO_SPACE' && !eventType.message) {
    // An app can also be added to a space by @mentioning it in a
    // message. In that case, we fall through to the message case
    // and let the app respond. If the app was added using the
    // invite flow, we just post a thank you message in the space.
    return {
      parent: spaceName,
      message: { text: 'Thank you for adding me!' }
    };
  } else if (eventType == 'ADDED_TO_SPACE' || eventType == 'MESSAGE') {
    // In case of message, post the response in the same thread.
    return {
      parent: spaceName,
      messageReplyOption: MessageReplyOption.REPLY_MESSAGE_FALLBACK_TO_NEW_THREAD,
      message: {
        text: 'You said: `' + event.message.text + '`',
        thread: { name: event.message.thread.name }
      }
    };
  }
}

if (!process.env.PROJECT_ID) {
  console.log('Missing PROJECT_ID env var.');
  process.exit(1);
}
if (!process.env.SUBSCRIPTION_ID) {
  console.log('Missing SUBSCRIPTION_ID env var.');
  process.exit(1);
}
if (!process.env.GOOGLE_APPLICATION_CREDENTIALS) {
  console.log('Missing GOOGLE_APPLICATION_CREDENTIALS env var.');
  process.exit(1);
}

receiveMessages();

Python

在 CLI 中提供服務帳戶憑證：

export GOOGLE_APPLICATION_CREDENTIALS=SERVICE_ACCOUNT_FILE_PATH

在 CLI 中提供 Google Cloud 雲端專案 ID：
```
export PROJECT_ID=PROJECT_ID
```
在 CLI 中，提供您先前建立的 Pub/Sub 訂閱項目的訂閱 ID：
```
export SUBSCRIPTION_ID=SUBSCRIPTION_ID
```
在目前使用的目錄中，建立名為 requirements.txt 的檔案。
在 requirements.txt 檔案中貼上下列程式碼：

python/pub-sub-app/requirements.txt

前往 GitHub 查看
```
google-cloud-pubsub>=2.23.0
google-apps-chat==0.1.9
```
在目前使用的目錄中，建立名為 app.py 的檔案。

在 app.py 中貼上下列程式碼：

python/pub-sub-app/app.py

前往 GitHub 查看

import json
import logging
import os
import sys
import time
from google.apps import chat_v1 as google_chat
from google.cloud import pubsub_v1
from google.oauth2.service_account import Credentials


def receive_messages():
  """Receives messages from a pull subscription."""

  scopes = ['https://www.googleapis.com/auth/chat.bot']
  service_account_key_path = os.environ.get(
    'GOOGLE_APPLICATION_CREDENTIALS')
  creds = Credentials.from_service_account_file(
    service_account_key_path)
  chat = google_chat.ChatServiceClient(
    credentials = creds,
    client_options = {
      "scopes": scopes
    })

  project_id = os.environ.get('PROJECT_ID')
  subscription_id = os.environ.get('SUBSCRIPTION_ID')
  subscriber = pubsub_v1.SubscriberClient()
  subscription_path = subscriber.subscription_path(
      project_id, subscription_id)

  # Handle incoming message, then ack/nack the received message
  def callback(message):
    event = json.loads(message.data)
    logging.info('Data : %s', event)
    space_name = event['space']['name']

    # Post the response to Google Chat.
    request = format_request(event)
    if request is not None:
      chat.create_message(request)

    # Ack the message.
    message.ack()

  subscriber.subscribe(subscription_path, callback = callback)
  logging.info('Listening for messages on %s', subscription_path)

  # Keep main thread from exiting while waiting for messages
  while True:
    time.sleep(60)


def format_request(event):
  """Send message to Google Chat based on the type of event.
  Args:
    event: A dictionary with the event data.
  """
  space_name = event['space']['name']
  event_type = event['type']

  # If the app was removed, we don't respond.
  if event['type'] == 'REMOVED_FROM_SPACE':
    logging.info('App removed rom space %s', space_name)
    return
  elif event_type == 'ADDED_TO_SPACE' and 'message' not in event:
    # An app can also be added to a space by @mentioning it in a
    # message. In that case, we fall through to the message case
    # and let the app respond. If the app was added using the
    # invite flow, we just post a thank you message in the space.
    return google_chat.CreateMessageRequest(
        parent = space_name,
        message = {
          'text': 'Thank you for adding me!'
        }
    )
  elif event_type in ['ADDED_TO_SPACE', 'MESSAGE']:
    # In case of message, post the response in the same thread.
    return google_chat.CreateMessageRequest(
        parent = space_name,
        message_reply_option = google_chat.CreateMessageRequest.MessageReplyOption.REPLY_MESSAGE_FALLBACK_TO_NEW_THREAD,
        message = {
          'text': 'You said: `' + event['message']['text'] + '`',
          'thread': {
            'name': event['message']['thread']['name']
          }
        }
    )


if __name__ == '__main__':
  if 'PROJECT_ID' not in os.environ:
    logging.error('Missing PROJECT_ID env var.')
    sys.exit(1)

  if 'SUBSCRIPTION_ID' not in os.environ:
    logging.error('Missing SUBSCRIPTION_ID env var.')
    sys.exit(1)

  if 'GOOGLE_APPLICATION_CREDENTIALS' not in os.environ:
    logging.error('Missing GOOGLE_APPLICATION_CREDENTIALS env var.')
    sys.exit(1)

  logging.basicConfig(
      level=logging.INFO,
      style='{',
      format='{levelname:.1}{asctime} {filename}:{lineno}] {message}')
  receive_messages()

Java

在 CLI 中提供服務帳戶憑證：

export GOOGLE_APPLICATION_CREDENTIALS=SERVICE_ACCOUNT_FILE_PATH

在 CLI 中提供 Google Cloud 雲端專案 ID：
```
export PROJECT_ID=PROJECT_ID
```
在 CLI 中，提供您先前建立的 Pub/Sub 訂閱項目的訂閱 ID：
```
export SUBSCRIPTION_ID=SUBSCRIPTION_ID
```
在目前使用的目錄中，建立名為 pom.xml 的檔案。

在 pom.xml 檔案中貼上下列程式碼：

java/pub-sub-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>pub-sub-app</artifactId>
  <version>0.1.0</version>

  <name>pub-sub-app-java</name>

  <properties>
    <maven.compiler.release>21</maven.compiler.release>
    <maven.compiler.source>1.8</maven.compiler.source>
    <maven.compiler.target>1.8</maven.compiler.target>
  </properties>

  <dependencies>
    <!-- Google Chat GAPIC library -->
    <dependency>
      <groupId>com.google.api.grpc</groupId>
      <artifactId>proto-google-cloud-chat-v1</artifactId>
      <version>0.8.0</version>
    </dependency>
    <dependency>
      <groupId>com.google.api</groupId>
      <artifactId>gax</artifactId>
      <version>2.48.1</version>
    </dependency>
    <dependency>
      <groupId>com.google.cloud</groupId>
      <artifactId>google-cloud-chat</artifactId>
      <version>0.1.0</version>
    </dependency>
    <!-- Google Cloud Pub/Sub library -->
    <dependency>
      <groupId>com.google.cloud</groupId>
      <artifactId>google-cloud-pubsub</artifactId>
    <version>1.125.8</version>
    </dependency>
    <!-- JSON utilities -->
    <dependency>
      <groupId>com.fasterxml.jackson.core</groupId>
      <artifactId>jackson-databind</artifactId>
      <version>2.14.2</version>
    </dependency>
  </dependencies>

</project>

在目前使用的目錄中，建立 src/main/java 目錄結構。
在 src/main/java 目錄中，建立名為 Main.java 的檔案。

在 Main.java 中貼上下列程式碼：

java/pub-sub-app/src/main/java/Main.java

前往 GitHub 查看

import com.fasterxml.jackson.databind.JsonNode;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.google.api.gax.core.FixedCredentialsProvider;
import com.google.auth.oauth2.GoogleCredentials;
import com.google.chat.v1.ChatServiceClient;
import com.google.chat.v1.ChatServiceSettings;
import com.google.chat.v1.CreateMessageRequest;
import com.google.chat.v1.CreateMessageRequest.MessageReplyOption;
import com.google.chat.v1.Message;
import com.google.chat.v1.Thread;
import com.google.cloud.pubsub.v1.AckReplyConsumer;
import com.google.cloud.pubsub.v1.MessageReceiver;
import com.google.cloud.pubsub.v1.Subscriber;
import com.google.pubsub.v1.ProjectSubscriptionName;
import com.google.pubsub.v1.PubsubMessage;
import java.io.FileInputStream;
import java.util.Collections;

public class Main {

  public static final String PROJECT_ID_ENV_PROPERTY = "PROJECT_ID";
  public static final String SUBSCRIPTION_ID_ENV_PROPERTY = "SUBSCRIPTION_ID";
  public static final String CREDENTIALS_PATH_ENV_PROPERTY = "GOOGLE_APPLICATION_CREDENTIALS";

  public static void main(String[] args) throws Exception {
    ProjectSubscriptionName subscriptionName = ProjectSubscriptionName.of(
      System.getenv(Main.PROJECT_ID_ENV_PROPERTY),
      System.getenv(Main.SUBSCRIPTION_ID_ENV_PROPERTY));

    // Instantiate app, which implements an asynchronous message receiver.
    EchoApp echoApp = new EchoApp();

    // Create a subscriber for <var>SUBSCRIPTION_ID</var> bound to the message receiver
    final Subscriber subscriber = Subscriber.newBuilder(subscriptionName, echoApp).build();
    System.out.println("Subscriber is listening to events...");
    subscriber.startAsync();

    // Wait for termination
    subscriber.awaitTerminated();
  }
}

/**
 * A demo app which implements {@link MessageReceiver} to receive messages. It simply echoes the
 * incoming messages.
 */
class EchoApp implements MessageReceiver {

  // Path to the private key JSON file of the service account to be used for posting response
  // messages to Google Chat.
  // In this demo, we are using the same service account for authorizing with Cloud Pub/Sub to
  // receive messages and authorizing with Google Chat to post messages. If you are using
  // different service accounts, please set the path to the private key JSON file of the service
  // account used to post messages to Google Chat here.
  private static final String SERVICE_ACCOUNT_KEY_PATH =
    System.getenv(Main.CREDENTIALS_PATH_ENV_PROPERTY);

  // Developer code for Google Chat API scope.
  private static final String GOOGLE_CHAT_API_SCOPE = "https://www.googleapis.com/auth/chat.bot";

  private static final String ADDED_RESPONSE = "Thank you for adding me!";

  ChatServiceClient chatServiceClient;

  EchoApp() throws Exception {
    GoogleCredentials credential = GoogleCredentials
      .fromStream(new FileInputStream(SERVICE_ACCOUNT_KEY_PATH))
      .createScoped(Collections.singleton(GOOGLE_CHAT_API_SCOPE));

    // Create the ChatServiceSettings with the app credentials
    ChatServiceSettings chatServiceSettings = ChatServiceSettings.newBuilder()
      .setCredentialsProvider(FixedCredentialsProvider.create(credential)).build();

    // Set the Chat service client
    chatServiceClient = ChatServiceClient.create(chatServiceSettings);
  }

  // Called when a message is received by the subscriber.
  @Override
  public void receiveMessage(PubsubMessage pubsubMessage, AckReplyConsumer consumer) {
    System.out.println("Id : " + pubsubMessage.getMessageId());
    // Handle incoming message, then ack/nack the received message
    try {
      ObjectMapper mapper = new ObjectMapper();
      JsonNode dataJson = mapper.readTree(pubsubMessage.getData().toStringUtf8());
      System.out.println("Data : " + dataJson.toString());
      handle(dataJson);
      consumer.ack();
    } catch (Exception e) {
      System.out.println(e);
      consumer.nack();
    }
  }

  // Send message to Google Chat based on the type of event.
  public void handle(JsonNode eventJson) throws Exception {
    CreateMessageRequest createMessageRequest;
    switch (eventJson.get("type").asText()) {
      case "ADDED_TO_SPACE":
        // An app can also be added to a space by @mentioning it in a message. In that case, we fall
        // through to the MESSAGE case and let the app respond. If the app was added using the
        // invite flow, we just post a thank you message in the space.
        if (!eventJson.has("message")) {
          createMessageRequest = CreateMessageRequest.newBuilder()
            .setParent(eventJson.get("space").get("name").asText())
            .setMessage(Message.newBuilder().setText(ADDED_RESPONSE).build()).build();
          break;
        }
      case "MESSAGE":
        // In case of message, post the response in the same thread.
        createMessageRequest = CreateMessageRequest.newBuilder()
          .setParent(eventJson.get("space").get("name").asText())
          .setMessageReplyOption(MessageReplyOption.REPLY_MESSAGE_FALLBACK_TO_NEW_THREAD)
          .setMessage(Message.newBuilder()
            .setText("You said: `" + eventJson.get("message").get("text").asText() + "`")
            .setThread(Thread.newBuilder()
              .setName(eventJson.get("message").get("thread").get("name").asText())
              .build()).build()).build();
        break;
      case "REMOVED_FROM_SPACE":
      default:
        // Do nothing
        return;
    }

    // Post the response to Google Chat.
    chatServiceClient.createMessage(createMessageRequest);
  }
}

設定非外掛程式的 Chat 應用程式

在 Google Cloud 控制台中，依序前往「選單」>「API 和服務」>「已啟用的 API 和服務」>「Google Chat API」>「設定」。

前往「設定」
設定非 Pub/Sub 外掛程式的 Chat 應用程式：
1. 取消勾選「將這個 Chat 擴充應用程式建構為 Google Workspace 外掛程式」。系統會開啟對話方塊，要求您確認。在對話方塊中，按一下「停用」。
2. 在「應用程式名稱」中輸入 Quickstart App。
3. 在「顯示圖片網址」中輸入 https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png。
4. 在「Description」(說明) 中輸入 Quickstart app。
5. 在「功能」下方，選取「加入聊天室和群組對話」。
6. 在「連線設定」下方，選取「Cloud Pub/Sub」，然後貼上您先前建立的 Pub/Sub 主題名稱。
7. 在「可見度」下方，選取「將這個 Google Chat 應用程式提供給網域中的特定使用者和群組」，然後輸入電子郵件地址。
8. 在「記錄」下方，選取「將錯誤記錄至 Logging」。
按一下 [儲存]。

使用 Pub/Sub 建立設有防火牆的 Google Chat 應用程式 透過集合功能整理內容 你可以依據偏好儲存及分類內容。

必要條件

Node.js

Python

Java

設定環境

設定 Pub/Sub

編寫指令碼

Node.js

Python

Java

設定 Chat 應用程式

執行指令碼

Node.js

Python

Java

測試 Chat 應用程式

疑難排解

清除所用資源

相關主題

非外掛程式的 Chat 擴充應用程式：使用 Pub/Sub 建構 Google Chat 擴充應用程式

授予 Chat 發布至主題的權限

為非外掛程式的 Chat 應用程式編寫指令碼

Node.js

Python

Java

設定非外掛程式的 Chat 應用程式

使用 Pub/Sub 建立設有防火牆的 Google Chat 應用程式