REST Resource: properties.customDimensions

Recurso: CustomDimension

Uma definição de uma CustomDimension.

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

string

Apenas saída. Nome do recurso para este recurso CustomDimension. Formato: propriedades/{property}/customDimensions/{customDimension}
parameterName

string

Obrigatório. Imutável. Nome do parâmetro de inclusão de tag desta 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 do 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.

Só pode conter caracteres alfanuméricos e sublinhados, a começar com uma letra. Comprimento máximo de 24 caracteres para as dimensões no escopo do usuário e 40 caracteres para as 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éricos com espaço e sublinhado começando com uma letra. Nomes de exibição legados gerados pelo sistema podem conter colchetes, mas as atualizações desse campo nunca permitirão colchetes.
description

string

Opcional. Descrição dessa dimensão personalizada. Comprimento máximo de 150 caracteres.
scope

enum (DimensionScope)

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

boolean

Opcional. Se definida como verdadeira, 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 desta dimensão.

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

Métodos

archive

 Arquiva uma CustomDimension em uma propriedade.

create

 Cria uma CustomDimension.

get

 Pesquisa para uma única CustomDimension.

list

 Lista CustomDimensions em uma propriedade.

patch

 Atualiza uma CustomDimension em uma propriedade.