更新現有聯絡人的聯絡人資料。但不會修改任何非聯絡人的資料。系統將忽略所有更新對象的非聯絡人資料。系統將取代在 updateMask
中指定的所有欄位。
如果沒有指定聯絡人的 person.metadata.sources
,或是沒有聯絡人來源,伺服器會傳回 400 錯誤。
如果 person.metadata.sources.etag
與聯絡人的 etag 不同,伺服器會傳回 400 錯誤,原因為 "failedPrecondition"
,這表示聯絡人在讀取資料後有所變更。客戶應取得最新人員,並將他們的更新內容合併至最新人員。
如果 memberships
在更新且尚未指定聯絡人群組成員,則伺服器會傳回 400 錯誤。
如果在聯絡人來源的單一欄位中指定多個欄位,伺服器會傳回 400 錯誤:
- 傳記
- 生日
- 性別
- names
建議您依序傳送相同使用者的變更要求,以避免延遲和失敗。
HTTP 要求
PATCH https://people.googleapis.com/v1/{person.resourceName=people/*}:updateContact
這個網址使用 gRPC 轉碼語法。
路徑參數
參數 | |
---|---|
person.resourceName |
由伺服器指派的資源名稱,ASCII 字串,格式為 |
查詢參數
參數 | |
---|---|
updatePersonFields |
必要欄位。欄位遮罩,用於限制使用者更新的欄位。如要指定多個欄位,請以半形逗號加以分隔。系統將更新所有更新的欄位。以下為有效值:
|
personFields |
選用,欄位遮罩,以限制每位使用者傳回哪些欄位。如要指定多個欄位,請以半形逗號加以分隔。如未設定,則預設為所有欄位。以下為有效值:
|
sources[] |
選用,要傳回的來源類型遮罩。如果未設定,將預設為 |
要求主體
要求主體包含 Person
的例項。
回應主體
如果成功,回應主體會包含 Person
的執行例項。
授權範圍
需要下列 OAuth 範圍:
https://www.googleapis.com/auth/contacts
詳情請參閱授權指南。