REST Resource: properties.customMetrics

Resource: CustomMetric

Definisi untuk metrik kustom.

Representasi JSON 
{
  "name": string,
  "parameterName": string,
  "displayName": string,
  "description": string,
  "measurementUnit": enum (MeasurementUnit),
  "scope": enum (MetricScope),
  "restrictedMetricType": [
    enum (RestrictedMetricType)
  ]
}
Kolom
name

string

Hanya output. Nama resource untuk resource CustomMetric ini. Format: properties/{property}/customMetrics/{customMetric}
parameterName

string

Wajib. Tidak dapat diubah. Nama pemberian tag untuk metrik kustom ini.

Jika ini adalah metrik cakupan peristiwa, ini adalah nama parameter peristiwa.

Hanya boleh berisi karakter alfanumerik dan garis bawah, yang diawali dengan huruf. Panjang maksimum 40 karakter untuk metrik cakupan peristiwa.
displayName

string

Wajib. Nama tampilan untuk metrik kustom ini seperti yang ditampilkan di UI Analytics. Panjang maksimum 82 karakter, alfanumerik plus spasi dan garis bawah yang diawali dengan huruf. Nama tampilan yang dibuat sistem lama mungkin berisi tanda kurung siku, tetapi pembaruan pada kolom ini tidak akan pernah mengizinkan tanda kurung siku.
description

string

Opsional. Deskripsi untuk dimensi kustom ini. Panjang maksimal 150 karakter.
measurementUnit

enum (MeasurementUnit)

Wajib. Jenis untuk nilai metrik kustom.
scope

enum (MetricScope)

Wajib. Tidak dapat diubah. Cakupan metrik kustom ini.
restrictedMetricType[]

enum (RestrictedMetricType)

Opsional. Jenis data yang dibatasi yang mungkin terdapat dalam metrik ini. Wajib diisi untuk metrik dengan satuan pengukuran CURRENCY. Harus kosong untuk metrik dengan satuan pengukuran non-CURRENCY.

MeasurementUnit

Kemungkinan jenis representasi nilai metrik kustom.

Representasi mata uang dapat berubah pada masa mendatang, sehingga memerlukan perubahan API yang dapat menyebabkan gangguan.

Enum
MEASUREMENT_UNIT_UNSPECIFIED MeasurementUnit tidak ditentukan atau tidak ada.
STANDARD Metrik ini menggunakan unit default.
CURRENCY Metrik ini mengukur mata uang.
FEET Metrik ini mengukur kaki.
METERS Metrik ini mengukur meter.
KILOMETERS Metrik ini mengukur kilometer.
MILES Metrik ini mengukur mil.
MILLISECONDS Metrik ini mengukur milidetik.
SECONDS Metrik ini mengukur detik.
MINUTES Metrik ini mengukur menit.
HOURS Metrik ini mengukur jam.

MetricScope

Cakupan metrik ini.

Enum
METRIC_SCOPE_UNSPECIFIED Cakupan tidak diketahui atau tidak ditentukan.
EVENT Metrik yang dicakupkan ke peristiwa.

RestrictedMetricType

Label yang menandai data dalam metrik kustom ini sebagai data yang harus dibatasi untuk pengguna tertentu.

Enum
RESTRICTED_METRIC_TYPE_UNSPECIFIED Jenis tidak diketahui atau tidak ditentukan.
COST_DATA Metrik melaporkan data biaya.
REVENUE_DATA Metrik melaporkan data pendapatan.

Metode

archive

 Mengarsipkan CustomMetric di properti.

create

 Membuat CustomMetric.

get

 Mencari satu CustomMetric.

list

 Mencantumkan CustomMetrics di properti.

patch

 Memperbarui CustomMetric di properti.