更新一批联系人,并为更新后的联系人返回资源名称映射至 PersonResponses。
应按顺序发送同一用户的 mutate 请求,以避免延迟时间增加和失败。
HTTP 请求
POST https://people.googleapis.com/v1/people:batchUpdateContacts
网址采用 gRPC 转码语法。
请求正文
请求正文中包含结构如下的数据:
JSON 表示法 |
---|
{ "contacts": { string: { object ( |
字段 | |
---|---|
contacts |
必需。资源名称与要更新的个人数据的映射。在一个请求中最多可以包含 200 个联系人。 包含一系列 |
updateMask |
必需。用于限制要更新人员内哪些字段的字段掩码。可以指定多个字段,用英文逗号分隔各个字段。对于每个人,所有指定的字段都将被替换,或者留空。有效值包括:
|
readMask |
必需。字段掩码,用于限制返回每个人上的哪些字段。可以指定多个字段,用英文逗号分隔各个字段。如果读取掩码留空,则系统会跳过 post-mutate-get,响应中不会返回任何数据。有效值包括:
|
sources[] |
可选。要返回哪些来源类型的掩码。如果未设置,则默认为 |
响应正文
如果不成功,则返回 BatchUpdateContactsErrorDetails
(与每个联系人对应的错误列表)。
对更新一批联系人的请求的响应。
如果成功,响应正文将包含结构如下的数据:
JSON 表示法 |
---|
{
"updateResult": {
string: {
object ( |
字段 | |
---|---|
updateResult |
资源名称到已更新的联系人的映射,除非请求 包含一系列 |
授权范围
需要以下 OAuth 作用域:
https://www.googleapis.com/auth/contacts
有关详情,请参阅授权指南。