REST Resource: properties.customMetrics

Zasób: CustomMetric

Definicja danych niestandardowych.

Zapis JSON
{
  "name": string,
  "parameterName": string,
  "displayName": string,
  "description": string,
  "measurementUnit": enum (MeasurementUnit),
  "scope": enum (MetricScope),
  "restrictedMetricType": [
    enum (RestrictedMetricType)
  ]
}
Pola
name

string

Tylko dane wyjściowe. Nazwa zasobu tego zasobu CustomMetric. Format: properties/{property}/customMetrics/{customMetric}

parameterName

string

To pole jest wymagane. Stałe. Nazwa tagowania tych danych niestandardowych.

Jeśli są to dane ograniczone do zdarzenia, jest to nazwa parametru zdarzenia.

Może zawierać tylko znaki alfanumeryczne i podkreślenia, które rozpoczynają się od litery. Maksymalna długość danych ograniczonych do zdarzenia to 40 znaków.

displayName

string

To pole jest wymagane. Wyświetlana nazwa tych danych niestandardowych widoczna w interfejsie Analytics. Maksymalna długość to 82 znaki, ze znakami alfanumerycznymi, spacjami i podkreśleniami zaczynającymi się od litery. Starsze wyświetlane nazwy generowane przez system mogą zawierać nawiasy kwadratowe, ale aktualizowanie tego pola nigdy nie zezwala na użycie nawiasów kwadratowych.

description

string

Opcjonalnie. Opis tego wymiaru niestandardowego. Maksymalna długość to 150 znaków.

measurementUnit

enum (MeasurementUnit)

To pole jest wymagane. Typ wartości danych niestandardowych.

scope

enum (MetricScope)

To pole jest wymagane. Stałe. Zakres tych danych niestandardowych.

restrictedMetricType[]

enum (RestrictedMetricType)

Opcjonalnie. Rodzaje danych podlegających ograniczeniom, które mogą zawierać te dane. Wymagane w przypadku danych z jednostką miary w CURRENCY. Pole musi być puste w przypadku danych z jednostką miary inną niż CURRENCY.

MeasurementUnit

Możliwe typy reprezentowania wartości danych niestandardowych.

Reprezentacja waluty może się zmienić w przyszłości, co będzie wymagać nieupoważnionej zmiany w interfejsie API.

Wartości w polu enum
MEASUREMENT_UNIT_UNSPECIFIED Brakująca lub nieokreślona wartość MeasurementUnit.
STANDARD Ten wskaźnik używa jednostek domyślnych.
CURRENCY Te dane służą do pomiaru waluty.
FEET Jest to liczba stóp.
METERS Ten wskaźnik to metry.
KILOMETERS Ta wartość to kilometry.
MILES Ten wskaźnik służy do pomiaru mil.
MILLISECONDS Ta wartość to milisekundy.
SECONDS Jest to liczba sekund.
MINUTES Ten wskaźnik to minuty.
HOURS Ten rodzaj danych to godziny.

MetricScope

Zakres tych danych.

Wartości w polu enum
METRIC_SCOPE_UNSPECIFIED Nieznany lub nieokreślony zakres.
EVENT Wskaźnik ograniczony do zdarzenia.

RestrictedMetricType

Etykiety oznaczające dane w tych danych niestandardowych jako dane, które powinny być dostępne tylko dla określonych użytkowników.

Wartości w polu enum
RESTRICTED_METRIC_TYPE_UNSPECIFIED Nieznany lub nieokreślony typ.
COST_DATA Dane raportują dane o kosztach.
REVENUE_DATA Dane raportują dane o przychodach.

Metody

archive

Archiwizuje niestandardowe dane w usłudze.

create

Tworzy dane niestandardowe.

get

Wyszukiwanie pojedynczych danych niestandardowych.

list

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

patch

Aktualizuje niestandardowe dane w usłudze.