REST Resource: properties.customDimensions

Zasób: Wymiar niestandardowy

Definicja wymiaru niestandardowego.

Zapis JSON
{
  "name": string,
  "parameterName": string,
  "displayName": string,
  "description": string,
  "scope": enum (DimensionScope),
  "disallowAdsPersonalization": boolean
}
Pola
name

string

Tylko dane wyjściowe. Nazwa zasobu tego zasobu wymiaru niestandardowego. Format: properties/{property}/customDimensions/{customDimension}

parameterName

string

Wymagane. Stałe. Nazwa parametru tagowania dla tego wymiaru niestandardowego.

Jeśli jest to wymiar ograniczony do użytkownika, jest to nazwa właściwości użytkownika. Jeśli jest to wymiar ograniczony do zdarzenia, jest to nazwa parametru zdarzenia.

Jeśli jest to wymiar ograniczony do produktu, jest to nazwa parametru z tablicy items e-commerce.

Nazwa może zawierać tylko znaki alfanumeryczne i podkreślenia, zaczynając od litery. Maksymalna długość to 24 znaki w przypadku wymiarów ograniczonych do użytkownika i 40 znaków w przypadku wymiarów ograniczonych do zdarzenia.

displayName

string

Wymagane. Wyświetlana nazwa tego wymiaru niestandardowego podana w interfejsie Analytics. Maksymalna długość to 82 znaki, ze znakami alfanumerycznymi, spacjami i podkreśleniami zaczynającymi się od litery. Starsze wyświetlane nazwy generowane przez system mogą zawierać nawiasy kwadratowe, ale aktualizowanie tego pola nigdy nie zezwala na użycie nawiasów kwadratowych.

description

string

Opcjonalnie. Opis tego wymiaru niestandardowego. Maksymalna długość to 150 znaków.

scope

enum (DimensionScope)

Wymagane. Stałe. Zakres tego wymiaru.

disallowAdsPersonalization

boolean

Opcjonalnie. Jeśli ma wartość Prawda, ustawia ten wymiar jako niespersonalizowany i wyklucza go z personalizacji reklam.

Obecnie ta funkcja jest obsługiwana tylko w przypadku wymiarów niestandardowych ograniczonych do użytkownika.

DimensionScope

Prawidłowe wartości dla zakresu tego wymiaru.

Wartości w polu enum
DIMENSION_SCOPE_UNSPECIFIED Nieznany lub nieokreślony zakres.
EVENT Wymiar ograniczony do zdarzenia.
USER Wymiar ograniczony do użytkownika.
ITEM Wymiar ograniczony do elementów e-commerce

Metody

archive

Archiwizuje wymiar niestandardowy w usłudze.

create

Tworzy wymiar niestandardowy.

get

Wyszukują pojedynczy wymiar niestandardowy.

list

Wyświetla listę wymiarów niestandardowych w usłudze.

patch

Aktualizuje wymiar niestandardowy w usłudze.