Method: otherContacts.search

提供已验证用户的其他联系人中与搜索查询匹配的联系人列表。该查询与来自 OTHER_CONTACT 来源的联系人 names、emailAddresses 和 phoneNumbers 字段匹配。

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

HTTP 请求

GET https://people.googleapis.com/v1/otherContacts:search

网址采用 gRPC 转码语法。

查询参数

参数
query

string

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

integer

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

string (FieldMask format)

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

  • emailAddresses
  • 元数据
  • names
  • phoneNumbers

请求正文

请求正文必须为空。

响应正文

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

授权范围

需要以下 OAuth 作用域：

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

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