Method: properties.getMetadata

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

舉例來說，如果參數名稱為 levels_unlocked 的自訂指標已向資源完成登錄，中繼資料回應就會包含 customEvent:levels_unlocked。通用中繼資料是適用於任何資源的維度和指標，例如 country 和 totalUsers。

HTTP 要求

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

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

路徑參數

參數
name

string

必填。要擷取的中繼資料資源名稱。這個名稱欄位是在網址路徑中指定，而非網址參數。資源是 Google Analytics 資源的數字 ID。詳情請參閱「如何找出資源 ID」。

範例：properties/1234/metadata

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

要求主體

要求主體必須為空白。

回應主體

目前報表方法接受的維度、指標和比較。

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

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

string

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

object (DimensionMetadata)

維度說明。
metrics[]

object (MetricMetadata)

指標說明。
comparisons[]

object (ComparisonMetadata)

比較說明。
conversions[]

object (ConversionMetadata)

轉換說明。

授權範圍

需要下列其中一種 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,
  "category": string,
  "sections": [
    enum (Section)
  ]
}
欄位
apiName

string

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

string

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

string

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

string

這項維度仍可使用但已淘汰的名稱。如果填入資料，這項維度會在一段時間內，透過 apiName 或其中一個 deprecatedApiNames 提供。淘汰期過後，只有透過 apiName 才能使用這個維度。
customDefinition

boolean

如果維度是這個資源的自訂維度，則為 True。包括使用者、事件和項目範圍的自訂維度；如要進一步瞭解自訂維度，請參閱 https://support.google.com/analytics/answer/14240153。這也包括自訂管道群組；如要進一步瞭解自訂管道群組，請參閱 https://support.google.com/analytics/answer/13051316。
category

string

這個維度所屬類別的顯示名稱。相似的維度和指標會歸類在一起。
sections[]

enum (Section)

指定這個維度適用的 Google Analytics 區段。

MetricMetadata

說明指標。

JSON 表示法 
{
  "apiName": string,
  "uiName": string,
  "description": string,
  "deprecatedApiNames": [
    string
  ],
  "type": enum (MetricType),
  "expression": string,
  "customDefinition": boolean,
  "blockedReasons": [
    enum (BlockedReason)
  ],
  "category": string,
  "sections": [
    enum (Section)
  ]
}
欄位
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。
blockedReasons[]

enum (BlockedReason)

如果指定原因，您就無法存取該資源的這項指標。您對這項資源發出這項指標的 API 要求會成功，但報表中的這項指標只會顯示零。如果 API 要求對已封鎖的指標套用指標篩選器，就會失敗。如果原因為空白，表示您有權存取這項指標。

詳情請參閱「存取權和資料限制管理」。
category

string

指標所屬類別的顯示名稱。相似的維度和指標會歸類在一起。
sections[]

enum (Section)

指定這項指標適用的 Google Analytics 區段。

BlockedReason

說明這項指標遭到封鎖的原因。

列舉
BLOCKED_REASON_UNSPECIFIED API 回應中絕不會指定這個值。
NO_REVENUE_METRICS 如果出現這項訊息，表示您無法存取這項資源的收益相關指標，而這項指標與收益有關。
NO_COST_METRICS 如果出現這項訊息，表示您無法存取這項資源的費用相關指標，而這項指標與費用有關。

ComparisonMetadata

單一比較的元資料。

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

string

這項比較作業的資源名稱。可用於「比較」的 comparison 欄位。例如「comparisons/1234」。
uiName

string

Google Analytics 使用者介面中的比較名稱。
description

string

這項比較的說明。

ConversionMetadata

單一轉換的中繼資料。

JSON 表示法 
{
  "conversionAction": string,
  "displayName": string
}
欄位
conversionAction

string

轉換動作的專屬 ID。這個 ID 用於指定要在報表中納入哪些轉換，方法是在報表要求的 ConversionsSpec 中填入 conversionActions 欄位。例如「conversionActions/1234」。
displayName

string

Google Analytics 使用者介面中顯示的轉換名稱。