Спасибо за предварительный просмотр документации по новой платформе тегов Google! Этот сайт находится в публичной бета-версии. ( Обратная связь )

API Диспетчера тегов — Справочник по параметрам

Оптимизируйте свои подборки Сохраняйте и классифицируйте контент в соответствии со своими настройками.

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

Введение

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