REST Resource: properties.calculatedMetrics

Resource: CalculatedMetric

Definisi untuk metrik yang dihitung.

Representasi JSON 
{
  "name": string,
  "description": string,
  "displayName": string,
  "calculatedMetricId": string,
  "metricUnit": enum (MetricUnit),
  "restrictedMetricType": [
    enum (RestrictedMetricType)
  ],
  "formula": string,
  "invalidMetricReference": boolean
}
Kolom
name

string

ID. Nama resource untuk CalculatedMetric ini. Format: 'properties/{property_id}/calculatedMetrics/{calculatedMetricId}'
description

string

Opsional. Deskripsi untuk metrik yang dihitung ini. Panjang maksimum 4.096 karakter.
displayName

string

Wajib. Nama tampilan untuk metrik yang dihitung ini seperti yang ditampilkan di UI Google Analytics. Panjang maksimal 82 karakter.
calculatedMetricId

string

Hanya output. ID yang digunakan untuk metrik yang dihitung. Di UI, ini disebut sebagai "nama API".

calculatedMetricId digunakan saat mereferensikan metrik yang dihitung ini dari API eksternal. Misalnya, "calcMetric:{calculatedMetricId}".
metricUnit

enum (MetricUnit)

Wajib. Jenis untuk nilai metrik terhitung.
restrictedMetricType[]

enum (RestrictedMetricType)

Hanya output. Jenis data terlarang yang terdapat dalam metrik ini.
formula

string

Wajib. Definisi metrik yang dihitung. Jumlah maksimum metrik kustom yang dirujuk dan unik adalah 5. Formula mendukung operasi berikut: + (penambahan), - (pengurangan), - (negatif), * (perkalian), / (pembagian), () (tanda kurung). Semua bilangan riil yang valid dapat diterima dan sesuai dengan Long (bilangan bulat 64 bit) atau Double (bilangan floating point 64 bit). Contoh formula: "( customEvent:parameterName + cartPurchaseQuantity ) / 2.0"
invalidMetricReference

boolean

Hanya output. Jika benar, metrik kalkulasi ini memiliki referensi metrik yang tidak valid. Apa pun yang menggunakan metrik terhitung dengan invalidMetricReference disetel ke benar (true) dapat gagal, menghasilkan peringatan, atau menghasilkan hasil yang tidak terduga.

MetricUnit

Kemungkinan jenis untuk merepresentasikan nilai metrik yang dihitung.

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

RestrictedMetricType

Label yang menandai data dalam metrik kalkulasi yang digunakan bersama dengan peran pengguna yang membatasi akses ke metrik biaya dan/atau pendapatan.

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

Metode

create

 Membuat CalculatedMetric.

delete

 Menghapus CalculatedMetric di properti.

get

 Mencari satu CalculatedMetric.

list

 Mencantumkan CalculatedMetrics di properti.

patch

 Memperbarui CalculatedMetric di properti.