Tag Manager API – informacje o parametrach

W tym dokumencie opisano przeznaczenie i reprezentację Menedżera tagów. .

Wprowadzenie

Interfejs API Menedżera tagów umożliwia tworzenie zasobów Menedżera tagów i zarządzanie nimi np. Tagi, Reguły i Makra.

Większość typów tagów i makr ma dodatkowe, szczegółowe parametry do tagu lub makra i można go ustawić podczas tworzenia/aktualizowania zasobu. Lista parametrów (pary key, type) dla każdego tagu i makra wymienionych w argumencie Słownik tagów Źródła informacji i słownik makro Materiały referencyjne.

Aby skonfigurować parametry specyficzne dla tagu lub makra, parametr Obiekt jest zdefiniowany i ustawiony jako wartość parameter właściwości Tag. lub Zasób makra.

Obiekt parametru

Ten obiekt reprezentuje obiekt parametru:

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

type

Typ parametru konfigurowanego tagu lub makra.

Właściwość type określa czy jest usługą value, list czy map musi zostać uwzględniona w obiekcie parametru, zgodnie z opisem w tabeli poniżej.

Jeśli np. type ma wartość boolean, to W obiekcie parametru i ustaw właściwość value do true lub false.

Wartość Dodatkowa usługa do uwzględnienia Co ustawić dodatkową usługę
template value value to dowolny ciąg, w tym odwołania do makr, np. foo{{bar}}
boolean value value to true lub false.
number value value jest liczbą całkowitą.
list list list będzie zawierać zero lub więcej parametrów; zamówienie może/może bez znaczenia. key dowolnego parametru w funkcji list zostanie zignorowany.
map map Pole map będzie zawierać zero lub więcej parametrów, kolejność nie ma znaczenie; parametr key w dowolnym parametrze w parametrze map powinien być unikalna.

key

Klucz parametru konfigurowanego tagu lub makra.

Pole key służy do określania parametru określonego Ustawione tagi lub makra. Wszystkie typy parametrów wymagają parametru key (z wyjątkiem parametrów list).

Przykłady

obiekt parametru niestandardowego tagu HTML, z 1 parametrem typu template i 2 typem boolean parametry:

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

Obiekt parametru tabeli przeglądowej Makro, które ma dwa parametry typu template i jeden Parametr typu list:

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

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

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