カスタム絵文字を削除する

このガイドでは、Google Chat API の CustomEmoji リソースで delete メソッドを使用して、Google Workspace 組織のカスタム絵文字を削除する方法について説明します。

デフォルトでは、ユーザーは自分が作成したカスタム絵文字のみを削除できます。管理者が割り当てた絵文字管理者は、組織内の任意のカスタム絵文字を削除できます。

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

前提条件

Node.js

カスタム絵文字を削除する

ユーザー認証を使用してカスタム絵文字を削除するには、リクエストで次の情報を渡します。

  • chat.customemojis 認証スコープを指定します。
  • DeleteCustomEmoji() メソッドを呼び出します。
    • リクエストの本文で、name を削除するカスタム絵文字のリソース名に設定します。

次の例では、カスタム絵文字を削除します。

Node.js

chat/client-libraries/cloud/delete-custom-emoji-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 delete a 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 = {
    // TODO(developer): Replace EMOJI_NAME here.
    name: 'customEmojis/EMOJI_NAME'
  };

  // Make the request
  const response = await chatClient.deleteCustomEmoji(request);

  // Handle the response
  console.log(response);
}

main().catch(console.error);

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

  • EMOJI_NAME: カスタム絵文字の一意の名前（emoji_name フィールド）。この ID は、ListCustomEmoji メソッドを呼び出すか、Chat API でカスタム絵文字を非同期で作成した後に返されるレスポンスの本文から取得できます。