Method: users.sections.items.list

موارد موجود در یک بخش را فهرست می‌کند.

در حال حاضر، فقط فاصله‌ها می‌توانند آیتم‌های بخش باشند. برای جزئیات بیشتر، به «ایجاد و سازماندهی بخش‌ها در گوگل چت» مراجعه کنید.

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

  • https://www.googleapis.com/auth/chat.users.sections
  • https://www.googleapis.com/auth/chat.users.sections.readonly

درخواست HTTP

GET https://chat.googleapis.com/v1/{parent=users/*/sections/*}/items

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

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

پارامترها
parent

string

الزامی. والد، که نام منبع بخش است و مالک این مجموعه از آیتم‌های بخش است. فقط از فهرست کردن آیتم‌های بخش برای کاربر فراخواننده پشتیبانی می‌کند.

قالب: users/{user}/sections/{section}

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

پارامترها
pageSize

integer

اختیاری. حداکثر تعداد آیتم‌های بخش برای برگرداندن. سرویس ممکن است کمتر از این مقدار را برگرداند.

در صورت عدم مشخص کردن، حداکثر 10 مورد از بخش‌ها بازگردانده خواهد شد.

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

مقادیر منفی خطای INVALID_ARGUMENT را برمی‌گردانند.

pageToken

string

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

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

filter

string

اختیاری. یک فیلتر پرس‌وجو.

در حال حاضر فقط از فیلتر کردن بر اساس فاصله پشتیبانی می‌کند.

برای مثال، space = spaces/{space} .

درخواست‌های نامعتبر با خطای INVALID_ARGUMENT رد می‌شوند.

درخواست بدنه

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

بدنه پاسخ

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

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

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

object ( SectionItem )

آیتم‌های بخش از بخش مشخص‌شده.

nextPageToken

string

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

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

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

  • https://www.googleapis.com/auth/chat.users.sections
  • https://www.googleapis.com/auth/chat.users.sections.readonly

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