更新消息

本指南介绍了如何对 Google Chat API 的 Message 资源使用 update() 方法来更新聊天室中的文本消息或卡片消息。更新消息可更改消息属性，例如消息内容或卡片内容。您还可以将短信附加到卡片消息之前，或将卡片附加到短信之后。

在 Chat API 中，Chat 消息由 Message 资源表示。虽然 Chat 用户只能发送包含文字的消息，但 Chat 应用可以使用许多其他消息传递功能，包括显示静态或交互式界面、从用户处收集信息以及以私密方式传送消息。如需详细了解 Chat API 提供的消息功能，请参阅 Google Chat 消息概览。

前提条件

Node.js

• 有权访问 Google Chat 的 Google Workspace 商务版或企业版账号。

• 设置环境：
  • 创建 Google Cloud 项目。
  • 配置 OAuth 同意屏幕。
  • 为您的 Chat 应用启用和配置 Google Chat API，并为其指定一个名称、图标和说明。
  • 安装 Node.js Cloud 客户端库。
  • 根据您希望在 Google Chat API 请求中进行身份验证的方式创建访问凭据：
    • 如需以 Chat 用户身份进行身份验证，请创建 OAuth 客户端 ID 凭据，并将凭据以 JSON 文件 (client_secrets.json) 的形式保存到本地目录。
    • 如需以 Chat 应用的身份进行身份验证，请创建服务账号凭据，并将凭据保存为名为 credentials.json 的 JSON 文件。
• 根据您是要以用户身份还是以 Chat 应用的身份进行身份验证， 选择授权范围。

Python

• 拥有对 Google Chat 访问权限的商务版或企业版 Google Workspace 账号。

• 设置环境：
  • 创建 Google Cloud 项目。
  • 配置 OAuth 同意屏幕。
  • 为您的 Chat 应用启用和配置 Google Chat API，并为其指定一个名称、图标和说明。
  • 安装 Python Cloud 客户端库。
  • 根据您希望在 Google Chat API 请求中进行身份验证的方式创建访问凭据：
    • 如需以 Chat 用户身份进行身份验证，请创建 OAuth 客户端 ID 凭据，并将凭据保存为名为 client_secrets.json 的 JSON 文件，保存到本地目录中。
    • 如需以 Chat 应用的身份进行身份验证，请创建服务账号凭据并将凭据保存为名为 credentials.json 的 JSON 文件。
• 根据您是要以用户身份还是以 Chat 应用的身份进行身份验证， 选择授权范围。

Java

• 拥有对 Google Chat 访问权限的商务版或企业版 Google Workspace 账号。

• 设置您的环境：
  • 创建 Google Cloud 项目。
  • 配置 OAuth 同意屏幕。
  • 启用和配置 Google Chat API，为 Chat 应用提供名称、图标和说明。
  • 安装 Java Cloud 客户端库。
  • 根据您要在 Google Chat API 请求中采用的身份验证方式创建访问凭据：
    • 如需以 Chat 用户身份进行身份验证，请创建 OAuth 客户端 ID 凭据，并将凭据保存为名为 client_secrets.json 的 JSON 文件，保存到本地目录中。
    • 如需以 Chat 应用的身份进行身份验证，请创建服务账号凭据并将凭据保存为名为 credentials.json 的 JSON 文件。
• 根据您是要以用户身份还是以 Chat 应用的身份进行身份验证， 选择授权范围。

Apps 脚本

• 拥有对 Google Chat 访问权限的商务版或企业版 Google Workspace 账号。

• 设置环境：
  • 创建 Google Cloud 项目。
  • 配置 OAuth 同意屏幕。
  • 为您的 Chat 应用启用和配置 Google Chat API，并为其指定一个名称、图标和说明。
  • 创建一个独立的 Apps 脚本项目，然后开启高级聊天服务。
  • 在本指南中，您必须使用用户身份验证或应用身份验证。如需以 Chat 应用的身份进行身份验证，请创建服务账号凭据。如需了解具体步骤，请参阅以 Google Chat 应用身份进行身份验证和授权。
• 根据您是要以用户身份还是以 Chat 应用的身份进行身份验证， 选择授权范围。

本页中的代码示例使用 gRPC API 与 Google Cloud 客户端库交互。或者，您也可以使用 REST API 接口。如需详细了解 gRPC 和 REST 接口，请参阅 Google Chat API 概览。

代表用户更新消息

使用用户身份验证时，只能更新消息的文本。

如需使用用户身份验证更新消息，请在请求中传递以下内容：

• 指定 chat.messages 授权范围。
• 调用 UpdateMessage() 方法。
• 将 message 作为 Message 的实例传递，并加入以下代码：
  • 设置为要更新的消息的 name 字段，其中包含聊天室 ID 和消息 ID。
  • 使用新文本设置的 text 字段。
• 传递值为 text 的 updateMask。

如果更新的消息是卡片消息，则文本会附加到卡片（这些卡片会继续显示）之前。

下面介绍了如何更新消息，或在卡片消息前面添加短信（需要用户身份验证）：

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 脚本

聊天/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：聊天室的 name 中的 ID。您可以通过调用 ListSpaces() 方法或从聊天室的网址中获取 ID。
• MESSAGE_NAME：消息的 name 中的 ID。您可以从使用 Chat API 异步创建消息后返回的响应正文中获取 ID，也可以使用在创建消息时分配给消息的自定义名称来获取该 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 脚本

聊天/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：聊天室的 name 中的 ID。您可以通过调用 ListSpaces() 方法或从聊天室的网址中获取 ID。
• MESSAGE_NAME：消息的 name 中的 ID。您可以通过以下方式获取 ID：使用 Chat API 异步创建消息后从返回的响应正文中获取，或者使用在创建消息时分配给消息的自定义名称获取。

Chat API 会返回一个 Message 实例，其中详细说明了更新的消息。

相关主题

• 设置邮件格式。
• 删除消息。
• 获取有关消息的详细信息。
• 在聊天室中列出消息。
• 发送消息。