Répertorier des messages

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 de messages dans un espace.

La ressource Message représente un message texte ou fiche 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 messages texte et les messages sous forme de fiches, consultez Présentation des messages Google Chat.

Prérequis

Python

  • Python 3.6 ou version ultérieure
  • L'outil de gestion des 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
  • Un projet Google Cloud avec l'API Google Chat 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 liste des messages nécessite une authentification de l'utilisateur avec le champ d'application d'autorisation chat.messages.readonly ou chat.messages.

Répertorier des messages

Pour répertorier les messages avec authentification utilisateur, transmettez les éléments suivants dans votre requête:

L'exemple suivant répertorie les messages d'un espace Chat envoyés après le 16 mars 2023:

Python

  1. Dans votre répertoire de travail, créez un fichier nommé chat_messages_list.py.

  2. Incluez 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 details about the created membership.
    print(result)

if __name__ == '__main__':
    main()

  3. Dans le code, remplacez SPACE par le nom d'un espace, que vous pouvez obtenir à partir de la méthode spaces.list de l'API Chat ou de l'URL d'un espace.

  4. Dans votre répertoire de travail, créez et exécutez l'exemple:

    python3 chat_messages_list.py

L'API Google Chat renvoie une liste des messages envoyés dans l'espace spécifié après le 16 mars 2023.