创建一批新联系人,并为新联系人返回 PersonResponses
应按顺序发送针对同一用户的 mutate 请求,以避免延迟时间增加和失败增加。
HTTP 请求
POST https://people.googleapis.com/v1/people:batchCreateContacts
网址采用 gRPC 转码语法。
请求正文
请求正文中包含结构如下的数据:
JSON 表示法 |
---|
{ "contacts": [ { object ( |
字段 | |
---|---|
contacts[] |
必需。要创建的联系人。一次最多允许 200 个联系人。 |
readMask |
必需。字段掩码,用于限制在响应中返回每个人的哪些字段。可以指定多个字段,只需用逗号分隔即可。如果读取掩码留空,则会跳过 post-mutate-get,且不会在响应中返回任何数据。有效值包括:
|
sources[] |
可选。要在 post mutate 读取中返回的来源类型的掩码。如果未设置,则默认为 |
响应正文
如果未成功,则返回 BatchCreateContactsErrorDetails
,其中包含每个无效联系人的错误列表。
对创建一批联系人的请求的响应。
如果成功,响应正文将包含结构如下的数据:
JSON 表示法 |
---|
{
"createdPeople": [
{
object ( |
字段 | |
---|---|
createdPeople[] |
创建的联系人(除非请求 |
授权范围
需要以下 OAuth 范围:
https://www.googleapis.com/auth/contacts
有关详情,请参阅授权指南。
ContactToCreate
一个封装容器,其中包含用于填充新创建的来源的用户数据。
JSON 表示法 |
---|
{
"contactPerson": {
object ( |
字段 | |
---|---|
contactPerson |
必需。要填充新创建的来源的人员数据。 |