Method: contactGroups.list

لیست تمام گروه های تماس متعلق به کاربر تایید شده. اعضای گروه های تماس پرجمعیت نیستند.

درخواست HTTP

GET https://people.googleapis.com/v1/contactGroups

URL از دستور GRPC Transcoding استفاده می کند.

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

پارامترها
pageToken

string

اختیاری. مقدار nextPageToken از تماس قبلی به contactGroups.list برگردانده شد. صفحه بعدی منابع را درخواست می کند.

pageSize

integer

اختیاری. حداکثر تعداد منابع برای بازگشت. مقادیر معتبر شامل 1 تا 1000 است. اگر تنظیم نشده باشد 30 پیش‌فرض می‌شود یا روی 0 تنظیم می‌شود.

syncToken

string

اختیاری. یک نشانه همگام‌سازی که با تماس قبلی به contactgroups.list برگردانده شده است. فقط منابعی که از زمان ایجاد نشانه همگام‌سازی تغییر کرده‌اند بازگردانده می‌شوند.

groupFields

string ( FieldMask format)

اختیاری. یک فیلد ماسک برای محدود کردن اینکه کدام فیلدها در گروه بازگردانده شوند. پیش‌فرض metadata ، groupType ، memberCount و name اگر تنظیم نشده باشد یا خالی باشد. فیلدهای معتبر عبارتند از:

  • کلاینت دیتا
  • نوع گروه
  • تعداد اعضا
  • ابرداده
  • نام

درخواست بدن

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

بدن پاسخگو

پاسخ به یک لیست درخواست گروه های مخاطب.

در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی داده هایی با ساختار زیر است:

نمایندگی JSON 
{
  "contactGroups": [
    {
      object (ContactGroup)
    }
  ],
  "totalItems": integer,
  "nextPageToken": string,
  "nextSyncToken": string
}
فیلدها
contactGroups[]

object ( ContactGroup )

لیست گروه های تماس اعضای گروه های تماس پرجمعیت نیستند.

totalItems

integer

تعداد کل موارد موجود در لیست بدون صفحه بندی.

nextPageToken

string

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

nextSyncToken

string

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

محدوده مجوز

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

  • https://www.googleapis.com/auth/contacts
  • https://www.googleapis.com/auth/contacts.readonly

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