Method: contactGroups.list

הצגת רשימה של כל קבוצות אנשי הקשר שבבעלות המשתמש המאומת. חברים בקבוצות אנשי קשר לא מאוכלסים.

בקשת HTTP

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

בכתובת ה-URL נעשה שימוש בתחביר המרת קידוד של gRPC.

פרמטרים של שאילתה

פרמטרים
pageToken

string

זה שינוי אופציונלי. הערך nextPageToken שהוחזר מקריאה קודמת אל contactGroups.list. המערכת מבקשת את דף המשאבים הבא.
pageSize

integer

זה שינוי אופציונלי. המספר המקסימלי של משאבים שיש להחזיר. הערכים החוקיים הם בין 1 ל-1,000, כולל. אם הפרמטר לא מוגדר או מוגדר ל-0, ברירת המחדל היא 30.
syncToken

string

זה שינוי אופציונלי. אסימון סנכרון שהוחזר על ידי קריאה קודמת אל contactgroups.list. יוחזרו רק משאבים שהשתנו מאז יצירת אסימון הסנכרון.
groupFields

string (FieldMask format)

זה שינוי אופציונלי. אנונימיזציה של שדות להגבלת השדות בקבוצה שמוחזרים. אם הפרמטר לא מוגדר או מוגדר כערך ריק, ברירת המחדל היא metadata, groupType, memberCount ו-name. השדות החוקיים הם:

  • clientData
  • groupType
  • memberCount
  • מטא נתונים
  • name

גוף הבקשה

גוף הבקשה חייב להיות ריק.

גוף התשובה

התשובה לבקשה של רשימה של אנשי קשר.

אם הפעולה בוצעה ללא שגיאות, גוף התשובה מכיל נתונים במבנה הבא:

ייצוג 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

למידע נוסף, עיינו במדריך ההרשאות.