删除邮件

本指南介绍了如何使用 Google Chat API 的 Message 资源中的 delete() 方法来删除文本或卡片消息。

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

借助应用身份验证，您可以使用此方法删除 Chat 应用发送的消息。启用用户身份验证后，您可以使用此方法删除经过身份验证的用户发送的消息。如果该用户是聊天室的管理员，您或许还可以删除其他聊天室成员发送的消息。如需了解详情，请参阅了解您作为聊天室管理员的角色。

前提条件

Node.js

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

• 设置您的环境：
  • 创建 Google Cloud 项目。
  • 配置 OAuth 同意屏幕。
  • 启用和配置 Google Chat API，为 Chat 应用提供名称、图标和说明。
  • 安装 Node.js Cloud 客户端库。
  • 根据您要在 Google Chat API 请求中采用的身份验证方式创建访问凭据：
    • 如需以 Chat 用户身份进行身份验证，请创建 OAuth 客户端 ID 凭据，并将凭据保存为名为 client_secrets.json 的 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 同意屏幕。
  • 启用和配置 Google Chat API，为 Chat 应用提供名称、图标和说明。
  • 创建一个独立的 Apps 脚本项目，然后开启高级聊天服务。
  • 在本指南中，您必须使用用户身份验证或应用身份验证。如需以 Chat 应用的身份进行身份验证，请创建服务账号凭据。如需了解具体步骤，请参阅以 Google Chat 应用身份进行身份验证和授权。
• 根据您是要以用户身份还是以 Chat 应用的身份进行身份验证， 选择授权范围。

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

通过用户身份验证删除邮件

如需通过用户身份验证删除消息，请在请求中传递以下内容：

• 指定 chat.messages 授权范围。
• 调用 DeleteMessage() 方法。
• 将 name 设置为要删除的消息的资源名称。

以下示例会删除经过用户身份验证的消息：

Node.js

chat/client-libraries/cloud/delete-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 delete 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 = {
    // Replace SPACE_NAME and MESSAGE_NAME here
    name: 'spaces/SPACE_NAME/messages/MESSAGE_NAME'
  };

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

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

main().catch(console.error);

Python

chat/client-libraries/cloud/delete_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 delete a message with user credential
def delete_message_with_user_cred():
    # Create a client
    client = create_client_with_user_credentials(SCOPES)

    # Initialize request argument(s)
    request = google_chat.DeleteMessageRequest(
        # Replace SPACE_NAME and MESSAGE_NAME here
        name = "spaces/SPACE_NAME/messages/MESSAGE_NAME",
    )

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

    # Handle the response
    print(response)

delete_message_with_user_cred()

Java

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

在 GitHub 上查看

import com.google.chat.v1.ChatServiceClient;
import com.google.chat.v1.DeleteMessageRequest;
import com.google.chat.v1.SpaceName;

// This sample shows how to delete message with user credential.
public class DeleteMessageUserCred {

  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))) {
      DeleteMessageRequest.Builder request = DeleteMessageRequest.newBuilder()
        // replace SPACE_NAME and MESSAGE_NAME here
        .setName("spaces/SPACE_NAME/messages/MESSAGE_NAME");
      chatServiceClient.deleteMessage(request.build());
    }
  }
}

Apps 脚本

chat/advanced-service/Main.gs

在 GitHub 上查看

/**
 * This sample shows how to delete 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 deleteMessageUserCred() {
  // Initialize request argument(s)
  // TODO(developer): Replace SPACE_NAME and MESSAGE_NAME here
  const name = 'spaces/SPACE_NAME/messages/MESSAGE_NAME';

  // Make the request
  const response = Chat.Spaces.Messages.remove(name);

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

如需运行此示例，请替换以下内容：

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

如果成功，则响应正文为空，表示消息已被删除。

通过应用身份验证删除消息

如需使用应用身份验证删除消息，请在请求中传递以下内容：

• 指定 chat.bot 授权范围。
• 调用 DeleteMessage() 方法。
• 将 name 设置为要删除的消息的资源名称。

以下示例演示了如何删除通过应用身份验证的消息：

Node.js

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

在 GitHub 上查看

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

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

  // Initialize request argument(s)
  const request = {
    // Replace SPACE_NAME and MESSAGE_NAME here
    name: 'spaces/SPACE_NAME/messages/MESSAGE_NAME'
  };

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

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

main().catch(console.error);

Python

chat/client-libraries/cloud/delete_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 delete a message with app credential
def delete_message_with_app_cred():
    # Create a client
    client = create_client_with_app_credentials()

    # Initialize request argument(s)
    request = google_chat.DeleteMessageRequest(
        # Replace SPACE_NAME and MESSAGE_NAME here
        name = "spaces/SPACE_NAME/messages/MESSAGE_NAME",
    )

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

    # Handle the response
    print(response)

delete_message_with_app_cred()

Java

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

在 GitHub 上查看

import com.google.chat.v1.ChatServiceClient;
import com.google.chat.v1.DeleteMessageRequest;

// This sample shows how to delete message with app credential.
public class DeleteMessageAppCred {

  public static void main(String[] args) throws Exception {
    try (ChatServiceClient chatServiceClient =
        AuthenticationUtils.createClientWithAppCredentials()) {
      DeleteMessageRequest.Builder request = DeleteMessageRequest.newBuilder()
        // replace SPACE_NAME and MESSAGE_NAME here
        .setName("spaces/SPACE_NAME/messages/MESSAGE_NAME");
      chatServiceClient.deleteMessage(request.build());
    }
  }
}

Apps 脚本

chat/advanced-service/Main.gs

在 GitHub 上查看

/**
 * This sample shows how to delete a message with app credential
 * 
 * It relies on the OAuth2 scope 'https://www.googleapis.com/auth/chat.bot'
 * used by service accounts.
 */
function deleteMessageAppCred() {
  // Initialize request argument(s)
  // TODO(developer): Replace SPACE_NAME and MESSAGE_NAME here
  const name = 'spaces/SPACE_NAME/messages/MESSAGE_NAME';
  const parameters = {};

  // Make the request
  const response = Chat.Spaces.Messages.remove(name, parameters, getHeaderWithAppCredentials());

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

如需运行此示例，请替换以下内容：

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

如果成功，则响应正文为空，表示消息已删除。

相关主题

• 设置邮件格式。
• 获取消息的详细信息。
• 列出聊天室中的消息。
• 更新消息。
• 发送消息。