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 的资源名称。格式：“properties/{property_id}/calculatedMetrics/{calculatedMetricId}”
description

string

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

string

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

string

仅限输出。用于计算指标的 ID。在界面中，这称为“API 名称”。

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

enum (MetricUnit)

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

enum (RestrictedMetricType)

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

string

必需。计算指标的定义。引用的唯一自定义指标的数量上限为 5。公式支持以下运算：+（加法）、-（减）、-（负）、*（乘号）、/（除号）、()（圆括号）。任何适合长整型（64 位整数）或双精度型（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。