Method: accounts.list

列出呼叫使用者可存取的帳戶,並符合要求的限制條件,例如頁面大小或篩選器。這項作業不僅會列出 MCA 的子帳戶,還會列出呼叫使用者可存取的所有帳戶,包括其他 MCA、已連結帳戶、獨立帳戶等等。如果未提供篩選器,則會傳回使用者直接加入的帳戶。

HTTP 要求

GET https://merchantapi.googleapis.com/accounts/v1beta/accounts

這個網址使用 gRPC 轉碼語法。

查詢參數

參數
pageSize

integer

選用設定。要傳回的帳戶數量上限。服務傳回的產品數量可能會少於這個值。如未指定,最多會傳回 250 個帳戶。許可的最大值為 500;超出的數值將一律指定為 500。

pageToken

string

選用設定。從先前 accounts.list 呼叫收到的網頁權杖。提供此項目即可擷取後續網頁。

進行分頁時,提供至 accounts.list 的所有其他參數須與提供網頁權杖的呼叫相符。

filter

string

選用設定。只會傳回符合篩選器的帳戶。詳情請參閱篩選器語法參考資料

要求主體

要求主體必須為空白。

回應主體

accounts.list 方法的回應訊息。

如果成功,回應主體會含有以下結構的資料:

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

object (Account)

ListAccountsRequest 相符的帳戶。

nextPageToken

string

可做為 pageToken 傳送的權杖,用於擷取後續網頁。如果省略這個欄位,就不會有後續頁面。

授權範圍

需要下列 OAuth 範圍:

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

詳情請參閱 OAuth 2.0 總覽