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

僅供輸出。這個 CustomMetric 資源的資源名稱。格式：properties/{property}/customMetrics/{customMetric}
parameterName

string

必要，不可變動。這個自訂指標的標記名稱。

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

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

string

必要，這個自訂指標的顯示名稱，會顯示在 Analytics (分析) 使用者介面中。長度上限為 82 個半形字元，且開頭須為英文字母，且開頭須為英文字母。舊版系統產生的顯示名稱可能包含方括號，但這個欄位更新時一律不得使用方括號。
description

string

選用，此自訂維度的說明。長度上限為 150 個字元。
measurementUnit

enum (MeasurementUnit)

必要，自訂指標值的類型。
scope

enum (MetricScope)

必要，不可變動。這個自訂指標的範圍。
restrictedMetricType[]

enum (RestrictedMetricType)

選用，這項指標可能包含的受限資料類型類型。如果指標是 CURRENCY 的測量單位，則為必要欄位。如果指標採用非 CURRENCY 測量單位，則須留空。

計量單位

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

貨幣貨幣未來可能會變更，因此需要破壞 API 變更。

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

指標範圍

這項指標的範圍。

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

限制指標類型

將這個自訂指標中的資料標示為標籤，且只應提供給特定使用者的資料。

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

方法

archive

 封存屬性中的 CustomMetric。

create

 建立 CustomMetric。

get

 查詢單一 CustomMetric。

list

 列出資源的 CustomMetrics。

patch

 更新屬性中的 CustomMetric。