Method: contactGroups.batchGet

الحصول على قائمة بمجموعات جهات الاتصال التي يملكها المستخدم الذي تمت المصادقة عليه من خلال تحديد قائمة بأسماء موارد مجموعة جهات الاتصال

طلب HTTP

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

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

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

المَعلمات
resourceNames[]

string

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

هناك 200 اسم مورد بحدٍّ أقصى.
maxMembers

integer

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

string (FieldMask format)

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

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

نص الطلب

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

نص الاستجابة

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

إذا كانت الاستجابة ناجحة، سيحتوي نص الاستجابة على بيانات بالبنية التالية:

تمثيل 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)

مجموعة جهات الاتصال.