Method: spaces.messagePins.list

پین‌های پیام را در یک فضا فهرست می‌کند. کاربران می‌توانند پیام‌های مهم را برای دسترسی آسان در فضاها پین کنند. برای اطلاعات بیشتر، به پین ​​کردن یا لغو پین کردن مکالمه در Google Chat مراجعه کنید.

نیاز به احراز هویت کاربر با یکی از حوزه‌های مجوز زیر دارد:

  • https://www.googleapis.com/auth/chat.spaces.pins.readonly
  • https://www.googleapis.com/auth/chat.spaces.pins
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.spaces

درخواست HTTP

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

این URL از سینتکس Transcoding در gRPC استفاده می‌کند.

پارامترهای مسیر

پارامترها
parent

string

الزامی. فضای والد که مالک مجموعه آیتم‌های پین‌شده است. قالب: spaces/{space}

پارامترهای پرس و جو

پارامترها
pageSize

integer

اختیاری. حداکثر تعداد پین‌های پیام برگشتی. سرویس ممکن است پیام‌های کمتری از این مقدار برگرداند. حداکثر مقدار ۱۰۰ است. اگر از مقداری بیش از ۱۰۰ استفاده کنید، به طور خودکار به ۱۰۰ تغییر می‌کند. اگر مشخص نشود، حداکثر ۱۰۰ پین پیام برگردانده می‌شود. مقادیر منفی خطای INVALID_ARGUMENT را برمی‌گردانند.

pageToken

string

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

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

درخواست بدنه

بدنه درخواست باید خالی باشد.

بدنه پاسخ

پیام پاسخ برای فهرست کردن پین‌های پیام.

در صورت موفقیت، بدنه پاسخ شامل داده‌هایی با ساختار زیر است:

نمایش JSON 
{
  "messagePins": [
    {
      object (MessagePin)
    }
  ],
  "nextPageToken": string
}
فیلدها
messagePins[]

object ( MessagePin )

پیام‌های پین‌شده از فضای مشخص‌شده.

nextPageToken

string

شما می‌توانید یک توکن به عنوان pageToken ارسال کنید تا صفحه بعدی نتایج را بازیابی کنید. اگر خالی باشد، صفحات بعدی وجود ندارند.

دامنه‌های مجوز

به یکی از حوزه‌های OAuth زیر نیاز دارد:

  • https://www.googleapis.com/auth/chat.spaces.pins
  • https://www.googleapis.com/auth/chat.spaces.pins.readonly
  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly

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