Method: people.updateContact

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

השרת מחזיר שגיאה 400 אם לא צוין person.metadata.sources עבור איש הקשר לעדכון או אם לא קיים מקור איש קשר.

השרת מחזיר שגיאה 400 עם הסיבה "failedPrecondition" אם person.metadata.sources.etag שונה מה-etag של איש הקשר, דבר שמעיד על כך שאיש הקשר השתנה מאז שהנתונים שלו נקראו. לקוחות צריכים להשיג את המשתמש העדכני ביותר ולמזג את העדכונים שלהם לאדם העדכני ביותר.

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

השרת מחזיר שגיאה 400 אם מצוין יותר משדה אחד בשדה שהוא סינגלטון עבור מקורות של אנשי קשר:

  • ביוגרפיות
  • ימי הולדת
  • מינים
  • names

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

בקשת HTTP

PATCH https://people.googleapis.com/v1/{person.resourceName=people/*}:updateContact

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

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

פרמטרים
person.resourceName

string

שם המשאב של האדם, שהוקצה על ידי השרת. מחרוזת ASCII בצורת people/{person_id}.

פרמטרים של שאילתה

פרמטרים
updatePersonFields

string (FieldMask format)

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

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

string (FieldMask format)

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

  • כתובות
  • 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.

גוף הבקשה

גוף הבקשה מכיל מופע של Person.

גוף התשובה

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

היקפי הרשאות

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

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

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