Cómo enumerar las reacciones a un mensaje

En esta guía, se explica cómo usar el método list en el recurso Reaction de la API de Google Chat para enumerar reacciones a un mensaje, como 👍, ViewGroup y 💰.

El recurso Reaction representa un emoji que las personas pueden usar para reaccionar a un mensaje, como 👍, 红 y Elegir.

Requisitos previos

Python

  • Python 3.6 o superior
  • La herramienta de administración de paquetes pip
  • Las bibliotecas cliente de Google más recientes para Python. Para instalarlos o actualizarlos, ejecuta el siguiente comando en tu interfaz de línea de comandos:

    pip3 install --upgrade google-api-python-client google-auth-oauthlib
    
  • Un proyecto de Google Cloud con la API de Google Chat habilitada y configurada Para conocer los pasos, consulta Compila una app de Google Chat.
  • Autorización configurada para la app de Chat. Las reacciones de enumeración requieren autenticación del usuario con el alcance de autorización chat.messages.reactions.readonly, chat.messages.reactions, chat.messages.readonly o chat.messages.

Enumerar reacciones

Para enumerar las reacciones a un mensaje, pasa lo siguiente en la solicitud:

  • Especifica el alcance de la autorización chat.messages.reactions.readonly, chat.messages.reactions, chat.messages.readonly o chat.messages.
  • Llama al [método list]/workspace(/chat/api/reference/rest/v1/spaces.messages.reactions/list) en el recurso Reaction.

En el siguiente ejemplo, se enumeran las reacciones para un mensaje especificado:

Python

  1. En el directorio de trabajo, crea un archivo llamado chat_reactions_list.py.
  2. Incluye el siguiente código en 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. En el código, reemplaza lo siguiente:

    • SPACE: Es un nombre de espacio, que puedes obtener del método spaces.list en la API de Chat, o bien desde la URL de un espacio.
    • MESSAGE: Es un nombre de mensaje, que puedes obtener del cuerpo de la respuesta que se muestra después de crear un mensaje de forma asíncrona con la API de Chat o con el nombre personalizado asignado al mensaje en el momento de la creación.
  4. En el directorio de trabajo, compila y ejecuta la muestra:

    python3 chat_reactions_list.py
    

La API de Chat muestra un array de reacciones paginado.