API de Tag Manager: Referencia de parámetros

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

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 etiquetas y variables tienen parámetros adicionales que son específicos a la etiqueta o la variable, y se puede configurar cuando se crea o actualiza el recurso. La lista de parámetros (pares key, type) para cada etiqueta y variable se enumeran en el Diccionario de etiquetas Referencia.

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

El objeto del 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 variable que se configura.

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

Por ejemplo, si type se establece en boolean, entonces una La propiedad value debe incluirse en el objeto del parámetro y establecerse. a true o false.

Valor Propiedad adicional que se incluirá Dónde configurar 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 pedido puede o puede no importan; el key de cualquier parámetro en list se ignorarán.
map map map contendrá cero o más parámetros, pero el orden no la importancia; key en cualquier parámetro de map debe ser únicos.

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 un Las etiquetas o variables que se están estableciendo. Todos los tipos de parámetros necesitan un 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 de tipo boolean parámetros:

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

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

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