Method: customEmojis.list

Listet benutzerdefinierte Emojis auf, die für den authentifizierten Nutzer sichtbar sind.

Erfordert die Nutzerauthentifizierung.

HTTP-Anfrage

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Abfrageparameter

Parameter
pageSize

integer

Optional. Die maximale Anzahl der zurückgegebenen benutzerdefinierten Emojis. Der Dienst kann weniger benutzerdefinierte Emojis als diesen Wert zurückgeben. Wenn keine Angabe erfolgt, beträgt der Standardwert 25. Der Maximalwert ist 200. Werte über 200 werden in 200 geändert.
pageToken

string

Optional. (Wenn die Abfrage fortgesetzt wird.)

Ein Seitentoken, das von einem vorherigen Aufruf der Liste mit benutzerdefinierten Emojis empfangen wurde. Geben Sie diese an, um die nachfolgende Seite abzurufen.

Beim Paginieren muss der Filterwert mit dem Aufruf übereinstimmen, der das Seitentoken bereitgestellt hat. Wenn Sie einen anderen Wert übergeben, kann das zu unerwarteten Ergebnissen führen.
filter

string

Optional. Einen Abfragefilter.

Es wird die Filterung nach Creator unterstützt.

Wenn du nach Creator filtern möchtest, musst du einen gültigen Wert angeben. Derzeit können benutzerdefinierte Emojis nur mit creator("users/me") und NOT creator("users/me") danach gefiltert werden, ob sie vom anrufenden Nutzer erstellt wurden oder nicht.

Die folgende Abfrage gibt beispielsweise benutzerdefinierte Emojis zurück, die vom Anrufer erstellt wurden:

creator("users/me")

Ungültige Abfragen werden vom Server mit dem Fehler INVALID_ARGUMENT abgelehnt.

Anfragetext

Der Anfragetext muss leer sein.

Antworttext

Eine Antwort auf eine Liste mit benutzerdefinierten Emojis.

Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:

JSON-Darstellung 
{
  "customEmojis": [
    {
      object (CustomEmoji)
    }
  ],
  "nextPageToken": string
}
Felder
customEmojis[]

object (CustomEmoji)

Unsortierte Liste. Liste der benutzerdefinierten Emojis auf der angeforderten (oder ersten) Seite.
nextPageToken

string

Ein Token, das als pageToken gesendet werden kann, um die nächste Ergebnisseite abzurufen. Wenn dieses Feld leer ist, gibt es keine nachfolgenden Seiten.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

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

Weitere Informationen finden Sie im Leitfaden zur Autorisierung.