Method: customEmojis.list

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

Os emojis personalizados só estão disponíveis para contas do Google Workspace, e o administrador precisa ativar esse recurso para a organização. Para mais informações, consulte Saiba mais sobre os emojis personalizados no Google Chat e Gerenciar permissões de emojis personalizados.

Requer autenticação do usuário com um dos seguintes escopos de autorização:

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

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 disso 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 de 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 filtrar por criador de conteúdo.

Para filtrar por criador, especifique um valor válido. No momento, apenas creator("users/me") e NOT creator("users/me") são aceitos para filtrar emojis personalizados de acordo com se eles foram criados pelo usuário que fez a chamada ou não.

Por exemplo, a consulta a seguir retorna emojis personalizados criados pelo autor da chamada:

creator("users/me")

Consultas inválidas são rejeitadas com um erro INVALID_ARGUMENT.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Uma resposta para listar 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.
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.