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