Method: customEmojis.list
Koleksiyonlar ile düzeninizi koruyun
İçeriği tercihlerinize göre kaydedin ve kategorilere ayırın.
HTTP isteği
GET https://chat.googleapis.com/v1/customEmojis
URL, gRPC Kod Dönüştürme söz dizimini kullanır.
Sorgu parametreleri
| Parametreler |
pageSize |
integer
İsteğe bağlı. Döndürülen maksimum özel emoji sayısı. Hizmet, bu değerden daha az özel emoji döndürebilir. Belirtilmediği takdirde varsayılan değer 25'tir. Maksimum değer 200'dür. 200'ün üzerindeki değerler 200 olarak değiştirilir.
|
pageToken |
string
İsteğe bağlı. (Önceki bir sorgudan devam ediliyorsa.) Önceki bir liste özel emoji çağrısından alınan sayfa jetonu. Sonraki sayfayı almak için bunu sağlayın. Sayfalandırma yaparken filtre değeri, sayfa jetonunu sağlayan çağrıyla eşleşmelidir. Farklı bir değer göndermek beklenmedik sonuçlara yol açabilir.
|
filter |
string
İsteğe bağlı. Sorgu filtresi. İçerik üreticiye göre filtrelemeyi destekler. İçerik üreticiye göre filtrelemek için geçerli bir değer belirtmeniz gerekir. Özel emojileri, arayan kullanıcı tarafından oluşturulup oluşturulmadıklarına göre filtrelemek için şu anda yalnızca creator("users/me") ve NOT creator("users/me") kabul edilmektedir. Örneğin, aşağıdaki sorgu arayan tarafından oluşturulan özel emojileri döndürür:
creator("users/me")
Geçersiz sorgular INVALID_ARGUMENT hatasıyla reddedilir.
|
İstek içeriği
İstek metni boş olmalıdır.
Yanıt gövdesi
Özel emojileri listeleyen bir yanıt.
Başarılı olursa yanıt metni aşağıdaki yapıyla birlikte verileri içerir:
| JSON gösterimi |
{
"customEmojis": [
{
object (CustomEmoji)
}
],
"nextPageToken": string
} |
| Alanlar |
customEmojis[] |
object (CustomEmoji)
Sırasız liste. Özel emojilerin listesi.
|
nextPageToken |
string
Sonuçların bir sonraki sayfasını almak için pageToken olarak gönderebileceğiniz bir jeton. Boşsa sonraki sayfa yoktur.
|
Yetkilendirme kapsamları
Aşağıdaki OAuth kapsamlarından birini gerektirir:
https://www.googleapis.com/auth/chat.customemojishttps://www.googleapis.com/auth/chat.customemojis.readonly
Daha fazla bilgi için Yetkilendirme kılavuzuna bakın.
Aksi belirtilmediği sürece bu sayfanın içeriği Creative Commons Atıf 4.0 Lisansı altında ve kod örnekleri Apache 2.0 Lisansı altında lisanslanmıştır. Ayrıntılı bilgi için Google Developers Site Politikaları'na göz atın. Java, Oracle ve/veya satış ortaklarının tescilli ticari markasıdır.
Son güncelleme tarihi: 2025-07-25 UTC.
[null,null,["Son güncelleme tarihi: 2025-07-25 UTC."],[[["\u003cp\u003eLists custom emojis visible to the authenticated user, requiring user authentication and specific authorization scopes.\u003c/p\u003e\n"],["\u003cp\u003eAllows filtering by creator to see emojis created by the calling user or others.\u003c/p\u003e\n"],["\u003cp\u003eSupports pagination to retrieve large lists of custom emojis, with a default page size of 25 and a maximum of 200.\u003c/p\u003e\n"],["\u003cp\u003eReturns a list of custom emojis and a token for retrieving subsequent pages if available.\u003c/p\u003e\n"],["\u003cp\u003eRequires an empty request body and provides a structured JSON response containing emoji details.\u003c/p\u003e\n"]]],["This document details how to list custom emojis in Google Chat via an HTTP GET request to `https://chat.googleapis.com/v1/customEmojis`. The request requires user authentication and supports optional query parameters: `pageSize` (default 25, max 200), `pageToken` (for pagination), and `filter` (to filter by emoji creator). The request body must be empty. The response includes a list of `customEmojis` and an optional `nextPageToken` for pagination. Authorization requires either `chat.customemojis` or `chat.customemojis.readonly` scope.\n"],null,["# Method: customEmojis.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.ListCustomEmojisResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nLists custom emojis visible to the authenticated user.\n\nCustom emojis are only available for Google Workspace accounts, and the administrator must turn custom emojis on for the organization. For more information, see [Learn about custom emojis in Google Chat](https://support.google.com/chat/answer/12800149) and [Manage custom emoji permissions](https://support.google.com/a/answer/12850085).\n\nRequires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following [authorization scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes):\n\n- `https://www.googleapis.com/auth/chat.customemojis.readonly`\n- `https://www.googleapis.com/auth/chat.customemojis`\n\n### HTTP request\n\n`GET https://chat.googleapis.com/v1/customEmojis`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Query parameters\n\n| Parameters ||\n|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `pageSize` | `integer` Optional. The maximum number of custom emojis returned. The service can return fewer custom emojis than this value. If unspecified, the default value is 25. The maximum value is 200; values above 200 are changed to 200. |\n| `pageToken` | `string` Optional. (If resuming from a previous query.) A page token received from a previous list custom emoji call. Provide this to retrieve the subsequent page. When paginating, the filter value should match the call that provided the page token. Passing a different value might lead to unexpected results. |\n| `filter` | `string` Optional. A query filter. Supports filtering by creator. To filter by creator, you must specify a valid value. Currently only `creator(\"users/me\")` and `NOT creator(\"users/me\")` are accepted to filter custom emojis by whether they were created by the calling user or not. For example, the following query returns custom emojis created by the caller: creator(\"users/me\") Invalid queries are rejected with an `INVALID_ARGUMENT` error. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nA response to list custom emojis.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|--------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"customEmojis\": [ { object (/workspace/chat/api/reference/rest/v1/customEmojis#CustomEmoji) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|------------------|-----------------------------------------------------------------------------------------------------------------------------------|\n| `customEmojis[]` | `object (`[CustomEmoji](/workspace/chat/api/reference/rest/v1/customEmojis#CustomEmoji)`)` Unordered list. List of custom emojis. |\n| `nextPageToken` | `string` A token that you can send as `pageToken` to retrieve the next page of results. If empty, there are no subsequent pages. |\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/chat.customemojis`\n- `https://www.googleapis.com/auth/chat.customemojis.readonly`\n\nFor more information, see the [Authorization guide](/workspace/chat/authenticate-authorize)."]]
