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