Method: users.sections.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

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

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

پارامترها
parent

string

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

  • نام مستعار « me . برای مثال، users/me .

  • آدرس ایمیل فضای کاری آنها. به عنوان مثال، users/user@example.com .

  • شناسه کاربری آنها. برای مثال، users/123456789 .

قالب: users/{user}

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

پارامترها
pageSize

integer

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

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

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

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

pageToken

string

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

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

درخواست بدنه

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

بدنه پاسخ

پیام پاسخ برای بخش‌های فهرست.

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

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

object ( Section )

بخش‌های مربوط به کاربر مشخص‌شده.

nextPageToken

string

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

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

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

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

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