Удалить сообщение

В этом руководстве объясняется, как использовать метод delete() ресурса Message API Google Chat для удаления текстового сообщения или карточки.

В API чата сообщение чата представлено ресурсом Message . Хотя пользователи чата могут отправлять только текстовые сообщения, приложения чата могут использовать множество других функций обмена сообщениями, включая отображение статических или интерактивных пользовательских интерфейсов, сбор информации от пользователей и доставку сообщений в частном порядке. Подробнее о функциях обмена сообщениями, доступных в API чата, см. в обзоре сообщений Google Chat .

При аутентификации приложения этот метод можно использовать для удаления сообщения, отправленного приложением Chat. При аутентификации пользователя этот метод можно использовать для удаления сообщения, отправленного аутентифицированным пользователем. Если пользователь является менеджером пространства, вы также можете удалить сообщение, отправленное другими участниками пространства. Подробнее см. в статье «Узнайте больше о вашей роли менеджера пространства» .

Предпосылки

Node.js

Питон

Ява

Скрипт приложений

Удалить сообщение с аутентификацией пользователя

Чтобы удалить сообщение с аутентификацией пользователя , передайте в запросе следующее:

  • Укажите область авторизации 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); }  main().catch(console.error);

Питон

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()

Ява

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());     }   } }

Скрипт приложений

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 сообщения. Вы можете получить идентификатор из корпуса ответа, возвращаемого после создания сообщения, асинхронно с помощью API чата или с помощью пользовательского имени, назначенного сообщению при создании.

В случае успеха тело ответа пустое, что означает, что сообщение удалено.

Удалить сообщение с аутентификацией приложения

Чтобы удалить сообщение с аутентификацией приложения , передайте в запросе следующее:

  • Укажите область авторизации chat.bot .
  • Вызовите метод DeleteMessage() .
  • Задайте name ресурса сообщения, которое нужно удалить.

Следующий пример удаляет сообщение с аутентификацией приложения :

Node.js

чат/клиентские-библиотеки/облако/удалить-сообщение-приложение-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); }  main().catch(console.error);

Питон

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()

Ява

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());     }   } }

Скрипт приложений

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 сообщения. Вы можете получить идентификатор из корпуса ответа, возвращаемого после создания сообщения, асинхронно с помощью API чата или с помощью пользовательского имени, назначенного сообщению при создании.

В случае успеха тело ответа пустое, что означает, что сообщение удалено.