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

גוף הבקשה

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

גוף התשובה

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

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

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

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