В этом документе описывается назначение и представление объекта параметра Диспетчера тегов.
Введение
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"
}
]