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 UI 中顯示的計算指標名稱。長度上限為 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。