Tag Manager API – informacje o parametrach

W tym dokumencie opisujemy przeznaczenie i reprezentację obiektu parametru Menedżera tagów.

Wstęp

Interfejs Tag Manager API umożliwia tworzenie zasobów Menedżera tagów, takich jak tagi, reguły i zmienne, oraz zarządzanie nimi.

Większość typów tagów i zmiennych ma dodatkowe parametry specyficzne dla tagu lub zmiennej i można je ustawić podczas tworzenia lub aktualizowania zasobu. Listę parametrów (pary key, type) dla każdego typu tagu i zmiennej znajdziesz w dokumentacji słownika tagów.

Aby skonfigurować te parametry związane z tagiem lub zmienną, należy zdefiniować obiekt parametru i ustawić go jako wartość właściwości parameter zasobu Tag lub zmiennej.

Obiekt parametru

Ten obiekt reprezentuje obiekt parametru:

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

type

Typ parametru konfigurowanego tagu lub zmiennej.

Właściwość type określa, czy w obiekcie parametru należy uwzględnić właściwość value, list czy map, jak opisano w tabeli poniżej.

Jeśli np. type ma wartość boolean, w obiekcie parametru powinna być właściwość value ustawiona na true lub false.

Wartość	Dodatkowa usługa do uwzględnienia	Na co ustawić dodatkową usługę
template	value	value to dowolny ciąg znaków, włącznie z odwołaniami do zmiennych, np. foo{{bar}}.
boolean	value	value ma wartość true lub false.
number	value	value jest liczbą całkowitą.
list	list	list będzie zawierać zero lub więcej parametrów. Kolejność może nie mieć znaczenia. key każdego parametru w elemencie list będzie ignorowane.
map	map	map będzie zawierać zero lub więcej parametrów. Kolejność nie ma znaczenia. Element key każdego parametru w map powinien być unikalny.

key

Klucz parametru konfigurowanego tagu lub zmiennej.

Pole key służy do identyfikowania parametrów ustawianych przez siebie tagów lub zmiennych. Wszystkie typy parametrów wymagają właściwości key (z wyjątkiem parametrów list).

Przykłady

Obiekt parametru niestandardowego tagu HTML, który zawiera 1 parametr typu template i 2 parametry typu boolean:

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

Obiekt parametru tagu wywołania funkcji, który ma 1 parametr typu template i 1 parametr typu map:

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