Listar reações a uma mensagem

Este guia explica como usar o método list no recurso Reaction da API Google Chat para listar as reações a uma mensagem, como 👍, ₤ e Magento.

O recurso Reaction representa um emoji que as pessoas podem usar para reagir a uma mensagem, como 👍, AdX e Magento.

Pré-requisitos

Python

  • Python 3.6 ou superior
  • A ferramenta de gerenciamento de pacotes pip

  • As bibliotecas de cliente mais recentes do Google para Python. Para instalar ou atualizar, execute o seguinte na interface de linha de comando:

    pip3 install --upgrade google-api-python-client google-auth-oauthlib
  • Um projeto do Google Cloud com a API Google Chat ativada e configurada. Veja as etapas em Criar um app do Google Chat.

  • Autorização configurada para o app do Chat. As reações à listagem exigem a autenticação do usuário com o escopo de autorização chat.messages.reactions.readonly, chat.messages.reactions, chat.messages.readonly ou chat.messages.

Listar reações

Para listar as reações de uma mensagem, transmita o seguinte na sua solicitação:

  • Especifique o escopo de autorização chat.messages.reactions.readonly, chat.messages.reactions, chat.messages.readonly ou chat.messages.
  • Chame [list method]/workspace(/chat/api/reference/rest/v1/spaces.messages.reactions/list) no recurso Reaction.

O exemplo abaixo lista as reações para uma mensagem especificada:

Python

  1. No diretório de trabalho, crie um arquivo chamado chat_reactions_list.py.

  2. Inclua o seguinte código em 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. No código, substitua o seguinte:

    • SPACE: um nome de espaço, que pode ser obtido no método spaces.list na API Chat ou no URL de um espaço.
    • MESSAGE: um nome de mensagem, que pode ser obtido no corpo da resposta retornado depois de criar uma mensagem de maneira assíncrona com a API Chat ou com o nome personalizado atribuído à mensagem no momento da criação.

  4. No diretório de trabalho, crie e execute a amostra:

    python3 chat_reactions_list.py

A API Chat retorna uma matriz paginada de reações.