REST Resource: properties.customMetrics

资源:CustomMetric

自定义指标的定义。

JSON 表示法
{
  "name": string,
  "parameterName": string,
  "displayName": string,
  "description": string,
  "measurementUnit": enum (MeasurementUnit),
  "scope": enum (MetricScope),
  "restrictedMetricType": [
    enum (RestrictedMetricType)
  ]
}
字段
name

string

仅供输出。此 CustomMetric 资源的资源名称。格式:properties/{property}/customMetrics/{customMetric}

parameterName

string

必需。不可变。此自定义指标的标记名称。

如果这是事件级范围的指标,则它是事件参数名称。

只能包含字母数字和下划线字符,且必须以字母开头。事件级范围的指标的长度上限为 40 个字符。

displayName

string

必需。此自定义指标的显示名,如 Google Analytics(分析)界面中所示。长度上限为 82 个字符,由字母数字、空格和下划线组成,以字母开头。系统生成的旧版显示名可以包含方括号,但此字段的更新将一律不允许使用方括号。

description

string

可选。此自定义维度的说明。长度上限为 150 个字符。

measurementUnit

enum (MeasurementUnit)

必需。自定义指标值的类型。

scope

enum (MetricScope)

必需。不可变。此自定义指标的范围。

restrictedMetricType[]

enum (RestrictedMetricType)

可选。此指标可能包含的受限数据类型。对于采用 CURRENCY 衡量单位的指标而言是必需的。对于使用非 CURRENCY 衡量单位的指标,必须为空。

MeasurementUnit

表示自定义指标值的可能类型。

将来,货币表示形式可能会发生变化,需要进行重大的 API 更改。

枚举
MEASUREMENT_UNIT_UNSPECIFIED MeasurementUnit 未指定或缺失。
STANDARD 此指标使用默认单位。
CURRENCY 该指标用于衡量货币。
FEET 该指标测量英尺。
METERS 该指标用于测量米数。
KILOMETERS 此指标测量公里。
MILES 此指标测量英里数。
MILLISECONDS 该指标测量毫秒数。
SECONDS 此指标衡量的是秒数。
MINUTES 该指标测量分钟数。
HOURS 此指标衡量小时数。

MetricScope

此指标的范围。

枚举
METRIC_SCOPE_UNSPECIFIED 范围未知或未指定。
EVENT 将范围限定到某个事件的指标。

RestrictedMetricType

用于将此自定义指标中的数据标记为应仅限特定用户查看的标签。

枚举
RESTRICTED_METRIC_TYPE_UNSPECIFIED 类型未知或未指定。
COST_DATA 指标可报告费用数据。
REVENUE_DATA 指标用于报告收入数据。

方法

archive

将媒体资源的 CustomMetric 归档。

create

创建自定义指标。

get

查找单个 CustomMetric。

list

列出媒体资源的自定义指标。

patch

更新媒体资源的 CustomMetric。