Method: contactGroups.batchGet

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

בקשת HTTP

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

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

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

פרמטרים
resourceNames[]

string

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

אפשר ליצור עד 200 שמות של משאבים.
maxMembers

integer

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

string (FieldMask format)

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

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

גוף הבקשה

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

גוף התשובה

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

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

ייצוג JSON 
{
  "responses": [
    {
      object (ContactGroupResponse)
    }
  ]
}
שדות
responses[]

object (ContactGroupResponse)

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

היקפי ההרשאות

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

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

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

ContactGroupResponse

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

ייצוג JSON 
{
  "requestedResourceName": string,
  "status": {
    object (Status)
  },
  "contactGroup": {
    object (ContactGroup)
  }
}
שדות
requestedResourceName

string

שם המשאב המבוקש המקורי.
status

object (Status)

הסטטוס של התגובה.
contactGroup

object (ContactGroup)

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