REST Resource: properties.customDimensions

Ressource: CustomDimension

Eine Definition für eine CustomDimension.

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

string

ID. 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. Wenn es sich um eine ereignisbezogene Dimension handelt, ist dies der Name des Ereignisparameters.

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

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. Anzeigename für diese benutzerdefinierte Dimension, wie er in der Analytics-Benutzeroberfläche angezeigt wird. Maximale Länge: 82 Zeichen. Alphanumerische Zeichen, Leerzeichen und Unterstriche sind zulässig. Muss mit einem Buchstaben beginnen. 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: 150 Zeichen.

scope

enum (DimensionScope)

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

disallowAdsPersonalization

boolean

Optional. Wenn der Wert auf „true“ gesetzt ist, wird diese Dimension als NPA festgelegt und von der Personalisierung von Anzeigen ausgeschlossen.

Derzeit wird dies nur von benutzerdefinierten Dimensionen auf Nutzerebene unterstützt.

DimensionScope

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

Enums
DIMENSION_SCOPE_UNSPECIFIED Der Bereich ist unbekannt oder nicht angegeben.
EVENT Dimension auf Ereignisebene.
USER Dimension auf Nutzerebene.
ITEM Dimension auf E-Commerce-Artikel beschränkt

Methoden

archive

Archiviert eine benutzerdefinierte Dimension in einer Property.

create

Erstellt eine CustomDimension.

get

Suche nach einer einzelnen CustomDimension.

list

Listet CustomDimensions für eine Property auf.

patch

Aktualisiert eine benutzerdefinierte Dimension für eine Property.