刪除留言

本指南說明如何使用 Google Chat API 的 Message 資源中的 delete() 方法，刪除文字或資訊卡訊息。

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

透過應用程式驗證，您可以使用這個方法刪除 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 授權範圍。
• 呼叫 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 Script

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

如果成功，回應主體會留白，表示訊息已刪除。

刪除已透過應用程式驗證的訊息

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

• 指定 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 Script

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

如果成功，回應主體會留白，表示訊息已刪除。

相關主題

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