REST Resource: properties.customDimensions

Ressource: CustomDimension

Définition d'une CustomDimension.

Représentation JSON
{
  "name": string,
  "parameterName": string,
  "displayName": string,
  "description": string,
  "scope": enum (DimensionScope),
  "disallowAdsPersonalization": boolean
}
Champs
name

string

Uniquement en sortie. Nom de la ressource CustomDimension. Format: properties/{property}/customDimensions/{customDimension}

parameterName

string

Obligatoire. Immuable. Nom du paramètre d'ajout de balises pour cette dimension personnalisée.

S'il s'agit d'une dimension de portée utilisateur, il s'agit du nom de la propriété utilisateur. S'il s'agit d'une dimension de portée événement, il s'agit du nom du paramètre d'événement.

S'il s'agit d'une dimension de portée article, il s'agit du nom du paramètre trouvé dans le tableau "Articles d'e-commerce".

Le nom ne peut contenir que des caractères alphanumériques et des traits de soulignement, et doit commencer par une lettre. Longueur maximale de 24 caractères pour les dimensions de portée utilisateur et 40 caractères pour les dimensions de portée événement.

displayName

string

Obligatoire. Nom à afficher pour cette dimension personnalisée, tel qu'il apparaît dans l'interface utilisateur Analytics. Longueur maximale de 82 caractères, caractères alphanumériques, espace et trait de soulignement commençant par une lettre. Les anciens noms à afficher générés par le système peuvent contenir des crochets, mais les mises à jour de ce champ n'autoriseront jamais les crochets.

description

string

Facultatif. Description de cette dimension personnalisée. Longueur maximale : 150 caractères

scope

enum (DimensionScope)

Obligatoire. Immuable. Portée de cette dimension.

disallowAdsPersonalization

boolean

Facultatif. Si elle est définie sur "True", cette dimension est définie comme ANP et l'exclut de la personnalisation des annonces.

Pour le moment, cette option n'est compatible qu'avec les dimensions personnalisées de portée utilisateur.

DimensionScope

Valeurs valides pour la portée de cette dimension.

Enums
DIMENSION_SCOPE_UNSPECIFIED Champ d'application inconnu ou non spécifié.
EVENT Dimension appliquée à un événement.
USER Dimension appliquée à un utilisateur.
ITEM Dimension appliquée aux articles d'e-commerce

Méthodes

archive

Archive un CustomDimension sur une propriété.

create

Crée un CustomDimension.

get

Recherche pour une seule CustomDimension.

list

Répertorie les CustomDimensions sur une propriété.

patch

Met à jour une CustomDimension sur une propriété.