Interfejs API Menedżera tagów – informacje o parametrach

Ten dokument opisuje cel i reprezentację obiektu parametru Menedżera tagów.

Wprowadzenie

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 właściwe dla tagu lub zmiennej, które można ustawić podczas tworzenia/aktualizowania zasobu. Lista parametrów (par key, type) dla każdego tagu i zmiennej znajduje się w dokumentacji słownika tagów.

Aby skonfigurować te parametry, użyj zdefiniowanego obiektu i ustaw go na wartość właściwości parameter tagu Tag lub Zmienna.

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 obiekt value, list, czy map musi zostać uwzględniony w obiekcie parametru zgodnie z opisem w tabeli poniżej.

Jeśli na przykład type jest ustawiony na boolean, właściwość value powinna być w obiekcie parametru i ustawiona na true lub false.

Wartość	Dodatkowa właściwość do uwzględnienia	Jak ustawić dodatkową usługę
template	value	value to dowolny ciąg znaków, w tym odwołania do zmiennych, np. foo{{bar}}.
boolean	value	value to true lub false.
number	value	value jest liczbą całkowitą.
list	list	list będzie zawierać co najmniej zero parametrów. Kolejność może nie mieć znaczenia. key dowolnego parametru w parametrze list będzie ignorowany.
map	map	map będzie zawierać co najmniej 0 parametrów. Kolejność nie ma znaczenia. key we wszystkich parametrach w parametrze map powinna być unikalna.

key

Klucz parametru konfigurowanego tagu lub zmiennej.

Pole key służy do identyfikowania parametrów określonych ustawionych tagów lub zmiennych. Wszystkie typy parametrów muszą mieć właściwość key (z wyjątkiem parametrów list).

Przykłady

Obiekt parametrów niestandardowego tagu HTML, który zawiera jeden parametr template i dwa parametry typu boolean:

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

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

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