Method: accountSummaries.list

傳回呼叫者可存取的所有帳戶的摘要。

HTTP 要求

GET https://analyticsadmin.googleapis.com/v1alpha/accountSummaries

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

查詢參數

參數
pageSize

integer

要傳回的 AccountSummary 資源數量上限。服務傳回的網頁可能會少於這個值,即使還有其他網頁也一樣。如未指定,最多將傳回 50 個資源。最大值為 200 (系統會將較高的值強制轉換為最大值)

pageToken

string

屬於接收自前一個 accountSummaries.list 呼叫的網頁權杖。提供此項目即可擷取後續網頁。進行分頁時,提供至 accountSummaries.list 的所有其他參數須與提供網頁權杖的呼叫相符。

要求主體

要求主體必須為空白。

回應主體

accountSummaries.list RPC 的回應訊息。

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

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

object (AccountSummary)

來電者可存取的所有帳戶的帳戶摘要。

nextPageToken

string

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

授權範圍

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

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit

AccountSummary

虛擬資源,用於代表帳戶及其所有子項 GA4 資源。

JSON 表示法
{
  "name": string,
  "account": string,
  "displayName": string,
  "propertySummaries": [
    {
      object (PropertySummary)
    }
  ]
}
欄位
name

string

此帳戶摘要的資源名稱。格式:accountSummaries/{account_id} 範例:「accountSummaries/1000」

account

string

這個帳戶摘要參照的帳戶資源名稱。格式:accounts/{account_id},範例:「accounts/1000」

displayName

string

此帳戶摘要中所參照帳戶的顯示名稱。

propertySummaries[]

object (PropertySummary)

此帳戶的子帳戶摘要清單。

PropertySummary

代表 GA4 資源中繼資料的虛擬資源。

JSON 表示法
{
  "property": string,
  "displayName": string,
  "propertyType": enum (PropertyType),
  "parent": string
}
欄位
property

string

這項資源摘要參照的資源名稱,格式:properties/{property_id},例如:「properties/1000」

displayName

string

這項資源摘要中所參照的資源名稱。

propertyType

enum (PropertyType)

屬性的屬性類型。

parent

string

此屬性邏輯父項的資源名稱。

注意:屬性移動 UI 可用來變更父項。格式:accounts/{account}、properties/{property} 範例:「accounts/100」、「properties/200」