REST Resource: properties.customMetrics

Ressource: CustomMetric

Eine Definition für einen benutzerdefinierten Messwert.

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

string

Nur Ausgabe. Ressourcenname für diese benutzerdefinierte Messwertressource. Format: properties/{property}/customMetrics/{customMetric}

parameterName

string

Erforderlich. Nicht veränderbar. Tagging-Name für diesen benutzerdefinierten Messwert.

Wenn es sich um einen ereignisbezogenen Messwert handelt, ist dies der Name des Ereignisparameters.

Darf nur alphanumerische Zeichen und Unterstriche enthalten und muss mit einem Buchstaben beginnen. Messwerte auf Ereignisebene dürfen maximal 40 Zeichen lang sein.

displayName

string

Erforderlich. Der Anzeigename für diesen benutzerdefinierten Messwert, wie er in der Analytics-Benutzeroberfläche angezeigt wird. Maximal 82 Zeichen, alphanumerisch, mit Leerzeichen und Unterstrich, beginnend mit einem Buchstaben. Alte systemgenerierte Anzeigenamen können eckige Klammern enthalten, bei Aktualisierungen dieses Feldes sind sie jedoch nicht zulässig.

description

string

Optional. Beschreibung dieser benutzerdefinierten Dimension. Maximale Länge: 150 Zeichen.

measurementUnit

enum (MeasurementUnit)

Erforderlich. Der Typ für den Wert des benutzerdefinierten Messwerts.

scope

enum (MetricScope)

Erforderlich. Nicht veränderbar. Der Umfang dieses benutzerdefinierten Messwerts.

restrictedMetricType[]

enum (RestrictedMetricType)

Optional. Arten von eingeschränkten Daten, die dieser Messwert enthalten kann. Erforderlich für Messwerte mit der Maßeinheit WÄHRUNG. Muss für Messwerte ohne Währung leer sein.

MeasurementUnit

Mögliche Arten, den Wert des benutzerdefinierten Messwerts darzustellen.

Die Währungsdarstellung kann sich in Zukunft ändern, was eine API-Änderung mit sich bringen kann.

Enums
MEASUREMENT_UNIT_UNSPECIFIED „MeasurementUnit“ nicht angegeben oder fehlt.
STANDARD Für diesen Messwert werden Standardeinheiten verwendet.
CURRENCY Dieser Messwert wird in einer Währung angegeben.
FEET Dieser Messwert wird in Fuß angegeben.
METERS Dieser Messwert wird in Metern angegeben.
KILOMETERS Dieser Messwert wird in Kilometern angegeben.
MILES Dieser Messwert wird in Meilen angegeben.
MILLISECONDS Dieser Messwert wird in Millisekunden gemessen.
SECONDS Dieser Messwert wird in Sekunden gemessen.
MINUTES Dieser Messwert wird in Minuten gemessen.
HOURS Dieser Messwert wird in Stunden gemessen.

MetricScope

Der Geltungsbereich dieses Messwerts.

Enums
METRIC_SCOPE_UNSPECIFIED Umfang unbekannt oder nicht angegeben.
EVENT Messwert auf Ereignisebene

RestrictedMetricType

Labels, die die Daten in diesem benutzerdefinierten Messwert als Daten kennzeichnen, die auf bestimmte Nutzer beschränkt werden sollen.

Enums
RESTRICTED_METRIC_TYPE_UNSPECIFIED Typ unbekannt oder nicht angegeben.
COST_DATA Messwertberichte enthalten Kostendaten.
REVENUE_DATA Messwerte enthalten Umsatzdaten.

Methoden

archive

Archiviert einen benutzerdefinierten Messwert in einer Property.

create

Erstellt einen benutzerdefinierten Messwert.

get

Suche nach einem einzelnen benutzerdefinierten Messwert.

list

Listet benutzerdefinierte Messwerte für eine Property auf.

patch

Aktualisiert einen benutzerdefinierten Messwert für eine Property.