Method: customEmojis.list

Muestra una lista de los emojis personalizados visibles para el usuario autenticado.

Los emojis personalizados solo están disponibles para las cuentas de Google Workspace, y el administrador debe activarlos para la organización. Para obtener más información, consulta Más información sobre los emojis personalizados en Google Chat y Administra los permisos de los emojis personalizados.

Requiere autenticación del usuario con uno de los siguientes alcances de autorización:

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

Solicitud HTTP

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

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de consulta

Parámetros
pageSize

integer

Opcional. Es la cantidad máxima de emojis personalizados que se devuelven. El servicio puede mostrar menos emojis personalizados que este valor. Si no se especifica, el valor predeterminado es 25. El valor máximo es 200; los valores superiores a 200 se cambian a 200.
pageToken

string

Opcional. (si se reanuda desde una consulta anterior).

Un token de página recibido de una llamada anterior a emojis personalizados de la lista. Proporciona esto para recuperar la página siguiente.

Cuando se realiza la paginación, el valor del filtro debe coincidir con la llamada que proporcionó el token de página. Pasar un valor diferente puede generar resultados inesperados.
filter

string

Opcional. Un filtro de búsqueda.

Admite el filtrado por creador.

Para filtrar por creador, debes especificar un valor válido. Actualmente, solo se aceptan creator("users/me") y NOT creator("users/me") para filtrar emojis personalizados según si el usuario que realiza la llamada los creó o no.

Por ejemplo, la siguiente consulta muestra los emojis personalizados que creó el llamador:

creator("users/me")

Las consultas no válidas se rechazan con un error INVALID_ARGUMENT.

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de la respuesta

Una respuesta para mostrar una lista de emojis personalizados.

Si se ejecuta correctamente, el cuerpo de la respuesta contendrá datos con la siguiente estructura:

Representación JSON 
{
  "customEmojis": [
    {
      object (CustomEmoji)
    }
  ],
  "nextPageToken": string
}
Campos
customEmojis[]

object (CustomEmoji)

Lista sin ordenar. Es la lista de emojis personalizados.
nextPageToken

string

Es un token que puedes enviar como pageToken para recuperar la siguiente página de resultados. Si está vacío, no hay páginas posteriores.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

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

Para obtener más información, consulta la Guía de autorización.