REST Resource: properties.customDimensions

Recurso: CustomDimension

Uma definição para um CustomDimension.

Representação JSON 
{
  "name": string,
  "parameterName": string,
  "displayName": string,
  "description": string,
  "scope": enum (DimensionScope),
  "disallowAdsPersonalization": boolean
}
Campos
name

string

Identificador. Nome do recurso para este recurso CustomDimension. Formato: properties/{property}/customDimensions/{customDimension}
parameterName

string

Obrigatório. Imutável. Nome do parâmetro de inclusão de tag para essa dimensão personalizada.

Se for uma dimensão no escopo do usuário, esse será o nome da propriedade do usuário. Se for uma dimensão no escopo do evento, esse será o nome do parâmetro de evento.

Se for uma dimensão no escopo do item, esse será o nome do parâmetro encontrado na matriz de itens de e-commerce.

Pode conter apenas caracteres alfanuméricos e sublinhados, começando com uma letra. Comprimento máximo de 24 caracteres para dimensões no escopo do usuário e 40 caracteres para dimensões no escopo do evento.
displayName

string

Obrigatório. Nome de exibição dessa dimensão personalizada, conforme mostrado na interface do Google Analytics. Comprimento máximo de 82 caracteres, alfanumérico mais espaço e sublinhado começando com uma letra. Os nomes de exibição legados gerados pelo sistema podem conter colchetes, mas as atualizações desse campo nunca vão permitir colchetes.
description

string

Opcional. Descrição para essa dimensão personalizada. No máximo 150 caracteres.
scope

enum (DimensionScope)

Obrigatório. Imutável. O escopo dessa dimensão.
disallowAdsPersonalization

boolean

Opcional. Se definido como "true", define essa dimensão como NPA e a exclui da personalização de anúncios.

No momento, isso só é compatível com dimensões personalizadas no escopo do usuário.

DimensionScope

Valores válidos para o escopo dessa dimensão.

Tipos enumerados
DIMENSION_SCOPE_UNSPECIFIED Escopo desconhecido ou não especificado.
EVENT Dimensão no escopo de um evento.
USER Dimensão no escopo de um usuário.
ITEM Dimensão no escopo de itens de e-commerce

Métodos

archive

 Arquiva uma CustomDimension em uma propriedade.

create

 Cria uma CustomDimension.

get

 Pesquisa de uma única CustomDimension.

list

 Lista CustomDimensions em uma propriedade.

patch

 Atualiza uma CustomDimension em uma propriedade.