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

這項指標仍可使用但已淘汰的名稱。如果填入資料,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 如果存在這個項目,就無法存取這項資源的費用相關指標,且這項指標與費用相關。