Ce guide explique comment utiliser la méthode delete
sur la ressource Message
de l'API Google Chat pour supprimer un message texte ou une carte.
La ressource Message
représente un message texte ou carte dans Google Chat. Vous pouvez create
, get
, update
ou delete
un message dans l'API Google Chat en appelant les méthodes correspondantes. Pour en savoir plus sur les SMS et les cartes, consultez la présentation des messages Google Chat.
Conditions préalables
Python
- Python 3.6 ou version ultérieure
- L'outil de gestion de packages pip
Les dernières bibliothèques clientes Google pour Python. Pour les installer ou les mettre à jour, exécutez la commande suivante dans votre interface de ligne de commande:
pip3 install --upgrade google-api-python-client google-auth-oauthlib google-auth
- Un projet Google Cloud dans lequel l'API Google Chat est activée et configurée Pour connaître la procédure à suivre, consultez Créer une application Google Chat.
Autorisation configurée pour l'application Chat. La suppression d'un message est compatible avec les deux méthodes d'authentification suivantes:
- L'authentification des utilisateurs, avec le niveau d'autorisation
chat.messages
, peut supprimer les messages créés par cet utilisateur. Si vous êtes gestionnaire de l'espace, vous pouvez peut-être supprimer d'autres messages. Pour en savoir plus, consultez En savoir plus sur votre rôle de gestionnaire de l'espace. - L'authentification des applications, dotée du niveau d'autorisation
chat.bot
, peut supprimer les messages créés par cette application à l'aide de son compte de service.
- L'authentification des utilisateurs, avec le niveau d'autorisation
Supprimer un message avec authentification de l'utilisateur
Pour supprimer un message avec authentification de l'utilisateur, transmettez les éléments suivants dans votre requête:
- Spécifiez le champ d'application de l'autorisation
chat.messages
. - Appelez la méthode
delete
sur la ressourceMessage
. - Définissez
name
sur le nom de ressource du message à supprimer.
L'exemple suivant supprime un message avec authentification de l'utilisateur:
Python
- Dans votre répertoire de travail, créez un fichier nommé
chat_message_delete_user.py
. Ajoutez le code suivant dans
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()
Dans le code, remplacez les éléments suivants:
SPACE
: nom d'un espace, que vous pouvez obtenir à partir de la méthodespaces.list
dans l'API Chat ou à partir de son URL.MESSAGE
: nom du message que vous pouvez obtenir à partir du corps de la réponse renvoyé après avoir créé un message de manière asynchrone avec l'API Chat, ou avec le nom personnalisé attribué au message lors de sa création.
Dans votre répertoire de travail, créez et exécutez l'exemple:
python3 chat_message_delete_user.py
Si la requête aboutit, le corps de la réponse est vide, ce qui indique que le message est supprimé.
Supprimer un message avec l'authentification par application
Pour supprimer un message avec l'authentification des applications, transmettez les éléments suivants dans votre requête:
- Spécifiez le champ d'application de l'autorisation
chat.bot
. - Appelez la méthode
delete
sur la ressourceMessage
. - Définissez
name
sur le nom de ressource du message à supprimer.
L'exemple suivant supprime un message avec authentification de l'application:
Python
- Dans votre répertoire de travail, créez un fichier nommé
chat_delete_message_app.py
. Ajoutez le code suivant dans
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)
Dans le code, remplacez les éléments suivants:
SPACE
:name
de l'espace dans lequel le message est publié, que vous pouvez obtenir à partir de la méthodespaces.list
de l'API Chat ou à partir de l'URL d'un espace.MESSAGE
: nom du message, que vous pouvez obtenir à partir du corps de la réponse renvoyé après avoir créé un message de manière asynchrone avec l'API Chat, ou avec le nom personnalisé attribué au message lors de sa création.
Dans votre répertoire de travail, créez et exécutez l'exemple:
python3 chat_delete_message_app.py
Si la requête aboutit, le corps de la réponse est vide, ce qui indique que le message est supprimé.
Articles associés
- Mettez en forme un message.
- En savoir plus sur un message
- Lister les messages d'un espace
- Modifier un message
- Envoyer un message.