Method: customEmojis.list

Lista os emojis personalizados visíveis para o usuário autenticado.

Exige a autenticação do usuário.

Solicitação HTTP

GET https://chat.googleapis.com/v1/customEmojis

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

Parâmetros de consulta

Parâmetros
pageSize

integer

Opcional. O número máximo de emojis personalizados retornados. O serviço pode retornar menos emojis personalizados 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 emoji personalizado da lista 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.

Suporte para filtragem por criador de conteúdo.

Para filtrar por criador, você precisa especificar um valor válido. No momento, apenas creator("users/me") e NOT creator("users/me") são aceitos para filtrar emojis personalizados, sejam eles criados ou não pelo usuário que fez a chamada.

Por exemplo, a consulta a seguir retorna o emoji personalizado criado pelo autor da chamada:

creator("users/me")

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

Uma resposta a uma lista de emojis personalizados.

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

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

object (CustomEmoji)

Lista não ordenada. Lista de emojis personalizados na página solicitada (ou primeira).
nextPageToken

string

Um token que pode ser enviado como pageToken para recuperar a próxima página de resultados. Se estiver vazio, não haverá páginas subsequentes.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/chat.customemojis
  • https://www.googleapis.com/auth/chat.customemojis.readonly

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