Method: spaces.messages.reactions.list

メッセージに対するリアクションを一覧表示します。例については、メッセージのリアクションを一覧表示するをご覧ください。ユーザー認証が必要です。

HTTP リクエスト

GET https://chat.googleapis.com/v1/{parent=spaces/*/messages/*}/reactions

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
parent

string

必須。ユーザーがリアクションしたメッセージ。

形式: spaces/{space}/messages/{message}

クエリ パラメータ

パラメータ
pageSize

integer

省略可。返されるリアクションの最大数。サービスは、この値よりも少ないリアクションを返すことができます。指定しない場合、デフォルト値は 25 です。最大値は 200 です。200 を超える値は 200 に変更されます
pageToken

string

省略可。（前のクエリから再開する場合）。

前の list reactions 呼び出しから受け取ったページトークン。後続のページを取得するにはこれを指定します。

ページ分割を行う場合、フィルタ値は、ページトークンを提供した呼び出しと一致する必要があります。別の値を渡すと、予期しない結果が生じる可能性があります。
filter

string

省略可。クエリフィルタ。

絵文字（emoji.unicode または emoji.custom_emoji.uid）とユーザー（user.name）でリアクションをフィルタできます。

複数の絵文字やユーザーのリアクションをフィルタするには、類似のフィールドを OR 演算子（emoji.unicode = "🙂" OR emoji.unicode = "👍" や user.name = "users/AAAAAA" OR user.name = "users/BBBBBB" など）で結合します。

絵文字やユーザーでリアクションをフィルタするには、AND 演算子（emoji.unicode = "🙂" AND user.name = "users/AAAAAA" など）を使用します。

クエリで AND と OR の両方を使用する場合は、それらをかっこでグループ化します。

たとえば、次のクエリは有効です。

user.name = "users/{user}"
emoji.unicode = "🙂"
emoji.custom_emoji.uid = "{uid}"
emoji.unicode = "🙂" OR emoji.unicode = "👍"
emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}"
emoji.unicode = "🙂" AND user.name = "users/{user}"
(emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}")
AND user.name = "users/{user}"

次のクエリは無効です。

emoji.unicode = "🙂" AND emoji.unicode = "👍"
emoji.unicode = "🙂" AND emoji.custom_emoji.uid = "{uid}"
emoji.unicode = "🙂" OR user.name = "users/{user}"
emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}" OR
user.name = "users/{user}"
emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}"
AND user.name = "users/{user}"

無効なクエリは、サーバーによって INVALID_ARGUMENT エラーで拒否されます。

リクエスト本文

リクエストの本文は空にする必要があります。

レスポンスの本文

リアクションの一覧表示リクエストに対するレスポンス。

成功した場合、レスポンスの本文には次の構造のデータが含まれます。

JSON 表現 
{
  "reactions": [
    {
      object (Reaction)
    }
  ],
  "nextPageToken": string
}
フィールド
reactions[]

object (Reaction)

リクエストされた（または最初の）ページのリアクションのリスト。
nextPageToken

string

結果の次のページを取得するための継続トークン。結果の最後のページは空になります。

認可スコープ

次の OAuth スコープのいずれかが必要です。

  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.readonly
  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages.reactions.readonly

詳細については、承認ガイドをご覧ください。