Method: people.batchUpdateContacts

更新一批聯絡人，並將資源名稱對應傳回給已更新聯絡人的 PersonResponses。

請依序傳送對同一位使用者的變動要求，以免增加延遲時間和失敗。

HTTP 要求

POST https://people.googleapis.com/v1/people:batchUpdateContacts

這個網址使用 gRPC 轉碼語法。

要求主體

要求主體的資料會採用以下結構：

JSON 表示法 
{
  "contacts": {
    string: {
      object (Person)
    },
    ...
  },
  "updateMask": string,
  "readMask": string,
  "sources": [
    enum (ReadSourceType)
  ]
}
欄位
contacts

map (key: string, value: object (Person))

必要欄位。將要更新使用者資料的資源名稱對應。單次要求最多可允許 200 位聯絡人。

這個物件中包含 "key": value 組合的清單，範例：{ "name": "wrench", "mass": "1.3kg", "count": "3" }。
updateMask

string (FieldMask format)

必要欄位。欄位遮罩，可限制要更新人員上的哪些欄位。如要指定多個欄位，請以半形逗號分隔。系統會替換所有指定欄位，或將所有使用者留空。有效值如下：

  • addresses
  • 傳記
  • 生日
  • calendarUrls
  • clientData
  • emailAddresses
  • 活動
  • externalIds
  • 性別
  • imClients
  • 興趣
  • locales
  • 位置
  • 會籍
  • miscKeywords
  • 名稱
  • 暱稱
  • 職業
  • 機構組織
  • phoneNumbers
  • 關係
  • sipAddresses
  • 網址
  • userDefined
readMask

string (FieldMask format)

必要欄位。欄位遮罩可限制系統傳回每個人的哪些欄位。如要指定多個欄位，請以半形逗號分隔。如果讀取遮罩為空白，就會略過 post-mut-get，且回應中不會傳回任何資料。有效值如下：

  • addresses
  • ageRanges
  • 傳記
  • 生日
  • calendarUrls
  • clientData
  • coverPhotos
  • emailAddresses
  • 活動
  • externalIds
  • 性別
  • imClients
  • 興趣
  • locales
  • 位置
  • 會籍
  • 中繼資料
  • miscKeywords
  • 名稱
  • 暱稱
  • 職業
  • 機構組織
  • phoneNumbers
  • 相片
  • 關係
  • sipAddresses
  • skills
  • 網址
  • userDefined
sources[]

enum (ReadSourceType)

選用設定。指定要傳回哪些來源類型的遮罩。如果未設定，預設為 READ_SOURCE_TYPE_CONTACT 和 READ_SOURCE_TYPE_PROFILE。

回應主體

如果失敗，系統會傳回 BatchUpdateContactsErrorDetails，其中包含每個聯絡人的對應錯誤清單。

更新批次聯絡人要求的回應。

如果成功，回應主體會含有以下結構的資料：

JSON 表示法 
{
  "updateResult": {
    string: {
      object (PersonResponse)
    },
    ...
  }
}
欄位
updateResult

map (key: string, value: object (PersonResponse))

與已更新聯絡人的資源名稱對應 (除非 readMask 要求為空白)。

這個物件中包含 "key": value 組合的清單，範例：{ "name": "wrench", "mass": "1.3kg", "count": "3" }。

授權範圍

需要下列 OAuth 範圍：

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

詳情請參閱授權指南。