Excluir uma mensagem

Este guia explica como usar o método delete() no recurso Message da API Google Chat para excluir uma mensagem de texto ou card.

Na API Chat, uma mensagem é representada pelo recurso Message. Enquanto os usuários do Chat só podem enviar mensagens de texto, os apps do Chat podem usar muitos outros recursos de mensagens, incluindo a exibição de interfaces de usuário estáticas ou interativas, a coleta de informações dos usuários e o envio de mensagens particulares. Para saber mais sobre os recursos de mensagens disponíveis para a API Chat, consulte a Visão geral das mensagens do Google Chat.

Com a autenticação de apps, você pode usar esse método para excluir uma mensagem enviada pelo app do Chat. Com a autenticação do usuário, é possível usar esse método para excluir uma mensagem enviada pelo usuário autenticado. Se o usuário for administrador do espaço, você também poderá excluir uma mensagem enviada por outros participantes. Para mais informações, consulte Saiba mais sobre sua função como administrador do espaço.

Pré-requisitos

Node.js

Python

Java

Apps Script

Excluir uma mensagem com autenticação do usuário

Para excluir uma mensagem com autenticação do usuário, transmita o seguinte na sua solicitação:

  • Especifique o escopo de autorização chat.messages.
  • Chame o método DeleteMessage().
  • Defina name como o nome do recurso da mensagem a ser excluída.

O exemplo a seguir exclui uma mensagem com autenticação do usuário:

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

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

Para executar este exemplo, substitua o seguinte:

  • SPACE_NAME: o ID do name do espaço. Para conseguir o ID, chame o método ListSpaces() ou o URL do espaço.
  • MESSAGE_NAME: o ID do name da mensagem. É possível receber o ID do corpo da resposta retornado após a criação de uma mensagem de forma assíncrona com a API Chat ou com o nome personalizado atribuído à mensagem na criação.

Se a solicitação for bem-sucedida, o corpo da resposta vai estar vazio, o que indica que a mensagem foi excluída.

Excluir uma mensagem com autenticação de app

Para excluir uma mensagem com autenticação de app, transmita o seguinte na sua solicitação:

  • Especifique o escopo de autorização chat.bot.
  • Chame o método DeleteMessage().
  • Defina name como o nome do recurso da mensagem a ser excluída.

O exemplo a seguir exclui uma mensagem com autenticação de apps:

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

main().catch(console.error);

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

Para executar este exemplo, substitua o seguinte:

  • SPACE_NAME: o ID do name do espaço. Você pode conseguir o ID chamando o método ListSpaces() ou pelo URL do espaço.
  • MESSAGE_NAME: o ID do name da mensagem. É possível receber o ID do corpo da resposta retornado após a criação de uma mensagem de forma assíncrona com a API Chat ou com o nome personalizado atribuído à mensagem na criação.

Se a solicitação for bem-sucedida, o corpo da resposta vai estar vazio, o que indica que a mensagem foi excluída.