Questo documento descrive lo scopo e la rappresentazione dell'oggetto parametro di Tag Manager.
Introduzione
L'API Tag Manager consente di creare e gestire risorse di Tag Manager come Tag, Attivatori e Variabili.
La maggior parte dei tipi di tag e variabili dispone di parametri aggiuntivi specifici per il tag o la variabile e che possono essere impostati durante la creazione o l'aggiornamento della risorsa. L'elenco di parametri (key, type coppie) per ogni tipo di tag e variabile è riportato nel riferimento del dizionario tag.
Per configurare questi parametri specifici per tag o variabile, viene definito un oggetto parametro e impostato come valore per la proprietà parameter della risorsa Tag o
Variabile.
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 variabile da configurare.
La proprietà type determina
se una proprietà value, list o map
deve essere inclusa nell'oggetto parametro, come descritto nella
tabella riportata di seguito.
Ad esempio, se type è impostato su boolean, è necessario includere una proprietà value nell'oggetto parametro e impostarla su true o false.
| Valore | Proprietà aggiuntiva da includere | Cosa impostare la proprietà aggiuntiva |
|---|---|---|
template |
value |
value è qualsiasi stringa, inclusi i riferimenti alle variabili, ad esempio
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/potrebbe non essere rilevante; il valore key di qualsiasi parametro in list verrà ignorato. |
map |
map |
map conterrà zero o più parametri, l'ordine non è importante; il valore key su qualsiasi parametro in map deve essere univoco. |
key
La chiave del parametro del tag o della variabile in fase di configurazione.
Il campo key viene utilizzato per identificare il parametro di variabili o tag specifici che vengono impostati. Tutti i tipi di parametri devono avere una proprietà key (tranne i parametri list).
Esempi
Un oggetto parametro per un tag HTML personalizzato, che ha un parametro di tipo template e due parametri di tipo boolean:
"parameter": [
{
"key": "html",
"type": "template",
"value": "<script>alert('hello world')</script>"
},
{
"key": "supportDocumentWrite",
"type": "boolean",
"value": "false"
}
]
Un oggetto parametro per un tag chiamata funzione, che ha un parametro di tipo template e un parametro di tipo map:
"parameter": [
{
"key": "functionName",
"type": "template",
"value": "fn"
},
{
"key": "functionArgument",
"map": [
{
"key": "argkey1",
"type": "template",
"value": "argval1"
}
],
"type": "map"
}
]