Method: people.batchCreateContacts

创建一批新联系人,并为新联系人返回 PersonResponses。

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

HTTP 请求

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

网址采用 gRPC 转码语法。

请求正文

请求正文中包含结构如下的数据:

JSON 表示法
{
  "contacts": [
    {
      object (ContactToCreate)
    }
  ],
  "readMask": string,
  "sources": [
    enum (ReadSourceType)
  ]
}
字段
contacts[]

object (ContactToCreate)

必需。要创建的联系人。在一个请求中最多可以包含 200 个联系人。

readMask

string (FieldMask format)

必需。字段掩码,用于限制响应中返回每个人上的哪些字段。可以指定多个字段,用英文逗号分隔各个字段。如果读取掩码留空,则系统会跳过 post-mutate-get,响应中不会返回任何数据。有效值包括:

  • addresses
  • ageRanges
  • 传记
  • 生日
  • calendarUrls
  • clientData
  • coverPhotos
  • emailAddresses
  • events
  • externalIds
  • 性别
  • imClients
  • 兴趣
  • locales
  • 位置
  • memberships
  • 元数据
  • miscKeywords
  • names
  • 昵称
  • 职业
  • organizations
  • phoneNumbers
  • 照片
  • 关系
  • sipAddresses
  • skills
  • urls
  • userDefined
sources[]

enum (ReadSourceType)

可选。在 mutate 读取后要返回的来源类型的掩码。如果未设置,则默认为 READ_SOURCE_TYPE_CONTACTREAD_SOURCE_TYPE_PROFILE

响应正文

如果失败,则返回 BatchCreateContactsErrorDetails,其中包含每个无效联系人的错误列表。

对创建一批联系人的请求的响应。

如果成功,响应正文将包含结构如下的数据:

JSON 表示法
{
  "createdPeople": [
    {
      object (PersonResponse)
    }
  ]
}
字段
createdPeople[]

object (PersonResponse)

已创建的联系人,除非请求 readMask 为空。

授权范围

需要以下 OAuth 作用域:

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

有关详情,请参阅授权指南

ContactToCreate

包含用于填充新创建的来源的个人数据的封装容器。

JSON 表示法
{
  "contactPerson": {
    object (Person)
  }
}
字段
contactPerson

object (Person)

必需。用于填充新创建的来源的个人数据。