עדכון הפרטים ליצירת קשר של איש קשר קיים. נתונים שלא קשורים ליצירת קשר לא ישתנו. המערכת תתעלם מכל נתון של איש הקשר שאינו פרט ליצירת קשר. כל השדות שצוינו ב-updateMask
יוחלפו.
השרת מחזיר שגיאה 400 אם לא צוין person.metadata.sources
של איש הקשר שרוצים לעדכן, או אם אין מקור ליצירת קשר.
השרת מחזיר שגיאה 400 עם הסיבה "failedPrecondition"
אם הערך של person.metadata.sources.etag
שונה מה-etag של איש הקשר, כלומר איש הקשר השתנה מאז שהנתונים שלו נקראו. הלקוחות צריכים לקבל את האדם העדכני ביותר ולמזג את העדכונים שלהם עם האדם העדכני ביותר. אם מבצעים עדכונים רצופים לאותו אדם, צריך להשתמש ב-etag מהתגובה updateContact
כדי למנוע כשלים.
השרת מחזיר שגיאה 400 אם מתבצע עדכון של memberships
ואין למשתמש חברות בקבוצות של אנשי קשר.
השרת מחזיר שגיאה 400 אם צוין יותר משדה אחד בשדה שהוא יחיד עבור מקורות של אנשי קשר:
- ביוגרפיות
- ימי הולדת
- מינים
- שמות
כדי למנוע עלייה בזמן האחזור ובמספר הכשלים, צריך לשלוח בקשות לשינוי של אותו משתמש ברצף.
בקשת HTTP
PATCH https://people.googleapis.com/v1/{person.resourceName=people/*}:updateContact
כתובת ה-URL משתמשת בתחביר של Transcoding של gRPC.
פרמטרים של נתיב
פרמטרים | |
---|---|
person.resourceName |
שם המשאב של האדם, שהוקצה על ידי השרת. מחרוזת ASCII בפורמט |
פרמטרים של שאילתה
פרמטרים | |
---|---|
updatePersonFields |
חובה. אנונימיזציה של שדות כדי להגביל את השדות של האדם שעודכנו. אפשר לציין כמה שדות ולהפריד ביניהם באמצעות פסיקים. כל השדות המעודכנים יוחלפו. הערכים החוקיים כוללים:
|
personFields |
אופציונלי. מסכת שדות כדי להגביל את השדות של כל אדם שיוחזרו. אפשר לציין כמה שדות ולהפריד ביניהם באמצעות פסיקים. אם לא מגדירים ערך, ברירת המחדל היא כל השדות. הערכים החוקיים כוללים:
|
sources[] |
אופציונלי. מסכה של סוגי המקורות להחזרה. אם הפרמטר לא הוגדר, ערכי ברירת המחדל שלו הם |
גוף הבקשה
גוף הבקשה מכיל מופע של Person
.
גוף התשובה
אם הפעולה מצליחה, גוף התגובה מכיל מופע של Person
.
היקפי הרשאה
נדרשת הרשאת OAuth ברמת ההיקף הבאה:
https://www.googleapis.com/auth/contacts
מידע נוסף זמין במדריך ההרשאות.