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

僅供輸出。這個計算指標的資源名稱。格式：「properties/{property_id}/calculatedMetrics/{calculatedMetricId}」
description

string

選用設定。這項計算指標的說明。長度上限為 4096 個字元。
displayName

string

必要欄位。這個計算指標的顯示名稱，如 Google Analytics UI 所示。長度上限為 82 個半形字元。
calculatedMetricId

string

僅供輸出。用於計算指標的 ID。在 UI 中稱為「API 名稱」。

參照外部 API 產生的這個計算指標時，會使用 countMetricId。例如：「calcMetric:{calculatedMetricId}」。
metricUnit

enum (MetricUnit)

必要欄位。計算指標值的類型。
restrictedMetricType[]

enum (RestrictedMetricType)

僅供輸出。這項指標包含的受限資料類型。
formula

string

必要欄位。計算指標的定義。不重複參照的自訂指標數量上限為 5 個。公式支援下列運算：+ (加法)、- (減法)、- (排除)、* (乘號)、/ (除號)、() (括號)。系統接受任何符合 Long (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

 建立計算指標。

delete

 刪除屬性中的 CalculatedMetric。

get

 查詢單一 CalculatedMetric。

list

 可列出屬性的 CalculatedMetrics。

patch

 更新屬性的 CalculatedMetric。