Method: contactGroups.get

يمكنك الحصول على مجموعة جهات اتصال محدَّدة يمتلكها المستخدم الذي تمت المصادقة عليه من خلال تحديد اسم مورد لمجموعة جهات الاتصال.

طلب HTTP

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

يستخدم عنوان URL بنية تحويل الترميز gRPC.

معلمات المسار

المَعلمات
resourceName

string

مطلوبة. اسم المورد لمجموعة جهات الاتصال التي تريد الحصول عليها.

معلمات طلب البحث

المَعلمات
maxMembers

integer

اختياريّ. تُحدِّد هذه السياسة الحد الأقصى لعدد الأعضاء المطلوب الانضمام إليهم. يتم ضبط القيمة تلقائيًا على 0 في حال عدم ضبطها، ما يؤدي إلى عدم عرض أي أعضاء.
groupFields

string (FieldMask format)

اختياريّ. قناع حقل لتقييد الحقول التي يتم عرضها في المجموعة ويتم ضبط الإعدادات التلقائية على metadata وgroupType وmemberCount وname إذا لم يتم ضبطها أو تم ضبطها على "فارغ". الحقول الصالحة هي:

  • clientData
  • groupType
  • memberCount
  • البيانات الوصفية
  • اسم

نص الطلب

يجب أن يكون نص الطلب فارغًا.

نص الاستجابة

إذا كانت الاستجابة ناجحة، يحتوي نص الاستجابة على مثال ContactGroup.

نطاقات التفويض

يتطلب استخدام أحد نطاقات OAuth التالية:

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

لمزيد من المعلومات، يُرجى الاطّلاع على دليل التفويض.