הצגת רשימה של כל קבוצות אנשי הקשר שבבעלות המשתמש המאומת. חברים בקבוצות אנשי קשר לא מאוכלסים.
בקשת HTTP
GET https://people.googleapis.com/v1/contactGroups
בכתובת ה-URL נעשה שימוש בתחביר המרת קידוד של gRPC.
פרמטרים של שאילתה
פרמטרים | |
---|---|
pageToken |
זה שינוי אופציונלי. הערך nextPageToken שהוחזר מקריאה קודמת אל contactGroups.list. המערכת מבקשת את דף המשאבים הבא. |
pageSize |
זה שינוי אופציונלי. המספר המקסימלי של משאבים שיש להחזיר. הערכים החוקיים הם בין 1 ל-1,000, כולל. אם הפרמטר לא מוגדר או מוגדר ל-0, ברירת המחדל היא 30. |
syncToken |
זה שינוי אופציונלי. אסימון סנכרון שהוחזר על ידי קריאה קודמת אל |
groupFields |
זה שינוי אופציונלי. אנונימיזציה של שדות להגבלת השדות בקבוצה שמוחזרים. אם הפרמטר לא מוגדר או מוגדר כערך ריק, ברירת המחדל היא
|
גוף הבקשה
גוף הבקשה חייב להיות ריק.
גוף התשובה
התשובה לבקשה של רשימה של אנשי קשר.
אם הפעולה בוצעה ללא שגיאות, גוף התשובה מכיל נתונים במבנה הבא:
ייצוג JSON |
---|
{
"contactGroups": [
{
object ( |
שדות | |
---|---|
contactGroups[] |
רשימת הקבוצות של אנשי הקשר. חברים בקבוצות אנשי קשר לא מאוכלסים. |
totalItems |
המספר הכולל של הפריטים ברשימה ללא עימוד. |
nextPageToken |
האסימון שניתן להשתמש בו כדי לאחזר את דף התוצאות הבא. |
nextSyncToken |
האסימון שאפשר להשתמש בו כדי לאחזר שינויים מאז הבקשה האחרונה. |
היקפי הרשאות
נדרש אחד מהיקפי ההרשאות הבאים של OAuth:
https://www.googleapis.com/auth/contacts
https://www.googleapis.com/auth/contacts.readonly
למידע נוסף, עיינו במדריך ההרשאות.