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

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

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

前提条件

Node.js

• Google Chat にアクセスできる Business または Enterprise Google Workspace アカウント。

• 環境を設定します。
  • Google Cloud プロジェクトを作成します。
  • OAuth 同意画面を構成します。
  • Chat アプリの名前、 アイコン、説明を使用して、Google Chat API を有効にして構成します。
  • Node.js Cloud クライアント ライブラリをインストールします。
  • デスクトップ アプリケーションの OAuth クライアント ID 認証情報を作成します。このガイドのサンプルを実行するには、認証情報を credentials.json という名前の JSON ファイルとしてローカル ディレクトリに保存します。
  手順については、この クイックスタートの環境設定の手順を完了してください。
• ユーザー認証をサポートする認証スコープを選択します。

このページのコードサンプルでは、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);
  }
}

await main();

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

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

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

関連トピック

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