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 如果存在,则禁止您访问此媒体资源的费用相关指标,并且该指标与费用相关。