Tag Manager API – dokumentacja słownika makr

W tym dokumencie opisujemy właściwości, które można ustawiać w makrach Menedżera tagów Google.

Wstęp

Każde makro Menedżera tagów Google ma kod type, który identyfikuje makro. Poza tym większość makr zawiera parametry (pary key, type), które można ustawić jako część „obiektu parametru” podczas tworzenia lub aktualizowania makra. Więcej informacji o ustawianiu tych parametrów za pomocą obiektu parametru znajdziesz w dokumentacji parametrów.

W pozostałej części tego dokumentu znajdziesz szczegółowe informacje na temat wszystkich obsługiwanych makr.

Własny plik cookie

Typ kodu

k

Parametry

Klucz	Typ	Uwagi
name	template	Nazwa pliku cookie.

Przykład

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

Zmienna zdarzenia automatycznego

Typ kodu

aev

Parametry

Klucz	Typ	Uwagi
varType	template	Jedna z tych wartości: 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	Opcjonalnie.

Przykład

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

Ciąg stały

Typ kodu

c

Parametry

Klucz	Typ
value	template

Przykład

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

Numer wersji kontenera

Typ kodu

ctv

Parametry

Nie dotyczy

Przykład

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

Zdarzenie niestandardowe

Typ kodu

Parametry

Nie dotyczy

Przykład

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

Niestandardowy kod JavaScript

Typ kodu

jsm

Parametry

Klucz	Typ
javascript	template

Przykład

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

Zmienna warstwy danych

Typ kodu

v

Parametry

Klucz	Typ	Uwagi
name	template	Nazwa zmiennej warstwy danych.
defaultValue	template
dataLayerVersion	integer	1 lub 2.

Przykład

  {
   "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"
    }
   ]
  }

Tryb debugowania

Typ kodu

dbg

Parametry

Nie dotyczy

Przykład

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

Element DOM

Typ kodu

d

Parametry

Klucz	Typ	Uwagi
elementId	template
attributeName	template	Opcjonalnie.

Przykład

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

Strona odsyłająca HTTP

Typ kodu

f

Parametry

Klucz	Typ	Uwagi
component	template	Jedno z tych: URL, PROTOCOL, HOST, PORT, PATH, QUERY, FRAGMENT.
stripWww	boolean	Dla komponentu = HOST
queryKey	template	Dla komponentu = QUERY

Przykład

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

Zmienna JavaScript

Typ kodu

j

Parametry

Klucz	Typ	Uwagi
name	template	Nazwa zmiennej globalnej.

Przykład

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

Tabela przeglądowa

Typ kodu

smm

Parametry

Klucz	Typ	Uwagi
input	template	Wartość używana do wyszukiwania, powinna być odwołaniem do makra.
map	list	Lista map, każda zawierająca 1 parę [key, value].
map[].key	template
map[].value	template
defaultValue	template	Opcjonalnie.

Przykład

  {
   "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"
    }
   ]
  }

Losowa liczba

Typ kodu

r

Parametry

Nie dotyczy

Przykład

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

Adres URL

Typ kodu

u

Parametry

Klucz	Typ	Uwagi
component	template	Jedno z tych: URL, PROTOCOL, HOST, PORT, PATH, QUERY, FRAGMENT.
customUrlSource	template	Opcjonalnie.
stripWww	boolean	Dla komponentu = HOST.
queryKey	template	Dla komponentu = QUERY.

Przykład

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