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

Wymagane. Stały. Nazwa tagowania tych danych niestandardowych.

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

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

displayName

string

Wymagane. Wyświetlana nazwa niestandardowych danych widoczna w interfejsie Analytics. Maksymalna długość 82 znaków alfanumerycznych, w tym spacja i podkreślenia, które zaczynają się od litery. Starsze wyświetlane nazwy generowane przez system mogą zawierać nawiasy kwadratowe, ale aktualizacja tego pola nie będzie zezwalać na stosowanie nawiasów kwadratowych.

description

string

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

measurementUnit

enum (MeasurementUnit)

Wymagane. Typ wartości danych niestandardowych.

scope

enum (MetricScope)

Wymagane. Stały. 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 CURRENCY. To pole musi być puste w przypadku danych z jednostką miary innej niż CURRENCY.

MeasurementUnit

Możliwe typy przedstawiania wartości danych niestandardowych.

W przyszłości prezentacja waluty może się zmienić, co może wymagać zmiany interfejsu API.

Wartości w polu enum
MEASUREMENT_UNIT_UNSPECIFIED Brak jednostki miary lub jej brak.
STANDARD Ten wskaźnik używa jednostek domyślnych.
CURRENCY Te dane określają walutę.
FEET Ta wartość to stopy.
METERS Ta wartość to metry.
KILOMETERS Ta wartość to kilometry.
MILES Ten rodzaj danych mierzy mile.
MILLISECONDS Ta wartość jest mierzona w milisekundach.
SECONDS Ta wartość służy do pomiaru sekund.
MINUTES Ta wartość to pomiar minut.
HOURS Ten wskaźnik mierzy godziny.

MetricScope

Zakres tego wskaźnika.

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

RestrictedMetricType

Etykiety oznaczają informacje 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 Typ nieznany lub nieokreślony.
COST_DATA Dane są podawane w raportach o kosztach.
REVENUE_DATA Dane są podawane w raportach o przychodach.

Metody

archive

Archiwizuje dane CustomMetric w usłudze.

create

Tworzy dane CustomMetric.

get

Wyszukaj pojedynczy rodzaj danych niestandardowych.

list

Wyświetla listę wskaźników CustomMetrics w usłudze.

patch

Aktualizuje dane niestandardowe w usłudze.