Ce document décrit l'objectif et la représentation de l'objet de paramètre Tag Manager.
Introduction
L'API Tag Manager vous permet de créer et de gérer des ressources Tag Manager telles que des balises, des règles et des macros.
La plupart des types de tag et de macro comportent des paramètres supplémentaires spécifiques au tag ou à la macro, qui peuvent être définis lors de la création ou de la mise à jour de la ressource. La liste des paramètres (paires key, type) pour chaque balise et type de macro est répertoriée dans la documentation de référence sur le dictionnaire de balises et dans la documentation de référence sur le dictionnaire de macros.
Pour configurer ces paramètres spécifiques aux tags ou aux macros, un objet de paramètre est défini et défini comme valeur de la propriété parameter de la ressource Tag ou
Macro.
Objet de paramètre
L'objet suivant représente un objet de paramètre:
[
{
"type": string,
"key": string,
"value": string,
"list": [
(Parameter)
],
"map": [
(Parameter)
]
}
]
type
Type de paramètre du tag ou de la macro en cours de configuration.
La propriété type détermine si une propriété value, list ou map doit être incluse dans l'objet de paramètre, comme décrit dans le tableau ci-dessous.
Par exemple, si type est défini sur boolean, une propriété value doit être incluse dans l'objet de paramètre et définie sur true ou false.
| Valeur | Propriété supplémentaire à inclure | Définir une propriété supplémentaire sur |
|---|---|---|
template |
value |
value correspond à n'importe quelle chaîne, y compris les références de macro, par exemple foo{{bar}}. |
boolean |
value |
value correspond à true ou false.
|
number |
value |
value est un entier. |
list |
list |
list contiendra zéro ou plusieurs paramètres. L'ordre n'a pas d'importance. Le key de tout paramètre dans list sera ignoré. |
map |
map |
map contiendra zéro ou plusieurs paramètres. L'ordre n'a pas d'importance. Le key de chaque paramètre dans map doit être unique. |
key
Clé de paramètre du tag ou de la macro en cours de configuration.
Le champ key permet d'identifier le paramètre des balises ou des macros spécifiques en cours de définition. Tous les types de paramètres nécessitent une propriété key (à l'exception des paramètres list).
Exemples
Un objet de paramètre pour une balise HTML personnalisée, qui comporte un paramètre de type template et deux paramètres de type boolean:
"parameter": [
{
"key": "html",
"type": "template",
"value": "<script>alert('hello world')</script>"
},
{
"key": "supportDocumentWrite",
"type": "boolean",
"value": "false"
}
]
Un objet de paramètre pour une macro de tableau de conversion, qui comporte deux paramètres de type template et un paramètre de type list:
"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"
}
]
Un objet de paramètre pour un tag d'appel de fonction, comportant un paramètre de type template et un paramètre de type map:
"parameter": [
{
"key": "functionName",
"type": "template",
"value": "fn"
},
{
"key": "functionArgument",
"map": [
{
"key": "argkey1",
"type": "template",
"value": "argval1"
}
],
"type": "map"
}
]