MetricMetadata

說明指標。

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

string

指標名稱。可用於 Metricname。例如:eventCount

uiName

string

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

description

string

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

deprecatedApiNames[]

string

這個指標的舊名稱,目前仍可使用。如果填入了這項指標,apiNamedeprecatedApiNames 就會在一段時間內提供這項指標。淘汰期過後,只有 apiName 可以使用這項指標。

type

enum (MetricType)

這個指標的類型。

expression

string

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

customDefinition

boolean

如果指標是這個資源的自訂指標,則為 True。

blockedReasons[]

enum (BlockedReason)

如果系統指定原因,就會封鎖您對這項資源的這項指標存取權。您針對這項指標向這項屬性提出的 API 要求會成功,但報表中這項指標的值只會是零。針對遭封鎖指標設定指標篩選器的 API 要求會失敗。如果原因為空白,表示您可以存取這項指標。

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

category

string

這個指標所屬類別的顯示名稱。相似的維度和指標會歸入同一類別。

BlockedReason

這項指標遭封鎖的理由。

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