API Tag Manager – Référence du dictionnaire de variables

Ce document décrit les propriétés pouvant être définies pour les variables Google Tag Manager.

Introduction

Chaque variable Google Tag Manager possède un code type pour l'identifier. En outre, la plupart des variables comportent des paramètres (paires key, type) que vous pouvez définir dans un "objet de paramètre" lorsque vous créez ou mettez à jour une variable. Pour en savoir plus sur la définition de ces paramètres à l'aide d'un objet de paramètre, consultez la page Référence des paramètres.

Le reste de ce document liste les détails de toutes les variables compatibles.

Cookie propriétaire

Code de type

k

Paramètres

Clé	Type	Remarques
name	template	Nom du cookie

Exemple

 {
   "name": "Sample First Party Cookie Variable",
   "type": "k",
   "parameter": [
    {
     "type": "template",
     "key": "name",
     "value": "myCookieName"
    }
   ]
 }

Variable d'événement automatique

Code de type

aev

Paramètres

Clé	Type	Remarques
varType	template	L'un des éléments suivants : ELEMENT,CLASSES, ID, TARGET, TEXT, URL, HISTORY_NEW_URL_FRAGMENT, HISTORY_OLD_URL_FRAGMENT, HISTORY_NEW_STATE, HISTORY_OLD_STATE ou HISTORY_CHANGE_SOURCE.
defaultValue	template	Facultatif.

Exemple

  {
   "name": "Sample AutoEvent Variable",
   "type": "aev",
   "parameter": [
    {
     "type": "template",
     "key": "varType",
     "value": "CLASSES"
    },
    {
     "type": "template",
     "key": "defaultValue",
     "value": "MyDefault"
    }
   ]
  }

Chaîne constante

Code de type

c

Paramètres

Clé	Type
value	template

Exemple

  {
   "name": "Sample Constant String",
   "type": "c",
   "parameter": [
    {
     "type": "template",
     "key": "value",
     "value": "MyString"
    }
   ]
  }

Numéro de version du conteneur

Code de type

ctv

Paramètres

N/A

Exemple

  {
   "name": "Sample Container Version Number",
   "type": "ctv"
  }

Événement personnalisé

Code de type

Paramètres

N/A

Exemple

  {
   "name": "Custom Event Name",
   "type": "e"
  }

JavaScript personnalisé

Code de type

jsm

Paramètres

Clé	Type
javascript	template

Exemple

  {
   "name": "Sample Custom Javascript",
   "type": "jsm",
   "parameter": [
    {
     "type": "template",
     "key": "javascript",
     "value": "function() {\n return \"Hello World\";\n}"
    }
   ]
  }

Variable de couche de données

Code de type

v

Paramètres

Clé	Type	Remarques
name	template	Nom de la variable de couche de données.
defaultValue	template
dataLayerVersion	integer	1 ou 2.

Exemple

  {
   "name": "Sample Data Layer Variable",
   "type": "v",
   "parameter": [
    {
     "type": "template",
     "key": "name",
     "value": "DL Variable Name"
    },
    {
     "type": "template",
     "key": "defaultValue",
     "value": "DEFAULT"
    },
    {
     "type": "integer",
     "key": "dataLayerVersion",
     "value": "2"
    }
   ]
  }

Mode débogage

Code de type

dbg

Paramètres

N/A

Exemple

  {
   "name": "Sample Debug Mode Variable",
   "type": "dbg"
  }

Élément DOM

Code de type

d

Paramètres

Clé	Type	Remarques
elementId	template
attributeName	template	Facultatif.

Exemple

  {
   "name": "Sample DOM Element Variable",
   "type": "d",
   "parameter": [
    {
     "type": "template",
     "key": "elementId",
     "value": "MyElementId"
    },
    {
     "type": "template",
     "key": "attributeName",
     "value": "MyAttributeName"
    }
   ]
  }

URL de provenance HTTP

Code de type

f

Paramètres

Clé	Type	Remarques
component	template	Choix possible: URL, PROTOCOL, HOST, PORT, PATH, QUERY, FRAGMENT.
stripWww	boolean	Pour le composant = HOST
queryKey	template	Pour le composant = QUERY

Exemple

  {
   "name": "Sample HTTP Referrer Variable",
   "type": "f",
   "parameter": [
    {
     "type": "template",
     "key": "component",
     "value": "URL"
    }
   ]
  }

Variable JavaScript

Code de type

j

Paramètres

Clé	Type	Remarques
name	template	Nom de la variable globale.

Exemple

  {
   "name": "Sample Javascript Variable",
   "type": "j",
   "parameter": [
    {
     "type": "template",
     "key": "name",
     "value": "MyGlobalVarName"
    }
   ]
  }

Tableau de conversion

Code de type

smm

Paramètres

Clé	Type	Remarques
input	template	La valeur utilisée pour la recherche doit être une référence à une variable.
map	list	Liste de cartes, chacune avec une seule paire [key, value].
map[].key	template
map[].value	template
defaultValue	template	Facultatif.

Exemple

  {
   "name": "Sample Lookup Table Variable",
   "type": "smm",
   "parameter": [
    {
     "type": "template",
     "key": "input",
     "value": "{{event}}"
    },
    {
     "type": "list",
     "key": "map",
     "list": [
      {
       "type": "map",
       "map": [
        {
         "type": "template",
         "key": "key",
         "value": "EventEqualsThis"
        },
        {
         "type": "template",
         "key": "value",
         "value": "ThenSetToThis"
        }
       ]
      }
     ]
    },
    {
     "type": "template",
     "key": "defaultValue",
     "value": "MyDefaultValue"
    }
   ]
  }

Nombre aléatoire

Code de type

r

Paramètres

N/A

Exemple

  {
   "name": "Sample Random Number Variable",
   "type": "r"
  }

URL

Code de type

u

Paramètres

Clé	Type	Remarques
component	template	Choix possible: URL, PROTOCOL, HOST, PORT, PATH, QUERY, FRAGMENT.
customUrlSource	template	Facultatif.
stripWww	boolean	Pour le composant = HOST.
queryKey	template	Pour le composant = QUERY.

Exemple

  {
   "name": "Sample URL Variable",
   "type": "u",
   "parameter": [
    {
     "type": "template",
     "key": "component",
     "value": "URL"
    },
    {
     "type": "template",
     "key": "customUrlSource",
     "value": "{{element}}"
    }
   ]
  }