Method: people.batchUpdateContacts

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

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

בקשת HTTP

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

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

גוף הבקשה

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

ייצוג JSON 
{
  "contacts": {
    string: {
      object (Person)
    },
    ...
  },
  "updateMask": string,
  "readMask": string,
  "sources": [
    enum (ReadSourceType)
  ]
}
שדות
contacts

map (key: string, value: object (Person))

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

אובייקט שמכיל רשימה של "key": value זוגות. לדוגמה: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
updateMask

string (FieldMask format)

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

  • כתובות
  • ביוגרפיות
  • ימי הולדת
  • calendarUrls
  • clientData
  • emailAddresses
  • אירועים
  • externalIds
  • מינים
  • imClients
  • תחומי עניין
  • locales
  • locations
  • מינויים
  • miscKeywords
  • names
  • כינויים
  • מקצועות
  • organizations
  • phoneNumbers
  • יחסים
  • sipAddresses
  • urls
  • userDefined
readMask

string (FieldMask format)

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

  • כתובות
  • ageRanges
  • ביוגרפיות
  • ימי הולדת
  • calendarUrls
  • clientData
  • coverPhotos
  • emailAddresses
  • אירועים
  • externalIds
  • מינים
  • imClients
  • תחומי עניין
  • locales
  • locations
  • מינויים
  • מטא נתונים
  • miscKeywords
  • names
  • כינויים
  • מקצועות
  • organizations
  • phoneNumbers
  • תמונות, תצלומים, צילומים, פוטוס
  • יחסים
  • sipAddresses
  • מיומנויות
  • urls
  • userDefined
sources[]

enum (ReadSourceType)

זה שינוי אופציונלי. מסכה של סוגי המקורות שיש להחזיר. אם המדיניות לא מוגדרת, ברירת המחדל היא READ_SOURCE_TYPE_CONTACT ו-READ_SOURCE_TYPE_PROFILE.

גוף התשובה

אם הפעולה לא בוצעה בהצלחה, מוחזר BatchUpdateContactsErrorDetails, רשימת שגיאות התואמת לכל איש קשר.

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

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

ייצוג JSON 
{
  "updateResult": {
    string: {
      object (PersonResponse)
    },
    ...
  }
}
שדות
updateResult

map (key: string, value: object (PersonResponse))

מפה של שמות המשאבים של אנשי הקשר שעודכנו, אלא אם הבקשה readMask ריקה.

אובייקט שמכיל רשימה של "key": value זוגות. לדוגמה: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

היקפי הרשאות

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

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

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