Method: people.searchContacts

提供经过身份验证的用户的分组联系人中与搜索查询匹配的联系人列表。该查询与来自 CONTACT 来源的联系人的 names、nickNames、emailAddresses、phoneNumbers 和 organizations 字段匹配。

重要提示：在搜索之前，客户端应发送包含空查询的预热请求以更新缓存。请参阅 https://developers.google.com/people/v1/contacts#search_the_users_contacts

HTTP 请求

GET https://people.googleapis.com/v1/people:searchContacts

网址采用 gRPC 转码语法。

查询参数

参数
query

string

必需。请求的纯文本查询。该查询用于匹配某个人的字段前缀短语。例如，名为“foo name”的人与诸如“f”“fo”“foo”“foo n”“nam”等的查询匹配，但与“oo n”等查询不匹配。
pageSize

integer

可选。要返回的结果数量。如果未设置字段，则默认为 10，或者设置为 0。大于 30 的值将限制为 30。
readMask

string (FieldMask format)

必需。字段掩码，用于限制返回每个人上的哪些字段。可以指定多个字段，用英文逗号分隔各个字段。有效值包括：

  • 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_CONTACT。

请求正文

请求正文必须为空。

响应正文

如果成功，则响应正文包含一个 SearchResponse 实例。

授权范围

需要以下 OAuth 范围之一：

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

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