Method: customEmojis.list

列出通過驗證的使用者會看到的自訂表情符號。

需要使用者驗證。

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

詳情請參閱授權指南。