API Google Tag Manager – Referência do dicionário de macros

Neste documento, descrevemos as propriedades que podem ser definidas para Macros do Gerenciador de tags do Google.

Introdução

Cada Macro do Gerenciador de tags do Google tem um código type para identificação. Além disso, a maioria tem parâmetros (pares key, type) que podem ser definidos como parte de um "objeto de parâmetro" durante a criação ou atualização da macro. Para saber mais sobre como definir esses parâmetros usando um objeto, consulte a Referência de parâmetros.

No restante deste documento, listamos os detalhes de todas as macros compatíveis.

Cookie primário

Código de tipo

k

Parâmetros

Chave Tipo Observações
name template Nome do cookie.

Exemplo

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

Variável de evento automático

Código de tipo

aev

Parâmetros

Chave Tipo Observações
varType template Um dentre 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.

Exemplo

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

String constante

Código de tipo

c

Parâmetros

Chave Tipo
value template

Exemplo

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

Número da versão do contêiner

Código de tipo

ctv

Parâmetros

N/D

Exemplo

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

Evento personalizado

Código de tipo

Parâmetros

N/D

Exemplo

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

JavaScript personalizado

Código de tipo

jsm

Parâmetros

Chave Tipo
javascript template

Exemplo

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

Variável de camada de dados

Código de tipo

v

Parâmetros

Chave Tipo Observações
name template Nome da variável da camada de dados.
defaultValue template
dataLayerVersion integer 1 ou 2.

Exemplo

  {
   "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 depuração

Código de tipo

dbg

Parâmetros

N/D

Exemplo

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

Elemento DOM

Código de tipo

d

Parâmetros

Chave Tipo Observações
elementId template
attributeName template Opcional.

Exemplo

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

Referenciador de HTTP

Código de tipo

f

Parâmetros

Chave Tipo Observações
component template Um dentre: URL, PROTOCOL, HOST, PORT, PATH, QUERY, FRAGMENT.
stripWww boolean Para componente = HOST.
queryKey tempalte Para componente = QUERY.

Exemplo

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

Variável JavaScript

Código de tipo

j

Parâmetros

Chave Tipo Observações
name template Nome da variável global.

Exemplo

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

Tabela de consulta

Código de tipo

smm

Parâmetros

Chave Tipo Observações
input template O valor usado para pesquisa precisa ser uma referência de macro.
map list Uma lista de mapas, cada um com um único par [key, value].
map[].key template
map[].value template
defaultValue template Opcional.

Exemplo

  {
   "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 aleatório

Código de tipo

r

Parâmetros

N/D

Exemplo

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

URL

Código de tipo

u

Parâmetros

Chave Tipo Observações
component template Um dentre: URL, PROTOCOL, HOST, PORT, PATH, QUERY, FRAGMENT.
customUrlSource template Opcional.
stripWww boolean Para componente = HOST.
queryKey tempalte Para componente = QUERY.

Exemplo

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