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

Nur Ausgabe Ressourcenname für diese CustomMetric-Ressource. Format: Properties/{Property}/customMetrics/{customMetric}

parameterName

string

Erforderlich. Nicht veränderbar. Tagging-Name für diesen benutzerdefinierten Messwert.

Wenn es sich um einen Messwert auf Ereignisebene handelt, ist das der Name des Ereignisparameters.

Darf nur alphanumerische Zeichen und Unterstriche enthalten, beginnend mit einem Buchstaben. Maximale Länge von 40 Zeichen für Messwerte auf Ereignisebene.

displayName

string

Erforderlich. Anzeigename für diesen benutzerdefinierten Messwert, wie er in der Analytics-Benutzeroberfläche angezeigt wird Maximale Länge: 82 Zeichen, alphanumerische Zeichen plus Leerzeichen und Unterstriche, die mit einem Buchstaben beginnen Ältere, systemgenerierte Anzeigenamen können eckige Klammern enthalten. Bei Aktualisierungen dieses Felds sind jedoch niemals eckige Klammern zulässig.

description

string

Optional. Beschreibung für diese benutzerdefinierte Dimension. Maximale Länge: 150 Zeichen

measurementUnit

enum (MeasurementUnit)

Erforderlich. Der Typ des benutzerdefinierten Messwerts.

scope

enum (MetricScope)

Erforderlich. Nicht veränderbar. Der Umfang dieses benutzerdefinierten Messwerts.

restrictedMetricType[]

enum (RestrictedMetricType)

Optional. Arten eingeschränkter Daten, die dieser Messwert enthalten kann. Erforderlich für Messwerte mit der Maßeinheit CURRENCY. Muss für Messwerte mit einer anderen Einheit als CURRENCY leer sein.

MeasurementUnit

Mögliche Typen zur Darstellung des benutzerdefinierten Messwerts

Die Währungsdarstellung kann sich in Zukunft ändern, sodass eine nicht abwärtskompatible API-Änderung erforderlich ist.

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

MetricScope

Der Umfang dieses Messwerts.

Enums
METRIC_SCOPE_UNSPECIFIED Bereich unbekannt oder nicht angegeben.
EVENT Messwert, der sich auf ein Ereignis bezieht.

RestrictedMetricType

Labels, die die Daten in diesem benutzerdefinierten Messwert als Daten kennzeichnen, die auf bestimmte Nutzer beschränkt sein sollten.

Enums
RESTRICTED_METRIC_TYPE_UNSPECIFIED Typ unbekannt oder nicht angegeben.
COST_DATA Messwertberichte zu Kostendaten.
REVENUE_DATA Messwert meldet Umsatzdaten.

Methoden

archive

Archiviert einen CustomMetric-Wert für eine Eigenschaft.

create

Erstellt einen CustomMetric.

get

Suche nach einem einzelnen CustomMetric-Wert.

list

Listet CustomMetrics für eine Eigenschaft auf.

patch

Aktualisiert einen CustomMetric-Wert für eine Eigenschaft.