API de Tag Manager: Referencia de parámetros

En este documento, se describen el propósito y la representación del objeto de parámetro de Tag Manager.

Introducción

La API de Tag Manager te permite crear y administrar recursos de Tag Manager, como Etiquetas, Activadores y Variables.

La mayoría de los tipos de etiqueta y variable tienen parámetros adicionales que son específicos de la etiqueta o la variable y se pueden configurar cuando se crea o actualiza el recurso. La lista de parámetros (pares key y type) para cada tipo de etiqueta y variable se muestra en la Referencia del diccionario de etiquetas.

Para configurar estos parámetros específicos de etiqueta o variable, se define un objeto de parámetro y se establece como el valor de la propiedad parameter del recurso Etiqueta o Variable.

El objeto de parámetro

El siguiente objeto representa un objeto de parámetro:

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

type

El tipo de parámetro de la etiqueta o la variable que se configura.

La propiedad type determinará si se debe incluir una propiedad value, list o map en el objeto de parámetro, como se describe en la siguiente tabla.

Por ejemplo, si type se configura como boolean, se debe incluir una propiedad value en el objeto de parámetro y establecerse en true o false.

Valor Propiedad adicional que se incluirá Cómo establecer la propiedad adicional
template value value es cualquier cadena, incluidas las referencias de variables, p.ej., foo{{bar}}.
boolean value value es true o false.
number value value es un número entero.
list list list contendrá cero o más parámetros, el orden puede o no importar. Se ignorará el key de cualquier parámetro en el list.
map map map contendrá cero o más parámetros. El orden no importa; el key de cualquier parámetro de map debe ser único.

key

La clave del parámetro de la etiqueta o la variable que se configura.

El campo key se usa para identificar el parámetro de etiquetas o variables específicas que se establecen. Todos los tipos de parámetros necesitan una propiedad key (excepto los parámetros list).

Ejemplos

Un objeto de parámetro para una etiqueta HTML personalizada, que tiene un parámetro de tipo template y dos parámetros de tipo boolean:

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

Un objeto de parámetro para una etiqueta de llamada a función, que tiene un parámetro de tipo template y un parámetro de tipo map:

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