Method: customEmojis.list

Répertorie les emoji personnalisés visibles par l'utilisateur authentifié.

Nécessite une authentification de l'utilisateur.

Requête HTTP

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

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de requête

Paramètres
pageSize

integer

Facultatif. Nombre maximal d'emoji personnalisés renvoyés. Le service peut renvoyer un nombre inférieur à cette valeur. Si aucune valeur n'est spécifiée, la valeur par défaut est 25. La valeur maximale est 200. Les valeurs supérieures à 200 sont remplacées par 200.
pageToken

string

Facultatif. (Si vous reprenez à partir d'une requête précédente.)

Jeton de page reçu lors d'un appel d'emoji personnalisés de liste précédent. Fournissez-le pour récupérer la page suivante.

Lors de la pagination, la valeur du filtre doit correspondre à l'appel ayant fourni le jeton de page. La transmission d'une valeur différente peut entraîner des résultats inattendus.
filter

string

Facultatif. Filtre de requête

Possibilité de filtrer par créateur

Pour filtrer par créateur, vous devez spécifier une valeur valide. Actuellement, seuls creator("users/me") et NOT creator("users/me") sont acceptés pour filtrer les emoji personnalisés selon qu'ils ont été créés par l'utilisateur appelant ou non.

Par exemple, la requête suivante renvoie les emoji personnalisés créés par l'appelant :

creator("users/me")

Les requêtes non valides sont rejetées par le serveur avec une erreur INVALID_ARGUMENT.

Corps de la requête

Le corps de la requête doit être vide.

Corps de la réponse

Réponse à une liste d'emoji personnalisés.

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

Représentation JSON 
{
  "customEmojis": [
    {
      object (CustomEmoji)
    }
  ],
  "nextPageToken": string
}
Champs
customEmojis[]

object (CustomEmoji)

Liste à puces. Liste des emoji personnalisés sur la page demandée (ou la première page).
nextPageToken

string

Jeton que vous pouvez envoyer en tant que pageToken pour récupérer la page suivante des résultats. Si ce champ est vide, aucune page suivante n'existe.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

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

Pour en savoir plus, consultez le Guide relatif aux autorisations.