Tag Manager API - パラメータ リファレンス

このドキュメントでは、タグ マネージャー パラメータ オブジェクトの目的と表現について説明します。

はじめに

Tag Manager API を使用すると、タグ マネージャーのリソース（タグ、ルール、マクロなど）を作成、管理できます。

タグとマクロのほとんどのタイプには、タグやマクロに固有の追加パラメータがあり、リソースの作成時や更新時に設定できます。タグとマクロタイプのパラメータのリスト（key、type ペア）は、タグ辞書リファレンスとマクロ ディクショナリ リファレンスに記載されています。

これらのタグまたはマクロに固有のパラメータを設定するには、パラメータ オブジェクトを定義し、タグまたは マクロリソースの parameter プロパティの値として設定します。

パラメータ オブジェクト

次のオブジェクトは、パラメータ オブジェクトを表します。

[
  {
    "type": string,
    "key": string,
    "value": string,
    "list": [
      (Parameter)
    ],
    "map": [
      (Parameter)
    ]
  }
]

type

設定されているタグやマクロのパラメータ タイプ。

type プロパティは、次の表に示すように、value、list、map プロパティをパラメータ オブジェクトに含める必要があるかどうかを決定します。

たとえば、type が boolean に設定されている場合、value プロパティがパラメータ プロパティに含まれ、true または false に設定されている必要があります。

値	含める追加プロパティ	追加プロパティに設定する値
template	value	value は、マクロ参照を含む任意の文字列です（例: foo{{bar}}）。
boolean	value	value は true または false です。
number	value	value は整数です。
list	list	list には 0 個以上のパラメータが含まれ、順序は重要な場合とそうでない場合があります。list 内のどのパラメータの key も無視されます。
map	map	map には 0 個以上のパラメータが含まれ、順序は重要ではありません。map 内のどのパラメータの key も一意でなければなりません。

key

設定されているタグやマクロのパラメータキー。

key フィールドは、設定されている特定のタグまたはマクロのパラメータを識別するために使用されます。すべてのパラメータ タイプには key プロパティ（list パラメータを除く）が必要です。

例

カスタム HTML タグのパラメータ オブジェクト。template タイプのパラメータと、boolean タイプのパラメータが 1 つずつあります。

"parameter": [
  {
    "key": "html",
    "type": "template",
    "value": "<script>alert('hello world')</script>"
  },
  {
    "key": "supportDocumentWrite",
    "type": "boolean",
    "value": "false"
  }
]

ルックアップ テーブルマクロのパラメータ オブジェクト。template 型のパラメータが 2 つ、list 型のパラメータが 1 つあります。

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

関数呼び出しタグのパラメータ オブジェクト。template タイプのパラメータと map タイプのパラメータが 1 つずつあります。

"parameter": [
  {
    "key": "functionName",
    "type": "template",
    "value": "fn"
  },
  {
    "key": "functionArgument",
    "map": [
      {
        "key": "argkey1",
        "type": "template",
        "value": "argval1"
      }
    ],
    "type": "map"
  }
]