Method: spaces.messages.reactions.list

Lista as reações a uma mensagem. Veja um exemplo em Listar reações para uma mensagem.

Exige a autenticação do usuário.

Solicitação HTTP

GET https://chat.googleapis.com/v1/{parent=spaces/*/messages/*}/reactions

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
parent

string

Obrigatório. A mensagem que os usuários reagiram.

Formato: spaces/{space}/messages/{message}

Parâmetros de consulta

Parâmetros
pageSize

integer

Opcional. O número máximo de reações retornadas. O serviço pode retornar menos reações do que esse valor. Se não for especificado, o valor padrão será 25. O valor máximo é 200. valores acima de 200 são alterados para 200.

pageToken

string

Opcional. (Se estiver retomando de uma consulta anterior.)

Um token de página recebido de uma chamada de lista de reações anterior. Forneça isso para recuperar a página subsequente.

Ao fazer a paginação, o valor do filtro precisa corresponder à chamada que forneceu o token da página. Transmitir um valor diferente pode levar a resultados inesperados.

filter

string

Opcional. Um filtro de consulta.

Você pode filtrar as reações por emoji (emoji.unicode ou emoji.custom_emoji.uid) e usuário (user.name).

Para filtrar reações de vários emojis ou usuários, una campos semelhantes com o operador OR, como emoji.unicode = "🙂" OR emoji.unicode = "👍" e user.name = "users/AAAAAA" OR user.name = "users/BBBBBB".

Para filtrar reações por emoji e usuário, use o operador AND, como emoji.unicode = "🙂" AND user.name = "users/AAAAAA".

Se a consulta usar AND e OR, agrupe-as com parênteses.

Por exemplo, as consultas a seguir são válidas:

user.name = "users/{user}"
emoji.unicode = "🙂"
emoji.custom_emoji.uid = "{uid}"
emoji.unicode = "🙂" OR emoji.unicode = "👍"
emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}"
emoji.unicode = "🙂" AND user.name = "users/{user}"
(emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}")
AND user.name = "users/{user}"

As seguintes consultas são inválidas:

emoji.unicode = "🙂" AND emoji.unicode = "👍"
emoji.unicode = "🙂" AND emoji.custom_emoji.uid = "{uid}"
emoji.unicode = "🙂" OR user.name = "users/{user}"
emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}" OR
user.name = "users/{user}"
emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}"
AND user.name = "users/{user}"

As consultas inválidas são rejeitadas pelo servidor com um erro INVALID_ARGUMENT.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Resposta a uma solicitação de lista de reações.

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Representação JSON
{
  "reactions": [
    {
      object (Reaction)
    }
  ],
  "nextPageToken": string
}
Campos
reactions[]

object (Reaction)

Lista de reações na página solicitada (ou primeira).

nextPageToken

string

Token de continuação para recuperar a próxima página de resultados. Está vazio na última página de resultados.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.readonly
  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages.reactions.readonly

Para mais informações, consulte o guia de autorização.