Method: accounts.listSubaccounts

列出指定多客户账号的所有子账号。这是更强大的 accounts.list 方法的便捷封装容器。此方法会产生与使用以下过滤条件调用 ListsAccounts 相同的结果:relationship(providerId={parent} AND service(type="ACCOUNT_AGGREGATION"))

HTTP 请求

GET https://merchantapi.googleapis.com/accounts/v1beta/{provider=accounts/*}:listSubaccounts

网址采用 gRPC 转码语法。

路径参数

参数
provider

string

必需。汇总服务提供商。格式:providers/{providerId}

查询参数

参数
pageSize

integer

可选。要返回的账号数量上限。服务返回的值可能小于此值。如果未指定,则最多返回 250 个账号。最大值为 500;大于 500 的值会强制转换为 500。

pageToken

string

可选。从之前的 accounts.list 调用接收的页面令牌。利用其进行后续页面检索。

进行分页时,提供给 accounts.list 的所有其他参数必须与提供页面令牌的调用匹配。

请求正文

请求正文必须为空。

响应正文

accounts.listSubaccounts 方法的响应消息。

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

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

object (Account)

指定父级账号是汇总账号的账号。

nextPageToken

string

可作为 pageToken 发送并用于检索下一页的令牌。如果省略此字段,则不存在后续页面。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/content

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