REST Resource: properties.customDimensions

Ресурс: CustomDimension

Определение CustomDimension.

JSON-представление 
{
  "name": string,
  "parameterName": string,
  "displayName": string,
  "description": string,
  "scope": enum (DimensionScope),
  "disallowAdsPersonalization": boolean
}
Поля
name

string

Только вывод. Имя ресурса для этого ресурса CustomDimension. Формат: свойства/{свойство}/customDimensions/{customDimension}

parameter Name

string

Необходимый. Неизменяемый. Имя параметра тегирования для этого специального параметра.

Если это измерение на уровне пользователя, то это имя свойства пользователя. Если это измерение в области событий, то это имя параметра события.

Если это измерение на уровне элемента, то это имя параметра, найденное в массиве элементов электронной коммерции.

Может содержать только буквенно-цифровые символы и символы подчеркивания, начинающиеся с буквы. Максимальная длина — 24 символа для измерений на уровне пользователя и 40 символов для измерений на уровне событий.

display Name

string

Необходимый. Отображаемое имя для этого специального параметра, как показано в пользовательском интерфейсе Analytics. Максимальная длина — 82 символа, буквенно-цифровые, плюс пробел и подчеркивание, начинающиеся с буквы. Отображаемые имена, созданные устаревшей системой, могут содержать квадратные скобки, но обновления этого поля никогда не допускают использования квадратных скобок.

description

string

Необязательный. Описание этого специального параметра. Максимальная длина 150 символов.

scope

enum ( DimensionScope )

Необходимый. Неизменяемый. Объем этого измерения.

disallow Ads Personalization

boolean

Необязательный. Если установлено значение true, этот параметр устанавливается как NPA и исключается из персонализации рекламы.

В настоящее время это поддерживается только специальными параметрами на уровне пользователя.

РазмерОбласть измерения

Допустимые значения для области этого измерения.

Перечисления
DIMENSION_SCOPE_UNSPECIFIED Область применения неизвестна или не указана.
EVENT Измерение привязано к событию.
USER Измерение ограничено пользователем.
ITEM Измерение ограничено товарами электронной торговли

Методы

archive

 Архивирует CustomDimension для свойства.

create

 Создает CustomDimension.

get

 Найдите один CustomDimension.

list

 Перечисляет CustomDimensions для свойства.

patch

 Обновляет CustomDimension свойства.