Method: people.updateContact

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

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

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

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

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

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

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

בקשת 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
  • כתובות אימייל
  • אירועים
  • מזהה חיצוני
  • מינים
  • imClients
  • תחומי עניין
  • לוקאלים
  • locations
  • מינויים
  • מילות מפתח שונות
  • שמות
  • כינויים
  • מקצועות
  • ארגונים
  • מספרי טלפון
  • יחסים
  • כתובות
  • כתובות אתרים
  • בהגדרת משתמש
personFields

string (FieldMask format)

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

  • כתובות
  • טווחי גילאים
  • ביוגרפיות
  • ימי הולדת
  • calendarUrls
  • clientData
  • תמונות שער
  • כתובות אימייל
  • אירועים
  • מזהה חיצוני
  • מינים
  • imClients
  • תחומי עניין
  • לוקאלים
  • locations
  • מינויים
  • מטא נתונים
  • מילות מפתח שונות
  • שמות
  • כינויים
  • מקצועות
  • ארגונים
  • מספרי טלפון
  • תמונות, תצלומים, צילומים, פוטוס
  • יחסים
  • כתובות
  • מיומנויות
  • כתובות אתרים
  • בהגדרת משתמש
sources[]

enum (ReadSourceType)

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

גוף הבקשה

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

גוף התשובה

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

היקפי הרשאה

ההגדרה הזו מחייבת את היקפי ההרשאות הבאים של OAuth:

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

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