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. Tagging-Name für diesen benutzerdefinierten Messwert.

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

Darf nur alphanumerische Zeichen und Unterstriche enthalten und muss mit einem Buchstaben beginnen. 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 von 82 Zeichen, alphanumerisch plus Leerzeichen und Unterstrich, beginnend mit einem Buchstaben. 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 von 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 Währungsdarstellung kann sich in Zukunft ändern, was eine grundlegende API-Änderung erforderlich macht.

Enums
MEASUREMENT_UNIT_UNSPECIFIED Maßeinheit nicht angegeben oder fehlt.
STANDARD Für diesen Messwert werden Standardeinheiten verwendet.
CURRENCY Dieser Messwert misst eine Währung.
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 Dieser Messwert misst Stunden.

MetricScope

Der Umfang dieses Messwerts.

Enums
METRIC_SCOPE_UNSPECIFIED Umfang unbekannt oder nicht angegeben.
EVENT Messwert auf Ereignisebene.

RestrictedMetricType

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

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

Methoden

archive

 Archiviert einen benutzerdefinierten Messwert in einer Property.

create

 Erstellt einen benutzerdefinierten Messwert.

get

 Sucht nach einem einzelnen benutzerdefinierten Messwert.

list

 Listet benutzerdefinierte Messwerte in einer Property auf.

patch

 Aktualisiert einen benutzerdefinierten Messwert in einer Property.