Tag Manager API - マクロ辞書参照

このドキュメントでは、Google タグ マネージャーのマクロに設定できるプロパティについて説明します。

はじめに

Google タグ マネージャーの各マクロには、マクロを識別する type コードが含まれています。 また、ほとんどのマクロには、マクロを作成または更新する際に「パラメータ オブジェクト」の一部として設定できるパラメータ（key、type ペア）があります。パラメータ オブジェクトを使用してこれらのパラメータを設定する方法について詳しくは、パラメータ リファレンスをご覧ください。

このドキュメントの残りの部分では、サポートされているすべてのマクロの詳細を示します。

ファーストパーティ Cookie

タイプコード

k

パラメータ

キー	種類	メモ
name	template	Cookie 名。

例

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

自動イベント変数

タイプコード

aev

パラメータ

キー	種類	メモ
varType	template	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	省略可。

例

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

定数文字列

タイプコード

c

パラメータ

キー	種類
value	template

例

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

コンテナのバージョン番号

タイプコード

ctv

パラメータ

なし

例

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

カスタム イベント

タイプコード

パラメータ

なし

例

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

カスタム JavaScript

タイプコード

jsm

パラメータ

キー	種類
javascript	template

例

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

データレイヤー変数

タイプコード

v

パラメータ

キー	種類	メモ
name	template	データレイヤー変数名。
defaultValue	template
dataLayerVersion	integer	1 または 2。

例

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

デバッグモード

タイプコード

dbg

パラメータ

なし

例

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

DOM 要素

タイプコード

d

パラメータ

キー	種類	メモ
elementId	template
attributeName	template	省略可。

例

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

HTTP リファラー

タイプコード

f

パラメータ

キー	種類	メモ
component	template	次のいずれか: URL, PROTOCOL, HOST, PORT, PATH, QUERY, FRAGMENT。
stripWww	boolean	コンポーネント = HOST
queryKey	template	コンポーネント = QUERY

例

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

JavaScript 変数

タイプコード

j

パラメータ

キー	種類	メモ
name	template	グローバル変数名。

例

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

ルックアップ テーブル

タイプコード

smm

パラメータ

キー	種類	メモ
input	template	ルックアップに使用する値。マクロ参照でなければなりません。
map	list	それぞれが 1 つの [key、value] ペアを持つマップのリスト。
map[].key	template
map[].value	template
defaultValue	template	省略可。

例

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

乱数

タイプコード

r

パラメータ

なし

例

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

URL

タイプコード

u

パラメータ

キー	種類	メモ
component	template	次のいずれか: URL, PROTOCOL, HOST, PORT, PATH, QUERY, FRAGMENT。
customUrlSource	template	省略可。
stripWww	boolean	コンポーネント = HOST。
queryKey	template	コンポーネント = QUERY。

例

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