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
texte
ou
carte
message dans Google Chat. Vous pouvez
create
, get
, update
ou delete
un message dans l'API Google Chat en appelant
méthodes correspondantes. Pour en savoir plus sur les messages texte et les cartes, consultez
Présentation des messages Google Chat
Avec l'authentification des applications, vous pouvez utiliser cette méthode pour supprimer un message Application Chat envoyée. Avec authentification utilisateur, vous vous pouvez utiliser cette méthode pour supprimer un message envoyé par l'utilisateur authentifié. Si l'utilisateur est gestionnaire de l'espace, vous pouvez également supprimer un envoyé par les autres membres de l'espace. Pour en savoir plus, consultez la section En savoir plus votre rôle de gestionnaire de l'espace.
Prérequis
Python
- Une entreprise Un compte Google Workspace ayant accès à Google Chat :
- Python 3.6 ou version ultérieure
- L'outil de gestion de packages pip
- Les dernières bibliothèques clientes Google 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
- Configurez votre environnement:
- Créez un projet Google Cloud.
- Configurer l'écran de consentement OAuth
- activer et configurer l'API Google Chat à l'aide d'un nom ; et la description de votre application Chat.
-
Créez des identifiants client OAuth pour une application de bureau. Pour exécuter l'exemple
, enregistrez les identifiants dans un fichier JSON (
client_secrets.json
) dans votre dans votre répertoire local.
- Choisissez un niveau d'autorisation compatible avec l'authentification des utilisateurs.
Supprimer un message avec authentification de l'utilisateur
Pour supprimer un message avec l'authentification de l'utilisateur, procédez comme suit : transmettez les éléments suivants dans votre requête:
- Spécifiez le champ d'application de l'autorisation
chat.messages
. - Appelez la méthode
Méthode
delete
le RessourceMessage
. - Définissez
name
sur le nom de ressource du message à supprimer.
L'exemple suivant supprime un message contenant 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'espace, que vous pouvez obtenir à partir de la Méthodespaces.list
dans l'API Chat ou depuis l'URL d'un espace.MESSAGE
: nom du message, que vous pouvez obtenir à partir du corps de la réponse renvoyé après la création d'un message de manière asynchrone. à l'aide de l'API Chat ou 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és.
Supprimer un message avec l'authentification par application
Pour supprimer un message avec authentification de l'application, transmettez la dans votre demande:
- Spécifiez le champ d'application de l'autorisation
chat.bot
. - Appelez la méthode
Méthode
delete
sur la ressourceMessage
. - Définissez
name
sur le nom de ressource du message à supprimer.
L'exemple suivant supprime un message contenant 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 où s'affiche. Vous pouvez l'obtenir à partir du Méthodespaces.list
dans l'API Chat ou depuis l'URL d'un espace.MESSAGE
: nom du message, que vous pouvez obtenir à partir du corps de la réponse renvoyé après la création d'un message de manière asynchrone. à l'aide de l'API Chat ou 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és.
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.