メッセージのリアクションを一覧表示する

このガイドでは、Google Chat API の Reaction リソースで list() メソッドを使用して、メッセージのリアクション（👍、🚲、🌞 など）を一覧表示する方法について説明します。

Reaction リソースは、ユーザーがメッセージにリアクションするために使用できる絵文字を表します（例: 👍、🚲、🌞）。

前提条件

Node.js

• Google Chat へのアクセス権を持つビジネスまたはエンタープライズ向け Google Workspace アカウント。

• 環境を設定します。
  • Google Cloud プロジェクトを作成します。
  • OAuth 同意画面を構成する
  • Google Chat API を有効にして構成する。名前、 アプリのアイコン、説明を入力します。
  • Node.js の Cloud クライアント ライブラリをインストールします。
  • <ph type="x-smartling-placeholder"></ph> デスクトップ アプリケーション用の OAuth クライアント ID 認証情報を作成するサンプルを実行するには、 で、認証情報を client_secrets.json という名前の JSON ファイルとして ディレクトリにあります。
  で確認できます。 詳しくは、こちらの クイックスタートをご覧ください。
• <ph type="x-smartling-placeholder"></ph> ユーザー認証をサポートする認可スコープを選択します。

このページのコードサンプルでは、Google Cloud クライアント ライブラリで gRPC API インターフェースを使用しています。また、REST API インターフェースを使用することもできます。gRPC インターフェースと REST インターフェースの詳細については、Google Chat API の概要をご覧ください。

リアクションを一覧表示する

メッセージのリアクションを一覧表示するには、リクエストに次のものを渡します。

• chat.messages.reactions.readonly、chat.messages.reactions、 承認スコープは chat.messages.readonly または chat.messages です。
• ListReactions() メソッドを呼び出し、parent をメッセージのリソース名として渡します。

次の例では、指定したメッセージのリアクションを一覧表示します。

Node.js

chat/client-libraries/cloud/list-reactions-user-cred.js

GitHub で表示

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

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

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

  // Initialize request argument(s)
  const request = {
    // Replace SPACE_NAME and MESSAGE_NAME here.
    parent: 'spaces/SPACE_NAME/messages/MESSAGE_NAME'
  };

  // Make the request
  const pageResult = chatClient.listReactionsAsync(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);

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

• SPACE_NAME: スペースの ID name。 ID を取得するには、このメソッドを呼び出して、 ListSpaces() スペースの URL から取得できます。
• MESSAGE_NAME: メッセージの name の ID。ID は、レスポンスの作成後に返されるレスポンスの本文から取得できます。 Chat API を使用してメッセージを非同期で送信したり、 カスタム名 自動的に割り当てられます。

Chat API は、リアクションのページ分割リストを返します。

関連トピック

• メッセージにリアクションを追加する
• メッセージからリアクションを削除する。