資源:CalculatedMetric
計算指標的定義。
JSON 表示法 |
---|
{ "name": string, "description": string, "displayName": string, "calculatedMetricId": string, "metricUnit": enum ( |
欄位 | |
---|---|
name |
僅供輸出。此 CalculatedMetric 的資源名稱。格式:「properties/{property_id}/calculatedMetrics/{calculatedMetricId}」 |
description |
選用設定。這個計算指標的說明。長度上限為 4096 個半形字元。 |
displayName |
必要欄位。這項計算指標的顯示名稱,如 Google Analytics (分析) UI 所示。長度上限為 82 個半形字元。 |
calculatedMetricId |
僅供輸出。計算指標所使用的 ID。在使用者介面中,這稱為「API 名稱」。 從外部 API 參照這個計算指標時,系統會使用 CalculateMetricId。例如「calcMetric:{calculatedMetricId}」。 |
metricUnit |
必要欄位。計算指標值的類型。 |
restrictedMetricType[] |
僅供輸出。這項指標包含的受限資料類型。 |
formula |
必要欄位。計算指標的定義。不重複參照的自訂指標數量上限為 5 個。公式支援下列運算:+ (加法)、- (減號)、- (負數)、* (乘號)、/ (除號)、() (括號)。可接受長為長整數 (64 位元整數) 或雙倍 (64 位元浮點數) 的有效實數。範例公式:「( customEvent:parameterName + cartPurchaseQuantity) / 2.0」 |
invalidMetricReference |
僅供輸出。如果為 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 |
「指標」會回報收益資料, |
方法 |
|
---|---|
|
建立 CalculatedMetric。 |
|
刪除屬性上的 CalculatedMetric。 |
|
查詢單一 CalculatedMetric。 |
|
列出屬性的 CalculatedMetrics。 |
|
更新屬性的 CalculatedMetric。 |