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 des messages d'un espace.

Dans l'API Chat, un message Chat est représenté par l'icône Ressource Message. Les utilisateurs de Chat ne peuvent envoyer que des messages contenant du texte, Les applications de chat peuvent utiliser de nombreuses autres fonctionnalités de messagerie, y compris l'affichage d'interfaces utilisateur statiques ou interactives, la collecte d'informations et en distribuant des messages en privé. Pour en savoir plus sur la messagerie disponibles pour l'API Chat, consultez la Présentation des messages Google Chat

Prérequis

Python

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 ou chat.messages.
  • Appelez la méthode Méthode list le Ressource Message.

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. 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()

  3. Dans le code, remplacez SPACE par un nom d'espace, ce qui que vous pouvez obtenir Méthode spaces.list dans l'API Chat ou via 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 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, {}.