API de Tag Manager - Referencia de parámetros

En este documento se describe el objetivo y la representación del objeto de parámetro de Tag Manager.

Introducción

Con la API de Tag Manager puedes crear y gestionar recursos de esta solución como, por ejemplo, Tags, Rules y Macros.

La mayoría de los tipos de recursos Tag y Macro incluyen parámetros adicionales específicos que se pueden configurar al crear o al actualizar el recurso. La lista de parámetros (pares key/type) de cada tipo de recurso Tag y Macro se incluye en la Referencia del diccionario del recurso Tag y en la Referencia del diccionario del recurso Macro.

Para configurar estos parámetros específicos de Tag o de Macro, se define un objeto de parámetro y se configura como valor de la propiedad parameter del recurso Tag o del recurso Macro.

Objeto de parámetro

El siguiente objeto representa un objeto de parámetro:

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

type

Tipo de parámetro del recurso Tag o Macro que se configura.

La propiedad type determinará si una propiedad value, list o map debe incluirse en el objeto de parámetro, como se describe en la tabla que se muestra a continuación.

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

Valor Propiedad adicional que se debe incluir Valor en el que se debe configurar la propiedad adicional
template value La propiedad value es cualquier cadena, incluidas las referencias de macro, por ejemplo, foo{{bar}}.
boolean value La propiedad value es true o false.
number value La propiedad value es un número entero.
list list La propiedad list incluirá cero o más parámetros (en cualquier orden o bien en un orden concreto); la propiedad key de cualquier parámetro de la lista (list) se ignorará.
map map La propiedad map incluirá cero o más parámetros (en cualquier orden); la propiedad key de cualquier parámetro del mapa (map) debe ser única.

key

Clave del parámetro del recurso Tag o Macro que se configura.

El campo key se utiliza para identificar el parámetro de los recursos Tag o Macro que se están configurando. Todos los tipos de parámetro necesitan una propiedad key (excepto los parámetros list).

Ejemplos

Un objeto de parámetro de un recurso Tag HTML personalizado, 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 de un recurso Macro de tabla de consulta, que tiene dos parámetros de tipo template y un parámetro de tipo 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 objeto de parámetro de un recurso Tag de llamada de 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"
  }
]