REST Resource: properties.calculatedMetrics

Ressource: computedMetric

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 computedMetric. Format: 'properties/{property_id}/calculatedMetrics/{calculatedMetricId}'

description

string

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

displayName

string

Erforderlich. Anzeigename für diesen berechneten Messwert, wie er auf der Google Analytics-Benutzeroberfläche angezeigt wird Maximale Länge: 82 Zeichen.

calculatedMetricId

string

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

Die „CalcedMetricId“ wird verwendet, wenn von externen APIs auf diesen berechneten Messwert verwiesen wird. Beispiel: „calcMetric:{calculatedMetricId}“.

metricUnit

enum (MetricUnit)

Erforderlich. Der Typ des berechneten Messwerts.

restrictedMetricType[]

enum (RestrictedMetricType)

Nur Ausgabe. Arten eingeschränkter Daten, die dieser Messwert enthält.

formula

string

Erforderlich. 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 Long (64-Bit-Ganzzahl) oder Double (64-Bit-Gleitkommazahl) passen. Beispielformel: "( customEvent:parameterName + carPurchaseQuantity ) / 2.0"

invalidMetricReference

boolean

Nur Ausgabe. Wenn „true“ festgelegt ist, hat dieser berechnete Messwert eine ungültige Messwertreferenz. Wenn Sie einen berechneten Messwert verwenden, bei dem „ungültigMetricReference“ auf „true“ festgelegt ist, kann es zu einem Fehler, Warnungen oder unerwarteten Ergebnissen kommen.

MetricUnit

Mögliche Arten der Darstellung des berechneten Messwerts.

Enums
METRIC_UNIT_UNSPECIFIED MetricUnit nicht angegeben oder fehlt.
STANDARD Für diesen Messwert werden Standardeinheiten verwendet.
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 die Minuten.
HOURS Mit diesem Messwert werden Stunden gemessen.

RestrictedMetricType

Labels zur Kennzeichnung der Daten in berechneten Messwerten, 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 zu Kostendaten.
REVENUE_DATA Der Messwert gibt Umsatzdaten an.

Methoden

create

Erstellt einen computedMetric-Messwert.

delete

Löscht einen computedMetric-Messwert für eine Property.

get

Suchen Sie nach einem einzelnen computedMetric-Wert.

list

Listet computedMetrics für eine Eigenschaft auf.

patch

Aktualisiert einen Calc.-Messwert für eine Property.