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

如果維度是這項資源的自訂維度，則為 True。

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

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