REST Resource: properties.calculatedMetrics

Zasób: CalculatedMetric

Definicja obliczonych danych.

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

string

Identyfikator. Nazwa zasobu tych obliczonych danych. Format: 'properties/{property_id}/calculatedMetrics/{calculatedMetricId}'

description

string

Opcjonalnie. Opis tych obliczonych danych. Maksymalna długość to 4096 znaków.

displayName

string

Wymagane. Wyświetlana nazwa tych obliczonych danych w interfejsie Google Analytics. Maksymalna długość to 82 znaki.

calculatedMetricId

string

Tylko dane wyjściowe. Identyfikator, który ma być używany w przypadku obliczonych danych. W interfejsie użytkownika jest to „Nazwa interfejsu API”.

Identyfikator calculatedMetricId jest używany podczas odwoływania się do tych obliczonych danych z zewnętrznych interfejsów API. Na przykład „calcMetric:{calculatedMetricId}”.

metricUnit

enum (MetricUnit)

Wymagane. Typ wartości obliczonych danych.

restrictedMetricType[]

enum (RestrictedMetricType)

Tylko dane wyjściowe. Typy danych objętych ograniczeniami, które zawiera ten rodzaj danych.

formula

string

Wymagane. Definicja obliczonych danych. Maksymalna liczba unikalnych danych niestandardowych, do których odwołuje się warunek, to 5. Formuły obsługują te działania: + (dodawanie), - (odejmowanie), - (liczba ujemna), * (mnożenie), / (dzielenie), () (nawiasy). Dopuszczalne są wszystkie prawidłowe liczby rzeczywiste, które mieszczą się w zakresie typu Long (64-bitowa liczba całkowita) lub Double (64-bitowa liczba zmiennoprzecinkowa). Przykładowa formuła: „( customEvent:parameterName + cartPurchaseQuantity ) / 2.0”

invalidMetricReference

boolean

Tylko dane wyjściowe. Jeśli wartość to „prawda”, te obliczone dane mają nieprawidłowe odwołanie do danych. Wszystko, co korzysta z obliczonych rodzajów danych z ustawioną wartością „true” w przypadku parametru invalidMetricReference, może nie działać, generować ostrzeżenia lub dawać nieoczekiwane wyniki.

MetricUnit

Możliwe typy reprezentacji wartości obliczonych danych.

Wartości w polu enum
METRIC_UNIT_UNSPECIFIED Brak wartości lub nieokreślona wartość MetricUnit.
STANDARD Ten wskaźnik używa domyślnych jednostek.
CURRENCY Te dane są wyrażone w walucie.
FEET Te dane są podawane w stopach.
MILES Te dane są podawane w milach.
METERS Te dane są podawane w metrach.
KILOMETERS Te dane są podawane w kilometrach.
MILLISECONDS Te dane są podawane w milisekundach.
SECONDS Ten wskaźnik mierzy czas w sekundach.
MINUTES Ten wskaźnik jest mierzony w minutach.
HOURS Te dane są podawane w godzinach.

RestrictedMetricType

Etykiety, które oznaczają dane w obliczonych danych, używane w połączeniu z rolami użytkowników, które ograniczają dostęp do danych o kosztach lub przychodach.

Wartości w polu enum
RESTRICTED_METRIC_TYPE_UNSPECIFIED Typ nieznany lub nieokreślony.
COST_DATA Raport dotyczący danych zawiera dane o kosztach.
REVENUE_DATA Raport Rodzaj danych zawiera dane o przychodach.

Metody

create

Tworzy obiekt CalculatedMetric.

delete

Usuwa z usługi obliczone dane.

get

Wyszukiwanie pojedynczego obiektu CalculatedMetric.

list

Wyświetla listę obliczonych danych w usłudze.

patch

Aktualizuje obliczone dane w usłudze.