En este documento se describen 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 Tag Manager, como etiquetas, activadores o variables.
La mayoría de los tipos de etiqueta y variable incluyen parámetros adicionales específicos que se pueden definir al crear o al actualizar el recurso. La lista de parámetros (los pares key-type) de todos los tipos de etiqueta y variable está disponible en la referencia del diccionario de etiquetas.
Para configurar estos parámetros específicos de una etiqueta o variable, se define un objeto de parámetro, que se asigna como valor a la propiedad parameter de la etiqueta o variable en cuestión.
Objeto de parámetro
El siguiente objeto representa un objeto de parámetro:
[
{
"type": string,
"key": string,
"value": string,
"list": [
(Parameter)
],
"map": [
(Parameter)
]
}
]
type
Es el tipo de parámetro de la etiqueta o variable que se configura.
La propiedad type determina si hay que incluir una propiedad value, list o map en el objeto de parámetro, tal como se describe en la tabla de este artículo.
Por ejemplo, si se asigna el valor boolean a type, se debe incluir una propiedad value en el objeto de parámetro y asignarle el valor true o false.
| Valor | Propiedad adicional que se debe incluir | Valor que debe tener la propiedad adicional |
|---|---|---|
template |
value |
value es cualquier cadena, incluidas referencias de variables, como foo{{bar}}. |
boolean |
value |
value puede ser true o false.
|
number |
value |
value es un número entero. |
list |
list |
list puede o no contener parámetros, y el orden puede importar o no. No tiene en cuenta el valor key de list. |
map |
map |
map puede o no contener parámetros, y el orden no importa. El valor de key de cualquier parámetro de map debe ser único. |
key
Es la clave del parámetro de la etiqueta o variable que se configura.
El campo key se usa para identificar el parámetro de la etiqueta o variable que se configura. Todos los tipos de parámetro necesitan una propiedad key, excepto los parámetros list.
Ejemplos
A continuación, se muestra un objeto de parámetro de una etiqueta HTML personalizada con un parámetro de tipo template y dos de tipo boolean:
"parameter": [
{
"key": "html",
"type": "template",
"value": "<script>alert('hello world')</script>"
},
{
"key": "supportDocumentWrite",
"type": "boolean",
"value": "false"
}
]
A continuación, se muestra un objeto de parámetro de una etiqueta de llamada de función con un parámetro de tipo template y otro de tipo map:
"parameter": [
{
"key": "functionName",
"type": "template",
"value": "fn"
},
{
"key": "functionArgument",
"map": [
{
"key": "argkey1",
"type": "template",
"value": "argval1"
}
],
"type": "map"
}
]