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 este recurso CustomDimension. Formato: Properties/{property}/customDimensões/{customDimension}

parameterName

string

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

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

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

Pode conter apenas caracteres alfanuméricos e sublinhado, 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éricos mais espaço e sublinhado começando com uma letra. Nomes de exibição gerados pelo sistema legados podem conter colchetes, mas as atualizações nesse 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 dessa dimensão.

disallowAdsPersonalization

boolean

Opcional. Se definida como verdadeira, a dimensão será definida como NPA e será excluída 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 no escopo para itens de e-commerce

Métodos

archive

Arquiva uma CustomDimension em uma propriedade.

create

Cria uma CustomDimension.

get

Busca uma única CustomDimension.

list

Lista as dimensões personalizadas de uma propriedade.

patch

Atualiza uma CustomDimension em uma propriedade.