Method: contactGroups.list

列出经过身份验证的用户拥有的所有联系人群组。系统不会填充联系人群组的成员。

HTTP 请求

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

网址采用 gRPC 转码语法。

查询参数

参数
pageToken

string

可选。上次调用 contactGroups.list 返回的 nextPageToken 值。请求下一页资源。
pageSize

integer

可选。要返回的最大资源数。有效值介于 1 和 1000 之间（含 1 和 1000）。如果未设置或设置为 0，则默认为 30。
syncToken

string

可选。同步令牌，由之前对 contactgroups.list 的调用返回。系统只会返回自创建同步令牌后更改的资源。
groupFields

string (FieldMask format)

可选。字段掩码，用于限制返回组上的哪些字段。如果未设置或留空，则默认为 metadata、groupType、memberCount 和 name。有效字段包括：

  • clientData
  • groupType
  • memberCount
  • 元数据
  • name

请求正文

请求正文必须为空。

响应正文

对列出联系人群组请求的响应。

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

JSON 表示法 
{
  "contactGroups": [
    {
      object (ContactGroup)
    }
  ],
  "totalItems": integer,
  "nextPageToken": string,
  "nextSyncToken": string
}
字段
contactGroups[]

object (ContactGroup)

联系人群组列表。系统不会填充联系人群组的成员。
totalItems

integer

列表中未分页的项总数。
nextPageToken

string

可用于检索下一页结果的令牌。
nextSyncToken

string

可用于检索自上次请求以来更改的令牌。

授权范围

需要以下 OAuth 范围之一：

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

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