組織内のカスタム絵文字を一覧表示する

このガイドでは、Google Chat API の CustomEmoji リソースで list メソッドを使用して、認証済みユーザーが Google Workspace 組織で表示できるカスタム絵文字を一覧表示する方法について説明します。

カスタム絵文字は Google Workspace アカウントでのみ使用できます。管理者は、組織でカスタム絵文字を有効にする必要があります。詳細については、Google Chat のカスタム絵文字についてと カスタム絵文字の権限を管理するをご覧ください。

前提条件

Node.js

組織内のカスタム絵文字を一覧表示する

ユーザー認証を使用して組織内のカスタム絵文字を一覧表示するには、リクエストで次の情報を渡します。

  • chat.customemojis 認可スコープを指定します。
  • ListCustomEmojis メソッドを呼び出します。

次の例では、組織内のカスタム絵文字を一覧表示します。

Node.js

chat/client-libraries/cloud/list-custom-emojis-user-cred.js
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);
  }
}

await main();

このサンプルを実行するには、次の値を置き換えます。

  • FILTER: 省略可。リスト リクエストに適用するフィルタ。