Method: properties.getMetadata

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

舉例來說,如果將參數名稱為「levels_unlocked」的自訂指標註冊了某項資源,中繼資料回應就會包含 customEvent:levels_unlocked。通用中繼資料是適用於任何資源 (如 countrytotalUsers) 的維度和指標。

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)
    }
  ]
}
欄位
name

string

此中繼資料的資源名稱。

dimensions[]

object (DimensionMetadata)

維度說明。

metrics[]

object (MetricMetadata)

指標說明。

授權範圍

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

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