API de Tag Manager: Referencia de diccionario de variables

En este documento, se describen las propiedades que se pueden configurar para las variables de Google Tag Manager.

Introducción

Cada variable de Google Tag Manager tiene un código type para identificarla. Además, la mayoría de las variables tienen parámetros (pares key y type) que puedes configurar como parte de un "objeto de parámetro" cuando creas o actualizas una variable. Para obtener más información sobre cómo configurar estos parámetros mediante un objeto de parámetro, consulta la Referencia de parámetros.

En el resto de este documento, se enumeran los detalles de todas las variables admitidas.

Cookie propia

Ingresar código

k

Parámetros

Clave Tipo Notas
name template Nombre de la cookie.

Ejemplo

 {
   "name": "Sample First Party Cookie Variable",
   "type": "k",
   "parameter": [
    {
     "type": "template",
     "key": "name",
     "value": "myCookieName"
    }
   ]
 }

Variable de evento automático

Ingresar código

aev

Parámetros

Clave Tipo Notas
varType template Uno de los siguientes: ELEMENT, CLASSES, ID, TARGET, TEXT, URL, HISTORY_NEW_URL_FRAGMENT, HISTORY_OLD_URL_FRAGMENT, HISTORY_NEW_STATE, HISTORY_OLD_STATE o HISTORY_CHANGE_SOURCE.
defaultValue template Opcional.

Ejemplo

  {
   "name": "Sample AutoEvent Variable",
   "type": "aev",
   "parameter": [
    {
     "type": "template",
     "key": "varType",
     "value": "CLASSES"
    },
    {
     "type": "template",
     "key": "defaultValue",
     "value": "MyDefault"
    }
   ]
  }

String constante

Ingresar código

c

Parámetros

Clave Tipo
value template

Ejemplo

  {
   "name": "Sample Constant String",
   "type": "c",
   "parameter": [
    {
     "type": "template",
     "key": "value",
     "value": "MyString"
    }
   ]
  }

Número de versión del contenedor

Ingresar código

ctv

Parámetros

No disponible

Ejemplo

  {
   "name": "Sample Container Version Number",
   "type": "ctv"
  }

Evento personalizado

Ingresar código

Parámetros

No disponible

Ejemplo

  {
   "name": "Custom Event Name",
   "type": "e"
  }

JavaScript personalizado

Ingresar código

jsm

Parámetros

Clave Tipo
javascript template

Ejemplo

  {
   "name": "Sample Custom Javascript",
   "type": "jsm",
   "parameter": [
    {
     "type": "template",
     "key": "javascript",
     "value": "function() {\n return \"Hello World\";\n}"
    }
   ]
  }

Variable de capa de datos

Ingresar código

v

Parámetros

Clave Tipo Notas
name template Nombre de la variable de capa de datos.
defaultValue template
dataLayerVersion integer 1 o 2.

Ejemplo

  {
   "name": "Sample Data Layer Variable",
   "type": "v",
   "parameter": [
    {
     "type": "template",
     "key": "name",
     "value": "DL Variable Name"
    },
    {
     "type": "template",
     "key": "defaultValue",
     "value": "DEFAULT"
    },
    {
     "type": "integer",
     "key": "dataLayerVersion",
     "value": "2"
    }
   ]
  }

Modo de depuración

Ingresar código

dbg

Parámetros

No disponible

Ejemplo

  {
   "name": "Sample Debug Mode Variable",
   "type": "dbg"
  }

Elemento DOM

Ingresar código

d

Parámetros

Clave Tipo Notas
elementId template
attributeName template Opcional.

Ejemplo

  {
   "name": "Sample DOM Element Variable",
   "type": "d",
   "parameter": [
    {
     "type": "template",
     "key": "elementId",
     "value": "MyElementId"
    },
    {
     "type": "template",
     "key": "attributeName",
     "value": "MyAttributeName"
    }
   ]
  }

URL de referencia HTTP

Ingresar código

f

Parámetros

Clave Tipo Notas
component template Uno de los siguientes: URL, PROTOCOL, HOST, PORT, PATH, QUERY, FRAGMENT.
stripWww boolean Para el componente = HOST
queryKey template Para el componente = QUERY

Ejemplo

  {
   "name": "Sample HTTP Referrer Variable",
   "type": "f",
   "parameter": [
    {
     "type": "template",
     "key": "component",
     "value": "URL"
    }
   ]
  }

Variable de JavaScript

Ingresar código

j

Parámetros

Clave Tipo Notas
name template Nombre de la variable global.

Ejemplo

  {
   "name": "Sample Javascript Variable",
   "type": "j",
   "parameter": [
    {
     "type": "template",
     "key": "name",
     "value": "MyGlobalVarName"
    }
   ]
  }

Tabla de consulta

Ingresar código

smm

Parámetros

Clave Tipo Notas
input template Valor que se usa para la búsqueda, debe ser una referencia de variable.
map list Una lista de mapas, cada uno con un solo par [key, value].
map[].key template
map[].value template
defaultValue template Opcional.

Ejemplo

  {
   "name": "Sample Lookup Table Variable",
   "type": "smm",
   "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"
    }
   ]
  }

Número al azar

Ingresar código

r

Parámetros

No disponible

Ejemplo

  {
   "name": "Sample Random Number Variable",
   "type": "r"
  }

URL

Ingresar código

u

Parámetros

Clave Tipo Notas
component template Uno de los siguientes: URL, PROTOCOL, HOST, PORT, PATH, QUERY, FRAGMENT.
customUrlSource template Opcional.
stripWww boolean Para el componente = HOST.
queryKey template Para el componente = QUERY.

Ejemplo

  {
   "name": "Sample URL Variable",
   "type": "u",
   "parameter": [
    {
     "type": "template",
     "key": "component",
     "value": "URL"
    },
    {
     "type": "template",
     "key": "customUrlSource",
     "value": "{{element}}"
    }
   ]
  }