Excluir uma mensagem

Neste guia, explicamos como usar o método delete no recurso Message da API Google Chat para excluir uma mensagem de texto ou card.

O recurso Message representa uma mensagem de texto ou card no Google Chat. Você pode usar create, get, update ou delete em uma mensagem na API Google Chat chamando métodos correspondentes. Para saber mais sobre mensagens de texto e cards, consulte Visão geral das mensagens do Google Chat.

Pré-requisitos

Python

  • Python 3.6 ou superior
  • A ferramenta de gerenciamento de pacotes pip

  • As bibliotecas de cliente mais recentes do Google para Python. Para instalar ou atualizar, execute o seguinte na interface de linha de comando:

    pip3 install --upgrade google-api-python-client google-auth-oauthlib google-auth
  • Um projeto do Google Cloud com a API Google Chat ativada e configurada. Veja as etapas em Criar um app do Google Chat.

  • Autorização configurada para o app do Chat. A exclusão de uma mensagem aceita os dois métodos de autenticação a seguir:

Excluir uma mensagem com autenticação de 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 delete no recurso Message.
  • 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:

Python

  1. No diretório de trabalho, crie um arquivo chamado chat_message_delete_user.py.

  2. Inclua o seguinte código em chat_message_delete_user.py:

    from google_auth_oauthlib.flow import InstalledAppFlow
from googleapiclient.discovery import build

# Define your app's authorization scopes.
# When modifying these scopes, delete the file token.json, if it exists.
SCOPES = ["https://www.googleapis.com/auth/chat.messages"]

def main():
    '''
    Authenticates with Chat API via user credentials,
    then deletes a message.
    '''

    # Authenticate with Google Workspace
    # and get user authorization.
    flow = InstalledAppFlow.from_client_secrets_file(
                      'client_secrets.json', SCOPES)
    creds = flow.run_local_server()

    # Build a service endpoint for Chat API.
    chat = build('chat', 'v1', credentials=creds)

    # Use the service endpoint to call Chat API.
    result = chat.spaces().messages().delete(

        # The message to delete.
        #
        # Replace SPACE with a space name.
        # Obtain the space name from the spaces resource of Chat API,
        # or from a space's URL.
        #
        # Replace MESSAGE with a message name.
        # Obtain the message name from the response body returned
        # after creating a message asynchronously with Chat REST API.
        name = 'spaces/SPACE/messages/MESSAGE'

    ).execute()

    # Prints details about the created membership.
    print(result)

if __name__ == '__main__':
    main()

  3. No código, substitua o seguinte:

    • SPACE: um nome de espaço, que pode ser obtido no método spaces.list na API Chat ou no URL de um espaço.
    • MESSAGE: um nome de mensagem, que pode ser obtido no corpo da resposta retornado depois de criar uma mensagem de maneira assíncrona com a API Chat ou com o nome personalizado atribuído à mensagem no momento da criação.

  4. No diretório de trabalho, crie e execute a amostra:

    python3 chat_message_delete_user.py

Se a solicitação for bem-sucedida, o corpo da resposta ficará 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 delete no recurso Message.
  • Defina name como o nome do recurso da mensagem a ser excluída.

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

Python

  1. No diretório de trabalho, crie um arquivo chamado chat_delete_message_app.py.

  2. Inclua o seguinte código em chat_delete_message_app.py:

    from google.oauth2 import service_account
from apiclient.discovery import build

# Specify required scopes.
SCOPES = ['https://www.googleapis.com/auth/chat.bot']

# Specify service account details.
CREDENTIALS = (
    service_account.Credentials.from_service_account_file('credentials.json')
    .with_scopes(SCOPES)
)

# Build the URI and authenticate with the service account.
chat = build('chat', 'v1', credentials=CREDENTIALS)

# Delete a Chat message.
result = chat.spaces().messages().delete(

  # The message to delete.
  #
  # Replace SPACE with a space name.
  # Obtain the space name from the spaces resource of Chat API,
  # or from a space's URL.
  #
  # Replace MESSAGE with a message name.
  # Obtain the message name from the response body returned
  # after creating a message asynchronously with Chat REST API.
  name='spaces/SPACE/messages/MESSAGE'

).execute()

# Print Chat API's response in your command line interface.
# When deleting a message, the response body is empty.
print(result)

  3. No código, substitua o seguinte:

    • SPACE: o name do espaço em que a mensagem é postada, que pode ser acessado no método spaces.list na API Chat ou no URL de um espaço.
    • MESSAGE: o nome da mensagem, que pode ser obtido no corpo da resposta retornado depois de criar uma mensagem de forma assíncrona com a API Chat ou com o nome personalizado atribuído à mensagem no momento da criação.

  4. No diretório de trabalho, crie e execute a amostra:

    python3 chat_delete_message_app.py

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