Répertorier les réactions à un message

Ce guide explique comment utiliser la méthode list sur la ressource Reaction de l'API Google Chat pour lister les réactions à un message (telles que 👍, 💀 et 😂).

La ressource Reaction représente un emoji que les utilisateurs peuvent utiliser pour réagir à un message, par exemple 👍, 💀 et 😂.

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. Lister les réactions nécessite l'authentification des utilisateurs avec le niveau d'autorisation chat.messages.reactions.readonly, chat.messages.reactions, chat.messages.readonly ou chat.messages.

Répertorier les réactions

Pour lister les réactions à un message, transmettez les éléments suivants dans votre requête:

  • Spécifiez le champ d'application des autorisations chat.messages.reactions.readonly, chat.messages.reactions, chat.messages.readonly ou chat.messages.
  • Appelez la [méthode list]/workspace(/chat/api/reference/rest/v1/spaces.messages.reactions/list) sur la ressource Reaction.

L'exemple suivant répertorie les réactions à un message spécifié:

Python

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

  2. Incluez le code suivant dans chat_reactions_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.reactions.readonly"]

def main():
    '''
    Authenticates with Chat API via user credentials,
    then lists reactions to 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().reactions().list(

        # The message to list reactions to.
        #
        # 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.
        parent = 'spaces/SPACE/messages/MESSAGE'

    ).execute()

    # Prints details about the created reactions.
    print(result)

if __name__ == '__main__':
    main()

  3. Dans le code, remplacez ce qui suit:

    • SPACE: nom d'espace, que vous pouvez obtenir à partir de la méthode spaces.list de l'API Chat ou de l'URL d'un espace.
    • MESSAGE: nom du message, que vous pouvez obtenir dans le 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.

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

    python3 chat_reactions_list.py

L'API Chat renvoie un tableau paginé de réactions.