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 dies der Name des Ereignisparameters.

Darf nur alphanumerische Zeichen und Unterstriche enthalten, die mit einem Buchstaben beginnen. Maximale Länge: 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 Änderungen an diesem Feld sind eckige Klammern jedoch nie 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. 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. Dieses Feld muss für Messwerte mit einer anderen Maßeinheit als Währung 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 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 die Minuten.
HOURS Mit diesem Messwert werden Stunden gemessen.

MetricScope

Umfang dieses Messwerts.

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

RestrictedMetricType

Labels, durch die 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 Messwertberichte zu Kostendaten.
REVENUE_DATA Der Messwert gibt Umsatzdaten an.

Methoden

archive

Archiviert einen CustomMetric für eine Eigenschaft.

create

Erstellt einen CustomMetric.

get

Suchen Sie nach einem einzelnen CustomMetric.

list

Listet CustomMetrics für eine Eigenschaft auf.

patch

Aktualisiert einen CustomMetric für eine Eigenschaft.