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
  • מטא נתונים
  • שם

גוף הבקשה

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

גוף התשובה

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

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

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

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