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

Identyfikator. Nazwa zasobu tej niestandardowej wartości. Format: properties/{property}/customMetrics/{customMetric}
parameterName

string

Wymagane. Niezmienna. 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 oraz musi zaczynać się od litery. Maksymalna długość wskaźników ograniczonych do zdarzenia to 40 znaków.
displayName

string

Wymagane. Wyświetlana nazwa tych danych niestandardowych widoczna w interfejsie Analytics. Maksymalna długość to 82 znaki alfanumeryczne, spacja i podkreślenie, zaczynające się od litery. Wyświetlane nazwy wygenerowane przez starsze systemy mogą zawierać nawiasy kwadratowe, ale aktualizacje tego pola nigdy nie będą ich dopuszczać.
description

string

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

enum (MeasurementUnit)

Wymagane. Typ wartości danych niestandardowych.
scope

enum (MetricScope)

Wymagane. Niezmienna. Zakres tych danych niestandardowych.
restrictedMetricType[]

enum (RestrictedMetricType)

Opcjonalnie. Typy danych z ograniczonym dostępem, które mogą być zawarte w tym rodzaju danych. Wymagane w przypadku danych z jednostką miary CURRENCY. W przypadku danych z jednostką miary inną niż CURRENCY pole musi być puste.

MeasurementUnit

Możliwe typy reprezentacji wartości danych niestandardowych.

Sposób reprezentacji waluty może się w przyszłości zmienić, co będzie wymagało wprowadzenia zmian w interfejsie API.

Wartości w polu enum
MEASUREMENT_UNIT_UNSPECIFIED Brak jednostki miary lub nie została ona określona.
STANDARD Ten wskaźnik używa domyślnych jednostek.
CURRENCY Te dane są wyrażone w walucie.
FEET Te dane są podawane w stopach.
METERS Te dane są podawane w metrach.
KILOMETERS Te dane są podawane w kilometrach.
MILES Te dane są podawane w milach.
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.

MetricScope

Zakres tych danych.

Wartości w polu enum
METRIC_SCOPE_UNSPECIFIED Zakres nieznany lub nieokreślony.
EVENT Dane ograniczone do zdarzenia.

RestrictedMetricType

Etykiety, które oznaczają dane w tej niestandardowej wartości jako dane, do których dostęp powinien być ograniczony do określonych użytkowników.

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

archive

 Archiwizuje dane niestandardowe w usłudze.

create

 Tworzy obiekt CustomMetric.

get

 Wyszukiwanie pojedynczego obiektu CustomMetric.

list

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

patch

 Aktualizuje CustomMetric w usłudze.