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. Memberi tag pada nama untuk metrik kustom ini.

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

Hanya dapat berisi karakter alfanumerik dan garis bawah, yang dimulai dengan huruf. Panjang maksimal 40 karakter untuk metrik cakupan peristiwa.

displayName

string

Wajib. Nama tampilan untuk metrik kustom ini seperti yang ditampilkan di UI Analytics. Panjang maksimal 82 karakter, alfanumerik, spasi, dan garis bawah yang diawali dengan huruf. Nama tampilan lama yang dihasilkan sistem mungkin berisi tanda kurung siku, namun pembaruan pada kolom ini tidak akan 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 dapat terdapat dalam metrik ini. Diperlukan untuk metrik dengan unit pengukuran CURRENCY. Harus kosong untuk metrik dengan unit pengukuran non-CURRENCY.

MeasurementUnit

Kemungkinan jenis untuk mewakili nilai metrik kustom.

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

Enum
MEASUREMENT_UNIT_UNSPECIFIED MeasurementUnit belum ditetapkan atau tidak ada.
STANDARD Metrik ini menggunakan satuan 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 Data biaya laporan metrik.
REVENUE_DATA Data pendapatan laporan metrik.

Metode

archive

Mengarsipkan CustomMetric pada properti.

create

Membuat CustomMetric.

get

Cari CustomMetric satu.

list

Mencantumkan CustomMetrics di properti.

patch

Memperbarui CustomMetric di properti.