Method: people.batchUpdateContacts

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

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

בקשת 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
  • תחומי עניין
  • לוקאלים
  • locations
  • מועדוני חברים
  • miscKeywords
  • שמות
  • כינויים
  • מקצועות
  • ארגונים
  • phoneNumbers
  • קשרים
  • sipAddresses
  • כתובות אתרים
  • userDefined
readMask

string (FieldMask format)

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

  • כתובות
  • ageRanges
  • ביוגרפיות
  • ימי הולדת
  • calendarUrls
  • clientData
  • coverPhotos
  • emailAddresses
  • אירועים
  • externalIds
  • מינים
  • imClients
  • תחומי עניין
  • לוקאלים
  • locations
  • מועדוני חברים
  • מטא נתונים
  • miscKeywords
  • שמות
  • כינויים
  • מקצועות
  • ארגונים
  • phoneNumbers
  • תמונות, תצלומים, צילומים, פוטוס
  • קשרים
  • sipAddresses
  • מיומנויות
  • כתובות אתרים
  • 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

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