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 资源的资源名称。格式:property/{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

创建一个 CustomMetric。

get

查找单个自定义指标。

list

列出某个媒体资源的 CustomMetrics。

patch

更新媒体资源的 CustomMetric。