Method: contactGroups.create

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

השמות של קבוצות אנשי הקשר שאתם יוצרים חייבים להיות ייחודיים לקבוצות של אנשי הקשר של המשתמשים. ניסיון ליצור קבוצה עם שם כפול יחזיר שגיאת HTTP 409.

בקשות לשינוי עבור אותו משתמש צריכות להישלח ברצף כדי למנוע זמן אחזור ארוך יותר וכשלים.

בקשת HTTP

POST https://people.googleapis.com/v1/contactGroups

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

גוף הבקשה

גוף הבקשה מכיל נתונים במבנה הבא:

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

object (ContactGroup)

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

string (FieldMask format)

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

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

גוף התשובה

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

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

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

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