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)

(可选)此指标可能包含的受限数据类型。带有货币衡量单位的指标是必需的。对于包含非货币衡量单位的指标,必须为空。

测量单位

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

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

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

指标范围

此指标的范围。

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

受限指标类型

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

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

方法

archive

归档媒体资源上的 CustomMetric。

create

创建 CustomMetric。

get

查找单个 CustomMetric。

list

列出媒体资源上的 CustomMetrics。

patch

更新媒体资源上的 CustomMetric。