REST Resource: properties.customMetrics

Ressource: CustomMetrics

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 benutzerdefinierte Messwertressource. Format: Properties/{Property}/customMetrics/{customMetrics}
parameterName

string

Erforderlich. Nicht veränderbar. 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, die mit einem Buchstaben beginnen. Maximale Länge von 40 Zeichen für Messwerte auf Ereignisebene.
displayName

string

Erforderlich. Der angezeigte Name des benutzerdefinierten Messwerts, wie er in der Analytics-Benutzeroberfläche angezeigt wird. Maximale Länge: 82 Zeichen, alphanumerische Zeichen sowie Leerzeichen und Unterstriche, die mit einem Buchstaben beginnen. Bisherige, vom System generierte Anzeigenamen können eckige Klammern enthalten. Bei Änderungen an diesem Feld sind jedoch keine eckigen 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 von eingeschränkten Daten, die dieser Messwert enthalten kann. Erforderlich für Messwerte mit der Maßeinheit Währung. Muss für Messwerte mit einer Nicht-Währungs-Messeinheit leer sein.

Maßeinheit

Mögliche Arten der Darstellung des benutzerdefinierten Messwerts

Die Währung kann sich in Zukunft ändern, sodass die API geändert werden muss.

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 angegeben.
FEET Dieser Messwert misst Fuß.
METERS Dieser Messwert misst Meter.
KILOMETERS Dieser Messwert ist Kilometer.
MILES Dieser Messwert ist Meilen.
MILLISECONDS Dieser Messwert misst Millisekunden.
SECONDS Dieser Messwert misst Sekunden.
MINUTES Mit diesem Messwert werden Minuten erfasst.
HOURS Dieser Messwert gibt die Stunden an.

Messwertumfang

Der Umfang dieses Messwerts.

Enums
METRIC_SCOPE_UNSPECIFIED Bereich unbekannt oder nicht angegeben.
EVENT Messwert, der einem Ereignis zugeordnet ist.

Eingeschränkter Messwerttyp

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

Enums
RESTRICTED_METRIC_TYPE_UNSPECIFIED Typ unbekannt oder nicht angegeben.
COST_DATA Kostendaten für Messwertberichte
REVENUE_DATA Der Messwert erfasst Umsatzdaten.

Methoden

archive

 Archiviert einen benutzerdefinierten Messwert in einer Property.

create

 Erstellt einen CustomMetrics.

get

 Suchen Sie nach einem einzelnen benutzerdefinierten Messwert.

list

 Listet CustomMetrics für eine Property auf.

patch

 Aktualisiert einen CustomMetrics für eine Eigenschaft.