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

ID. Ressourcenname für diese CustomMetric-Ressource. Format: properties/{property}/customMetrics/{customMetric}
parameterName

string

Erforderlich. Nicht veränderbar. Der 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. Maximale Länge: 82 Zeichen. Alphanumerische Zeichen, Leerzeichen und Unterstriche sind zulässig. Muss mit einem Buchstaben beginnen. Von Legacy-Systemen generierte Anzeigenamen können eckige Klammern enthalten. Bei Aktualisierungen dieses Felds sind eckige Klammern jedoch nicht zulässig.
description

string

Optional. Beschreibung für diese benutzerdefinierte 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 CURRENCY. Muss für Messwerte mit einer anderen Maßeinheit als CURRENCY leer sein.

MeasurementUnit

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

Die Darstellung von Währungen kann sich in Zukunft ändern, was eine grundlegende API-Änderung erfordert.

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ß gemessen.
METERS Dieser Messwert wird in Metern angegeben.
KILOMETERS Dieser Messwert wird in Kilometern gemessen.
MILES Mit diesem Messwert werden Kilometer gemessen.
MILLISECONDS Dieser Messwert wird in Millisekunden gemessen.
SECONDS Dieser Messwert wird in Sekunden gemessen.
MINUTES Dieser Messwert wird in Minuten angegeben.
HOURS Dieser Messwert wird in Stunden gemessen.

MetricScope

Der Bereich dieses Messwerts.

Enums
METRIC_SCOPE_UNSPECIFIED Der Bereich ist 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 sollten.

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

Methoden

archive

 Archiviert einen CustomMetric für eine Property.

create

 Erstellt einen CustomMetric.

get

 Sucht nach einem einzelnen CustomMetric.

list

 Listet CustomMetrics für eine Property auf.

patch

 Aktualisiert eine benutzerdefinierte Messwertdefinition für eine Property.