Method: otherContacts.list

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

同步令牌在完全同步 7 天后过期。同步令牌过期的请求将收到包含 google.rpc.ErrorInfo 的错误，原因为“EXPIRED_SYNC_TOKEN”。如果发生此类错误，客户端应在不使用 syncToken 的情况下发出完全同步请求。

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

指定 syncToken 后，系统会将自上次同步后删除的资源以 PersonMetadata.deleted 设置为 true 的用户身份返回。

如果指定了 pageToken 或 syncToken，所有其他请求参数都必须与第一次调用匹配。

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

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

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
  • 元数据
  • 名字
  • phoneNumbers
  • 照片

如果使用 READ_SOURCE_TYPE_PROFILE，则有效值为：

  • addresses
  • ageRanges
  • 传记
  • 生日
  • calendarUrls
  • clientData
  • coverPhotos
  • emailAddresses
  • 活动
  • externalIds
  • 性别
  • imClients
  • 兴趣
  • locales
  • 地理位置
  • memberships
  • 元数据
  • miscKeywords
  • 名字
  • 昵称
  • 职业
  • 组织
  • phoneNumbers
  • 照片
  • 关系
  • sipAddresses
  • skills
  • 网址
  • userDefined
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)

“其他联系人”列表以 Person 资源的形式返回。“其他联系人”支持的字段数量有限。如需了解详情，请参阅 ListOtherContactsRequest.request_mask。
nextPageToken

string

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

string

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

integer

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

授权范围

需要以下 OAuth 范围：

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

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