REST Resource: properties.calculatedMetrics

Ressource: CalculatordMetric

Eine Definition für einen berechneten Messwert.

JSON-Darstellung 
{
  "name": string,
  "description": string,
  "displayName": string,
  "calculatedMetricId": string,
  "metricUnit": enum (MetricUnit),
  "restrictedMetricType": [
    enum (RestrictedMetricType)
  ],
  "formula": string,
  "invalidMetricReference": boolean
}
Felder
name

string

Nur Ausgabe. Ressourcenname für diesen Berechneten Messwert. Format: „properties/{property_id}/installedMetrics/{createdMetricId}“
description

string

Optional. Beschreibung dieses berechneten Messwerts. Maximale Länge: 4.096 Zeichen.
displayName

string

Erforderlich. Anzeigename für diesen berechneten Messwert, wie er in der Google Analytics-Benutzeroberfläche angezeigt wird. Darf maximal 82 Zeichen lang sein.
calculatedMetricId

string

Nur Ausgabe. Die ID, die für den berechneten Messwert verwendet werden soll. In der Benutzeroberfläche wird dies als „API-Name“ bezeichnet.

Sie wird verwendet, wenn von externen APIs auf diesen berechneten Messwert verwiesen wird. Beispiel: „calcMetric:{createdMetricId}“.
metricUnit

enum (MetricUnit)

Erforderlich. Der Typ des berechneten Messwerts.
restrictedMetricType[]

enum (RestrictedMetricType)

Nur Ausgabe. Arten von eingeschränkten Daten, die dieser Messwert enthält.
formula

string

Erforderlich. Die Definition des berechneten Messwerts. Die maximale Anzahl eindeutiger referenzierter benutzerdefinierter Messwerte ist 5. Formeln unterstützen die folgenden Operationen: + (Addition), - (Subtraktion), - (negativ), * (Multiplikation), / (Division), () (Klammer). Alle gültigen reellen Zahlen sind zulässig, die in eine Long- (64-Bit-Ganzzahl) oder eine Double- (64-Bit-Gleitkommazahl) passen. Beispielformel: „( customEvent:parameterName + carPurchaseQuantity ) / 2.0“
invalidMetricReference

boolean

Nur Ausgabe. Falls wahr, hat dieser berechnete Messwert eine ungültige Messwertreferenz. Alle Vorgänge, bei denen ein berechneter Messwert mit dem Wert "true" (ungültig) festgelegt ist, können fehlschlagen, zu Warnungen oder unerwarteten Ergebnissen führen.

MetricUnit

Mögliche Arten zur Darstellung des berechneten Messwerts

Enums
METRIC_UNIT_UNSPECIFIED MetricUnit nicht angegeben oder fehlt.
STANDARD Für diesen Messwert werden Standardeinheiten verwendet.
CURRENCY Mit diesem Messwert wird eine Währung gemessen.
FEET Diese Metrik misst Fuß.
MILES Mit diesem Messwert werden Meilen gemessen.
METERS Dieser Messwert misst Meter.
KILOMETERS Mit diesem Messwert werden Kilometer gemessen.
MILLISECONDS Dieser Messwert misst Millisekunden.
SECONDS Dieser Messwert misst Sekunden.
MINUTES Dieser Messwert misst die Minuten.
HOURS Dieser Messwert gibt die Stunden an.

RestrictedMetricType

Labels, die die Daten in berechneten Messwerten kennzeichnen, die in Verbindung mit Nutzerrollen verwendet werden, die den Zugriff auf Kosten- und/oder Umsatzmesswerte einschränken.

Enums
RESTRICTED_METRIC_TYPE_UNSPECIFIED Typ unbekannt oder nicht angegeben.
COST_DATA Messwertberichte Kostendaten.
REVENUE_DATA Der Messwert enthält Umsatzdaten.

Methoden

create

 Erstellt einen Berechneten Messwert.

delete

 Löscht einen berechneten Messwert für eine Property.

get

 Suche nach einem einzelnen berechneten Messwert.

list

 Listet Berechnete Messwerte für eine Eigenschaft auf.

patch

 Aktualisiert einen Berechneten Messwert für eine Eigenschaft.