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 diisi. Tidak dapat diubah. Nama pemberian tag untuk metrik kustom ini.

Jika ini adalah metrik cakupan peristiwa, berarti 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 diisi. Tampilkan nama untuk metrik kustom ini seperti yang ditampilkan di UI Analytics. Panjang maksimal 82 karakter, alfanumerik ditambah spasi dan garis bawah yang diawali dengan huruf. Nama tampilan lama yang dihasilkan sistem mungkin berisi tanda kurung siku, tetapi pembaruan 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 diisi. Jenis untuk nilai metrik kustom.

scope

enum (MetricScope)

Wajib diisi. Tidak dapat diubah. Cakupan metrik kustom ini.

restrictedMetricType[]

enum (RestrictedMetricType)

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

UnitPengukuran

Kemungkinan jenis yang mewakili nilai metrik kustom.

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

Enumerasi
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.

CakupanMetrik

Cakupan metrik ini.

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

Jenis Metrik Terbatas

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

Enumerasi
RESTRICTED_METRIC_TYPE_UNSPECIFIED Ketik tidak dikenal atau tidak ditentukan.
COST_DATA Laporan metrik data biaya.
REVENUE_DATA Metrik melaporkan data pendapatan.

Metode

archive

Mengarsipkan CustomMetric pada properti.

create

Membuat CustomMetric.

get

Cari satu CustomMetric.

list

Mencantumkan CustomMetrics pada properti.

patch

Memperbarui CustomMetric pada properti.