Tag Manager API – Parameterreferenz

In diesem Dokument werden der Zweck und die Darstellung von Tag Manager beschrieben. Parameter-Objekt enthält.

Einführung

Mit der Tag Manager API können Sie Tag Manager-Ressourcen erstellen und verwalten. wie Tags, Regeln und Makros.

Die meisten Tag- und Makrotypen haben zusätzliche Parameter, die speziell an das Tag oder das Makro und kann beim Erstellen/Aktualisieren der Ressource festgelegt werden. Die Liste von Parametern (key-, type-Paare) für jedes Tag und jedes Makro sind in den das Tag-Wörterbuch Referenz und das Makro-Wörterbuch Referenz.

Zur Konfiguration dieser Tag- oder Makro-spezifischen Parameter wird ein Parameter Objekt definiert und als Wert für parameter festgelegt. des Tags. oder Makro.

Parameterobjekt

Das folgende Objekt stellt ein Parameterobjekt dar:

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

type

Der Parametertyp des Tags oder Makros, das konfiguriert wird.

Das Attribut type bestimmt, eine value-, list- oder map-Property muss wie in der Tabelle beschrieben im Parameterobjekt enthalten sein. unten.

Wenn beispielsweise type auf boolean gesetzt ist, dann ist ein Das Attribut value muss im Parameterobjekt enthalten und festgelegt sein. auf true oder false.

Wert	Zusätzliche Property, die eingeschlossen werden soll	Festlegen, auf welche Eigenschaft die zusätzliche Property festgelegt werden soll
template	value	value ist ein beliebiger String, einschließlich Makroreferenzen, z.B. foo{{bar}}.
boolean	value	value ist entweder true oder false.
number	value	value ist eine Ganzzahl.
list	list	list enthält null oder mehr Parameter, die Reihenfolge kann/kann ist nicht wichtig; die key eines beliebigen Parameters im list werden ignoriert.
map	map	map enthält null oder mehr Parameter, die Reihenfolge nicht Matter; Das key für einen beliebigen Parameter im map sollte eindeutig sein.

key

Der Parameterschlüssel des Tags oder Makros, das konfiguriert wird.

Das Feld key dient dazu, den Parameter eines bestimmten Tags oder Makros, die festgelegt werden. Für alle Parametertypen ist ein key erforderlich Property mit Ausnahme von list-Parametern.

Beispiele

Ein Parameterobjekt für ein benutzerdefiniertes HTML-Tag mit einem template-Typparameter und zwei boolean-Typen Parameter:

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

Ein Parameterobjekt für eine Suchtabelle Makro mit zwei template-Typparametern und einem Typparameter 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"
  }
]

Ein Parameterobjekt für einen Funktionsaufruf Tag mit einem template-Typparameter und einem map Typparameter:

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