MetricMetadata

說明指標。

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

如果指標是這項資源的自訂指標,則為「是」。

blockedReasons[]

enum (BlockedReason)

如果已指明原因,您對這個資源就無法存取這項指標。您向這項資源提出的 API 要求將會成功;但報表中只會包含零個值。如果 API 要求含有封鎖指標的指標篩選器,就無法執行。如果原因留空,您就能查看這項指標。

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

category

string

這項指標所屬類別的顯示名稱。相似的維度和指標會歸為一組。

BlockedReason

這項指標遭封鎖的理由。

列舉
BLOCKED_REASON_UNSPECIFIED 一律不會在 API 回應中指定。
NO_REVENUE_METRICS 出現的話,表示您無法存取這項資源的收益相關指標,且這個指標與收益相關。
NO_COST_METRICS 出現的話,就無法存取這項資源的費用相關指標,而這項指標與費用有關。