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 您无法访问此媒体资源的费用相关指标(如果有),并且此指标与费用相关。