REST Resource: properties.customDimensions

Recurso: CustomDimension

Uma definição para 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 essa dimensão personalizada. Formato: properties/{property}/customDimensions/{customDimension}
parameterName

string

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

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

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

Só pode conter caracteres alfanuméricos e sublinhados, começando com uma letra. O 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. Máximo de 82 caracteres, alfanuméricos, espaço e sublinhado, começando com uma letra. Os nomes de exibição gerados pelo sistema legados podem conter colchetes, mas as atualizações desse campo nunca vão permitir colchetes.
description

string

Opcional. Descrição da dimensão personalizada. O tamanho máximo é de 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ó é possível com as 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 no escopo de um evento.
USER Dimensão no escopo de um usuário.
ITEM Dimensão no escopo dos itens de e-commerce

Métodos

archive

 Arquiva uma CustomDimension em uma propriedade.

create

 Cria uma CustomDimension.

get

 Consultar uma única CustomDimension.

list

 Lista as CustomDimensions em uma propriedade.

patch

 Atualiza uma CustomDimension em uma propriedade.