Method: accounts.list

列出经过身份验证的用户的所有账号。这包括用户拥有的所有账号,以及用户拥有管理权限的所有账号。

HTTP 请求

GET https://mybusiness.googleapis.com/v4/accounts

网址采用 gRPC 转码语法。

查询参数

参数
pageSize

integer

每页提取的账号数量。默认值为 20,最小值为 2,页面大小上限为 20。

pageToken

string

如果指定,则检索到账号的下一页。当调用 accounts.list 返回的结果数超过所请求的页面大小所能容纳的数量时,系统会返回 pageToken

name

string

要检索可直接访问的账号列表的账号的资源名称。这仅适用于组织和用户组。如果为空,则针对经过身份验证的用户返回 accounts.list

filter

string

限制要返回的账号的过滤条件。响应仅包含与过滤条件匹配的条目。如果 filter 为空,则系统不会应用任何限制条件,并且系统将为所请求的账号检索所有账号(已分页)。

例如,包含过滤条件 type=USER_GROUP 的请求将仅返回用户组。

请求正文

请求正文必须为空。

响应正文

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

Accounts.ListAccounts 的响应消息。

JSON 表示法
{
  "accounts": [
    {
      object (Account)
    }
  ],
  "nextPageToken": string
}
字段
accounts[]

object (Account)

用户有访问权限的一组账号。执行查询的用户的个人账号将始终是结果的第一项,除非它被滤除。

nextPageToken

string

如果账号数量超过所请求的页面大小,系统会使用令牌填充此字段,以在后续调用 accounts.list 时获取下一页账号。如果没有更多账号,则响应中不会显示此字段。

授权范围

需要以下 OAuth 范围之一:

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

如需了解详情,请参阅 OAuth 2.0 概览