Method: contactGroups.get

通过指定联系人群组资源名称,获取已验证用户拥有的特定联系人群组。

HTTP 请求

GET https://people.googleapis.com/v1/{resourceName=contactGroups/*}

网址采用 gRPC 转码语法。

路径参数

参数
resourceName

string

必需。要获取的联系人群组的资源名称。

查询参数

参数
maxMembers

integer

可选。指定要返回的成员数量上限。如果未设置,则默认为 0,这样将返回零个成员。

groupFields

string (FieldMask format)

可选。用于限制返回组中哪些字段的字段掩码。如果未设置或为空,则默认值为 metadatagroupTypememberCountname。有效字段包括:

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

请求正文

请求正文必须为空。

响应正文

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

授权范围

需要以下 OAuth 范围之一:

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

有关详情,请参阅授权指南