Method: properties.getMetadata

傳回報表方法中可用的維度和指標中繼資料。用於探索維度和指標。使用這個方法時，系統會在請求中指定 Google Analytics GA4 資源 ID，而中繼資料回應包含自訂維度和指標以及通用中繼資料。

舉例來說，如果將參數名稱為 levels_unlocked 的自訂指標註冊至某個資源，中繼資料回應就會包含 customEvent:levels_unlocked。通用中繼資料是指適用於 country 和 totalUsers 等任何資源的維度和指標。

HTTP 要求

GET https://analyticsdata.googleapis.com/v1alpha/{name=properties/*/metadata}

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

路徑參數

參數
name

string

必要欄位。要擷取中繼資料的資源名稱。這個名稱欄位是在網址路徑中指定，而不是網址參數。資源是數值型的 Google Analytics GA4 資源 ID。詳情請參閱「如何查看資源 ID」一文。

範例：properties/1234/metadata

對於所有資源通用的維度和指標，請將資源 ID 設為 0。在這個特殊模式中，這個方法不會傳回自訂維度和指標。

要求主體

要求主體必須為空白。

回應主體

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

目前用於報表方法的維度和指標。

JSON 表示法 
{
  "name": string,
  "dimensions": [
    {
      object (DimensionMetadata)
    }
  ],
  "metrics": [
    {
      object (MetricMetadata)
    }
  ]
}
欄位
name

string

這項中繼資料的資源名稱。
dimensions[]

object (DimensionMetadata)

維度說明。
metrics[]

object (MetricMetadata)

指標說明。

授權範圍

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

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

DimensionMetadata

表示維度。

JSON 表示法 
{
  "apiName": string,
  "uiName": string,
  "description": string,
  "deprecatedApiNames": [
    string
  ],
  "customDefinition": boolean
}
欄位
apiName

string

這個維度的名稱。可用於「維度」的 name。例如：eventName。
uiName

string

這個維度在 Google Analytics 使用者介面中的名稱。例如 Event name。
description

string

說明這項維度的使用方式和計算方式。
deprecatedApiNames[]

string

這個維度的名稱仍可使用，但已淘汰。如果填入維度，「apiName」或其中一個「deprecatedApiNames」可在一段時間內使用這項維度。淘汰期結束後，維度將僅在 apiName前提供。
customDefinition

boolean

如果維度是此資源的自訂維度，則為「是」。

MetricMetadata

說明指標。

JSON 表示法 
{
  "apiName": string,
  "uiName": string,
  "description": string,
  "deprecatedApiNames": [
    string
  ],
  "type": enum (MetricType),
  "expression": string,
  "customDefinition": boolean
}
欄位
apiName

string

指標名稱。可用於指標的 name。例如：eventCount。
uiName

string

這項指標在 Google Analytics 使用者介面中的名稱。例如 Event count。
description

string

這項指標的使用和計算方式說明。
deprecatedApiNames[]

string

這項指標仍可使用，但已淘汰的名稱。如果填入了這項指標，代表「apiName」或「deprecatedApiNames」在特定期間內可使用這項指標。淘汰期結束後，這項指標將自 apiName起才能使用。
type

enum (MetricType)

這個指標的類型。
expression

string

這個衍生指標的數學運算式。可用於對等報表的指標 expression 欄位。大多數的指標都不是運算式，如果不是運算式，這個欄位會空白。
customDefinition

boolean

如果指標是這項資源的自訂指標，則為「是」。