Method: otherContacts.list

列出“其他联系人”,即不在联系人群组中的联系人。“其他联系人”通常是根据互动自动创建的联系人。

同步令牌会在完全同步的 7 天后过期。包含过期同步令牌的请求将收到 google.rpc.ErrorInfo 错误,原因为“EXPIRED_SYNC_TOKEN”。如果出现此类错误,客户端应发出不带 syncToken 的完整同步请求。

完整同步请求的第一页有额外的配额。如果超出配额,将返回 429 错误。此配额是固定的,无法增加。

指定 syncToken 后,自上次同步以来删除的资源将作为 PersonMetadata.deleted 设置为 true 的用户返回。

如果指定了 pageTokensyncToken,所有其他请求参数都必须与首次调用匹配。

写入的传播请求可能会延迟几分钟。增量同步不适用于写入后读取的用例。

请参阅列出用户的其他已更改联系人示例。

HTTP 请求

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

网址采用 gRPC 转码语法。

查询参数

参数
pageToken

string

(可选)从上一个响应 nextPageToken 接收的页面令牌。利用其进行后续页面检索。

进行分页时,提供给 otherContacts.list 的所有其他参数必须与提供页面令牌的第一个调用匹配。

pageSize

integer

(可选)要添加到回复中的“其他联系人”的数量。有效值介于 1 到 1000 之间(含 1 和 1000)。如果未设置或设置为 0,则默认为 100。

requestSyncToken

boolean

(可选)响应是否应在结果的最后一页返回 nextSyncToken。通过对请求 syncToken 进行设置,它可用于获取自上次请求以来的增量更改。

如需详细了解同步行为,请访问 otherContacts.list

syncToken

string

(可选)从之前的响应 nextSyncToken 收到的同步令牌。提供此令牌以仅检索自上次请求后更改的资源。

在同步时,提供给 otherContacts.list 的所有其他参数必须与提供同步令牌的第一个调用匹配。

如需详细了解同步行为,请访问 otherContacts.list

readMask

string (FieldMask format)

必需。一个字段掩码,用于限制返回每个人的字段。您可以指定多个字段,只需用英文逗号分隔即可。哪些值有效值取决于所使用的 ReadSourceType。

如果使用 READ_SOURCE_TYPE_CONTACT,则有效值如下:

  • emailAddresses
  • 元数据
  • names
  • phoneNumbers
  • 照片

如果使用 READ_SOURCE_TYPE_PROFILE,则有效值为:

  • addresses
  • ageRanges [年龄段]
  • 传记
  • 生日
  • 日历网址
  • 客户端数据
  • 封面照片
  • emailAddresses
  • events
  • externalId
  • 性别
  • IMClient
  • 兴趣
  • locales
  • 地理位置
  • memberships
  • 元数据
  • 其他关键字
  • names
  • 昵称
  • 职业
  • organizations
  • phoneNumbers
  • 照片
  • 关系
  • sipAddress
  • skills
  • 网址
  • 用户指定
sources[]

enum (ReadSourceType)

(可选)要返回的来源类型的掩码。如果未设置,则默认为 READ_SOURCE_TYPE_CONTACT

此字段的可能值包括:

不允许指定 READ_SOURCE_TYPE_PROFILE 而不指定 READ_SOURCE_TYPE_CONTACT

请求正文

请求正文必须为空。

响应正文

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

对经过身份验证的用户的“其他联系人”的请求进行响应。

JSON 表示法
{
  "otherContacts": [
    {
      object (Person)
    }
  ],
  "nextPageToken": string,
  "nextSyncToken": string,
  "totalSize": integer
}
字段
otherContacts[]

object (Person)

作为“人”资源返回的“其他联系人”列表。“其他联系人”支持一部分字段。如需了解详情,请参阅 ListOtherContactsRequest.request_mask。

nextPageToken

string

可作为 pageToken 发送并用于检索下一页的令牌。如果省略此字段,则不存在后续页面。

nextSyncToken

string

一个令牌,可作为 syncToken 发送以检索自上次请求以来的更改。请求必须设置 requestSyncToken 才能返回同步令牌。

totalSize

integer

列表中未分页的其他联系人总数。

授权范围

需要以下 OAuth 作用域:

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

如需了解详情,请参阅授权指南