REST Resource: properties.customMetrics

資源:CustomMetric

自訂指標的定義。

JSON 表示法
{
  "name": string,
  "parameterName": string,
  "displayName": string,
  "description": string,
  "measurementUnit": enum (MeasurementUnit),
  "scope": enum (MetricScope),
  "restrictedMetricType": [
    enum (RestrictedMetricType)
  ]
}
欄位
name

string

僅供輸出。這項自訂指標的資源名稱。格式:Properties/{property}/customMetrics/{customMetric}

parameterName

string

必要欄位。無法變更。這個自訂指標的標記名稱。

如果是以事件為範圍的指標,這是事件參數名稱。

只能使用英數字元和底線字元,並以英文字母開頭。以事件為範圍的指標長度上限為 40 個字元。

displayName

string

必要欄位。此自訂指標的顯示名稱,如 Analytics (分析) UI 所示。長度上限為 82 個字元,可使用英數字元、空格和底線,並以英文字母開頭。舊版系統產生的顯示名稱可能包含方括號,但這個欄位的更新一律不得使用方括號。

description

string

選用設定。這個自訂維度的說明。長度上限為 150 個字元。

measurementUnit

enum (MeasurementUnit)

必要欄位。自訂指標值的類型。

scope

enum (MetricScope)

必要欄位。無法變更。這項自訂指標的範圍。

restrictedMetricType[]

enum (RestrictedMetricType)

選用設定。這項指標可能包含的受限資料類型。採用 CURRENCY 測量單位的指標必填。如果是非 CURRENCY 測量單位的指標,就必須留空。

MeasurementUnit

代表自訂指標值的可能類型。

幣別表示法日後可能會改變,因此需要做出破壞性 API 變更。

列舉
MEASUREMENT_UNIT_UNSPECIFIED 未指定或缺少 MeasurementUnit。
STANDARD 這項指標使用預設單位。
CURRENCY 這項指標會計算貨幣。
FEET 這項指標測量的是英尺。
METERS 這項指標測量的是公尺。
KILOMETERS 這項指標會測量公里數。
MILES 這項指標會測量英里數。
MILLISECONDS 這項指標的測量單位是毫秒。
SECONDS 這項指標會測量秒數。
MINUTES 這項指標測量的是分鐘。
HOURS 這項指標可評估小時。

MetricScope

這項指標的範圍。

列舉
METRIC_SCOPE_UNSPECIFIED 範圍不明或未指定。
EVENT 以事件為範圍的指標。

RestrictedMetricType

用來將這項自訂指標中的資料標示為僅限特定使用者存取的資料的標籤。

列舉
RESTRICTED_METRIC_TYPE_UNSPECIFIED 類型不明或未指定。
COST_DATA 指標會回報費用資料。
REVENUE_DATA 指標會回報收益資料。

方法

archive

封存資源的自訂指標。

create

建立自訂指標。

get

查詢一個自訂指標。

list

列出資源上的 CustomMetrics。

patch

更新資源上的自訂指標。