更新訊息

本指南說明如何使用 Google Chat API Message 資源的 update() 方法，更新聊天室中的文字或訊息卡片。更新訊息即可變更訊息屬性，例如訊息內容或資訊卡內容。你也可以在訊息卡片前加上文字訊息，或在文字訊息後加上訊息卡片。

在 Chat API 中，Chat 訊息以 Message 資源表示。Chat 使用者只能傳送含有文字的訊息，但 Chat 擴充應用程式可以使用許多其他訊息功能，包括顯示靜態或互動式使用者介面、向使用者收集資訊，以及私下傳送訊息。如要進一步瞭解 Chat API 提供的訊息功能，請參閱「Google Chat 訊息總覽」。

必要條件

Node.js

• 具有 Google Chat 存取權的 Business 或 Enterprise 版 Google Workspace 帳戶。

• 設定環境：
  • 建立 Google Cloud 專案。
  • 設定 OAuth 同意畫面。
  • 啟用及設定 Google Chat API，並為 Chat 應用程式命名、設定圖示和說明。
  • 安裝 Node.js Cloud 用戶端程式庫。
  • 根據您要在 Google Chat API 要求中驗證的方式，建立存取憑證：
    • 如要以 Chat 使用者身分進行驗證，請建立 OAuth 用戶端 ID 憑證，並將憑證儲存至本機目錄，命名為 credentials.json 的 JSON 檔案。
    • 如要以 Chat 應用程式的身分進行驗證，請建立服務帳戶憑證，然後將憑證儲存為名為 credentials.json 的 JSON 檔案。
• 根據您要以使用者或 Chat 應用程式的身分驗證，選擇授權範圍。

Python

• 具有 Google Chat 存取權的 Business 或 Enterprise 版 Google Workspace 帳戶。

• 設定環境：
  • 建立 Google Cloud 專案。
  • 設定 OAuth 同意畫面。
  • 啟用及設定 Google Chat API，並為 Chat 應用程式命名、設定圖示和說明。
  • 安裝 Python Cloud 用戶端程式庫。
  • 根據您要在 Google Chat API 要求中驗證的方式，建立存取憑證：
    • 如要以 Chat 使用者身分進行驗證，請建立 OAuth 用戶端 ID 憑證，並將憑證儲存至本機目錄，命名為 credentials.json 的 JSON 檔案。
    • 如要以 Chat 應用程式的身分進行驗證，請建立服務帳戶憑證，然後將憑證儲存為名為 credentials.json 的 JSON 檔案。
• 根據您要以使用者或 Chat 應用程式的身分驗證，選擇授權範圍。

Java

• 具有 Google Chat 存取權的 Business 或 Enterprise 版 Google Workspace 帳戶。

• 設定環境：
  • 建立 Google Cloud 專案。
  • 設定 OAuth 同意畫面。
  • 啟用及設定 Google Chat API，並為 Chat 應用程式命名、設定圖示和說明。
  • 安裝 Java Cloud 用戶端程式庫。
  • 根據您要在 Google Chat API 要求中驗證的方式，建立存取憑證：
    • 如要以 Chat 使用者身分進行驗證，請建立 OAuth 用戶端 ID 憑證，並將憑證儲存至本機目錄，命名為 credentials.json 的 JSON 檔案。
    • 如要以 Chat 應用程式的身分進行驗證，請建立服務帳戶憑證，然後將憑證儲存為名為 credentials.json 的 JSON 檔案。
• 根據您要以使用者或 Chat 應用程式的身分驗證，選擇授權範圍。

Apps Script

• 具有 Google Chat 存取權的 Business 或 Enterprise 版 Google Workspace 帳戶。

• 設定環境：
  • 建立 Google Cloud 專案。
  • 設定 OAuth 同意畫面。
  • 啟用及設定 Google Chat API，並為 Chat 應用程式命名、設定圖示和說明。
  • 建立獨立的 Apps Script 專案，並開啟進階 Chat 服務。
  • 在本指南中，您必須使用使用者或應用程式驗證。如要以 Chat 應用程式的身分進行驗證，請建立服務帳戶憑證。如需相關步驟，請參閱「以 Google Chat 擴充應用程式的身分驗證及授權」。
• 根據您要以使用者或 Chat 應用程式的身分驗證，選擇授權範圍。

本頁的程式碼範例使用 gRPC API 介面和 Google Cloud 用戶端程式庫。或者，您也可以使用 REST API 介面。如要進一步瞭解 gRPC 和 REST 介面，請參閱「Google Chat API 總覽」。

代表使用者更新訊息

透過使用者驗證，只能更新訊息文字。

如要使用使用者驗證更新訊息，請在要求中傳遞下列內容：

• 指定 chat.messages 授權範圍。
• 呼叫 UpdateMessage() 方法。
• 將 message 做為 Message 的執行個體傳遞，並使用下列項目：
  • name 欄位設為要更新的訊息，包括空間 ID 和訊息 ID。
  • 以新文字設定的 text 欄位。
• 傳遞 updateMask，並將值設為 text。

如果更新後的訊息是資訊卡訊息，文字會加在資訊卡前面 (資訊卡會繼續顯示)。

以下說明如何更新訊息，或使用使用者驗證在訊息卡片中加入文字訊息：

Node.js

chat/client-libraries/cloud/update-message-user-cred.js

前往 GitHub 查看

import {createClientWithUserCredentials} from './authentication-utils.js';

const USER_AUTH_OAUTH_SCOPES = ['https://www.googleapis.com/auth/chat.messages'];

// This sample shows how to update a message with user credential
async function main() {
  // Create a client
  const chatClient = await createClientWithUserCredentials(USER_AUTH_OAUTH_SCOPES);

  // Initialize request argument(s)
  const request = {
    message: {
      // Replace SPACE_NAME and MESSAGE_NAME here
      name: 'spaces/SPACE_NAME/messages/MESSAGE_NAME',
      text: 'Updated with user credential!'
    },
    // The field paths to update. Separate multiple values with commas or use
    // `*` to update all field paths.
    updateMask: {
      // The field paths to update.
      paths: ['text']
    }
  };

  // Make the request
  const response = await chatClient.updateMessage(request);

  // Handle the response
  console.log(response);
}

main().catch(console.error);

Python

chat/client-libraries/cloud/update_message_user_cred.py

前往 GitHub 查看

from authentication_utils import create_client_with_user_credentials
from google.apps import chat_v1 as google_chat

SCOPES = ["https://www.googleapis.com/auth/chat.messages"]

# This sample shows how to update a message with user credential
def update_message_with_user_cred():
    # Create a client
    client = create_client_with_user_credentials(SCOPES)

    # Initialize request argument(s)
    request = google_chat.UpdateMessageRequest(
        message = {
            # Replace SPACE_NAME and MESSAGE_NAME here
            "name": "spaces/SPACE_NAME/messages/MESSAGE_NAME",
            "text": "Updated with user credential!"
        },
        # The field paths to update. Separate multiple values with commas or use
        # `*` to update all field paths.
        update_mask = "text"
    )

    # Make the request
    response = client.update_message(request)

    # Handle the response
    print(response)

update_message_with_user_cred()

Java

chat/client-libraries/cloud/src/main/java/com/google/workspace/api/chat/samples/UpdateMessageUserCred.java

前往 GitHub 查看

import com.google.chat.v1.ChatServiceClient;
import com.google.chat.v1.UpdateMessageRequest;
import com.google.chat.v1.Message;
import com.google.protobuf.FieldMask;

// This sample shows how to update message with user credential.
public class UpdateMessageUserCred {

  private static final String SCOPE =
    "https://www.googleapis.com/auth/chat.messages";

  public static void main(String[] args) throws Exception {
    try (ChatServiceClient chatServiceClient =
        AuthenticationUtils.createClientWithUserCredentials(
          ImmutableList.of(SCOPE))) {
      UpdateMessageRequest.Builder request = UpdateMessageRequest.newBuilder()
        .setMessage(Message.newBuilder()
          // replace SPACE_NAME and MESSAGE_NAME here
          .setName("spaces/SPACE_NAME/messages/MESSAGE_NAME")
          .setText("Updated with user credential!"))
        .setUpdateMask(FieldMask.newBuilder()
          // The field paths to update.
          .addPaths("text"));
      Message response = chatServiceClient.updateMessage(request.build());

      System.out.println(JsonFormat.printer().print(response));
    }
  }
}

Apps Script

chat/advanced-service/Main.gs

前往 GitHub 查看

/**
 * This sample shows how to update a message with user credential
 * 
 * It relies on the OAuth2 scope 'https://www.googleapis.com/auth/chat.messages'
 * referenced in the manifest file (appsscript.json).
 */
function updateMessageUserCred() {
  // Initialize request argument(s)
  // TODO(developer): Replace SPACE_NAME and MESSAGE_NAME here
  const name = 'spaces/SPACE_NAME/messages/MESSAGE_NAME';
  const message = {
    text: 'Updated with user credential!'
  };
  // The field paths to update. Separate multiple values with commas or use
  // `*` to update all field paths.
  const updateMask = 'text';

  // Make the request
  const response = Chat.Spaces.Messages.patch(message, name, {
    updateMask: updateMask
  });

  // Handle the response
  console.log(response);
}

如要執行這個範例，請替換下列項目：

• SPACE_NAME：來自聊天室的 ID。name。您可以呼叫 ListSpaces() 方法，或從空間的網址取得 ID。
• MESSAGE_NAME：訊息 name 中的 ID。您可以透過使用 Chat API 非同步建立訊息後傳回的回應主體，或透過建立訊息時指派給訊息的自訂名稱，取得 ID。

Chat API 會傳回 Message 的執行個體，其中詳述更新的訊息。

以 Chat 應用程式身分更新訊息

透過應用程式驗證，即可更新訊息的文字和卡片。

如要使用應用程式驗證更新訊息，請在要求中傳遞下列項目：

• 指定 chat.bot 授權範圍。
• 呼叫 UpdateMessage() 方法。
• 將 message 做為 Message 的執行個體傳遞，並使用下列項目：
  • name 欄位設為要更新的訊息，包括空間 ID 和訊息 ID。
  • 如果需要更新，請使用新文字設定 text 欄位。
  • 如果需要更新，請使用新卡片設定 cardsV2 欄位。
• 傳遞 updateMask，其中包含要更新的欄位清單，例如 text 和 cardsV2。

如果更新後的訊息是資訊卡訊息，且文字已更新，更新後的文字會加在資訊卡前面 (資訊卡會繼續顯示)。如果更新後的訊息是簡訊，且卡片已更新，更新後的卡片會附加到文字訊息 (文字訊息會繼續顯示)。

如要透過應用程式驗證更新訊息的文字和卡片，請按照下列步驟操作：

Node.js

chat/client-libraries/cloud/update-message-app-cred.js

前往 GitHub 查看

import {createClientWithAppCredentials} from './authentication-utils.js';

// This sample shows how to update a message with app credential
async function main() {
  // Create a client
  const chatClient = createClientWithAppCredentials();

  // Initialize request argument(s)
  const request = {
    message: {
      // Replace SPACE_NAME and MESSAGE_NAME here
      name: 'spaces/SPACE_NAME/messages/MESSAGE_NAME',
      text: 'Text updated with app credential!',
      cardsV2 : [{ card: { header: {
        title: 'Card updated with app credential!',
        imageUrl: 'https://fonts.gstatic.com/s/i/short-term/release/googlesymbols/info/default/24px.svg'
      }}}]
    },
    // The field paths to update. Separate multiple values with commas or use
    // `*` to update all field paths.
    updateMask: {
      // The field paths to update.
      paths: ['text', 'cards_v2']
    }
  };

  // Make the request
  const response = await chatClient.updateMessage(request);

  // Handle the response
  console.log(response);
}

main().catch(console.error);

Python

chat/client-libraries/cloud/update_message_app_cred.py

前往 GitHub 查看

from authentication_utils import create_client_with_app_credentials
from google.apps import chat_v1 as google_chat

# This sample shows how to update a message with app credential
def update_message_with_app_cred():
    # Create a client
    client = create_client_with_app_credentials()

    # Initialize request argument(s)
    request = google_chat.UpdateMessageRequest(
        message = {
            # Replace SPACE_NAME and MESSAGE_NAME here
            "name": "spaces/SPACE_NAME/messages/MESSAGE_NAME",
            "text": "Text updated with app credential!",
            "cards_v2" : [{ "card": { "header": {
                "title": 'Card updated with app credential!',
                "image_url": 'https://fonts.gstatic.com/s/i/short-term/release/googlesymbols/info/default/24px.svg'
            }}}]
        },
        # The field paths to update. Separate multiple values with commas or use
        # `*` to update all field paths.
        update_mask = "text,cardsV2"
    )

    # Make the request
    response = client.update_message(request)

    # Handle the response
    print(response)

update_message_with_app_cred()

Java

chat/client-libraries/cloud/src/main/java/com/google/workspace/api/chat/samples/UpdateMessageAppCred.java

前往 GitHub 查看

import com.google.apps.card.v1.Card;
import com.google.apps.card.v1.Card.CardHeader;
import com.google.chat.v1.CardWithId;
import com.google.chat.v1.ChatServiceClient;
import com.google.chat.v1.UpdateMessageRequest;
import com.google.chat.v1.Message;
import com.google.protobuf.FieldMask;

// This sample shows how to update message with app credential.
public class UpdateMessageAppCred {

  public static void main(String[] args) throws Exception {
    try (ChatServiceClient chatServiceClient =
        AuthenticationUtils.createClientWithAppCredentials()) {
      UpdateMessageRequest.Builder request = UpdateMessageRequest.newBuilder()
        .setMessage(Message.newBuilder()
          // replace SPACE_NAME and MESSAGE_NAME here
          .setName("spaces/SPACE_NAME/messages/MESSAGE_NAME")
          .setText("Text updated with app credential!")
          .addCardsV2(CardWithId.newBuilder().setCard(Card.newBuilder()
            .setHeader(CardHeader.newBuilder()
              .setTitle("Card updated with app credential!")
              .setImageUrl("https://fonts.gstatic.com/s/i/short-term/release/googlesymbols/info/default/24px.svg")))))
        .setUpdateMask(FieldMask.newBuilder()
          // The field paths to update.
          .addAllPaths(List.of("text", "cards_v2")));
      Message response = chatServiceClient.updateMessage(request.build());

      System.out.println(JsonFormat.printer().print(response));
    }
  }
}

Apps Script

chat/advanced-service/Main.gs

前往 GitHub 查看

/**
 * This sample shows how to update a message with app credential
 * 
 * It relies on the OAuth2 scope 'https://www.googleapis.com/auth/chat.bot'
 * used by service accounts.
 */
function updateMessageAppCred() {
  // Initialize request argument(s)
  // TODO(developer): Replace SPACE_NAME and MESSAGE_NAME here
  const name = 'spaces/SPACE_NAME/messages/MESSAGE_NAME';
  const message = {
    text: 'Text updated with app credential!',
    cardsV2 : [{ card: { header: {
      title: 'Card updated with app credential!',
      imageUrl: 'https://fonts.gstatic.com/s/i/short-term/release/googlesymbols/info/default/24px.svg'
    }}}]
  };
  // The field paths to update. Separate multiple values with commas or use
  // `*` to update all field paths.
  const updateMask = 'text,cardsV2';

  // Make the request
  const response = Chat.Spaces.Messages.patch(message, name, {
    updateMask: updateMask
  }, getHeaderWithAppCredentials());

  // Handle the response
  console.log(response);
}

如要執行這個範例，請替換下列項目：

• SPACE_NAME：來自聊天室的 ID。name。您可以呼叫 ListSpaces() 方法，或從空間的網址取得 ID。
• MESSAGE_NAME：訊息 name 中的 ID。您可以透過使用 Chat API 非同步建立訊息後傳回的回應主體，或透過建立訊息時指派給訊息的自訂名稱，取得 ID。

Chat API 會傳回 Message 的執行個體，其中詳述更新的訊息。

相關主題

• 設定訊息格式。
• 刪除訊息。
• 取得訊息詳細資料。
• 列出聊天室中的訊息。
• 傳送訊息。