Method: contactGroups.get

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

درخواست HTTP

GET https://people.googleapis.com/v1/{resourceName=contactGroups/*}

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

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

مولفه های
resourceName

string

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

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

مولفه های
maxMembers

integer

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

groupFields

string ( FieldMask format)

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

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

درخواست بدن

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

بدن پاسخگو

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

محدوده مجوز

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

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

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