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

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