Method: contactGroups.batchGet

通过指定联系人群组资源名称列表,获取经过身份验证的用户拥有的联系人群组列表。

HTTP 请求

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

网址采用 gRPC 转码语法。

查询参数

参数
resourceNames[]

string

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

最多 200 个资源名称。

maxMembers

integer

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

groupFields

string (FieldMask format)

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

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

请求正文

请求正文必须为空。

响应正文

对批量 get 联系人群组请求的响应。

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

JSON 表示法
{
  "responses": [
    {
      object (ContactGroupResponse)
    }
  ]
}
字段
responses[]

object (ContactGroupResponse)

每个请求的联系人群组资源的响应列表。

授权范围

需要以下 OAuth 范围之一:

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

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

ContactGroupResponse

特定联系人群组的响应。

JSON 表示法
{
  "requestedResourceName": string,
  "status": {
    object (Status)
  },
  "contactGroup": {
    object (ContactGroup)
  }
}
字段
requestedResourceName

string

请求的原始资源名称。

status

object (Status)

响应的状态。

contactGroup

object (ContactGroup)

联系人群组。