Ce guide explique comment utiliser la méthode list
sur la ressource Message
de
l'API Google Chat pour afficher une liste paginée et filtrable des messages d'un espace.
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
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.
Répertorier des messages
Pour répertorier les messages avec authentification des utilisateurs, transmettez les éléments suivants dans votre requête:
- Spécifiez le champ d'application de l'autorisation
chat.messages.readonly
ouchat.messages
. - Appelez la méthode
Méthode
list
le RessourceMessage
.
L'exemple suivant répertorie les messages d'un espace Chat envoyés après le 16 mars 2023:
Python
- Dans votre répertoire de travail, créez un fichier nommé
chat_messages_list.py
. Ajoutez le code suivant dans
chat_messages_list.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.readonly"] def main(): ''' Authenticates with Chat API via user credentials, then lists messages in a space sent after March 16, 2023. ''' # 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().list( # The space for which to list messages. parent = 'spaces/SPACE', # An optional filter that returns messages # created after March 16, 2023. filter = 'createTime > "2023-03-16T00:00:00-00:00"' ).execute() # Prints the list of messages. print(result) if __name__ == '__main__': main()
Dans le code, remplacez
SPACE
par un nom d'espace, ce qui que vous pouvez obtenir Méthodespaces.list
dans l'API Chat ou depuis l'URL d'un espace.Dans votre répertoire de travail, créez et exécutez l'exemple:
python3 chat_messages_list.py
L'API Chat renvoie la liste des messages envoyés dans l'espace spécifié
après le 16 mars 2023. Si la requête ne contient aucun message,
La réponse de l'API Chat renvoie un objet vide. Lorsque vous utilisez un
Interface REST/HTTP, la réponse contient un objet JSON vide, {}
.
Articles associés
- Mettez en forme un message.
- Supprimer un message
- En savoir plus sur un message
- Modifier un message
- Envoyer un message.