קבלת רשימה של קבוצות אנשי קשר שבבעלות המשתמש המאומת על ידי ציון רשימה של שמות המשאבים של קבוצת אנשי הקשר.
בקשת HTTP
GET https://people.googleapis.com/v1/contactGroups:batchGet
בכתובת ה-URL נעשה שימוש בתחביר המרת קידוד של gRPC.
פרמטרים של שאילתה
פרמטרים | |
---|---|
resourceNames[] |
חובה. שמות המשאבים של קבוצות אנשי הקשר שמקבלים. יש עד 200 שמות של משאבים. |
maxMembers |
זה שינוי אופציונלי. מציין את המספר המקסימלי של חברים שיש להחזיר בכל קבוצה. אם הפרמטר לא מוגדר, ערך ברירת המחדל שלו הוא 0, וכך הפונקציה מחזירה אפס איברים. |
groupFields |
זה שינוי אופציונלי. אנונימיזציה של שדות להגבלת השדות בקבוצה שמוחזרים. אם הפרמטר לא מוגדר או מוגדר כערך ריק, ברירת המחדל היא
|
גוף הבקשה
גוף הבקשה חייב להיות ריק.
גוף התשובה
התשובה לבקשה לקבלת קבוצות של אנשי קשר באצווה.
אם הפעולה בוצעה ללא שגיאות, גוף התשובה מכיל נתונים במבנה הבא:
ייצוג JSON |
---|
{
"responses": [
{
object ( |
שדות | |
---|---|
responses[] |
רשימת התשובות לכל משאב מבוקש של קבוצת אנשי קשר. |
היקפי הרשאות
נדרש אחד מהיקפי ההרשאות הבאים של OAuth:
https://www.googleapis.com/auth/contacts
https://www.googleapis.com/auth/contacts.readonly
למידע נוסף, עיינו במדריך ההרשאות.
ContactGroupResponse
התשובה לקבוצת אנשי קשר ספציפית.
ייצוג JSON |
---|
{ "requestedResourceName": string, "status": { object ( |
שדות | |
---|---|
requestedResourceName |
שם המשאב המקורי המבוקש. |
status |
הסטטוס של התגובה. |
contactGroup |
הקבוצה של אנשי הקשר. |