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

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

string

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

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

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

string

必填。Analytics 使用者介面中顯示的自訂指標顯示名稱。最多 82 個字元，開頭須為英文字母，且只能使用英數字元、空格和底線。舊版系統產生的顯示名稱可能包含方括號，但更新這個欄位時，一律不得使用方括號。
description

string

(選用步驟) 這個自訂維度的說明。長度上限為 150 個字元。
measurementUnit

enum (MeasurementUnit)

必填。自訂指標值的類型。
scope

enum (MetricScope)

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

enum (RestrictedMetricType)

(選用步驟) 這項指標可能包含的受限資料類型。如果指標的測量單位為貨幣，則必須提供此值。如果指標的測量單位不是「貨幣」，則必須留空。

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

 封存資源中的 CustomMetric。

create

 建立 CustomMetric。

get

 查詢單一 CustomMetric。

list

 列出資源的 CustomMetrics。

patch

 更新資源的 CustomMetric。