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)

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