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

اختیاری. (در صورت از سرگیری درخواست قبلی.)

یک نشانه صفحه دریافت شده از تماس واکنش های لیست قبلی. این را برای بازیابی صفحه بعدی ارائه کنید.

هنگام صفحه‌بندی، مقدار فیلتر باید با تماسی که توکن صفحه را ارائه می‌کند، مطابقت داشته باشد. عبور یک مقدار متفاوت ممکن است منجر به نتایج غیرمنتظره شود.

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

برای اطلاعات بیشتر، به راهنمای مجوز مراجعه کنید.