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

必需。此自定义指标在 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

创建 CustomMetric。

get

查找单个 CustomMetric。

list

列出媒体资源中的 CustomMetric。

patch

更新媒体资源中的 CustomMetric。