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

גוף התשובה

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

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

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

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

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