REST Resource: properties.customDimensions

Ressource: CustomDimension

Eine Definition für eine benutzerdefinierte Dimension.

JSON-Darstellung
{
  "name": string,
  "parameterName": string,
  "displayName": string,
  "description": string,
  "scope": enum (DimensionScope),
  "disallowAdsPersonalization": boolean
}
Felder
name

string

Nur Ausgabe. Ressourcenname für diese CustomDimension-Ressource. Format: properties/{property}/customDimensions/{customDimension}

parameterName

string

Erforderlich. Nicht veränderbar. Name des Tagging-Parameters für diese benutzerdefinierte Dimension.

Wenn es sich um eine Dimension auf Nutzerebene handelt, ist dies der Name der Nutzereigenschaft. Bei einer Dimension auf Ereignisebene ist dies der Name des Ereignisparameters.

Wenn es sich um eine Dimension auf Artikelebene handelt, ist dies der Parametername im E-Commerce-Artikel-Array.

Darf nur alphanumerische Zeichen und Unterstriche enthalten und muss mit einem Buchstaben beginnen. Maximale Länge: 24 Zeichen für Dimensionen auf Nutzerebene, 40 Zeichen für Dimensionen auf Ereignisebene.

displayName

string

Erforderlich. Der Anzeigename dieser benutzerdefinierten Dimension, wie er in der Analytics-Benutzeroberfläche angezeigt wird. Maximal 82 Zeichen, alphanumerisch, mit Leerzeichen und Unterstrich, beginnend mit einem Buchstaben. Alte systemgenerierte Anzeigenamen können eckige Klammern enthalten, bei Aktualisierungen dieses Feldes sind sie jedoch nicht zulässig.

description

string

Optional. Beschreibung dieser benutzerdefinierten Dimension. Maximale Länge: 150 Zeichen.

scope

enum (DimensionScope)

Erforderlich. Nicht veränderbar. Der Geltungsbereich dieser Dimension.

disallowAdsPersonalization

boolean

Optional. Wenn dieser Parameter auf „wahr“ gesetzt ist, wird diese Dimension als nicht personalisiert gekennzeichnet und von der Personalisierung von Anzeigen ausgeschlossen.

Dies wird derzeit nur von benutzerdefinierten Dimensionen auf Nutzerebene unterstützt.

DimensionScope

Gültige Werte für den Gültigkeitsbereich dieser Dimension.

Enums
DIMENSION_SCOPE_UNSPECIFIED Umfang unbekannt oder nicht angegeben.
EVENT Dimension auf Ereignisebene
USER Dimension auf Nutzerebene.
ITEM Dimension auf E-Commerce-Artikelebene

Methoden

archive

Archiviert eine benutzerdefinierte Dimension in einer Property.

create

Erstellt eine benutzerdefinierte Dimension.

get

Suche nach einer einzelnen benutzerdefinierten Dimension.

list

Listet benutzerdefinierte Dimensionen für eine Property auf.

patch

Aktualisiert eine benutzerdefinierte Dimension in einer Property.