列出所有“其他联系人”,即不在联系人群组中的联系人。“其他联系人”通常是根据互动自动创建的联系人。
同步令牌会在完全同步 7 天后过期。同步令牌已过期的请求将收到错误,并显示 google.rpc.ErrorInfo,原因为“EXPIRED_SYNC_TOKEN”。如果发生此类错误,客户端应在不使用
的情况下发出完整的同步请求。syncToken
完整同步请求的第一页有额外的配额。如果超出配额,将返回 429 错误。此配额是固定的,无法增加。
指定
后,自上次同步后删除的资源将以人的身份返回,并将 syncToken
设置为 true。PersonMetadata.deleted
指定
或 pageToken
时,所有其他请求参数必须与第一次调用匹配。syncToken
对于同步请求,写入操作的传播延迟可能会持续几分钟。增量同步不适用于写后读用例。
请参阅列出用户的其他已更改联系人中的用法示例。
HTTP 请求
GET https://people.googleapis.com/v1/otherContacts
网址采用 gRPC 转码语法。
查询参数
参数 | |
---|---|
pageToken |
可选。从上一个响应 进行分页时,提供给 |
pageSize |
可选。响应中包含的“其他联系人”的数量。有效值介于 1 到 1000 之间(含 1 和 1000)。如果未设置或设为 0,则默认设置为 100。 |
requestSyncToken |
可选。响应是否应在结果的最后一页上返回 如需详细了解同步行为,请访问 |
syncToken |
可选。从上一个响应接收的同步令牌 同步时,提供给 如需详细了解同步行为,请访问 |
readMask |
必需。字段掩码,用于限制返回每个人上的哪些字段。可以指定多个字段,用英文逗号分隔各个字段。有效的值取决于所使用的 ReadSourceType。 如果使用 READ_SOURCE_TYPE_CONTACT,则有效值为:
如果使用 READ_SOURCE_TYPE_PROFILE,则有效值为:
|
sources[] |
可选。要返回哪些来源类型的掩码。如果未设置,则默认为 此字段的可能值包括: 不允许在未指定 |
请求正文
请求正文必须为空。
响应正文
对针对经过身份验证的用户的“其他联系人”的请求的响应。
如果成功,响应正文将包含结构如下的数据:
JSON 表示法 |
---|
{
"otherContacts": [
{
object ( |
字段 | |
---|---|
otherContacts[] |
作为“人员”资源返回的“其他联系人”列表。“其他联系人”仅支持部分字段。如需了解详情,请参阅 ListOtherContactsRequest.request_mask。 |
nextPageToken |
可作为 |
nextSyncToken |
令牌,可作为 |
totalSize |
列表中未分页的其他联系人的总数。 |
授权范围
需要以下 OAuth 作用域:
https://www.googleapis.com/auth/contacts.other.readonly
有关详情,请参阅授权指南。