Method: contactGroups.get

כדי לקבל קבוצת אנשי קשר ספציפית שבבעלות המשתמש המאומת, צריך לציין שם משאב של קבוצת אנשי קשר.

בקשת HTTP

GET https://people.googleapis.com/v1/{resourceName=contactGroups/*}

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

פרמטרים של נתיב

פרמטרים
resourceName

string

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

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

פרמטרים
maxMembers

integer

זה שינוי אופציונלי. מציין את המספר המקסימלי של חברים שיש להחזיר. אם הפרמטר לא מוגדר, ערך ברירת המחדל שלו הוא 0, וכך הפונקציה מחזירה אפס איברים.
groupFields

string (FieldMask format)

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

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

גוף הבקשה

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

גוף התשובה

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

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

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

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