Method: organizations.list

傳回使用者可存取的機構清單。

HTTP 要求

GET https://marketingplatformadmin.googleapis.com/v1alpha/organizations

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

查詢參數

參數
pageSize

integer

(選用步驟) 單次呼叫傳回的機構數量上限。服務傳回的產品數量可能會少於這個值。

如未指定，最多將傳回 50 個機構。許可的最大值為 1000；超出的數值將一律指定為 1000。
pageToken

string

(選用步驟) 屬於接收自前一個 organizations.list 呼叫的網頁權杖。提供此項目即可擷取後續網頁。

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

要求主體

要求主體必須為空白。

回應主體

organizations.list RPC 的回應訊息。

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

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

object (Organization)

使用者可存取的機構資源，包括機構 ID 和顯示名稱。
nextPageToken

string

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

授權範圍

需要下列其中一種 OAuth 範圍：

  • https://www.googleapis.com/auth/marketingplatformadmin.analytics.read
  • https://www.googleapis.com/auth/marketingplatformadmin.analytics.update