Method: contactGroups.list

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

طلب HTTP

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

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

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

المَعلمات
pageToken

string

اختياريّ. قيمة nextPageToken التي تم إرجاعها من استدعاء سابق إلى contactGroups.list. لطلب الصفحة التالية من الموارد.
pageSize

integer

اختياريّ. الحد الأقصى لعدد الموارد المطلوب عرضها. تتراوح القيم الصالحة بين 1 و1000، بشكل شامل. يتم ضبط القيمة على 30 تلقائيًا إذا لم يتم ضبطها أو تم ضبطها على 0.
syncToken

string

اختياريّ. رمز مميز للمزامنة، تم عرضه من خلال مكالمة سابقة إلى contactgroups.list. سيتم عرض الموارد التي تم تغييرها منذ إنشاء الرمز المميّز للمزامنة فقط.
groupFields

string (FieldMask format)

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

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

نص الطلب

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

نص الاستجابة

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

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

تمثيل JSON 
{
  "contactGroups": [
    {
      object (ContactGroup)
    }
  ],
  "totalItems": integer,
  "nextPageToken": string,
  "nextSyncToken": string
}
الحقول
contactGroups[]

object (ContactGroup)

قائمة مجموعات جهات الاتصال. لا تتم تعبئة أعضاء مجموعات جهات الاتصال.
totalItems

integer

إجمالي عدد العناصر في القائمة بدون التقسيم على صفحات.
nextPageToken

string

الرمز المميز الذي يمكن استخدامه لاسترداد الصفحة التالية من النتائج.
nextSyncToken

string

الرمز المميّز الذي يمكن استخدامه لاسترداد التغييرات منذ آخر طلب.

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

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

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

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