ลบข้อความ

คู่มือนี้อธิบายวิธีใช้ delete() เมธอดในแหล่งข้อมูล Message ของ Google Chat API เพื่อลบข้อความที่เป็นข้อความธรรมดาหรือข้อความการ์ด

ใน Chat API ข้อความ Chat จะแสดงด้วย Message แหล่งข้อมูล แม้ว่าผู้ใช้ Chat จะส่งได้เฉพาะข้อความที่มีข้อความธรรมดา แต่แอป Chat สามารถใช้ฟีเจอร์การรับส่งข้อความอื่นๆ ได้มากมาย รวมถึงการแสดงอินเทอร์เฟซผู้ใช้แบบคงที่หรือแบบโต้ตอบ การรวบรวมข้อมูลจากผู้ใช้ และการส่งข้อความแบบส่วนตัว ดูข้อมูลเพิ่มเติมเกี่ยวกับฟีเจอร์การรับส่งข้อความ ที่พร้อมใช้งานสำหรับ Chat API ได้ที่ ภาพรวมของข้อความ Google Chat

เมื่อใช้การตรวจสอบสิทธิ์แอป คุณจะใช้เมธอดนี้เพื่อลบข้อความที่ แอป Chat ส่งได้ เมื่อใช้ การตรวจสอบสิทธิ์ผู้ใช้ คุณ จะใช้เมธอดนี้เพื่อลบข้อความที่ผู้ใช้ที่ตรวจสอบสิทธิ์แล้วส่งได้ หากผู้ใช้เป็นผู้จัดการพื้นที่ทำงานของพื้นที่ทำงาน คุณอาจลบข้อความที่สมาชิกคนอื่นๆ ในพื้นที่ทำงานส่งได้ด้วย ดูข้อมูลเพิ่มเติมได้ที่หัวข้อดูข้อมูลเกี่ยวกับ บทบาทในฐานะผู้จัดการพื้นที่ทำงาน

ข้อกำหนดเบื้องต้น

Node.js

Python

Java

Apps Script

ลบข้อความด้วยการตรวจสอบสิทธิ์ผู้ใช้

หากต้องการลบข้อความด้วย การตรวจสอบสิทธิ์ผู้ใช้, ให้ส่งข้อมูลต่อไปนี้ในคำขอ

  • ระบุขอบเขตการให้สิทธิ์ chat.messages
  • เรียกใช้เมธอด DeleteMessage()
  • ตั้งค่า name เป็นชื่อทรัพยากรของข้อความที่จะลบ

ตัวอย่างต่อไปนี้แสดงการลบข้อความด้วย การตรวจสอบสิทธิ์ผู้ใช้

Node.js

chat/client-libraries/cloud/delete-message-user-cred.js
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);
}

await main();

Python

chat/client-libraries/cloud/delete_message_user_cred.py
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
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
/**
 * 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 ของพื้นที่ทำงาน คุณสามารถรับรหัสได้โดยเรียกใช้เมธอด ListSpaces() หรือจาก URL ของพื้นที่ทำงาน
  • MESSAGE_NAME: รหัสจาก name ของข้อความ คุณสามารถรับรหัสได้จากเนื้อหาการตอบกลับที่ส่งคืนหลังจากสร้างข้อความแบบไม่พร้อมกันด้วย Chat API หรือจาก ชื่อที่กำหนดเอง ซึ่งกำหนดให้กับข้อความเมื่อสร้าง

หากทำสำเร็จ เนื้อหาการตอบกลับจะเป็นค่าว่าง ซึ่งบ่งบอกว่าข้อความถูกลบแล้ว

ลบข้อความด้วยการตรวจสอบสิทธิ์แอป

หากต้องการลบข้อความด้วย การตรวจสอบสิทธิ์แอป ให้ส่งข้อมูล ต่อไปนี้ในคำขอ

  • ระบุขอบเขตการให้สิทธิ์ chat.bot
  • เรียกใช้เมธอด DeleteMessage()
  • ตั้งค่า name เป็นชื่อทรัพยากรของข้อความที่จะลบ

ตัวอย่างต่อไปนี้แสดงการลบข้อความด้วย การตรวจสอบสิทธิ์แอป

Node.js

chat/client-libraries/cloud/delete-message-app-cred.js
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);
}

await main();

Python

chat/client-libraries/cloud/delete_message_app_cred.py
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
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
/**
 * 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 ของพื้นที่ทำงาน คุณสามารถรับรหัสได้โดยเรียกใช้เมธอด ListSpaces() หรือจาก URL ของพื้นที่ทำงาน
  • MESSAGE_NAME: รหัสจาก name ของข้อความ คุณสามารถรับรหัสได้จากเนื้อหาการตอบกลับที่ส่งคืนหลังจากสร้างข้อความแบบไม่พร้อมกันด้วย Chat API หรือจาก ชื่อที่กำหนดเอง ซึ่งกำหนดให้กับข้อความเมื่อสร้าง

หากทำสำเร็จ เนื้อหาการตอบกลับจะเป็นค่าว่าง ซึ่งบ่งบอกว่าข้อความถูกลบแล้ว