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

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

string

Opsional. Deskripsi untuk metrik yang dihitung ini. Panjang maksimal 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 akan digunakan untuk metrik yang dihitung. Pada UI, ini disebut sebagai "nama API".

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

enum (MetricUnit)

Wajib. Jenis untuk nilai metrik yang dihitung.
restrictedMetricType[]

enum (RestrictedMetricType)

Hanya output. Jenis data yang dibatasi dalam metrik ini.
formula

string

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

boolean

Hanya output. Jika true (benar), metrik yang dihitung ini memiliki referensi metrik yang tidak valid. Apa pun yang menggunakan metrik yang dihitung dengan invalidMetricReference yang ditetapkan ke true bisa gagal, menampilkan peringatan, atau memberikan hasil yang tidak diharapkan.

MetricUnit

Kemungkinan jenis representasi nilai metrik yang dihitung.

Enum
METRIC_UNIT_UNSPECIFIED MetricUnit tidak ditentukan atau tidak ada.
STANDARD Metrik ini menggunakan satuan default.
CURRENCY Metrik ini mengukur mata uang.
FEET Metrik ini mengukur kaki.
MILES Metrik ini mengukur mil.
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 yang dihitung 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 Metrik melaporkan data biaya.
REVENUE_DATA Metrik melaporkan data pendapatan.

Metode

create

 Membuat CalculatedMetric.

delete

 Menghapus CalculatedMetric pada properti.

get

 Mencari satu CalculatedMetric.

list

 Mencantumkan CalculatedMetrics pada properti.

patch

 Memperbarui CalculatedMetric pada properti.