針對已更新的聯絡人更新大量聯絡人,並將資源名稱對應關係傳回到 PersonResponses。
請為同一位使用者依序傳送 Mutate 要求,以避免延遲時間增加和失敗。
HTTP 要求
POST https://people.googleapis.com/v1/people:batchUpdateContacts
這個網址使用 gRPC 轉碼語法。
要求主體
要求主體的資料會採用以下結構:
JSON 表示法 |
---|
{ "contacts": { string: { object ( |
欄位 | |
---|---|
contacts |
必要欄位。將資源名稱對應到要更新的個人資料。每個要求最多可包含 200 位聯絡人。 這個物件中包含 |
updateMask |
必要欄位。欄位遮罩可限制使用者要更新哪些欄位。如要指定多個欄位,請用半形逗號分隔。系統會替換所有指定的欄位,如果每位使用者的留空,系統就會清除這些欄位。以下為有效值:
|
readMask |
必要欄位。欄位遮罩,用於限制傳回每個人上的欄位。如要指定多個欄位,請用半形逗號分隔。如果將讀取遮罩留空,系統會略過-change-change-get 參數,也不會在回應中傳回任何資料。以下為有效值:
|
sources[] |
選用設定。要傳回哪些來源類型的遮罩。如未設定,預設值為 |
回應主體
如果失敗,則傳回 BatchUpdateContactsErrorDetails
,系統會列出與每位聯絡人相關的錯誤清單。
對大量聯絡人更新要求的回應。
如果成功,回應主體即會包含具有以下結構的資料:
JSON 表示法 |
---|
{
"updateResult": {
string: {
object ( |
欄位 | |
---|---|
updateResult |
將資源名稱對應至已更新的聯絡人 (除非要求 這個物件中包含 |
授權範圍
需要下列 OAuth 範圍:
https://www.googleapis.com/auth/contacts
詳情請參閱授權指南。