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.
O
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.
Com a autenticação de apps, você pode usar esse método para excluir uma mensagem que o App do Chat enviado. Com autenticação do usuário, pode usar esse método para excluir uma mensagem que o usuário autenticado enviou. Se o usuário for admin do espaço, você também poderá excluir que outros participantes do espaço enviaram. Para mais informações, consulte Saiba mais sobre sua função de administrador do espaço.
Pré-requisitos
Python
- Uma empresa Conta do Google Workspace com acesso a Google Chat.
- Python 3.6 ou superior
- a ferramenta de gerenciamento de pacotes PIP;
- As bibliotecas de cliente mais recentes do Google. 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
- Configure o ambiente:
- Crie um projeto do Google Cloud.
- Configure a tela de permissão OAuth.
- Ative e configure a API Google Chat com um nome. o ícone e a descrição do app do Chat.
-
Criar credenciais de ID do cliente OAuth para um aplicativo para computador. Para executar o exemplo
salve as credenciais como um arquivo JSON (
client_secrets.json
) no seu no diretório local.
- Escolha um escopo de autorização que ofereça suporte à autenticação de usuários.
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) RecursoMessage
. - 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
- Em seu diretório de trabalho, crie um arquivo chamado
chat_message_delete_user.py
: 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()
No código, substitua o seguinte:
SPACE
: um nome de espaço, que você pode conferir em as Métodospaces.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.
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 recursoMessage
. - 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
- Em seu diretório de trabalho, crie um arquivo chamado
chat_delete_message_app.py
: 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)
No código, substitua o seguinte:
SPACE
: aname
do espaço em que o a mensagem é postada, e você pode acessá-la Métodospaces.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.
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.
Temas relacionados
- Formatar uma mensagem.
- Ver detalhes de uma mensagem.
- Listar mensagens em um espaço
- Atualizar uma mensagem.
- Enviar uma mensagem.