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.

Bei einem ereignisbezogenen Messwert ist das der Name des Ereignisparameters.

Darf nur alphanumerische Zeichen und Unterstriche enthalten, die mit einem Buchstaben beginnen. Messwerte auf Ereignisebene dürfen maximal 40 Zeichen lang sein.
displayName

string

Erforderlich. Anzeigename für diesen benutzerdefinierten Messwert, wie er in der Analytics-Benutzeroberfläche angezeigt wird. Darf 82 Zeichen lang sein, alphanumerische Zeichen plus Leerzeichen und Unterstriche beginnend mit einem Buchstaben. Ältere, vom System generierte Anzeigenamen können eckige Klammern enthalten. Aktualisierungen dieses Feldes lassen jedoch keine eckigen Klammern zu.
description

string

Optional. Beschreibung dieser benutzerdefinierten Dimension. Max. 150 Zeichen.
measurementUnit

enum (MeasurementUnit)

Erforderlich. Der Typ des benutzerdefinierten Messwerts.
scope

enum (MetricScope)

Erforderlich. Nicht veränderbar. 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 Arten zur Darstellung des Werts des benutzerdefinierten Messwerts.

Die Währung 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 Diese Metrik misst Fuß.
METERS Dieser Messwert misst Meter.
KILOMETERS Mit diesem Messwert werden Kilometer gemessen.
MILES Mit diesem Messwert werden Meilen gemessen.
MILLISECONDS Dieser Messwert misst Millisekunden.
SECONDS Dieser Messwert misst Sekunden.
MINUTES Dieser Messwert misst die Minuten.
HOURS Dieser Messwert gibt die Stunden an.

MetricScope

Der Umfang dieses Messwerts.

Enums
METRIC_SCOPE_UNSPECIFIED Bereich unbekannt oder nicht angegeben.
EVENT Messwert, der auf ein Ereignis festgelegt ist.

RestrictedMetricType

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

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

Methoden

archive

 Archiviert einen CustomMetric für eine Property.

create

 Erstellt einen CustomMetric.

get

 Suche nach einem einzelnen CustomMetric.

list

 Listet CustomMetrics für eine Eigenschaft auf.

patch

 Aktualisiert einen CustomMetric für eine Eigenschaft.