Method: properties.getMetadata

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

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

HTTP 要求

GET https://analyticsdata.googleapis.com/v1beta/{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)
    }
  ],
  "comparisons": [
    {
      object (ComparisonMetadata)
    }
  ]
}
欄位
name

string

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

object (DimensionMetadata)

維度說明。
metrics[]

object (MetricMetadata)

指標說明。
comparisons[]

object (ComparisonMetadata)

比較項目的說明。

授權範圍

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

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

ComparisonMetadata

單一比較的中繼資料。

JSON 表示法 
{
  "apiName": string,
  "uiName": string,
  "description": string
}
欄位
apiName

string

此比較的資源名稱。可用於「Comparison」(比較) 的 comparison 欄位。例如「comparisons/1234」。
uiName

string

這項比較在 Google Analytics (分析) 使用者介面中的名稱。
description

string

此比較項目的說明。