Method: customEmojis.list

列出已驗證使用者可看見的自訂表情符號。

自訂表情符號僅適用於 Google Workspace 帳戶，且管理員必須為機構開啟自訂表情符號。詳情請參閱「瞭解 Google Chat 中的自訂表情符號」和「管理自訂表情符號權限」。

需要使用下列其中一個授權範圍進行使用者驗證：

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

HTTP 要求

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

這個網址使用 gRPC 轉碼語法。

查詢參數

參數
pageSize

integer

(非必要) 傳回的自訂表情符號數量上限。服務傳回的自訂表情符號可能少於這個值。如未指定，則預設值為 25。許可的最大值為 200；超出的數值將一律指定為 200。
pageToken

string

(非必要) (如果是從先前的查詢繼續執行)。

從先前呼叫的列出自訂表情符號傳回的頁面權杖。提供此項目即可擷取後續網頁。

進行分頁時，篩選器值應與提供網頁權杖的呼叫相符。傳遞其他值可能會導致非預期的結果。
filter

string

(非必要) 查詢篩選器。

支援依創作者篩選。

如要依創作者篩選，您必須指定有效的值。目前只有 creator("users/me") 和 NOT creator("users/me") 可篩選自訂表情符號，判斷是否由通話使用者建立。

舉例來說，下列查詢會傳回呼叫端建立的自訂表情符號：

creator("users/me")

系統會拒絕無效的查詢，並傳回 INVALID_ARGUMENT 錯誤。

要求主體

要求主體必須為空白。

回應主體

回覆清單中的自訂表情符號。

如果成功，回應主體會含有以下結構的資料：

JSON 表示法 
{
  "customEmojis": [
    {
      object (CustomEmoji)
    }
  ],
  "nextPageToken": string
}
欄位
customEmojis[]

object (CustomEmoji)

未排序的清單。自訂表情符號清單。
nextPageToken

string

可做為 pageToken 傳送的權杖，用於擷取後續網頁的結果。如果留空，表示沒有後續網頁。

授權範圍

需要下列其中一種 OAuth 範圍：

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

詳情請參閱授權指南。