Excluir uma mensagem

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

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

Pré-requisitos

Python

  • Python 3.6 ou superior
  • O pip ferramenta de gerenciamento de pacotes
  • As bibliotecas de cliente mais recentes do Google para Python. Para instalar ou atualizar esses recursos, execute o seguinte comando 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. Para conferir as etapas, consulte Criar um app do Google Chat.
  • Autorização configurada para o app do Chat. Excluindo... uma mensagem suporta os dois métodos de autenticação a seguir:

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

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

  • Especifique o escopo de autorização chat.messages.
  • Chame o método Método delete no(a) 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. Em seu 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 response to the Chat API call.
        # When deleting a message, the response body is empty.
        print(result)
    
    if __name__ == '__main__':
        main()
    
  3. No código, substitua o seguinte:

    • SPACE: um nome de espaço, que você pode conferir em as Método spaces.list na API Chat ou pelo URL de um espaço.
    • MESSAGE: um nome de mensagem, que você pode acessar do corpo da resposta retornado após a criação de uma mensagem de forma assíncrona com a API Chat ou com a nome personalizado atribuído à mensagem na criação.
  4. No diretório de trabalho, crie e execute o exemplo:

    python3 chat_message_delete_user.py
    

Se bem-sucedido, o corpo da resposta ficará vazio, o que indica que a mensagem foi excluída.

Excluir uma mensagem com a autenticação de apps

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

  • Especifique o escopo de autorização chat.bot.
  • Chame o método 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 apps:

Python

  1. Em seu 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: a name do espaço em que o a mensagem é postada, e você pode acessá-la Método spaces.list na API Chat ou pelo URL de um espaço.
    • MESSAGE: o nome da mensagem, que você pode conferir do corpo da resposta retornado após a criação de uma mensagem de forma assíncrona com a API Chat ou com a nome personalizado atribuído à mensagem na criação.
  4. No diretório de trabalho, crie e execute o exemplo:

    python3 chat_delete_message_app.py
    

Se bem-sucedido, o corpo da resposta ficará vazio, o que indica que a mensagem foi excluída.