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」，則此欄必須留空。

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

 建立 CustomMetric。

get

 查詢單一 CustomMetric。

list

 列出資源的自訂指標。

patch

 更新資源的自訂指標。