API Tag Manager – Référence des paramètres

Ce document décrit l'objectif et la représentation de Tag Manager. .

Introduction

L'API Tag Manager vous permet de créer et de gérer des ressources Tag Manager comme les balises, les déclencheurs et les variables.

La plupart des types de balises et de variables comportent des paramètres supplémentaires spécifiques au tag ou à la variable. Vous pouvez les définir lors de la création ou de la mise à jour de la ressource. La liste de paramètres (paires key, type) pour chaque balise et variable sont répertoriés dans le Dictionnaire de tags Référence.

Pour configurer ces paramètres spécifiques aux balises ou aux variables, un paramètre objet est défini et défini comme valeur de l'attribut parameter du tag ou Variable.

L'objet "parameter"

L'objet suivant représente un objet paramètre:

[
  {
    "type": string,
    "key": string,
    "value": string,
    "list": [
      (Parameter)
    ],
    "map": [
      (Parameter)
    ]
  }
]

type

Type de paramètre de la balise ou de la variable en cours de configuration.

La propriété type détermine qu'il s'agisse d'une propriété value, list ou map doit être inclus dans l'objet de paramètre, comme décrit dans le tableau ci-dessous.

Par exemple, si type est défini sur boolean, alors un value doit être incluse dans l'objet de paramètre et définie à true ou false.

Valeur	Propriété supplémentaire à inclure	Définition d'une propriété supplémentaire
template	value	value correspond à n'importe quelle chaîne, y compris les références à des variables (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 peut/peut être peu importe. le key de tout paramètre dans list ; sont ignorées.
map	map	map contiendra zéro ou plusieurs paramètres, contrairement à l'ordre. qui lui sont liés ; key de n'importe quel paramètre de map doit être unique.

key

Clé de paramètre de la balise ou de la variable en cours de configuration.

Le champ key permet d'identifier le paramètre d'une Balises ou variables en cours de définition. Tous les types de paramètres nécessitent un 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. paramètres:

"parameter": [
  {
    "key": "html",
    "type": "template",
    "value": "<script>alert('hello world')</script>"
  },
  {
    "key": "supportDocumentWrite",
    "type": "boolean",
    "value": "false"
  }
]

Un objet de paramètre pour un appel de fonction Balise, qui comporte un paramètre de type template et un map paramètre de type:

"parameter": [
  {
    "key": "functionName",
    "type": "template",
    "value": "fn"
  },
  {
    "key": "functionArgument",
    "map": [
      {
        "key": "argkey1",
        "type": "template",
        "value": "argval1"
      }
    ],
    "type": "map"
  }
]