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

必要欄位。上層帳戶。格式:accounts/{account}

查詢參數

參數
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 總覽