Method: contactGroups.update

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

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

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

בקשת HTTP

PUT https://people.googleapis.com/v1/{contactGroup.resourceName=contactGroups/*}

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

פרמטרים של נתיב

פרמטרים
contactGroup.resourceName

string

שם המשאב של קבוצת אנשי הקשר, שהוקצה על ידי השרת. מחרוזת ASCII, בפורמט contactGroups/{contactGroupId}.

גוף הבקשה

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

ייצוג JSON 
{
  "contactGroup": {
    "resourceName": string,
    "etag": string,
    "metadata": {
      "updateTime": string,
      "deleted": boolean
    },
    "groupType": enum (GroupType),
    "name": string,
    "formattedName": string,
    "memberResourceNames": [
      string
    ],
    "memberCount": integer,
    "clientData": [
      {
        "key": string,
        "value": string
      }
    ]
  },
  "updateGroupFields": string,
  "readGroupFields": string
}
שדות
contactGroup.etag

string

תג ישות ה-HTTP של המשאב. משמש לאימות מטמון אינטרנט.
contactGroup.metadata

object (ContactGroupMetadata)

פלט בלבד. מטא-נתונים על קבוצת אנשי הקשר.
contactGroup.groupType

enum (GroupType)

פלט בלבד. הסוג של קבוצת אנשי הקשר.
contactGroup.name

string

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

ב-contactGroups.create או ב-contactGroups.update, השם חייב להיות ייחודי לקבוצות של אנשי הקשר של המשתמשים. ניסיון ליצור קבוצה עם שם כפול יחזיר שגיאת HTTP 409.
contactGroup.formattedName

string

פלט בלבד. השם מתורגם ומפורמט לפי הלוקאל של החשבון של הצופה או לפי הלוקאל של כותרת ה-HTTP Accept-Language לשמות של קבוצות המערכת. שמות קבוצה שהוגדרו על ידי הבעלים זהים לשמות.
contactGroup.memberResourceNames[]

string

פלט בלבד. רשימת שמות המשאבים של אנשי הקשר שחברים בקבוצה של אנשי הקשר. השדה יאוכלס רק בבקשות GET והוא יחזיר רק חברים רבים שמצוינים ב-maxMembers בבקשת השליפה.
contactGroup.memberCount

integer

פלט בלבד. המספר הכולל של אנשי קשר בקבוצה, ללא קשר למספר החברים המקסימלי שצוין בבקשה.
contactGroup.clientData[]

object (GroupClientData)

נתוני הלקוח של הקבוצה.
updateGroupFields

string (FieldMask format)

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

  • clientData
  • שם
readGroupFields

string (FieldMask format)

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

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

גוף התשובה

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

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

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

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

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