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

Tylko dane wyjściowe. Nazwa zasobu dla obliczonych danych. Format: 'properties/{property_id}/calculatedMetrics/{calculatedMetricId}'

description

string

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

displayName

string

Wymagane. Nazwa wyświetlana tego obliczonego rodzaju danych w interfejsie Google Analytics. Maksymalna długość to 82 znaki.

calculatedMetricId

string

Tylko dane wyjściowe. Identyfikator do użycia w przypadku obliczonych danych. W interfejsie jest ona określana jako „nazwa interfejsu API”.

Wartość calculatedMetricId jest używana podczas odwoływania się do 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 z ograniczonym dostępem, które zawiera ten rodzaj danych.

formula

string

Wymagane. Definicja obliczonych danych. Maksymalna liczba niepowtarzalnych niestandardowych danych, do których się odwołujesz, wynosi 5. Formuły obsługują te operacje: + (dodawanie), - (odejmowanie), - (ujemny), * (mnożenie), / (dzielenie), () (nawiasy). Dozwolone są dowolne liczby rzeczywiste, które mieszczą się w 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 to prawda, obliczone dane mają nieprawidłowy identyfikator danych. Wszystko, co korzysta z wyliczonego rodzaju danych z wartością „invalidMetricReference” ustawioną na „true”, może nie działać prawidłowo, 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 lub nieokreślona jednostka miary.
STANDARD Te dane używają domyślnych jednostek.
CURRENCY Te dane dotyczą waluty.
FEET Te dane dotyczą stóp.
MILES Te dane dotyczą mil.
METERS Te dane są podawane w metrach.
KILOMETERS Te dane dotyczą kilometrów.
MILLISECONDS Te dane są mierzone w milisekundach.
SECONDS Dane te są mierzone w sekundach.
MINUTES Te dane wskazują liczbę minut.
HOURS Te dane dotyczą godzin.

RestrictedMetricType

Etykiety, które oznaczają dane w wyliczonym wskaźniku używanym 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 jest nieznany lub nieokreślony.
COST_DATA Dane dotyczące kosztów.
REVENUE_DATA Dane o przychodach.

Metody

create

Tworzy obliczone dane.

delete

Usuwa z usługi obliczony typ danych.

get

Wyszukiwanie pojedynczych obliczonych danych.

list

Wypisuje obliczone dane w usłudze.

patch

Aktualizuje obliczony typ danych w usłudze.