列出機構中的自訂表情符號

本指南說明如何使用 Google Chat API 的 CustomEmoji 資源中的 list 方法，列出 Google Workspace 機構中通過驗證的使用者可見的自訂表情符號。

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

必要條件

Node.js

• 具有 Google Chat 存取權的 Business 或 Enterprise 版 Google Workspace 帳戶。

• 設定環境：
  • 建立 Google Cloud 專案。
  • 設定 OAuth 同意畫面。
  • 啟用及設定 Google Chat API，並為 Chat 應用程式命名、設定圖示和說明。
  • 安裝 Node.js Cloud 用戶端程式庫。
  • 根據您要在 Google Chat API 要求中驗證的方式，建立存取憑證：
    • 如要以 Chat 使用者身分進行驗證，請建立 OAuth 用戶端 ID 憑證，並將憑證儲存至本機目錄，命名為 credentials.json 的 JSON 檔案。
    • 如要以 Chat 應用程式的身分進行驗證，請建立服務帳戶憑證，然後將憑證儲存為名為 credentials.json 的 JSON 檔案。
• 根據您要以使用者或 Chat 應用程式的身分驗證，選擇授權範圍。

本頁的程式碼範例使用 gRPC API 介面和 Google Cloud 用戶端程式庫。或者，您也可以使用 REST API 介面。如要進一步瞭解 gRPC 和 REST 介面，請參閱「Google Chat API 總覽」。

列出機構中的自訂表情符號

如要列出機構中的自訂表情符號，請使用使用者驗證，並在要求中傳遞下列項目：

• 指定 chat.customemojis 授權範圍。
• 呼叫 ListCustomEmojis 方法。

以下範例會列出機構中的自訂表情符號。

Node.js

chat/client-libraries/cloud/list-custom-emojis-user-cred.js

前往 GitHub 查看

import {createClientWithUserCredentials} from './authentication-utils.js';

const USER_AUTH_OAUTH_SCOPES = ['https://www.googleapis.com/auth/chat.customemojis'];

// This sample shows how to get custom emoji with user credential
async function main() {
  // Create a client
  const chatClient = await createClientWithUserCredentials(USER_AUTH_OAUTH_SCOPES);

  // Initialize request argument(s)
  const request = {
    // Optional. Replace FILTER here
    filter: 'FILTER'
  };

  // Make the request
  const pageResult = await chatClient.listCustomEmojisAsync(request);

  // Handle the response. Iterating over pageResult will yield results and
  // resolve additional pages automatically.
  for await (const response of pageResult) {
    console.log(response);
  }
}

main().catch(console.error);

如要執行這個範例，請替換下列項目：

• FILTER：(選填) 要套用至清單要求的篩選器。

相關主題

• 建立自訂表情符號
• 刪除自訂表情符號
• 取得自訂表情符號的詳細資料