REST Resource: properties.calculatedMetrics

资源：CalculatedMetric

计算指标的定义。

JSON 表示法 
{
  "name": string,
  "description": string,
  "displayName": string,
  "calculatedMetricId": string,
  "metricUnit": enum (MetricUnit),
  "restrictedMetricType": [
    enum (RestrictedMetricType)
  ],
  "formula": string,
  "invalidMetricReference": boolean
}
字段
name

string

仅限输出。此 CalculatedMetric 的资源名称。Format: 'properties/{property_id}/calculatedMetrics/{calculatedMetricId}'
description

string

可选。此计算指标的说明。长度上限为 4096 个字符。
displayName

string

必需。此计算指标的显示名称，如 Google Analytics 界面中所示。长度上限为 82 个字符。
calculatedMetricId

string

仅限输出。要为计算指标使用的 ID。在界面中，此值称为“API 名称”。

从外部 API 引用此计算指标时，会使用 calculatedMetricId。例如，“calcMetric:{calculatedMetricId}”。
metricUnit

enum (MetricUnit)

必需。计算指标值的类型。
restrictedMetricType[]

enum (RestrictedMetricType)

仅限输出。此指标包含的受限数据类型。
formula

string

必需。计算指标的定义。引用的自定义指标的唯一数量上限为 5 个。公式支持以下运算：+（加法）、-（减法）、-（负号）、*（乘法）、/（除法）、()（圆括号）。可以接受任何可容纳在 Long（64 位整数）或 Double（64 位浮点数）中的有效实数。示例公式：“( customEvent:parameterName + cartPurchaseQuantity ) / 2.0”
invalidMetricReference

boolean

仅限输出。如果为 true，则表示此计算指标具有无效的指标引用。任何使用将 invalidMetricReference 设置为 true 的计算指标的操作都可能会失败、产生警告或产生意外结果。

MetricUnit

表示计算指标值的可能类型。

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

RestrictedMetricType

用于标记计算指标中数据的标签，可与限制对费用和/或收入指标的访问权限的用户角色搭配使用。

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

方法

create

 创建 CalculatedMetric。

delete

 删除媒体资源的 CalculatedMetric。

get

 查找单个 CalculatedMetric。

list

 列出媒体资源的 CalculatedMetrics。

patch

 更新媒体资源的 CalculatedMetric。