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 CustomMetric. Format: usługi/{usługa}customMetrics/{customMetric}
parameterName

string

Wymagane. Niezmienna. Nazwa tagu dla tych danych niestandardowych.

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

Nazwa może zawierać tylko znaki alfanumeryczne i podkreślenia. Musi zaczynać się od litery. Dane ograniczone do zdarzenia mogą mieć maksymalnie 40 znaków.
displayName

string

Wymagane. Wyświetlana nazwa tych danych niestandardowych w interfejsie Analytics. Maksymalna długość to 82 znaki, w tym znaki alfanumeryczne, spacje i znaki podkreślenia zaczynające się od litery. Wyświetlane nazwy generowane przez starsze wersje systemu mogą zawierać nawiasy kwadratowe, ale aktualizacje tego pola nigdy nie będą zawierać nawiasów kwadratowych.
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ą zawierać te dane. Wymagane w przypadku danych z jednostką miary PIENIĄDZE. W przypadku danych z jednostką miary inną niż CURRENCY pole musi być puste.

MeasurementUnit

Możliwe typy wartości danych niestandardowych.

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

Wartości w polu enum
MEASUREMENT_UNIT_UNSPECIFIED MeasurementUnit nie został określony lub go brakuje.
STANDARD Te dane używają domyślnych jednostek.
CURRENCY Te dane dotyczą waluty.
FEET Te dane dotyczą stóp.
METERS Te dane są podawane w metrach.
KILOMETERS Te dane dotyczą kilometrów.
MILES Te dane dotyczą mil.
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.

MetricScope

Zakres tych danych.

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

RestrictedMetricType

Etykiety, które oznaczają dane w tej metryce niestandardowej jako dane, które powinny być ograniczone do określonych użytkowników.

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

archive

 Archiwizuje dane niestandardowe w usłudze.

create

 Tworzy dane niestandardowe.

get

 wyszukiwanie pojedynczych danych niestandardowych,

list

 Wyświetla dane niestandardowe w usłudze.

patch

 Aktualizuje dane niestandardowe w usłudze.