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

Nur Ausgabe. 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. Der Anzeigename für diesen berechneten Messwert in der Google Analytics-Benutzeroberfläche. 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 dies als „API-Name“ bezeichnet.

Die „calculatedMetricId“ wird verwendet, wenn auf diesen berechneten Messwert von externen 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 referenzierter benutzerdefinierter Messwerte beträgt 5. In Formeln sind die folgenden Vorgänge zulässig: + (Addition), - (Subtraktion), - (Negativ), * (Multiplikation), / (Division), () (Klammern). 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 + cartPurchaseQuantity ) / 2.0“

invalidMetricReference

boolean

Nur Ausgabe. Wenn „true“ festgelegt ist, hat dieser berechnete Messwert eine ungültige Messwertreferenz. Wenn für einen berechneten Messwert „invalidMetricReference“ auf „wahr“ festgelegt ist, kann dies zu Fehlern, Warnungen oder unerwarteten Ergebnissen führen.

MetricUnit

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

Enums
METRIC_UNIT_UNSPECIFIED „MetricUnit“ ist 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.
MILES Dieser Messwert wird in Meilen angegeben.
METERS Dieser Messwert wird in Metern angegeben.
KILOMETERS Dieser Messwert wird in Kilometern 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.

RestrictedMetricType

Labels, die die Daten in einem berechneten Messwert kennzeichnen, der in Verbindung mit Nutzerrollen verwendet wird, durch die der Zugriff auf Kosten- und/oder Umsatzmesswerte eingeschränkt wird.

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

Methoden

create

Erstellt einen berechneten Messwert.

delete

Löscht einen berechneten Messwert in einer Property.

get

Suche nach einem einzelnen berechneten Messwert.

list

Listet berechnete Messwerte für eine Property auf.

patch

Aktualisiert einen berechneten Messwert für eine Property.