API Tag Manager: riferimento ai parametri

Questo documento descrive lo scopo e la rappresentazione di Tag Manager. .

Introduzione

L'API Tag Manager ti consente di creare e gestire le risorse di Tag Manager come Tag, Regole e Macro.

La maggior parte dei tipi di tag e macro ha parametri aggiuntivi specifici al tag o alla macro e possono essere impostate durante la creazione o l'aggiornamento della risorsa. Elenco di parametri (key, type coppie) per ogni tag e macro sono elencati in il dizionario dei tag Riferimento e Dizionario delle macro Riferimento.

Per configurare questi parametri specifici per tag o macro, un parametro viene definito e impostato come valore per l'elemento parameter. proprietà del tag oppure Macro.

L'oggetto parametro

Il seguente oggetto rappresenta un oggetto parametro:

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

type

Il tipo di parametro del tag o della macro da configurare.

La proprietà type determinerà se una proprietà value, list o map deve essere incluso nell'oggetto parametro, come descritto nella tabella di seguito.

Ad esempio, se type è impostato su boolean, viene a La proprietà value deve essere inclusa nell'oggetto parametro e impostata a true o false.

Valore	Proprietà aggiuntiva da includere	Su cosa impostare la proprietà aggiuntiva
template	value	value è qualsiasi stringa, inclusi i riferimenti macro, ad es. foo{{bar}}.
boolean	value	value è true o false.
number	value	value è un numero intero.
list	list	list conterrà zero o più parametri; l'ordine potrebbe non importa; il key di qualsiasi parametro nel list verrà ignorato.
map	map	map conterrà zero o più parametri, l'ordine no pratica; il key su qualsiasi parametro in map deve essere univoci.

key

La chiave del parametro del tag o della macro da configurare.

Il campo key viene utilizzato per identificare il parametro di un Tag o macro in fase di impostazione. Tutti i tipi di parametri richiedono un valore key (eccetto i parametri list).

Esempi

Un oggetto parametro per un tag HTML personalizzato. che ha un parametro di tipo template e due di tipo boolean parametri:

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

Un oggetto parametro per una tabella di ricerca Macro, che ha due parametri di tipo template e uno Parametro di tipo 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"
  }
]

Un oggetto parametro per una chiamata di funzione Tag, che ha un parametro di tipo template e un map parametro type:

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