Method: people.updateContactPhoto

更新联系人的照片。

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

HTTP 请求

PATCH https://people.googleapis.com/v1/{resourceName=people/*}:updateContactPhoto

网址采用 gRPC 转码语法。

路径参数

参数
resourceName

string

必需。人员资源名称

请求正文

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

JSON 表示法
{
  "photoBytes": string,
  "personFields": string,
  "sources": [
    enum (ReadSourceType)
  ]
}
字段
photoBytes

string (bytes format)

必需。原始照片字节数

使用 base64 编码的字符串。

personFields

string (FieldMask format)

可选。字段掩码,用于限制返回人员上的哪些字段。可以指定多个字段,用英文逗号分隔各个字段。如果未设置,则默认为空,这样会跳过 mutate 获取操作。有效值包括:

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

enum (ReadSourceType)

可选。要返回哪些来源类型的掩码。如果未设置,则默认为 READ_SOURCE_TYPE_CONTACTREAD_SOURCE_TYPE_PROFILE

响应正文

对更新联系人照片的响应。

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

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

object (Person)

更新后的人员(如果在 UpdateContactPhotoRequest 中设置了 personField);否则将取消设置。

授权范围

需要以下 OAuth 作用域:

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

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