API per modelli personalizzati

API di base

Queste API funzionano con JavaScript con sandbox per creare modelli personalizzati in Google Tag Manager. Ogni API viene aggiunta con un'istruzione require(), ad esempio:

const myAPI = require('myAPI');

addConsentListener

Registra una funzione listener da eseguire quando lo stato del tipo di consenso specificato cambia.

Il listener specificato verrà richiamato ogni volta che lo stato del tipo di consenso specificato cambia da negato a concesso o da concesso a negato. Un tipo di consenso senza stato viene considerato concesso, quindi il listener non verrà chiamato se un tipo di consenso non impostato viene aggiornato a Concesso. Le funzioni listener si occuperanno di garantire che il codice venga eseguito il numero appropriato di volte.

Esempio:

const isConsentGranted = require('isConsentGranted');
const addConsentListener = require('addConsentListener');

if (!isConsentGranted('ad_storage')) {
  let wasCalled = false;
  addConsentListener('ad_storage', (consentType, granted) => {
    if (wasCalled) return;
    wasCalled = true;

    const cookies = getMyCookies();
    sendFullPixel(cookies);
  });
}

Sintassi

addConsentListener(consentType, listener)

Parametri

Parametro Tipo Descrizione
consentType stringa Il tipo di consenso su cui ascoltare le modifiche dello stato.
listener funzione La funzione da eseguire quando lo stato del tipo di consenso specificato cambia.

Quando viene richiamato un listener, verrà passato il tipo di consenso che viene modificato e il nuovo valore di quel tipo di consenso:

Parametro Tipo Descrizione
consentType stringa Il tipo di consenso che viene modificato.
granted boolean Un valore booleano che è true se il tipo di consenso specificato viene modificato in concesso.

Autorizzazioni associate

Autorizzazione access_consent con accesso in lettura per il tipo di consenso.

addEventCallback

L'API addEventCallback consente di registrare una funzione di callback che verrà richiamata al termine di un evento. Il callback viene richiamato quando tutti i tag dell'evento sono stati eseguiti o se viene raggiunto un timeout dell'evento nella pagina. Al callback vengono passati due valori: l'ID del container che richiama la funzione e un oggetto che contiene informazioni sull'evento.

Sintassi

addEventCallback(callback)

Parametri

Parametro Tipo Descrizione
callback funzione La funzione da richiamare alla fine dell'evento.

L'oggetto eventData contiene i seguenti dati:

Nome chiave Tipo Descrizione
tags Array Un array di oggetti dati dei tag. Ogni tag attivato durante l'evento avrà una voce in questo array. L'oggetto dati del tag contiene l'ID del tag (id), il suo stato di esecuzione (status) e la data e l'ora di esecuzione (executionTime). I dati del tag includeranno anche metadati di tag aggiuntivi configurati nel tag.

Esempio

addEventCallback(function(ctid, eventData) {
  logToConsole('Tag count for container ' + ctid + ': ' + eventData['tags'].length);
});

Autorizzazioni associate

read_event_metadata

aliasInWindow

L'API aliasInWindow consente di creare un alias (ad es. window.foo = window.bar), che aiuta a supportare determinati tag che richiedono l'alias. Assegna il valore dell'oggetto window trovato in fromPath alla chiave dell'oggetto window in toPath. Restituisce true in caso di esito positivo, altrimenti false.

Sintassi

aliasInWindow(toPath, fromPath)

Parametri

Parametro Tipo Descrizione
toPath stringa Un percorso separato da punti nell'oggetto window in cui copiare un valore. Tutti i componenti del percorso fino all'ultimo componente devono già esistere nell'oggetto window.
fromPath stringa Un percorso separato da punti in window verso il valore da copiare. Se il valore non esiste, l'operazione non andrà a buon fine.

Esempio

aliasInWindow('foo.bar', 'baz.qux')

Autorizzazioni associate

access_globals è obbligatorio sia per toPath che per fromPath; toPath richiede accesso in scrittura, fromPath richiede accesso in lettura.

callInWindow

Consente di chiamare funzioni da un percorso all'esterno dell'oggetto window, in modo controllato da criteri. Richiama la funzione nel percorso specificato in window con gli argomenti indicati e restituisce il valore. Se il tipo restituito non può essere mappato direttamente a un tipo supportato nel codice JavaScript con sandbox, verrà restituito undefined. Gli otto tipi supportati in JavaScript con sandbox sono null, undefined, boolean, number, string, Array, Object e function. Se il percorso specificato non esiste o non fa riferimento a una funzione, undefined verrà restituito.

Sintassi

callInWindow(pathToFunction, argument [, argument2,... argumentN])

Parametri

Parametro Tipo Descrizione
pathToFunction stringa Un percorso separato da punti della funzione in window da chiamare.
args * Argomenti da passare alla funzione.

Autorizzazioni associate

access_globals con autorizzazione execute abilitata.

callLater

Pianifica una chiamata a una funzione in modo che avvenga in modo asincrono. La funzione verrà richiamata dopo il ritorno del codice corrente. Equivale a setTimeout(<function>, 0).

Sintassi

callLater(function)

Parametri

Parametro Tipo Descrizione
function funzione La funzione da chiamare.

copyFromDataLayer

Restituisce il valore attualmente assegnato alla chiave specificata nel livello dati: il valore trovato nella chiave specificata se è un tipo primitivo, una funzione o una letterale di oggetto oppure undefined in caso contrario.

Sintassi

copyFromDataLayer(key[, dataLayerVersion])

Parametri

Parametro Tipo Descrizione
key stringa La chiave nel formato "a.b.c".
dataLayerVersion numero La versione del livello dati facoltativa. Il valore predefinito è 2. È vivamente sconsigliato utilizzare il valore 1.

Autorizzazioni associate

read_data_layer

copyFromWindow

Copia una variabile dall'oggetto window. Se il valore in window non può essere mappato direttamente a un tipo supportato in JavaScript con sandbox, undefined verrà restituito. Gli otto tipi supportati in JavaScript con sandbox sono null, undefined, boolean, number, string, Array, Object e function. Restituisce il valore recuperato (e forzato).

Sintassi

copyFromWindow(key)

Parametri

Parametro Tipo Descrizione
key stringa La chiave nel window di cui copiare il valore.

Autorizzazioni associate

access_globals

createArgumentsQueue

Crea una coda compilata con oggetti argomento a supporto delle soluzioni tag che la richiedono.

Crea una funzione in ambito globale (ad es. window), utilizzando l'argomento fnKey (stessa semantica di createQueue). Dopo aver creato la funzione, questa API crea un array in window (se non esiste già) utilizzando l'argomento arrayKey.

Quando viene chiamata la funzione creata in fnKey, invia l'oggetto argomenti all'array creato in arrayKey. Il valore restituito dell'API è la funzione creata in fnKey.

Questa funzione richiede l'impostazione di lettura e scrittura per fnKey e arrayKey nell'autorizzazione access_globals.

Esempio:

const gtag = createArgumentsQueue('gtag', 'dataLayer');
gtag('set', {'currency': 'USD'});

Sintassi

createArgumentsQueue(fnKey, arrayKey)

Parametri

Parametro Tipo Descrizione
fnKey stringa Il percorso in window in cui è impostata la funzione, se non esiste già. Questo argomento supporta la notazione dei punti standard. Se il percorso della chiave non esiste, viene generata un'eccezione. In altre parole, se fnKey è 'one.two', verrà generata un'eccezione.
arrayKey stringa Il percorso in window in cui è impostato l'array, se non esiste già. Questo argomento supporta la notazione dei punti standard. Se il percorso della chiave non esiste, viene generata un'eccezione. In altre parole, se arrayKey è 'one.two' e non esiste un oggetto globale denominato 'one', verrà generata un' eccezione.

Autorizzazioni associate

access_globals

createQueue

Crea un array in window (se non esiste già) e restituisce una funzione che eseguirà il push dei valori in questo array.

Questa funzione richiede l'impostazione di lettura e scrittura per arrayKey nell'autorizzazione access_globals.

Esempio:

const dataLayerPush = createQueue('dataLayer');
dataLayerPush({'currency': 'USD'}, {'event': 'myConversion'});

Sintassi

createQueue(arrayKey)

Parametri

Parametro Tipo Descrizione
arrayKey stringa La chiave in window in cui è impostato l'array, se non esiste già. Questo argomento supporta la notazione dei punti standard. Se il percorso della chiave non esiste, viene generata un'eccezione. Ad esempio, se arrayKey è 'one.two' e non esiste un oggetto globale denominato 'one', verrà generata un' eccezione.

Autorizzazioni associate

access_globals

decodeUri

Decodifica tutti i caratteri codificati nell'URI fornito. Restituisce una stringa che rappresenta l'URI decodificato. Restituisce undefined se fornito con un input non valido.

Esempio:

const decode = require('decodeUri');

const decodedUrl = decode(data.encodedUrl);
if (decodedUrl) {
  // ...
}

Sintassi

decodeUri(encoded_uri)

Parametri

Parametro Tipo Descrizione
encoded_uri stringa Un URI che è stato codificato da encodeUri() o con altri mezzi.

Autorizzazioni associate

Nessuna.

decodeUriComponent

Decodifica tutti i caratteri codificati nel componente URI fornito. Restituisce una stringa che rappresenta il componente dell'URI decodificato. Restituisce undefined quando viene fornito un input non valido.

Esempio:

const decode = require('decodeUriComponent');

const decodedUrl = decode(data.encodedUrl);
if (decodedUrl) {
  // ...
}

Sintassi

decodeUriComponent(encoded_uri_component)

Parametri

Parametro Tipo Descrizione
encoded_uri_component stringa Un componente URI che è stato codificato da encodeUriComponent() o con altri mezzi.

Autorizzazioni associate

Nessuna.

encodeUri

Restituisce un URI (Uniform Resource Identifier) codificato eseguendo l'escape dei caratteri speciali. Restituisce una stringa che rappresenta la stringa fornita codificata come URI. Restituisce undefined se fornito con un input non valido (un surrogato solitario).

Esempio:

sendPixel('https://www.example.com/' + encodeUri(pathInput));

Sintassi

encodeUri(uri)

Parametri

Parametro Tipo Descrizione
uri stringa Un URI completo.

Autorizzazioni associate

Nessuna.

encodeUriComponent

Restituisce un URI (Uniform Resource Identifier) codificato eseguendo l'escape dei caratteri speciali. Restituisce una stringa che rappresenta la stringa fornita codificata come URI. Restituisce undefined se fornito con un input non valido (un surrogato solitario).

Esempio:

sendPixel('https://www.example.com/?' + encodeUriComponent(queryInput));

Sintassi

encodeUriComponent(str)

Parametri

Parametro Tipo Descrizione
str stringa Un componente di un URI.

Autorizzazioni associate

Nessuna.

fromBase64

L'API fromBase64 ti consente di decodificare le stringhe dalla loro rappresentazione base64. Restituisce undefined se fornito con un input non valido.

Sintassi

fromBase64(base64EncodedString)

Parametri

Parametro Tipo Descrizione
base64EncodedString stringa Stringa codificata Base64.

Esempio

const fromBase64 = require('fromBase64');

const greeting = fromBase64('aGVsbG8=');
if (greeting === 'hello') {
  // ...
}

Autorizzazioni associate

Nessuno

generateRandom

Restituisce un numero casuale (intero) all'interno dell'intervallo specificato.

Sintassi

generateRandom(min, max)

Parametri

Parametro Tipo Descrizione
min numero Valore potenziale minimo del numero intero restituito.
max numero Valore potenziale massimo del numero intero restituito.

Autorizzazioni associate

Nessuna.

getContainerVersion

Restituisce un oggetto contenente dati relativi al contenitore corrente. L'oggetto restituito include i seguenti campi:

{
  containerId: string,
  debugMode: boolean,
  environmentName: string,
  environmentMode: boolean,
  previewMode: boolean,
  version: string,
}

Esempio

const getContainerVersion = require('getContainerVersion');
const sendPixel = require('sendPixel');

if (query('read_container_data')) {
  const cv = getContainerVersion();

  const pixelUrl = 'https://pixel.com/' +
    '?version=' + cv.version +
    '&envName=' + cv.environmentName +
    '&ctid=' + cv.containerId +
    '&debugMode=' + cv.debugMode +
    '&previewMode=' + cv.previewMode;
  if (query('send_pixel', pixelUrl)) {
    sendPixel(pixelUrl);
  }
}

Sintassi

getContainerVersion();

Autorizzazioni associate

read_container_data

getCookieValues

Restituisce i valori di tutti i cookie con il nome specificato.

Sintassi

getCookieValues(name[, decode])

Parametri

Parametro Tipo Descrizione
name stringa Il nome del cookie.
decode boolean Consente di stabilire se i valori dei cookie devono essere decodificati con decodeURIComponent() di JavaScript. Il valore predefinito è true.

Autorizzazioni associate

get_cookies

getQueryParameters

Restituisce il primo o tutti i parametri per queryKey dell'URL corrente. Restituisce il primo valore da queryKey o un array di valori da queryKey.

Sintassi

getQueryParameters(queryKey[, retrieveAll])

Parametri

Parametro Tipo Descrizione
queryKey stringa La chiave per leggere dai parametri di query.
retrieveAll boolean Se recuperare tutti i valori.

Ad esempio, se l'URL corrente è https://example.com/path?var=foo&var1=foo1&var=foo2&var=foo, allora:

  • getQueryParameters('var') == 'foo'
  • getQueryParameters('var', false) == 'foo'
  • getQueryParameters('var', null) == 'foo'
  • getQueryParameters('var', true) == ['foo', 'foo2', 'foo']

Autorizzazioni associate

get_url deve consentire il componente query e deve specificare queryKey nelle chiavi di query consentite (oppure consentire qualsiasi chiave di query).

getReferrerQueryParameters

L'API getReferrerQueryParameters si comporta come getQueryParameters, ad eccezione del fatto che agisce sul referrer anziché sull'URL corrente. Restituisce il primo o tutti i parametri per queryKey del referrer specificato. Restituisce il primo valore di queryKey o un array di valori da queryKey.

Sintassi

getReferrerQueryParameters(queryKey[, retrieveAll])

Parametri

Parametro Tipo Descrizione
queryKey stringa La chiave per leggere dai parametri di query.
retrieveAll boolean Se recuperare tutti i valori.

Ad esempio, se l'URL del referrer è https://example.com/path?var=foo&var1=foo1&var=foo2&var=foo, allora:

  • getReferrerQueryParameters('var') == 'foo'
  • getReferrerQueryParameters('var', false) == 'foo'
  • getReferrerQueryParameters('var', null) == 'foo'
  • getReferrerQueryParameters('var', true) == ['foo', 'foo2', 'foo']

Autorizzazioni associate

get_referrer deve consentire il componente query e deve specificare queryKey nelle chiavi di query consentite (oppure consentire qualsiasi chiave di query).

getReferrerUrl

Dato un tipo di componente, l'API legge l'oggetto documento per il referrer e restituisce una stringa che rappresenta una parte del referrer. Se non viene specificato nessun componente, viene restituito l'URL del referrer completo.

Sintassi

getReferrerUrl([component])

Parametri

Parametro Tipo Descrizione
component stringa Il componente da restituire dall'URL. Può essere uno dei seguenti: protocol, host, port, path, query, extension. Se component è undefined, null o non corrisponde a uno di questi componenti, verrà restituito l'intero URL.

Autorizzazioni associate

get_referrer deve consentire il componente query e deve specificare queryKey nelle chiavi di query consentite (oppure consentire qualsiasi chiave di query).

getTimestamp

Obsoleta. Preferisci getTimestampMillis.

Restituisce un numero che rappresenta il tempo corrente in millisecondi dall'epoca di Unix, come restituito da Date.now().

Sintassi

getTimestamp();

Autorizzazioni associate

Nessuna.

getTimestampMillis

Restituisce un numero che rappresenta il tempo corrente in millisecondi dall'epoca di Unix, come restituito da Date.now().

Sintassi

getTimestampMillis();

Autorizzazioni associate

Nessuna.

getType

Restituisce una stringa che descrive il tipo di valore specificato. A differenza di typeof, getType fa differenza tra array e object.

Sintassi

getType(data.someField)

Note

Nella tabella seguente sono elencate le stringhe restituite per ciascun valore di input.

Valore input Risultato
undefined 'non definito'
null "nullo"
true 'boolean'
12 'numero'
'string' "stringa"
{ a: 3 } 'object'
[ 1, 3 ] "array"
(x) => x + 1 'funzione'

Autorizzazioni associate

Nessuna.

getUrl

Restituisce una stringa che rappresenta l'intero URL o una parte dell'URL corrente, in base a un tipo di componente e ad alcuni parametri di configurazione.

Sintassi

getUrl(component)

Parametri

Parametro Tipo Descrizione
component stringa Il componente da restituire dall'URL. Deve essere uno dei seguenti: protocol, host, port, path, query, extension, fragment. Se il componente è undefined, null o non corrisponde a uno di questi componenti, verrà restituito l'intero valore href.

Autorizzazioni associate

get_url

gtagSet

Invia un comando gtag set al livello dati affinché venga elaborato non appena possibile dopo la fine dell'elaborazione dell'evento attuale e degli eventuali tag che ha attivato (o dopo il raggiungimento del timeout di elaborazione dei tag). È garantito che l'aggiornamento venga elaborato in questo container prima di eventuali elementi in coda nella coda del livello dati.

Ad esempio, se chiamato da un tag attivato durante l'inizializzazione del consenso, l'aggiornamento verrà applicato prima che l'evento di inizializzazione venga elaborato. Ad esempio, l'impostazione di ads_data_redaction su true o false o l'impostazione di url_passthrough su true o false.

Esempi:

const gtagSet = require('gtagSet');

gtagSet({
  'ads_data_redaction': true,
  'url_passthrough': true,
});

Sintassi

gtagSet(object)

Parametri

Parametro Tipo Descrizione
Object oggetto Un oggetto che aggiorna lo stato globale delle proprietà che la contengono.

Autorizzazioni associate

write_data_layer controlla l'autorizzazione di scrittura per dataLayer per tutte le chiavi specificate. Se l'input in gtagSet è un oggetto semplice, l'API controllerà l'autorizzazione di scrittura per tutte le chiavi suddivise all'interno dell'oggetto, ad esempio per gtagSet({foo: {bar: 'baz'}}), l'API controllerà l'autorizzazione di scrittura per foo.bar.

Se l'input per gtagSet è una chiave e un valore di oggetto non semplice, l'API verificherà l'autorizzazione di scrittura per quella chiave; ad esempio per gtagSet('abc', true) , l'API verificherà l'autorizzazione di scrittura per 'abc'.

Tieni presente che se è presente un ciclo nell'oggetto di input, verranno controllate solo le chiavi prima di raggiungere lo stesso oggetto.

injectHiddenIframe

Aggiunge un iframe invisibile alla pagina.

I callback vengono forniti come istanze di funzione e sono aggregati nelle funzioni JavaScript che li richiamano.

Sintassi

injectHiddenIframe(url, onSuccess)

Parametri

Parametro Tipo Descrizione
url stringa L'URL da utilizzare come valore dell'attributo src dell'iframe.
onSuccess funzione Chiamato quando il frame viene caricato correttamente.

Autorizzazioni associate

inject_hidden_iframe

injectScript

Aggiunge un tag script alla pagina per caricare l'URL specificato in modo asincrono. I callback vengono forniti come istanze di funzione e sono aggregati nelle funzioni JavaScript che le richiamano.

Sintassi

injectScript(url, onSuccess, onFailure[, cacheToken])

Parametri

Parametro Tipo Descrizione
url stringa L'indirizzo dello script da inserire.
onSuccess funzione Richiamato quando lo script viene caricato correttamente.
onFailure funzione Chiamato quando lo script non viene caricato.
cacheToken stringa Stringa facoltativa utilizzata per indicare che l'URL specificato deve essere memorizzato nella cache. Se questo valore viene specificato, verrà creato un solo elemento script per richiedere JavaScript. Eventuali ulteriori tentativi di caricamento comporteranno la coda dei metodi onSuccess e onFailure specificati fino al caricamento dello script.

Autorizzazioni associate

inject_script

isConsentGranted

Restituisce true se viene concesso il tipo di consenso specificato.

Il consenso per un determinato tipo di consenso viene considerato concesso se il tipo di consenso è stato impostato su "Concesso" o non è stato configurato affatto. Se il tipo di consenso è impostato su un altro valore, viene considerato non concesso.

L'interfaccia utente di Tag Manager per le impostazioni dei tag offre un'opzione per attivarsi sempre. Se un tag con l'opzione sempre attivata utilizza questa API, il consenso viene considerato concesso e verrà restituito true, indipendentemente dallo stato effettivo del consenso.

Esempio:

const isConsentGranted = require('isConsentGranted');

if (isConsentGranted('ad_storage')) {
  sendFullPixel();
} else {
  sendPixelWithoutCookies();
}

Sintassi

isConsentGranted(consentType)

Parametri

Parametro Tipo Descrizione
consentType stringa Il tipo di consenso di cui verificare lo stato.

Autorizzazioni associate

Autorizzazione access_consent con accesso in lettura per il tipo di consenso.

JSON

Restituisce un oggetto che fornisce funzioni JSON.

La funzione parse() analizza una stringa JSON per costruire il valore o l'oggetto descritto dalla stringa. Se non è possibile analizzare il valore (ad es. JSON in formato non corretto), la funzione restituisce undefined. Se il valore di input non è una stringa, l'input verrà forzato in una stringa.

La funzione stringify() converte l'input in una stringa JSON. Se il valore non può essere analizzato (ad es. l'oggetto ha un ciclo), il metodo restituirà undefined.

Sintassi

JSON.parse(stringInput)
JSON.stringify(value);

Parametri

JSON.parse

Parametro Tipo Descrizione
stringInput qualsiasi Il valore da convertire. Se il valore non è una stringa, l'input verrà forzato in una stringa.

JSON.stringify

Parametro Tipo Descrizione
valore qualsiasi Il valore da convertire.

Esempio

const JSON = require('JSON');

// The JSON input string is converted to an object.
const object = JSON.parse('{"foo":"bar"}');

// The input object is converted to a JSON string.
const str = JSON.stringify({foo: 'bar'});

localStorage

Restituisce un oggetto con metodi per accedere allo spazio di archiviazione locale.

Sintassi

const localStorage = require('localStorage');

// Requires read access for the key. Returns null if the key does not exist.
localStorage.getItem(key);

// Requires write access for the key. Returns true if successful.
localStorage.setItem(key, value);

// Requires write access for the key.
localStorage.removeItem(key);

Autorizzazioni associate

access_local_storage

Esempio

const localStorage = require('localStorage');
if (localStorage) {
  const value = localStorage.getItem('my_key');
  if (value) {
    const success = localStorage.setItem('my_key', 'new_value');
    if (success) {
      localStorage.removeItem('my_key');
    }
  }
}

logToConsole

Registra gli argomenti nella console del browser.

Sintassi

logToConsole(obj1 [, obj2,... objN])

Parametri

Parametro Tipo Descrizione
obj1 [, obj2,... objN] qualsiasi Argomenti

Autorizzazioni associate

logging

makeInteger

Converte il valore specificato in un numero (numero intero).

Sintassi

makeInteger(value)

Parametri

Parametro Tipo Descrizione
value qualsiasi Il valore da convertire.

Autorizzazioni associate

Nessuna.

makeNumber

Converte il valore specificato in un numero.

Sintassi

makeNumber(value)

Parametri

Parametro Tipo Descrizione
value qualsiasi Il valore da convertire.

Autorizzazioni associate

Nessuna.

makeString

Restituisce il valore specificato come stringa.

Sintassi

makeString(value)

Parametri

Parametro Tipo Descrizione
value qualsiasi Il valore da convertire.

Autorizzazioni associate

Nessuna.

makeTableMap

Converte un oggetto di tabella semplice con due colonne in Map. Viene utilizzato per modificare un campo modello SIMPLE_TABLE con due colonne in un formato più gestibile.

Ad esempio, questa funzione potrebbe convertire un oggetto di tabella:

[
  {'key': 'k1', 'value': 'v1'},
  {'key': 'k2', 'value': 'v2'}
]

in una mappa:

{
  'k1': 'v1',
  'k2': 'v2'
}

Restituisce un Oggetto: il valore Map convertito se sono state aggiunte coppie chiave-valore, oppure null.

Sintassi

makeTableMap(tableObj, keyColumnName, valueColumnName)

Parametri

Parametro Tipo Descrizione
tableObj Elenca L'oggetto della tabella da convertire. È un elenco di mappe in cui ogni Map rappresenta una riga nella tabella. Ogni nome della proprietà in un oggetto riga è il nome della colonna e il valore della proprietà è il valore della colonna nella riga.
keyColumnName stringa Nome della colonna i cui valori diventeranno chiavi nell'elemento Map convertito.
valueColumnName stringa Nome della colonna i cui valori diventeranno valori nell'elemento Map convertito.

Autorizzazioni associate

Nessuna.

Math

Un oggetto che fornisce funzioni Math.

Sintassi

const Math = require('Math');

// Retrieve the absolute value.
const absolute = Math.abs(-3);

// Round the input down to the nearest integer.
const roundedDown = Math.floor(3.6);

// Round the input up to the nearest integer.
const roundedUp = Math.ceil(2.2);

// Round the input to the nearest integer.
const rounded = Math.round(3.1);

// Return the largest argument.
const biggest = Math.max(1, 3);

// Return the smallest argument.
const smallest = Math.min(3, 5);

// Return the first argument raised to the power of the second argument.
const powerful = Math.pow(3, 1);

// Return the square root of the argument.
const unsquared = Math.sqrt(9);

Parametri

I parametri delle funzioni matematiche vengono convertiti in numeri.

Autorizzazioni associate

Nessuna.

Object

Restituisce un oggetto che fornisce i metodi Object.

Il metodo keys() fornisce il comportamento Object.keys() della libreria standard. Restituisce un array dei nomi di proprietà enumerabili di un determinato oggetto, nello stesso ordine di un loop for...in.... Se il valore di input non è un oggetto, verrà forzato in un oggetto.

Il metodo values() fornisce il comportamento Object.values() della libreria standard. Restituisce un array dei valori delle proprietà enumerabili di un determinato oggetto, nello stesso ordine di un loop for...in.... Se il valore di input non è un oggetto, verrà forzato in un oggetto.

Il metodo entries() fornisce il comportamento Object.entries() della libreria standard. Restituisce un array delle coppie di proprietà enumerabili [key, value] di un determinato oggetto, nello stesso ordine di un loop for...in.... Se il valore di input non è un oggetto, verrà forzato in un oggetto.

Il metodo freeze() fornisce il comportamento Object.freeze() della libreria standard. Non è più possibile modificare un oggetto bloccato. Il blocco di un oggetto impedisce l'aggiunta di nuove proprietà all'oggetto, la rimozione di proprietà esistenti e la modifica dei valori delle proprietà esistenti. freeze() restituisce lo stesso oggetto trasmesso. Un argomento primitivo o null viene trattato come se fosse un oggetto bloccato e restituito.

Il metodo delete() fornisce il comportamento dell'operatore di eliminazione della libreria standard. La chiave specificata viene rimossa dall'oggetto a meno che quest'ultimo non sia bloccato. Come l'operatore di eliminazione della libreria standard, restituisce true se il primo valore di input (objectInput) è un oggetto non bloccato anche se il secondo valore di input (keyToDelete) specifica una chiave che non esiste. In tutti gli altri casi, restituisce false. Tuttavia, differisce dall'operatore di eliminazione della libreria standard per i seguenti aspetti:

  • keyToDelete non può essere una stringa delimitata da punti che specifica una chiave nidificata.
  • Non è possibile utilizzare delete() per rimuovere elementi da un array.
  • Non è possibile utilizzare delete() per rimuovere proprietà dall'ambito globale.

Sintassi

Object.keys(objectInput)
Object.values(objectInput)
Object.entries(objectInput)
Object.freeze(objectInput)
Object.delete(objectInput, keyToDelete)

Parametri

Object.keys

Parametro Tipo Descrizione
objectInput qualsiasi L'oggetto di cui enumerare le chiavi. Se l'input non è un oggetto, verrà forzato a diventare un oggetto.

Object.values

Parametro Tipo Descrizione
objectInput qualsiasi L'oggetto di cui enumerare i valori. Se l'input non è un oggetto, verrà forzato a diventare un oggetto.

Object.entries

Parametro Tipo Descrizione
objectInput qualsiasi L'oggetto di cui enumerare le coppie chiave/valore. Se l'input non è un oggetto, verrà forzato in un oggetto.

Object.freeze

Parametro Tipo Descrizione
objectInput qualsiasi L'oggetto da bloccare. Se l'input non è un oggetto, verrà trattato come un oggetto bloccato.

Object.delete

Parametro Tipo Descrizione
objectInput qualsiasi L'oggetto di cui eliminare la chiave.
keyToDelete stringa La chiave di primo livello da eliminare.

Esempio

const Object = require('Object');

// The keys of an object are enumerated in an array.
const keys = Object.keys({foo: 'bar'});

// The values of an object are enumerated in an array.
const values = Object.values({foo: 'bar'});

// The key/value pairs of an object are enumerated in an array.
const entries = Object.entries({foo: 'bar'});

// The input object is frozen.
const frozen = Object.freeze({foo: 'bar'});

// The key is removed from the input object.
const obj1 = {deleteme: 'value'};
Object.delete(obj1, 'deleteme');
// Only a top-level key can be specified as the key to delete.
const obj2 = {nested: {key: 'value'}};
Object.delete(obj2, 'nested.key'); // This has no effect.
Object.delete(obj2.nested, 'key'); // This deletes the nested key.

parseUrl

Restituisce un oggetto che contiene tutte le parti dei componenti di un determinato URL, in modo simile all'oggetto URL.

Questa API restituirà undefined per qualsiasi URL non valido. Per gli URL formattati correttamente, i campi non presenti nella stringa dell'URL avranno il valore di una stringa vuota o, nel caso di searchParams, un oggetto vuoto.

L'oggetto restituito avrà i seguenti campi:

{
  href: string,
  origin: string,
  protocol: string,
  username: string,
  password: string,
  host: string,
  hostname: string,
  port: string,
  pathname: string,
  search: string,
  searchParams: Object<string, (string|Array)>,
  hash: string,
}

Esempio

const parseUrl = require('parseUrl');

const urlObject = parseUrl('https://abc:xyz@example.com:8080/foo?param=val%2Cue#bar');

Sintassi

parseUrl(url);

Parametri

Parametro Tipo Descrizione
url stringa L'URL completo che verrà analizzato.

Autorizzazioni associate

Nessuna.

queryPermission

Eseguire una query sulle autorizzazioni consentite e limitate. Restituisce un boolean: true se viene concessa un'autorizzazione, false in caso contrario.

Sintassi

queryPermission(permission, functionArgs*)

Parametri

Parametro Tipo Descrizione
permission stringa Nome dell'autorizzazione.
functionArgs qualsiasi Gli argomenti delle funzioni variano in base all'autorizzazione per l'esecuzione della query. Consulta la sezione Argomenti delle funzioni di seguito.

Argomenti delle funzioni

sendPixel, injectScript, injectHiddenIframe: il secondo parametro deve essere una stringa URL.

writeGlobals, readGlobals: il secondo parametro deve essere la chiave da scrivere o leggere.

readUrl: non sono necessari argomenti aggiuntivi per eseguire query sulla possibilità di leggere l'intero URL. Per eseguire una query sulla possibilità di leggere un determinato componente, trasmetti il nome del componente come secondo argomento:

if (queryPermission('readUrl','port')) {
  // read the port
}

Per verificare se una chiave di query specifica è leggibile, trasmettila come terzo parametro:

if (queryPermission('readUrl','query','key')) {
  getUrlComponent(...);
}

Autorizzazioni associate

Nessuna.

readCharacterSet

Restituisce il valore di document.characterSet.

Sintassi

readCharacterSet()

Parametri

Nessuna.

Autorizzazioni associate

read_character_set

readTitle

Restituisce il valore di document.title.

Sintassi

readTitle()

Parametri

Nessuna.

Autorizzazioni associate

read_title

require

Importa una funzione integrata per nome. Restituisce una funzione o un oggetto che può essere chiamato dal tuo programma. Restituisce undefined quando il browser non supporta la funzione integrata.

Sintassi

require(name)

Parametri

Parametro Tipo Descrizione
name stringa Il nome della funzione da importare.

Esempio

const getUrl = require('getUrl');
const url = getUrl();

Autorizzazioni associate

Nessuna.

sendPixel

Effettua una richiesta GET a un endpoint URL specificato.

Sintassi

sendPixel(url, onSuccess, onFailure)

Parametri

Parametro Tipo Descrizione
url stringa Dove inviare il pixel.
onSuccess funzione Richiamato quando il pixel viene caricato correttamente. Nota: anche se la richiesta viene inviata correttamente, i browser potrebbero richiedere una risposta dell'immagine valida per essere eseguita suSuccess.
onFailure funzione Richiamato quando il caricamento del pixel non va a buon fine. Nota: anche se la richiesta viene inviata correttamente, onFailure può essere eseguito se il server non restituisce una risposta dell'immagine valida.

Autorizzazioni associate

send_pixel

setCookie

Imposta o elimina il cookie con il nome, il valore e le opzioni specificati.

Sintassi

setCookie(name, value[, options, encode])

Parametri

Parametro Tipo Descrizione
name stringa Il nome del cookie.
value stringa Valore del cookie.
options oggetto Specifica gli attributi Dominio, Percorso, Scadenza, Max-Age, Secure e SameSite. Vedi le Opzioni di seguito.
encode boolean Consente di stabilire se il valore del cookie deve essere codificato con encodeURIComponent() di JavaScript. Il valore predefinito è true.

  • Dominio: impostato dalla proprietà options['domain'], se presente. Imposta questo valore su 'auto' per provare a scrivere il cookie utilizzando il dominio più ampio possibile, in base alla posizione del documento. Se questo errore non riesce, proverà a restringere ulteriormente i sottodomini. Se tutte queste operazioni non risolvono il problema, proverà a scrivere il cookie senza un dominio. Se non viene impostato alcun valore, verrà provato a scrivere il cookie senza un dominio specificato. Nota: quando un cookie senza un dominio specificato viene scritto in document.cookie, lo user agent imposterà per impostazione predefinita il dominio del cookie sull'host della posizione attuale del documento.
  • Percorso: impostato da options['path'], se presente. Quando un cookie senza un percorso specificato viene scritto in document.cookie, lo user agent imposta il percorso del cookie relativo al percorso della posizione attuale del documento per impostazione predefinita.
  • Max-Age (Età massima): impostato da options['max-age'], se presente.
  • Scadenza: impostata da options['expires'], se presente. Se presente, deve essere una stringa di data in formato UTC. Date.toUTCString() può essere utilizzato per formattare un Date per questo parametro.
  • Sicuro: impostato da options['secure'], se presente.
  • SameSite: impostato da options['samesite'], se presente.

Autorizzazioni associate

set_cookies

setDefaultConsentState

Invia un aggiornamento del consenso predefinito al livello dati, in modo che venga elaborato non appena possibile dopo la fine dell'elaborazione dell'evento attuale e degli eventuali tag che ha attivato (o dopo il raggiungimento del timeout di elaborazione dei tag). È garantito che l'aggiornamento venga elaborato in questo container prima di qualsiasi elemento in coda nel livello dati. Scopri di più sul consenso.

Esempio:

const setDefaultConsentState = require('setDefaultConsentState');

setDefaultConsentState({
  'ad_storage': 'denied',
  'analytics_storage': 'granted',
  'third_party_storage': 'denied',
  'region': ['US-CA'],
  'wait_for_update': 500
});

Sintassi

setDefaultConsentState(consentSettings)

Parametri

Parametro Tipo Descrizione
consentSettings oggetto Un oggetto che definisce lo stato predefinito per i tipi di consenso specificati.

L'oggetto consentSettings è una mappatura di stringhe di tipo di consenso arbitrario su 'granted' o 'denied'. Supporta i seguenti valori:

Nome chiave Tipo Descrizione
consentType stringa Il valore per ogni tipo di consenso può essere impostato su "granted" o "negato". Qualsiasi valore diverso da "granted" verrà trattato come "negato". L'impostazione del valore su "undefined" non avrà alcun effetto sul valore precedente.
region Array Un array facoltativo di codici regione che specifica a quale regione si applicano le impostazioni di consenso. I codici regione vengono espressi utilizzando il paese e/o le suddivisioni nel formato ISO 3166-2.
wait_for_update numero Specifica un valore in millisecondi per controllare quanto attendere prima che i dati vengano inviati. Utilizzato con gli strumenti per il consenso che si caricano in modo asincrono.

Autorizzazioni associate

Autorizzazione access_consent con accesso in scrittura per tutti i tipi di consenso nell'oggetto consensoSettings.

setInWindow

Imposta il valore specificato in window in corrispondenza della chiave specificata. Per impostazione predefinita, questo metodo non imposta il valore in window se è già presente un valore. Imposta overrideExisting su true per impostare il valore in window indipendentemente dalla presenza di un valore esistente. Restituisce un boolean: true se il valore è stato impostato correttamente e false in caso contrario.

Sintassi

setInWindow(key, value, overrideExisting)

Parametri

Parametro Tipo Descrizione
key stringa La chiave in window in cui inserire il valore.
value * Il valore da impostare in window.
overrideExisting boolean Il flag che indica che il valore deve essere impostato in window, indipendentemente dal fatto che sia presente o meno un valore.

Autorizzazioni associate

access_globals

sha256

Calcola il digest SHA-256 dell'input e richiama un callback con il digest codificato in base64, a meno che l'oggetto options non specifichi una codifica di output diversa.

Esempio:

sha256('inputString', (digest) => {
  sendPixel('https://example.com/collect?id=' + digest);
  data.gtmOnSuccess();
}, data.gtmOnFailure);

sha256('inputString', (digest) => {
  sendPixel('https://example.com/collect?id=' + digest);
  data.gtmOnSuccess();
}, data.gtmOnFailure, {outputEncoding: 'hex'});

Sintassi

sha256(input, onSuccess, onFailure = undefined, options = undefined)

Parametri

Parametro Tipo Descrizione
input stringa La stringa per cui calcolare l'hash.
onSuccess funzione Chiamato con il digest risultante, codificato in base64, a meno che l'oggetto options non specifichi una codifica di output diversa.
onFailure funzione Richiamato se si verifica un errore durante il calcolo del digest o se il browser non supporta sha256 in modo nativo. Il callback viene chiamato con un oggetto contenente il nome dell'errore e il messaggio.
options oggetto Facoltativo per specificare la codifica di output. Se specificato, l'oggetto deve contenere la chiave outputEncoding con un valore pari a base64 o hex.

Autorizzazioni associate

Nessuna.

templateStorage

Restituisce un oggetto con metodi per accedere all'archiviazione dei modelli. L'archiviazione dei modelli consente di condividere i dati tra le esecuzioni di un singolo modello. I dati archiviati nell'archiviazione modello vengono conservati per tutta la durata della pagina.

Sintassi

const templateStorage = require('templateStorage');

templateStorage.getItem(key);

templateStorage.setItem(key, value);

templateStorage.removeItem(key);

// Deletes all stored values for the template.
templateStorage.clear();

Autorizzazioni associate

access_template_storage

Esempio

const templateStorage = require('templateStorage');
const sendPixel = require('sendPixel');

// Ensure sendPixel is called only once per page.
if (templateStorage.getItem('alreadyRan')) {
  data.gtmOnSuccess();
  return;
}

templateStorage.setItem('alreadyRan', true);

sendPixel(
  data.oncePerPagePixelUrl,
  data.gtmOnSuccess,
  () => {
    templateStorage.setItem('alreadyRan', false);
    data.gtmOnFailure();
  });

toBase64

L'API toBase64 ti consente di codificare una stringa in una rappresentazione base64.

Sintassi

toBase64(input)

Parametri

Parametro Tipo Descrizione
input stringa Stringa da codificare.

Esempio

const toBase64 = require('toBase64');

const base64Hello = toBase64('hello');

Autorizzazioni associate

Nessuno

updateConsentState

Invia un aggiornamento del consenso al livello dati, in modo che venga elaborato il prima possibile dopo che l'evento attuale e i tag che ha attivato hanno terminato l'elaborazione (o dopo il raggiungimento del timeout di elaborazione dei tag). È garantito che l'aggiornamento venga elaborato in questo container prima di qualsiasi elemento in coda nel livello dati. Scopri di più sul consenso.

Esempio:

const updateConsentState = require('updateConsentState');

updateConsentState({
  'ad_storage': 'granted',
  'analytics_storage': 'denied',
  'third_party_storage': 'granted',
});

Sintassi

updateConsentState(consentSettings)

Parametri

Parametro Tipo Descrizione
consentSettings oggetto Un oggetto che aggiorna lo stato per i tipi di consenso specificati.

L'oggetto consentSettings è una mappatura di stringhe di tipo di consenso arbitrario su 'granted' o 'denied'. Supporta i seguenti valori:

Nome chiave Tipo Descrizione
consentType stringa Il valore di ogni tipo di consenso può essere impostato su "concesso" o "negato". Qualsiasi valore diverso da "granted" verrà considerato come "negato". L 'impostazione del valore su "undefined" non influisce sul valore precedente.

Autorizzazioni associate

Autorizzazione access_consent con accesso in scrittura per tutti i tipi di consenso nell'oggetto consensoSettings.

API di test

Queste API funzionano con i test JavaScript con sandbox per creare test per i modelli personalizzati in Google Tag Manager. Queste API di test non richiedono un'istruzione require(). Scopri di più sui test dei modelli personalizzati.

assertApi

Restituisce un oggetto matcher che può essere utilizzato per fare asserzioni fluide sull'API specificata.

Sintassi

assertApi(apiName)

Parametri

Parametro Tipo Descrizione
apiName stringa Il nome dell'API da controllare. La stessa stringa passata a require().

Corrispondenze

  • Subject.wasCalled()
  • Subject.wasNotCalled()
  • Subject.wasCalledWith(...expected)
  • Subject.wasNotCalledWith(...expected)

Esempi

assertApi('sendPixel').wasCalled();
assertApi('getUrl').wasNotCalled();
assertApi('makeNumber').wasCalledWith('8');
assertApi('setInWindow').wasNotCalledWith('myVar', 'theWrongValue');

assertThat

L'API assertThat è modellata sulla base della libreria [Truth] di Google. Restituisce un oggetto che può essere utilizzato per fare fluentemente asserzioni sul valore di un soggetto. Un'affermazione non riuscita interrompe immediatamente il test e lo contrassegna come non riuscito. Tuttavia, un errore in un test non influirà su altri scenari di test.

Sintassi

assertThat(actual, opt_message)

Parametri

Parametro Tipo Descrizione
actual qualsiasi Il valore da utilizzare nei controlli del flusso di dati.
opt_message stringa Messaggio facoltativo da stampare se l'asserzione non va a buon fine.

Corrispondenze

Partita Descrizione
isUndefined() Dichiara che l'oggetto è undefined.
isDefined() Dichiara che il soggetto non è undefined.
isNull() Dichiara che l'oggetto è null.
isNotNull() Dichiara che il soggetto non è null.
isFalse() Dichiara che l'oggetto è false.
isTrue() Dichiara che l'oggetto è true.
isFalsy() Afferma che il soggetto è falso. I valori false sono undefined, null, false, NaN, 0 e '' (stringa vuota).
isTruthy() Afferma che il soggetto è veritiero. I valori false sono undefined, null, false, NaN, 0 e '' (stringa vuota).
isNaN() Dichiara che il soggetto è il valore NaN.
isNotNaN() Afferma che il soggetto è un valore diverso da NaN.
isInfinity() Afferma che il soggetto è un infinito positivo o negativo.
isNotInfinity() Afferma che il soggetto è un qualsiasi valore oltre all'Infinito positivo o negativo.
isEqualTo(expected) Dichiara che il soggetto è uguale al valore specificato. Questo è un confronto di valori, non di riferimento. I contenuti di oggetti e array vengono confrontati in modo ricorsivo.
isNotEqualTo(expected) Dichiara che il soggetto non è uguale al valore specificato. Questo è un confronto di valori, non di riferimento. I contenuti di oggetti e array vengono confrontati in modo ricorsivo.
isAnyOf(...expected) Dichiara che il soggetto è uguale a uno del valore specificato. Questo è un confronto di valori, non di riferimento. I contenuti di oggetti e array vengono confrontati in modo ricorsivo.
isNoneOf(...expected) Dichiara che il soggetto non è uguale a nessuno dei valori specificati. Questo è un confronto di valori, non di riferimento. I contenuti di oggetti e array vengono confrontati in modo ricorsivo.
isStrictlyEqualTo(expected) Dichiara che il soggetto è strettamente uguale (===) al valore specificato.
isNotStrictlyEqualTo(expected) Dichiara che il soggetto non è strettamente uguale (!==) al valore specificato.
isGreaterThan(expected) Dichiara che il soggetto è maggiore di (>) rispetto al valore specificato in un confronto ordinato.
isGreaterThanOrEqualTo(expected) Dichiara che il soggetto è maggiore o uguale a (>=) rispetto al valore specificato in un confronto ordinato.
isLessThan(expected) Dichiara che il soggetto è inferiore a (<) rispetto al valore specificato in un confronto ordinato.
isLessThanOrEqualTo(expected) Dichiara che il soggetto è inferiore o uguale a (<=) al valore specificato in un confronto ordinato.
contains(...expected) Dichiara che l'oggetto è un array o una stringa che contiene tutti i valori specificati in qualsiasi ordine. Questo è un confronto di valori, non di riferimento. I contenuti di oggetti e array vengono confrontati in modo ricorsivo.
doesNotContain(...expected) Dichiara che l'oggetto è un array o una stringa che non contiene nessuno dei valori specificati. Questo è un confronto di valori, non di riferimento. I contenuti di oggetti e array vengono confrontati in modo ricorsivo.
containsExactly(...expected) Dichiara che il soggetto è un array che contiene tutti i valori indicati in qualsiasi ordine e nessun altro valore. Questo è un confronto di valori, non di riferimento. I contenuti di oggetti e array vengono confrontati in modo ricorsivo.
doesNotContainExactly(...expected) Dichiara che il soggetto è un array che contiene un insieme di valori diverso dai valori specificati in qualsiasi ordine. Questo è un confronto di valori, non di riferimento. I contenuti di oggetti e array vengono confrontati in modo ricorsivo.
hasLength(expected) Dichiara che il soggetto è un array o una stringa della lunghezza specificata. L'asserzione ha sempre esito negativo se il valore non è una matrice o una stringa.
isEmpty() Dichiara che l'oggetto è un array o una stringa vuota (lunghezza = 0). L'asserzione ha sempre esito negativo se il valore non è un array o una stringa.
isNotEmpty() Dichiara che il soggetto è un array o una stringa non vuota (lunghezza > 0). L'asserzione ha sempre esito negativo se il valore non è un array o una stringa.
isArray() Dichiara che il tipo del soggetto è un array.
isBoolean() Dichiara che il tipo di soggetto è un booleano.
isFunction() Afferma che il tipo di soggetto è una funzione.
isNumber() Dichiara che il tipo di oggetto è un numero.
isObject() Afferma che il tipo di soggetto è un oggetto.
isString() Dichiara che il tipo di oggetto è una stringa.

Esempi

assertThat(undefined).isUndefined();
assertThat(id, 'ID must be defined').isDefined();
assertThat(null).isNull();
assertThat(undefined).isNotNull();
assertThat(true).isTrue();
assertThat(false).isFalse();
assertThat(1).isTruthy();
assertThat('').isFalsy();
assertThat(1/0).isInfinity();
assertThat(0).isNotInfinity();
assertThat(-'foo').isNaN();
assertThat(100).isNotNaN();
assertThat(sentUrl).isEqualTo('https://endpoint.example.com/?account=12345');
assertThat(category).isNotEqualTo('premium');
assertThat(5).isAnyOf(1, 2, 3, 4, 5);
assertThat(42).isNoneOf('the question', undefined, 41.9);
assertThat('value').isStrictlyEqualTo('value');
assertThat('4').isNotStrictlyEqualTo(4);
assertThat(['a', 'b', 'c']).contains('a', 'c');
assertThat(['x', 'y', 'z']).doesNotContain('f');
assertThat(['1', '2', '3']).containsExactly('3', '2', '1');
assertThat(['4', '5']).doesNotContainExactly('4');
assertThat('a string').hasLength(8);
assertThat([]).isEmpty();
assertThat('another string').isNotEmpty();

fail

Non supera immediatamente il test corrente e stampa il messaggio specificato, se fornito.

Sintassi

fail(opt_message);

Parametri

Parametro Tipo Descrizione
opt_message stringa Testo del messaggio di errore facoltativo.

Esempio

fail('This test has failed.');

mock

L'API mock consente di ignorare il comportamento delle API con sandbox. L'API fittizia è sicura da usare nel codice del modello, ma non è operativa se non in modalità di test. Le simulazioni vengono reimpostate prima dell'esecuzione di ogni test.

Sintassi

mock(apiName, returnValue);

Parametri

Parametro Tipo Descrizione
apiName stringa Il nome dell'API da simulare; la stessa stringa passata a require()
returnValue qualsiasi Il valore da restituire per l'API o una funzione chiamata al posto dell'API. Se returnValue è una funzione, questa viene chiamata al posto dell'API con sandbox; se returnValue è una funzione diversa da una funzione, questo valore viene restituito al posto dell'API Sandbox.

Esempi

mock('encodeUri', "https://endpoint.example.com/?account=12345");
mock('sendPixel', function(url, onSuccess, onFailure) {
    onSuccess();
});

runCode

Esegue il codice per il modello, ovvero i contenuti della scheda Codice, nell'ambiente di test corrente con un determinato oggetto dati di input.

Sintassi

runCode(data)

Parametri

Parametro Tipo Descrizione
data oggetto Oggetto dati da utilizzare nel test.

Valore restituito

Restituisce il valore di una variabile per i modelli di variabili; restituisce undefined per tutti gli altri tipi di modello.

Esempio

runCode({field1: 123, field2: 'value'});