Tag Manager API – Cправка по параметрам

В этом документе описывается назначение и представление объекта-параметра.

Введение

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 может содержать ноль или больше параметров, порядок которых не имеет значения. Ключи key любых параметров в свойстве list игнорируются.
map map map может содержать ноль или больше параметров, порядок которых не имеет значения. Ключ key каждого параметра в свойстве map должен быть уникальным.

key

Ключ параметра настраиваемого тега или переменной.

Поле key определяет параметры настраиваемых тегов и переменных. Все типы параметров должны иметь свойство key (кроме параметров list).

Примеры

Объект-параметр для пользовательского тега HTML с одним параметром template и двумя параметрами boolean.

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

Объект-параметр для тега вызова функции с одним параметром template и одним параметром map.

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