Method: people.batchUpdateContacts

更新一批联系人，并将资源名称映射返回到更新后的联系人的 PersonResponses。

应按顺序发送针对同一用户的 mutate 请求，以避免延迟时间增加和失败增加。

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
  • 地理位置
  • memberships
  • miscKeywords
  • 名字
  • 昵称
  • 职业
  • 组织
  • phoneNumbers
  • 关系
  • sipAddresses
  • 网址
  • userDefined
readMask

string (FieldMask format)

必需。字段掩码，用于限制返回每个人的哪些字段。可以指定多个字段，只需用逗号分隔即可。如果读取掩码留空，则会跳过 post-mutate-get，且不会在响应中返回任何数据。有效值包括：

  • addresses
  • ageRanges
  • 传记
  • 生日
  • calendarUrls
  • clientData
  • coverPhotos
  • emailAddresses
  • 活动
  • externalIds
  • 性别
  • imClients
  • 兴趣
  • locales
  • 地理位置
  • memberships
  • 元数据
  • 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

有关详情，请参阅授权指南。