REST Resource: accounts.containers.workspaces.variables

Ressource : Variable

Représente une variable Google Tag Manager.

Représentation JSON
{
  "path": string,
  "accountId": string,
  "containerId": string,
  "workspaceId": string,
  "variableId": string,
  "name": string,
  "type": string,
  "notes": string,
  "scheduleStartMs": string,
  "scheduleEndMs": string,
  "parameter": [
    {
      object (Parameter)
    }
  ],
  "enablingTriggerId": [
    string
  ],
  "disablingTriggerId": [
    string
  ],
  "fingerprint": string,
  "parentFolderId": string,
  "tagManagerUrl": string,
  "formatValue": {
    object (FormatValue)
  }
}
Champs
path

string

Chemin relatif de l'API de la variable GTM.

accountId

string

ID du compte GTM.

containerId

string

ID du conteneur GTM.

workspaceId

string

ID de l'espace de travail GTM.

variableId

string

L'ID de la variable identifie de manière unique la variable GTM.

name

string

Nom à afficher de la variable.

type

string

Type de variable GTM.

notes

string

Notes de l'utilisateur sur la façon d'appliquer cette variable dans le conteneur.

scheduleStartMs

string (int64 format)

Horodatage de début en millisecondes pour planifier une variable.

scheduleEndMs

string (int64 format)

Horodatage de fin en millisecondes pour planifier une variable.

parameter[]

object (Parameter)

Paramètres de la variable.

enablingTriggerId[]

string

Pour les conteneurs mobiles uniquement : liste des ID de déclencheurs permettant d'activer des variables conditionnelles. La variable est activée si l'un des déclencheurs d'activation est "true" et que tous les déclencheurs de désactivation sont "false". Considéré comme un ensemble non ordonné.

disablingTriggerId[]

string

Pour les conteneurs mobiles uniquement : liste des ID de déclencheurs permettant de désactiver des variables conditionnelles. La variable est activée si l'un des déclencheurs d'activation est "true" et que tous les déclencheurs de désactivation sont "false". Considéré comme un ensemble non ordonné.

fingerprint

string

Empreinte de la variable GTM calculée au moment du stockage. Cette valeur est recalculée chaque fois que la variable est modifiée.

parentFolderId

string

ID du dossier parent.

tagManagerUrl

string

Lien généré automatiquement vers l'interface utilisateur de Tag Manager.

formatValue

object (FormatValue)

Option permettant de convertir la valeur d'une variable en une autre valeur.

FormatValue

Représentation JSON
{
  "caseConversionType": enum (CaseConversionType),
  "convertToNumber": enum (DecimalSeparatorType),
  "convertNullToValue": {
    object (Parameter)
  },
  "convertUndefinedToValue": {
    object (Parameter)
  },
  "convertToBoolean": boolean,
  "convertTrueToValue": {
    object (Parameter)
  },
  "convertFalseToValue": {
    object (Parameter)
  }
}
Champs
caseConversionType

enum (CaseConversionType)

Option permettant de convertir la valeur d'une variable de type chaîne en minuscules ou en majuscules.

convertToNumber

enum (DecimalSeparatorType)

Option permettant de convertir la valeur d'une variable en nombre.

convertNullToValue

object (Parameter)

Valeur à convertir si la valeur d'une variable est nulle.

convertUndefinedToValue

object (Parameter)

Valeur à convertir si la valeur d'une variable n'est pas définie.

convertToBoolean

boolean

Option permettant de convertir la valeur d'une variable en booléen.

convertTrueToValue

object (Parameter)

Valeur à convertir si la valeur d'une variable est "true".

convertFalseToValue

object (Parameter)

Valeur à convertir si la valeur d'une variable est "false".

CaseConversionType

Enums
none
lowercase Option permettant de convertir la valeur d'une variable en minuscules.
uppercase Option permettant de convertir la valeur d'une variable en majuscules.

DecimalSeparatorType

Enums
decimalSeparatorTypeUnspecified
period Option permettant de convertir la valeur d'une variable en nombre avec un point comme séparateur décimal.
comma Option permettant de convertir la valeur d'une variable en nombre avec une virgule comme séparateur décimal.
automatic Option permettant de convertir la valeur d'une variable en nombre avec détection automatique du séparateur décimal.

Méthodes

create

Crée une variable GTM.

delete

Supprime une variable GTM.

get

Récupère une variable GTM.

list

Répertorie toutes les variables GTM d'un conteneur.

revert

Rétablit les modifications apportées à une variable GTM dans un espace de travail GTM.

update

Met à jour une variable GTM.