REST Resource: properties.customMetrics

資源：自訂指標

自訂指標的定義。

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

 可列出資源的自訂指標。

patch

 更新屬性的自訂指標。