REST Resource: properties.calculatedMetrics

Ressource: CalculatedMetric

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

ID. Ressourcenname für diesen berechneten Messwert. Format: „properties/{property_id}/calculatedMetrics/{calculatedMetricId}“
description

string

Optional. Beschreibung für diesen berechneten Messwert. 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. Maximale Länge: 82 Zeichen.
calculatedMetricId

string

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

Die calculatedMetricId wird verwendet, wenn auf diesen berechneten Messwert über externe APIs verwiesen wird. Beispiel: „calcMetric:{calculatedMetricId}“.
metricUnit

enum (MetricUnit)

Erforderlich. Der Typ für den Wert 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 benutzerdefinierter Messwerte, auf die verwiesen wird, beträgt 5. Formeln unterstützen die folgenden Operationen: + (Addition), - (Subtraktion), - (Negativ), * (Multiplikation), / (Division), () (Klammern). Es sind alle gültigen reellen Zahlen zulässig, die in einen Long-Wert (64-Bit-Ganzzahl) oder einen Double-Wert (64-Bit-Gleitkommazahl) passen. Beispielformel: „( customEvent:parameterName + cartPurchaseQuantity ) / 2.0“
invalidMetricReference

boolean

Nur Ausgabe. Wenn „true“, hat dieser berechnete Messwert einen ungültigen Messwertverweis. Bei allem, was einen berechneten Messwert mit „invalidMetricReference“ auf „true“ verwendet, kann es zu Fehlern, Warnungen oder unerwarteten Ergebnissen kommen.

MetricUnit

Mögliche Typen zur Darstellung des Werts des berechneten Messwerts.

Enums
METRIC_UNIT_UNSPECIFIED MetricUnit nicht angegeben oder fehlt.
STANDARD Dieser Messwert verwendet Standardeinheiten.
CURRENCY Dieser Messwert misst eine Währung.
FEET Dieser Messwert misst Fuß.
MILES Dieser Messwert misst Meilen.
METERS Dieser Messwert misst Meter.
KILOMETERS Dieser Messwert misst Kilometer.
MILLISECONDS Dieser Messwert misst Millisekunden.
SECONDS Dieser Messwert misst Sekunden.
MINUTES Dieser Messwert misst Minuten.
HOURS Dieser Messwert misst Stunden.

RestrictedMetricType

Labels, die die Daten im berechneten Messwert kennzeichnen und 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 Der Messwert enthält Kostendaten.
REVENUE_DATA Der Messwert enthält Umsatzdaten.

Methoden

create

 Erstellt einen berechneten Messwert.

delete

 Löscht einen berechneten Messwert in einer Property.

get

 Sucht nach einem einzelnen berechneten Messwert.

list

 Listet berechnete Messwerte in einer Property auf.

patch

 Aktualisiert einen berechneten Messwert in einer Property.