Method: contactGroups.batchGet

با مشخص کردن لیستی از نام منابع گروه تماس، فهرستی از گروه های مخاطب متعلق به کاربر تأیید شده را دریافت کنید.

درخواست HTTP

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

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

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

پارامترها
resourceNames[]

string

مورد نیاز. نام منابع گروه های تماس را دریافت کنید.

حداکثر 200 نام منبع وجود دارد.

maxMembers

integer

اختیاری. حداکثر تعداد اعضا را برای بازگشت برای هر گروه مشخص می کند. در صورت تنظیم نشدن، به طور پیش‌فرض به 0 می‌رسد که صفر عضو را برمی‌گرداند.

groupFields

string ( FieldMask format)

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

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

درخواست بدن

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

بدن پاسخگو

پاسخ به درخواست گروه های تماس دریافت دسته ای.

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

نمایندگی JSON 
{
  "responses": [
    {
      object (ContactGroupResponse)
    }
  ]
}
فیلدها
responses[]

object ( ContactGroupResponse )

لیست پاسخ ها برای هر منبع گروه تماس درخواستی.

محدوده مجوز

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

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

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

ContactGroupResponse

پاسخ برای یک گروه تماس خاص.

نمایندگی JSON 
{
  "requestedResourceName": string,
  "status": {
    object (Status)
  },
  "contactGroup": {
    object (ContactGroup)
  }
}
فیلدها
requestedResourceName

string

نام منبع درخواستی اصلی

status

object ( Status )

وضعیت پاسخ.

contactGroup

object ( ContactGroup )

گروه تماس.