API de Tag Manager: referencia del diccionario del recurso Macro

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

Introducción

Cada macro de Google Tag Manager tiene un código type que la identifica. Además, la mayoría de las macros tienen parámetros (pares key, type) que puedes ajustar como parte de un "objeto de parámetro" cuando creas o actualizas una macro. Para obtener más información sobre cómo configurar estos parámetros utilizando un objeto de parámetro, consulta la página sobre referencias de parámetros.

En el resto del documento encontrarás información detallada sobre todas las macros admitidas.

Cookie de origen

Código tipo

k

Parámetros

Clave Tipo Notas
name template Nombre de la cookie.

Ejemplo

 {
   "name": "Sample 1st Party Cookie Macro",
   "type": "k",
   "parameter": [
    {
     "type": "template",
     "key": "name",
     "value": "myCookieName"
    }
   ]
 }

Variable de evento automático

Código tipo

aev

Parámetros

Clave Tipo Notas
varType template Uno de: ELEMENT, CLASSES, ID, TARGET, TEXT, URL, HISTORY_NEW_URL_FRAGMENT, HISTORY_OLD_URL_FRAGMENT, HISTORY_NEW_STATE, HISTORY_OLD_STATE, 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"
    }
   ]
  }

Cadena constante

Código tipo

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

Código tipo

ctv

Parámetros

N/D

Ejemplo

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

Evento personalizado

Código tipo

Parámetros

N/D

Ejemplo

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

JavaScript personalizado

Código tipo

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

Código tipo

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

Código tipo

dbg

Parámetros

N/D

Ejemplo

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

Elemento DOM

Código tipo

d

Parámetros

Clave Tipo Notas
elementId template
attributeName template Opcional.

Ejemplo

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

HTTP Referer

Código tipo

f

Parámetros

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

Ejemplo

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

Variable JavaScript

Código tipo

j

Parámetros

Clave Tipo Notas
name template Nombre de las variables globales.

Ejemplo

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

Tabla de consulta

Código tipo

smm

Parámetros

Clave Tipo Notas
input template Valor utilizado para la búsqueda; debe ser una referencia de recurso Macro.
map list Una lista de mapas, cada uno con un par único key, value.
map[].key template
map[].value template
defaultValue template Opcional.

Ejemplo

  {
   "name": "Sample Lookup Table Macro",
   "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 aleatorio

Código tipo

r

Parámetros

N/D

Ejemplo

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

URL

Código tipo

u

Parámetros

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

Ejemplo

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