REST Resource: properties.customDimensions

Ресурс: Пользовательское измерение

Определение для пользовательского параметра (CustomDimension).

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

string

Идентификатор. Имя ресурса для данного ресурса CustomDimension. Формат: properties/{property}/customDimensions/{customDimension}

parameterName

string

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

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

Если это измерение, ограниченное областью действия элемента, то это имя параметра, найденное в массиве элементов электронной коммерции.

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

displayName

string

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

description

string

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

scope

enum ( DimensionScope )

Обязательно. Неизменяемо. Область действия данного измерения.

disallowAdsPersonalization

boolean

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

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

DimensionScope

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

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

Методы

archive

 Архивирует пользовательское измерение (CustomDimension) для объекта недвижимости.

create

 Создает пользовательское измерение.

get

 Найдите отдельное значение CustomDimension.

list

 Отображает пользовательские размеры объекта недвижимости.

patch

 Обновляет пользовательское измерение в свойстве.