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 בבקשת get.
contactGroup.memberCount

integer

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

object (GroupClientData)

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

string (FieldMask format)

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

  • clientData
  • name
readGroupFields

string (FieldMask format)

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

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

גוף התשובה

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

היקפי הרשאות

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

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

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