Questo documento illustra le API per il tagging lato server.
addEventCallback
Registra una funzione di callback che verrà richiamata al termine di un evento. Il callback verrà richiamato dopo l'esecuzione di tutti i tag per l'evento. Al callback vengono passati due valori: l'ID del container che richiama la funzione e un oggetto che contiene informazioni sull'evento.
Quando questa API viene utilizzata in un tag, viene associata all'evento corrente. Quando questa
API viene utilizzata in un client, deve essere associata a un evento specifico utilizzando la
funzione bindToEvent
dell'API runContainer
. Per ulteriori dettagli, consulta l'esempio.
Sintassi
const addEventCallback = require('addEventCallback');
addEventCallback((containerId, eventData) => {
// Take some action based on the event data.
});
Parametri
Parametro | Tipo | Descrizione |
---|---|---|
callback |
funzione | La funzione da richiamare al termine dell'evento. |
L'oggetto eventData
contiene i seguenti dati:
Nome chiave | Tipo | Descrizione |
---|---|---|
tags |
Array |
Un array di oggetti dati tag. Ogni tag attivato durante l'evento avrà una voce in questo array. L'oggetto dati tag contiene l'ID del tag (id ), lo stato di esecuzione (status ) e il tempo di esecuzione (executionTime ). I dati del tag includeranno anche ulteriori metadati di tag configurati nel tag.
|
In un cliente:
const addEventCallback = require('addEventCallback');
const claimRequest = require('claimRequest');
const extractEventsFromMpv1 = require('extractEventsFromMpv1');
const logToConsole = require('logToConsole');
const returnResponse = require('returnResponse');
const runContainer = require('runContainer');
claimRequest();
const events = extractEventsFromMpv1();
let eventsCompleted = 0;
events.forEach((evt, i) => {
runContainer(evt, /* onComplete= */ (bindToEvent) => {
bindToEvent(addEventCallback)((containerId, eventData) => {
logToConsole('Event Number: ' + i);
eventData.tags.forEach((tag) => {
logToConsole('Tag ID: ' + tag.id);
logToConsole('Tag Status: ' + tag.status);
logToConsole('Tag Execution Time: ' + tag.executionTime);
});
});
if (events.length === ++eventsCompleted) {
returnResponse();
}
});
});
In un tag:
const addEventCallback = require('addEventCallback');
addEventCallback((containerId, eventData) => {
// This will be called at the end of the current event.
});
Autorizzazioni associate
callLater
Schedules a call to a function to occur asynchronously. The function will be
called after the current code returns. This is equivalent to
setTimeout(<function>, 0)
.
Esempio
const callLater = require('callLater');
const logToConsole = require('logToConsole');
callLater(() => {
logToConsole('Logged asynchronously');
});
Sintassi
callLater(function)
Parametri
Parametro | Tipo | Descrizione |
---|---|---|
function |
funzione | La funzione da chiamare. |
Autorizzazioni associate
Nessuna.
claimRequest
Utilizza questa API in un client per rivendicare la richiesta. Dopo aver rivendicato la richiesta, il container non esegue altri client.
Questa API genera un'eccezione se chiamata in un tag o in una variabile. Questa API genera
un'eccezione se viene chiamata dopo il ritorno del client (ad es. se viene chiamata in un callback
asincrono come in callLater
o nella funzione onComplete
di runContainer
).
Un client deve rivendicare la richiesta utilizzando questa API prima di chiamare
l'API runContainer
.
Esempio
const claimRequest = require('claimRequest');
claimRequest();
Sintassi
claimRequest();
Autorizzazioni associate
Nessuna.
computeEffectiveTldPlusOne
Restituisce il dominio di primo livello effettivo + 1 (eTLD+1) del dominio o URL specificato. L'eTLD+1 viene calcolato valutando il dominio in base alle regole dell'elenco dei suffissi pubblici. eTLD+1 è in genere il dominio di livello più elevato su cui è possibile impostare un cookie.
Se l'argomento è nullo o non definito, il valore dell'argomento viene restituito inalterato. In caso contrario, l'argomento viene forzato a formare una stringa. Se l'argomento non è un dominio o un URL valido, viene restituita una stringa vuota. Se il server non è in grado di recuperare l'elenco di suffissi pubblici, il valore dell'argomento viene restituito inalterato.
Esempio
const computeEffectiveTldPlusOne = require('computeEffectiveTldPlusOne');
// Returns 'example.co.uk'
computeEffectiveTldPlusOne('analytics.example.co.uk');
// Returns 'example.co.uk'
computeEffectiveTldPlusOne('https://analytics.example.co.uk/path');
Sintassi
computeEffectiveTldPlusOne(domainOrUrl);
Parametri
Parametro | Tipo | Descrizione |
---|---|---|
domainOrUrl |
stringa | Un dominio o un URL su cui calcolare l'eTLD+1. |
Autorizzazioni associate
Nessuna.
createRegex
Crea una nuova istanza regex e la restituisce quando è sottoposta a wrapping in un oggetto. Non puoi accedere
direttamente all'espressione regolare. Tuttavia, puoi passarlo all'API testRegex
,
a String.replace()
, a String.match()
e a String.search()
.
Restituisce null
se l'espressione regolare non è valida o Re2 non è disponibile sul server.
Questa API utilizza un'implementazione Re2. L'immagine Docker del server deve essere alla versione 2.0.0 o successive.
Esempio
const createRegex = require('createRegex');
const domainRegex = createRegex('\\w+\\.com', 'i');
// Returns '/foobar'
'example.com/foobar'.replace(domainRegex, '');
Sintassi
createRegex(pattern, flags);
Parametri
Parametro | Tipo | Descrizione |
---|---|---|
pattern |
stringa | Testo dell'espressione regolare. |
flags |
stringa | Una stringa facoltativa contenente i flag per l'espressione regolare che viene creata. "g" (globale) e "i" (senza distinzione tra maiuscole e minuscole) sono supportati. Tutti gli altri caratteri vengono ignorati automaticamente. |
Autorizzazioni associate
Nessuna.
Versione minima immagine
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 decodeUri = require('decodeUri');
const decodedUrl = decodeUri(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 URI decodificato. Restituisce undefined
se
viene fornito un input non valido.
Esempio
const decodeUriComponent = require('decodeUriComponent');
const decodedQuery = decodeUriComponent(data.query);
if (decodedQuery) {
// ...
}
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.
Esempio
const encodeUri = require('encodeUri');
const sendHttpGet = require('sendHttpGet');
sendHttpGet('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.
Esempio
const encodeUriComponent = require('encodeUriComponent');
const sendHttpGet = require('sendHttpGet');
sendHttpGet('https://www.example.com/?' + encodeUriComponent(queryInput));
Sintassi
encodeUriComponent(str);
Parametri
Parametro | Tipo | Descrizione |
---|---|---|
str |
stringa | Componente di un URI. |
Autorizzazioni associate
Nessuna.
extractEventsFromMpv1
Converte una richiesta Measurement Protocol V1 in entrata in un elenco di eventi nel formato Schema unificato. Restituisce l'elenco degli eventi estratti. Se la richiesta non è nel formato corretto, genera un errore.
Esempio
const extractEventsFromMpv1 = require('extractEventsFromMpv1');
const isRequestMpv1 = require('isRequestMpv1');
if (isRequestMpv1()) {
const events = extractEventsFromMpv1();
for (let i = 0; i < events.length; ++i) {
const event = events[i];
// Process event.
}
}
Sintassi
extractEventsFromMpv1();
Autorizzazioni associate
Richiede l'autorizzazione read_request
. L'autorizzazione deve essere configurata in modo da consentire l'accesso almeno a:
body
query parameters
extractEventsFromMpv2
Converte una richiesta Measurement Protocol V2 in entrata in un elenco di eventi nel formato Schema unificato. Restituisce l'elenco degli eventi estratti. Se la richiesta non è nel formato corretto, genera un errore.
Esempio
const extractEventsFromMpv2 = require('extractEventsFromMpv2');
const isRequestMpv2 = require('isRequestMpv2');
if (isRequestMpv2()) {
const events = extractEventsFromMpv2();
for (let i = 0; i < events.length; ++i) {
const event = events[i];
// Process event.
}
}
Sintassi
extractEventsFromMpv2();
Autorizzazioni associate
Richiede l'autorizzazione read_request
. L'autorizzazione deve essere configurata in modo da consentire l'accesso almeno a:
body
query parameters
fromBase64
Decodifica una stringa con codifica base64. Restituisce undefined
se l'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
Nessuna.
generateRandom
Restituisce un numero casuale (intero) all'interno dell'intervallo specificato.
Esempio
const generateRandom = require('generateRandom');
const randomValue = generateRandom(0, 10000000);
Sintassi
generateRandom(min, max);
Parametri
Parametro | Tipo | Descrizione |
---|---|---|
min |
numero | Valore potenziale minimo del numero intero restituito (incluso). |
max |
numero | Valore potenziale massimo del numero intero restituito (incluso). |
Autorizzazioni associate
Nessuna.
getAllEventData
Restituisce una copia dei dati sull'evento.
Sintassi
getAllEventData();
Autorizzazioni associate
getClientName
Restituisce una stringa che contiene il nome del client corrente.
Sintassi
getClientName();
Autorizzazioni associate
getContainerVersion
Restituisce un oggetto contenente dati sul contenitore corrente. L'oggetto restituito avrà i seguenti campi:
{
containerId: string,
debugMode: boolean,
environmentName: string,
environmentMode: boolean,
previewMode: boolean,
version: string,
}
Esempio
const getContainerVersion = require('getContainerVersion');
const containerVersion = getContainerVersion();
const containerId = containerVersion['containerId'];
const isDebug = containerVersion['debugMode'];
Sintassi
getContainerVersion();
Autorizzazioni associate
getCookieValues
Restituisce un array contenente i valori di tutti i cookie con il nome specificato.
Esempio
const getCookieValues = require('getCookieValues');
const lastVisit = getCookieValues('lastVisit')[0];
if (lastVisit) {
// ...
}
Sintassi
getCookieValues(name[, noDecode]);
Parametri
Parametro | Tipo | Descrizione |
---|---|---|
name |
stringa | Nome del cookie. |
noDecode |
boolean |
Se true , i valori dei cookie non verranno decodificati prima di essere
restituiti. Il valore predefinito è false .
|
Autorizzazioni associate
getEventData
Restituisce una copia del valore nel percorso specificato nei dati sull'evento. Restituisce
undefined
se non ci sono dati sugli eventi o se non sono presenti valori nel percorso specificato.
Esempio
const getEventData = require('getEventData');
const campaignId = getEventData('campaign.id');
const itemId = getEventData('items.0.id');
const referrer = getEventData('page_referrer');
Parametri
Parametro | Tipo | Descrizione |
---|---|---|
keyPath |
qualsiasi |
Il percorso della chiave, in cui i componenti sono separati da punti. I componenti del percorso possono essere chiavi in un oggetto o indici in un array. Se
keyPath non è una stringa, viene forzato in stringa.
|
Sintassi
getEventData(keyPath);
Autorizzazioni associate
getGoogleAuth
Restituisce un oggetto autorizzazione che, se utilizzato con sendHttpGet
o sendHttpRequest
, includerà un'intestazione di autorizzazione per le API Google Cloud. Questa API utilizza Credenziali predefinite dell'applicazione per trovare automaticamente le credenziali dall'ambiente server.
Esempio
const getGoogleAuth = require('getGoogleAuth');
const logToConsole = require('logToConsole');
const sendHttpGet = require('sendHttpGet');
const auth = getGoogleAuth({
scopes: ['https://www.googleapis.com/auth/datastore']
});
sendHttpGet(
'https://firestore.googleapis.com/v1/projects/my-project/databases/(default)/documents/collection/document',
{authorization: auth}
).then((result) => {
if (result.statusCode >= 200 && result.statusCode < 300) {
logToConsole('Result: ' + result.body);
data.gtmOnSuccess();
} else {
data.gtmOnFailure();
}
});
Sintassi
getGoogleAuth(scopes);
Parametri
Parametro | Tipo | Descrizione |
---|---|---|
scopes
|
Array | Un array di ambiti API di Google OAuth 2.0 per cui richiedere l'accesso. |
Autorizzazioni associate
Richiede l'autorizzazione use_google_credentials
. L'autorizzazione deve essere configurata con uno o più ambiti consentiti.
getGoogleScript
Recupera una risorsa da un insieme predeterminato di script Google e restituisce una promessa con lo script e i metadati di memorizzazione nella cache associati.
La promessa si risolverà in un oggetto contenente due chiavi: script
e
metadata
. Se la richiesta non va a buon fine, la promessa viene rifiutata con una chiave reason
.
L'oggetto metadata
conterrà i seguenti metadati di memorizzazione nella cache in base alle intestazioni delle risposte delle risorse. Ogni campo sarà presente solo se l'intestazione corrispondente è presente nella risposta della risorsa.
{
'cache-control': string,
'expires': string,
'last-modified': string,
}
Esempio
const getGoogleScript = require('getGoogleScript');
getGoogleScript('ANALYTICS').then((result) => {
// Operate on result.script and result.metadata here.
});
Sintassi
getGoogleScript(script[, options]);
Parametri
Parametro | Tipo | Descrizione |
---|---|---|
script |
stringa |
Il nome dello script. Gli script supportati sono
'ANALYTICS' , 'GTAG' e
'GTM' .L'opzione 'ANALYTICS'
recupera lo script di Google Analytics da
https://www.google-analytics.com/analytics.js .L'opzione 'GTAG' recupera lo script del tag globale del sito (gtag.js) da https://www.googletagmanager.com/gtag/js .L'opzione 'GTM' recupera lo script di Google Tag Manager
da https://www.googletagmanager.com/gtm.js .
|
options |
oggetto | Opzioni di richiesta facoltative. Le opzioni supportate sono riportate di seguito. |
Opzioni
Opzione | Tipo | Descrizione |
---|---|---|
id |
stringa |
Applicabile a 'GTAG' con l'ID misurazione gtag e 'GTM' con l'ID contenitore web (ad es. GTM-XXXX).
|
debug |
qualsiasi | Se è attendibile, richiede e restituisce la versione di debug dello script di misurazione. |
timeout |
numero |
Timeout della richiesta in millisecondi. I valori non positivi vengono ignorati. Se la richiesta scade, il callback verrà richiamato con undefined per il valore dello script e {} per l'oggetto metadati.
|
Le chiavi di opzione non riconosciute vengono ignorate.
Autorizzazioni associate
Richiede l'autorizzazione send_http
. L'autorizzazione deve essere configurata in modo da consentire l'accesso almeno a:
- Consenti domini Google
getRemoteAddress
Restituisce una rappresentazione stringa dell'indirizzo IP da cui è stata originata la richiesta, ad esempio 12.345.67.890
per IPv4 o 2001:0db8:85a3:0:0:8a2e:0370:7334
per IPv6, leggendo le intestazioni delle richieste come Forwarded e X-Forwarded-For.
Nota: questa API tenta il più possibile di scoprire l'IP di origine, ma
non può garantire che il risultato sia accurato.
Sintassi
getRemoteAddress();
Autorizzazioni associate
Richiede l'autorizzazione read_request
. L'autorizzazione deve essere configurata in modo da consentire l'accesso almeno a:
- Intestazioni
Forwarded
eX-Forwarded-For
- Indirizzo IP remoto
getRequestBody
Restituisce il corpo della richiesta come string, se presente, oppure come undefined
.
Sintassi
getRequestBody();
Autorizzazioni associate
getRequestHeader
Restituisce il valore dell'intestazione della richiesta denominata come stringa, se presente, o come
undefined
in caso contrario. Se l'intestazione viene ripetuta, i valori restituiti vengono uniti a ', '
.
Esempio
const getRequestHeader = require('getRequestHeader');
const host = getRequestHeader('host');
Sintassi
getRequestHeader(headerName);
Parametri
Parametro | Tipo | Descrizione |
---|---|---|
headerName |
stringa | Il nome dell'intestazione. Questo valore è senza distinzione tra maiuscole e minuscole. |
Autorizzazioni associate
getRequestMethod
Restituisce il metodo di richiesta, ad es. 'GET'
o 'POST'
, come stringa.
Esempio
const getRequestMethod = require('getRequestMethod');
if (getRequestMethod() === 'POST') {
// Handle the POST request here.
}
Sintassi
getRequestMethod();
Autorizzazioni associate
Nessuna.
getRequestPath
Restituisce il percorso della richiesta senza la stringa di query. Ad esempio, se l'URL è
'/foo?id=123'
, viene restituito '/foo'
. Rimuove automaticamente il prefisso
dell'URL del contenitore del server dal percorso. Ad esempio, se l'URL del contenitore del server è https://example.com/analytics
e il percorso di richiesta è '/analytics/foo'
, viene restituito '/foo'
.
Esempio
const getRequestPath = require('getRequestPath');
const requestPath = getRequestPath();
if (requestPath === '/') {
// Handle a request for the root path.
}
Sintassi
getRequestPath();
Autorizzazioni associate
getRequestQueryParameter
Restituisce il valore decodificato del parametro della stringa di query denominato come stringa oppure undefined
se il parametro non è presente. Se il parametro viene ripetuto nella stringa di query, verrà restituito il primo valore visualizzato nella stringa di query.
Esempio
const getRequestQueryParameter = require('getRequestQueryParameter');
const query = getRequestQueryParameter('query');
if (query) {
// Process query here.
}
Sintassi
getRequestQueryParameter(name);
Parametri
Parametro | Tipo | Descrizione |
---|---|---|
name |
stringa | Il nome del parametro di query. |
Autorizzazioni associate
getRequestQueryParameters
Restituisce i parametri di query della richiesta HTTP in entrata come un oggetto che mappa i nomi dei parametri di query al valore o ai valori corrispondenti. I nomi e i valori dei parametri vengono decodificati.
Esempio
const getRequestQueryParameters = require('getRequestQueryParameters');
const queryParameters = getRequestQueryParameters();
if (queryParameters['search']) {
// Handle the search query here.
const maxResults = queryParameters['max_results'];
}
Sintassi
getRequestQueryParameters();
Autorizzazioni associate
getRequestQueryString
Restituisce la query della richiesta come stringa, senza il punto interrogativo iniziale, o come stringa vuota se l'URL della richiesta non include una stringa di query.
Esempio
const getRequestQueryString = require('getRequestQueryString');
const queryString = getRequestQueryString();
if (queryString !== '') {
// Handle the query string.
}
Sintassi
getRequestQueryString();
Autorizzazioni associate
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.
Tipo di input | Valore restituito |
---|---|
stringa | 'string' |
numero | 'number' |
boolean | 'boolean' |
null | 'null' |
non definito | 'undefined' |
Array | 'array' |
Oggetto | 'object' |
Funzione | 'function' |
Esempio
const getType = require('getType');
const type = getType(value);
if (type === 'string') {
// Handle string input.
} else if (type === 'number') {
// Handle numeric input.
} else {
logToConsole('Unsupported input type: ', type);
}
Sintassi
getType(value);
Parametri
Parametro | Tipo | Descrizione |
---|---|---|
value |
qualsiasi | Valore di input. |
Autorizzazioni associate
Nessuna.
hmacSha256
Calcola una firma codificata utilizzando il codice HMAC (Hash-based Message Authentication Code) con SHA-256. Il valore predefinito è la codifica base64url
.
Per utilizzare questa API, imposta la variabile di ambiente SGTM_CREDENTIALS
sul server
sul percorso di un file di chiave JSON codificato in UTF-8 con il seguente formato:
{
"key1": "YWJjZGVmZ2hpamtsbW5vcHFyc3R1dnd4eXowMTIzNDU2Nzg5",
"key2": "OTg3NjU0MzIxMHp5eHd2dXRzcnFwb25tbGtqaWhnZmVkY2Jh",
...
}
I valori sono chiavi HMAC codificate in base64.
Esempio
const hmacSha256 = require('hmacSha256');
const toBase64 = require('toBase64');
const header = toBase64('{"alg":"HS256","typ":"JWT"}', {urlEncoding: true});
const claim = toBase64('{"sub":"1234567890","iat":1698164946}', {urlEncoding: true});
const signature = hmacSha256(header + '.' + claim, 'key1');
const jwt = header + "." + claim + '.' + signature;
Sintassi
hmacSha256(data, keyId, options)
Parametri
Parametro | Tipo | Descrizione |
---|---|---|
data |
stringa | I dati per calcolare il valore HMAC. |
keyId
|
stringa | Un ID chiave del file di chiave JSON che fa riferimento alla chiave da utilizzare. |
options
|
oggetto | Configurazione API facoltativa. (vedi le opzioni di seguito). |
Opzioni
Opzione | Tipo | Descrizione |
---|---|---|
outputEncoding
|
stringa | Specifica il formato di codifica per il valore restituito. I formati supportati sono hex ,
base64 o base64url . Se non specificato, il valore predefinito è
base64url . |
Autorizzazioni associate
Versione minima immagine
isRequestMpv1
Restituisce true
se la richiesta in entrata è una richiesta Measurement Protocol V1 o false
in caso contrario.
Esempio
const isRequestMpv1 = require('isRequestMpv1');
if (isRequestMpv1()) {
// Handle Measurement Protocol V1 request.
const events = extractEventsFromMpv1();
}
Sintassi
isRequestMpv1();
Autorizzazioni associate
Nessuna.
isRequestMpv2
Restituisce true
se la richiesta in entrata è una richiesta Measurement Protocol V2 o
false
in caso contrario.
Esempio
const isRequestMpv2 = require('isRequestMpv2');
if (isRequestMpv2()) {
// Handle Measurement Protocol V2 request.
const events = extractEventsFromMpv2();
}
Sintassi
isRequestMpv2();
Autorizzazioni associate
Nessuna.
logToConsole
Registra i suoi argomenti nella console.
Questi log sono visibili all'interno di Esplora log nella console Google Cloud.
Da Esplora log, esegui la query logName =~ "stdout"
per visualizzare le voci di log create da questa API.
Esempio
const logToConsole = require('logToConsole');
const that = 123;
const those = { ... };
logToConsole('that is: ', that, ' and those is: ', those);
Sintassi
logToConsole(argument1[, argument2, ...]);
Parametri
L'API accetta uno o più argomenti, ognuno dei quali viene convertito in stringa, se necessario, e registrato nella console.
Autorizzazioni associate
makeInteger
Converte il valore specificato in un numero (numero intero).
Sintassi
makeInteger(value);
Parametri
Parametro | Tipo | Descrizione |
---|---|---|
value |
di qualsiasi tipo | Il valore da convertire. |
Autorizzazioni associate
Nessuna.
makeNumber
Converte il valore specificato in un numero.
Sintassi
makeNumber(value);
Parametri
Parametro | Tipo | Descrizione |
---|---|---|
value |
di qualsiasi tipo | Il valore da convertire. |
Autorizzazioni associate
Nessuna.
makeString
Restituisce il valore specificato come stringa.
Sintassi
makeString(value);
Parametri
Parametro | Tipo | Descrizione |
---|---|---|
value |
di qualsiasi tipo | Il valore da convertire. |
Autorizzazioni associate
Nessuna.
makeTableMap
Converte un oggetto di tabella semplice con due colonne in un Map
. Questo valore 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 tabella:
[
{'key': 'k1', 'value': 'v1'},
{'key': 'k2', 'value': 'v2'}
]
in una mappa:
{
'k1': 'v1',
'k2': 'v2'
}
Restituisce un oggetto. Il Map
delle coppie chiave-valore convertito è stato aggiunto o null
, altrimenti.
Sintassi
makeTableMap(tableObj, keyColumnName, valueColumnName);
Parametri
Parametro | Tipo | Descrizione |
---|---|---|
tableObj |
Elenca |
L'oggetto 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, mentre 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.
parseUrl
Restituisce un oggetto che contiene tutte le parti di un determinato URL, simile all'oggetto URL
.
L'API restituirà undefined
per gli URL con formato non corretto. Per gli URL correttamente formattati, 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.
returnResponse
Esegue il flush della risposta impostata in precedenza da altri modelli utilizzando le API che modificano la risposta, tra cui setCookie, setPixelResponse, setResponseBody, setResponseHeader e setResponseStatus. Il valore predefinito è un codice di stato HTTP 200, corpo vuoto e nessuna intestazione.
Ti consigliamo di utilizzare questa API da un modello client.
Sintassi
returnResponse();
Esempio
Vedi l'esempio di runContainer
.
Autorizzazioni associate
runContainer
Esegue la logica del contenitore (variabili, attivatori, tag) nell'ambito di un evento. Se questa API viene richiamata durante l'esecuzione del container, quest'ultimo viene eseguito di nuovo.
I callback onComplete
e onStart
ricevono una funzione denominata
bindToEvent
. Usa bindToEvent
per eseguire un'API nel contesto dell'evento.
Per ulteriori dettagli, vedi l'esempio di addEventCallback.
Ti consigliamo di utilizzare questa API da un modello client.
const returnResponse = require('returnResponse');
const runContainer = require('runContainer');
// Runs the container with a simple pageview event and then returns a response.
runContainer({'event_name': 'pageview'}, () => returnResponse());
Sintassi
runContainer(event, onComplete, onStart);
Parametri
Parametro | Tipo | Descrizione |
---|---|---|
event |
oggetto | I parametri evento. |
onComplete |
funzione | Un callback che viene attivato al termine dell'attivazione di tutti i tag. |
onStart |
funzione | Un callback che viene richiamato immediatamente, prima che i tag inizino a essere attivati. |
Autorizzazioni associate
sendEventToGoogleAnalytics
Invia un singolo evento utilizzando i dati sugli eventi comuni a Google Analytics e restituisce una
promessa che si risolve in un oggetto con una chiave location
o
si rifiuta in un oggetto con una chiave reason
. La destinazione, Universal
Analytics o Google Analytics 4, si basa sull'ID misurazione nei dati
sull'evento.
Il campo location
è impostato sull'intestazione location
, se presente.
Esempio
const logToConsole = require('logToConsole');
const sendEventToGoogleAnalytics = require('sendEventToGoogleAnalytics');
const setResponseHeader = require('setResponseHeader');
const setResponseStatus = require('setResponseStatus');
// Sends an event to Google Analytics and returns failure if the request did not
// succeed. Additionally, if the request resulted in a redirect request, the
// code nominates a redirect response to be returned.
sendEventToGoogleAnalytics(event).then((response) => {
if (response.location) {
setResponseHeader('location', response.location);
setResponseStatus(302);
} else {
setResponseStatus(200);
}
data.gtmOnSuccess();
}).catch((error) => {
logToConsole(error.reason);
setResponseStatus(500);
data.gtmOnFailure();
});
Sintassi
sendEventToGoogleAnalytics(event);
Parametri
Parametro | Tipo | Descrizione |
---|---|---|
event |
oggetto | L'evento nel formato Schema unificato. |
Autorizzazioni associate
Richiede l'autorizzazione send_http
. L'autorizzazione deve essere configurata in modo da consentire l'accesso almeno a:
- Consenti domini Google
sendHttpGet
Effettua una richiesta GET HTTP all'URL specificato e restituisce una promessa che si risolve con il risultato una volta che la richiesta viene completata o scade.
Il risultato risolto è un oggetto contenente tre chiavi: statusCode
, headers
e body
. Se la richiesta non è andata a buon fine (ad es. URL non valido, nessuna route all'host,
errore della negoziazione SSL e così via), la promessa viene rifiutata con: {reason:
'failed'}
. Se è stata impostata l'opzione timeout
e la richiesta è scaduta, la promessa verrà rifiutata con: {reason: 'timed_out'}
Esempio
const sendHttpGet = require('sendHttpGet');
// Returns the response body as the value for a variable.
return sendHttpGet('https://example.com/item/' + data.itemId, {
headers: {key: 'value'},
timeout: 500,
}).then((result) => result.body, () => undefined);
Sintassi
sendHttpGet(url[, options]);
Parametri
Parametro | Tipo | Descrizione |
---|---|---|
url |
stringa | L'URL richiesto. |
options
|
oggetto | Opzioni di richiesta facoltative. (vedi le opzioni di seguito). |
Opzioni
Opzione | Tipo | Descrizione |
---|---|---|
headers |
stringa | Intestazioni della richiesta aggiuntive. |
timeout
|
numero | Il timeout, in millisecondi, prima
dell'interruzione della richiesta. Il valore predefinito è 15000 . |
authorization
|
oggetto | Oggetto autorizzazione facoltativo dalla chiamata a getGoogleAuth per includere le intestazioni di autorizzazione quando si effettuano richieste a googleapis.com . |
Autorizzazioni associate
sendHttpRequest
Effettua una richiesta HTTP all'URL specificato e restituisce una promessa che si risolve con la risposta una volta che la richiesta viene completata o scade.
Il risultato risolto è un oggetto contenente tre chiavi: statusCode
, headers
e body
. Se la richiesta non è andata a buon fine (ad es. URL non valido, nessuna route all'host,
errore della negoziazione SSL e così via), la promessa viene rifiutata con: {reason:
'failed'}
. Se è stata impostata l'opzione timeout
e la richiesta è scaduta, la promessa verrà rifiutata con: {reason: 'timed_out'}
Esempio
const sendHttpRequest = require('sendHttpRequest');
const setResponseBody = require('setResponseBody');
const setResponseHeader = require('setResponseHeader');
const setResponseStatus = require('setResponseStatus');
const postBody = 'interaction=click&campaign=promotion&medium=email';
// Sends a POST request and nominates response based on the response to the POST
// request.
sendHttpRequest('https://example.com/collect', {
headers: {key: 'value'},
method: 'POST',
timeout: 500,
}, postBody).then((result) => {
setResponseStatus(result.statusCode);
setResponseBody(result.body);
setResponseHeader('cache-control', result.headers['cache-control']);
});
Sintassi
sendHttpRequest(url[, options[, body]]);
Parametri
Parametro | Tipo | Descrizione |
---|---|---|
url |
stringa | L'URL richiesto. |
options
|
oggetto | Opzioni di richiesta facoltative. (vedi le opzioni di seguito). |
body |
stringa | Corpo della richiesta facoltativo. |
Opzioni
Opzione | Tipo | Descrizione |
---|---|---|
headers |
stringa | Intestazioni della richiesta aggiuntive. |
method |
oggetto | Il metodo di richiesta. Il valore predefinito è GET . |
timeout
|
numero | Il timeout, in millisecondi, prima
dell'interruzione della richiesta. Il valore predefinito è 15000 . |
authorization
|
oggetto | Oggetto autorizzazione facoltativo dalla chiamata a getGoogleAuth per includere le intestazioni di autorizzazione quando si effettuano richieste a googleapis.com . |
Autorizzazioni associate
sendPixelFromBrowser
Invia un comando al browser per caricare l'URL fornito come tag <img>
. Questo protocollo di comando è supportato nel tag Google per i tag web GA4 e Google Analytics: evento GA. Devi configurare l'URL del contenitore
del server. Per ulteriori dettagli, consulta le istruzioni.
Questa API restituisce false
se la richiesta in entrata non supporta il protocollo dei comandi o se la risposta è già stata scaricata. In caso contrario, questa API
restituisce true
.
Esempio:
const sendPixelFromBrowser = require('sendPixelFromBrowser');
sendPixelFromBrowser('https://example.com/?id=123');
Sintassi
sendPixelFromBrowser(url)
Parametri
Parametro | Tipo | Descrizione |
---|---|---|
url |
stringa | L'URL da inviare al browser. |
Autorizzazioni associate
setCookie
Imposta o elimina un cookie con le opzioni specificate.
Per eliminare un cookie, è necessario impostarne uno con lo stesso percorso e lo stesso dominio con cui è stato creato e assegnargli un valore di scadenza passato, ad esempio "Thu, 01 Jan 1970 00:00:00 GMT"
.
Tieni presente che è necessario richiamare returnResponse affinché la risposta venga inviata al client.
Esempio
const setCookie = require('setCookie');
// Sets an httpOnly cookie with a max-age of 3600.
setCookie('cookieName', 'cookieValue', {'max-age': 3600, httpOnly: true});
Sintassi
setCookie(name, value[, options[, noEncode]]);
Parametri
Parametro | Tipo | Descrizione |
---|---|---|
name |
stringa | Il nome del cookie. Il nome non fa distinzione tra maiuscole e minuscole. |
value |
stringa | Il valore del cookie. |
options |
oggetto | Attributi facoltativi dei cookie:domain, expires, fallbackDomain, httpOnly, max- age, path, secure e sameSite. (vedi Opzioni di seguito). |
noEncode |
boolean |
Se impostato su true, il valore del cookie non verrà codificato. Il valore predefinito è
false .
|
domain: l'host a cui verrà inviato il cookie. Se impostato sul valore speciale "auto", l'host verrà calcolato automaticamente utilizzando la strategia seguente:
- eTLD+1 dell'intestazione
Forwarded
, se presente. - eTLD+1 dell'intestazione
X-Forwarded-Host
, se presente. - eTLD+1 dell'intestazione
Host
.
- eTLD+1 dell'intestazione
expires: la durata massima del cookie. Deve essere una stringa di data in formato UTC, ad esempio "Sab, 26 ott 1985 08:21:00 GMT". Se
expires
emax-age
sono impostati,max-age
ha la precedenza.httpOnly: impedisce a JavaScript di accedere al cookie se
true
.max-age: numero di secondi prima della scadenza del cookie. Un numero zero o negativo fa scadere il cookie immediatamente. Se sono impostati entrambi,
expires
emax-age
,max-age
ha la precedenza.path: un percorso che deve esistere nell'URL richiesto. In caso contrario, il browser non invierà l'intestazione Cookie.
secure: se impostato su
true
, il cookie viene inviato al server solo quando viene effettuata una richiesta da un endpointhttps:
.sameSite: dichiara che un cookie non deve essere inviato con richieste multiorigine. Deve essere
'strict'
,'lax'
o'none'
.
Autorizzazioni associate
setPixelResponse
Imposta il corpo della risposta su un GIF di 1 x 1, imposta l'intestazione Content-Type su "image/gif", imposta le intestazioni di memorizzazione nella cache in modo che gli user agent non memorizzino nella cache la risposta e imposta lo stato della risposta su 200.
Tieni presente che è necessario richiamare returnResponse affinché la risposta venga inviata al client.
Sintassi
setPixelResponse();
Autorizzazioni associate
Richiede l'autorizzazione access_response
. L'autorizzazione deve essere configurata in modo da consentire l'accesso almeno a:
headers
: devi autorizzare le seguenti chiavi:content-type
cache-control
expires
pragma
body
status
setResponseBody
Imposta il corpo della risposta sull'argomento.
Tieni presente che è necessario richiamare returnResponse affinché la risposta venga inviata al client.
Sintassi
setResponseBody(body[, encoding]);
Parametri
Parametro | Tipo | Descrizione |
---|---|---|
body |
stringa | Il valore da impostare come corpo della risposta. |
encoding |
stringa |
La codifica dei caratteri del corpo della risposta (il valore predefinito è 'utf8' ). I valori supportati includono 'ascii' , 'utf8' , 'utf16le' , 'ucs2' , 'base64' , 'latin1' , 'binary' e 'hex' .
|
Autorizzazioni associate
Richiede l'autorizzazione access_response
. L'autorizzazione deve essere configurata in modo da consentire l'accesso almeno a:
body
setResponseHeader
Imposta un'intestazione nella risposta che verrà restituita. Se un'intestazione con questo nome (senza distinzione tra maiuscole e minuscole) è stata precedentemente impostata da questa API, quest'ultima chiamata sovrascriverà o cancellerà il valore impostato dal chiamante precedente.
Tieni presente che è necessario richiamare returnResponse affinché la risposta venga inviata al client.
Sintassi
setResponseHeader(name, value);
Parametri
Parametro | Tipo | Descrizione |
---|---|---|
name |
stringa | Il nome dell'intestazione. I nomi delle intestazioni HTTP non fanno distinzione tra maiuscole e minuscole, pertanto il nome dell'intestazione sarà in minuscolo. |
value |
string undefined | Il valore dell'intestazione. Se nullo o non definito, l'intestazione denominata viene cancellata dalla risposta che verrà restituita. |
Autorizzazioni associate
Richiede l'autorizzazione access_response
. L'autorizzazione deve essere configurata in modo da consentire l'accesso almeno a:
headers
setResponseStatus
Imposta il codice di stato HTTP della risposta che verrà restituita.
Tieni presente che è necessario richiamare returnResponse affinché la risposta venga inviata al client.
Sintassi
setResponseStatus(statusCode);
Parametri
Parametro | Tipo | Descrizione |
---|---|---|
statusCode |
numero | Il codice di stato HTTP da restituire. |
Autorizzazioni associate
Richiede l'autorizzazione access_response
. L'autorizzazione deve essere configurata in modo da consentire l'accesso almeno a:
status
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.
La firma e il comportamento di questa API corrispondono all'API sha256
per i contenitori web. Tuttavia, i modelli personalizzati nei contenitori dei server dovrebbero utilizzare l'API sha256Sync
per generare un codice più semplice.
Esempio
const encodeUriComponent = require('encodeUriComponent');
const sendHttpGet = require('sendHttpGet');
const sha256 = require('sha256');
sha256('inputString', (digest) => {
sendHttpGet('https://example.com/collect?id=' + encodeUriComponent(digest));
});
sha256('inputString', (digest) => {
sendHttpGet('https://example.com/collect?id=' + encodeUriComponent(digest));
}, {outputEncoding: 'hex'});
Sintassi
sha256(input, onSuccess, options = undefined);
Parametri
Parametro | Tipo | Descrizione |
---|---|---|
input |
stringa | La stringa da sottoporre ad hashing. |
onSuccess |
funzione |
Chiamato con il digest risultante, codificato in base64, a meno che l'oggetto options non specifichi una codifica di output diversa.
|
options |
oggetto |
Oggetto opzioni facoltativo per specificare la codifica di output. Se specificato, l'oggetto deve contenere la chiave outputEncoding con il valore base64 o hex .
|
Autorizzazioni associate
Nessuna.
sha256Sync
Calcola e restituisce il digest SHA-256 dell'input, codificato in base64,
a meno che l'oggetto options
non specifichi una codifica di output diversa.
Esempio
const encodeUriComponent = require('encodeUriComponent');
const sendHttpGet = require('sendHttpGet');
const sha256Sync = require('sha256Sync');
const digestBase64 = sha256Sync('inputString');
const digestHex = sha256Sync('inputString', {outputEncoding: 'hex'});
sendHttpGet('https://example.com/collect?id=' + encodeUriComponent(digestBase64));
sendHttpGet('https://example.com/collect?id=' + encodeUriComponent(digestHex));
Sintassi
sha256Sync(input, options = undefined);
Parametri
Parametro | Tipo | Descrizione |
---|---|---|
input |
stringa | La stringa da sottoporre ad hashing. |
options |
oggetto |
Oggetto opzioni facoltativo per specificare la codifica di output. Se specificato, l'oggetto deve contenere la chiave outputEncoding con il valore base64 o hex .
|
Autorizzazioni associate
Nessuna.
templateDataStorage
Restituisce un oggetto con metodi per accedere all'archiviazione dei dati del modello. L'archiviazione dei dati tramite modello consente di condividere i dati tra le esecuzioni di un singolo modello. I dati archiviati nell'archiviazione dei dati di modello rimangono sul server che esegue il container. Nella maggior parte dei casi ci sono più server che eseguono il container, quindi l'archiviazione dei dati nell'archiviazione dei dati del modello non garantisce che ogni richiesta successiva avrà accesso ai dati.
L'espressione "dati" nel nome "templateDataStorage" si riferisce al fatto che tramite questa API possono essere archiviati solo tipi di dati
normali e non di funzione. Eventuali funzioni o riferimenti alle funzioni passate all'API verranno archiviati come null
.
Sintassi
const templateDataStorage = require('templateDataStorage');
// Returns a copy of the value stored for the given key, or null if nothing
// is stored with that key.
templateDataStorage.getItemCopy(key);
// Stores a copy of the value for the given key (or removes the data stored
// for the given key if the input value is null).
templateDataStorage.setItemCopy(key, value);
// Removes the value stored for the given key, if present.
templateDataStorage.removeItem(key);
// Deletes all values stored for the current template.
templateDataStorage.clear();
Esempio
const sendHttpGet = require('sendHttpGet');
const setResponseBody = require('setResponseBody');
const setResponseStatus = require('setResponseStatus');
const templateDataStorage = require('templateDataStorage');
// Check to see if the item is in the cache.
const cachedBody = templateDataStorage.getItemCopy(data.key);
if (cachedBody) {
setResponseBody(cachedBody);
data.gtmOnSuccess();
return;
}
sendHttpGet(data.url).then((result) => {
if (result.statusCode >= 200 && result.statusCode < 300) {
setResponseBody(result.body);
templateDataStorage.setItemCopy(data.key, result.body);
data.gtmOnSuccess();
} else {
data.gtmOnFailure();
}
setResponseStatus(result.statusCode);
});
Autorizzazioni associate
testRegex
Testa una stringa rispetto a un'espressione regolare creata tramite l'API createRegex
. Restituisce true
se l'espressione regolare corrisponde. In caso contrario, restituisce false
.
Un'espressione regolare creata con il flag globale è stateful. Consulta la documentazione RegExp per i dettagli.
Esempio
const createRegex = require('createRegex');
const testRegex = require('testRegex');
const domainRegex = createRegex('\\w+\\.com', 'i');
// createRegex returns null if the regex is invalid or Re2 is not available.
if (domainRegex === null) return;
// Returns true
testRegex(domainRegex, 'example.com/foobar');
Sintassi
testRegex(regex, string);
Parametri
Parametro | Tipo | Descrizione |
---|---|---|
regex |
Oggetto | L'espressione regolare da verificare, restituita dall'API createRegex. |
string |
stringa | Stringa di prova da testare. |
Autorizzazioni associate
Nessuna.
toBase64
Codifica una stringa come base64 o base64url. Il valore predefinito è la codifica Base64.
Sintassi
toBase64(input, options);
Parametri
Parametro | Tipo | Descrizione |
---|---|---|
input |
stringa | Stringa da codificare. |
options
|
oggetto | Configurazione API facoltativa. (vedi le opzioni di seguito). |
Opzioni
Opzione | Tipo | Descrizione | Versione minima |
---|---|---|---|
urlEncoding
|
boolean | Se true, il risultato verrà codificato nel formato base64url . |
1.0.0 |
Esempio
const toBase64 = require('toBase64');
const base64Hello = toBase64('hello');
const base64UrlHello = toBase64('hello', {urlEncoding: true});
Autorizzazioni associate
Nessuna.
BigQuery
Restituisce un oggetto che fornisce funzioni BigQuery.
La funzione BigQuery.insert
consente di scrivere dati in una tabella BigQuery. Restituisce una promessa che si risolve in seguito a un inserimento riuscito o che rifiuta in caso di errore.
Una volta inserito correttamente, la promessa viene risolta senza argomenti.
Quando l'inserimento non riesce, la promessa viene rifiutata con un elenco di oggetti contenenti il motivo dell'errore ed eventualmente un oggetto riga se si verifica un errore. È possibile che una parte della richiesta venga completata correttamente, mentre altre parti non lo sono. In questo caso, la promessa viene rifiutata con un elenco di errori per ogni riga con un oggetto riga per distinguere le righe inserite (consulta gli esempi di errori di seguito). Per ulteriori informazioni, consulta la documentazione di BigQuery sui messaggi di errore.
Sintassi
BigQuery.insert(connectionInfo, rows[, options]);
Parametro | Tipo | Descrizione |
---|---|---|
connectionInfo |
oggetto |
Definisce le informazioni necessarie per la connessione a una tabella BigQuery. Sono
presenti un parametro facoltativo e due parametri obbligatori:
|
rows |
Array | Le righe da inserire nella tabella. |
options |
oggetto | Opzioni di richiesta facoltative. Le opzioni supportate sono: ignoreUnknownValues e skipinvalidRows. Le chiavi di opzione sconosciute vengono ignorate. (vedi Opzioni di seguito). |
Parametro | Tipo | Descrizione |
---|---|---|
ignoreUnknownValues |
boolean | Se impostato su true , accetta le righe contenenti valori che non corrispondono allo schema. I valori sconosciuti vengono ignorati. Il valore predefinito è false . |
skipInvalidRows |
boolean | Se il criterio è impostato su true , inserisci tutte le righe valide di una richiesta,
anche se esistono righe non valide. Il valore predefinito è false . |
Un errore di modulo non trovato indica che è probabile che il contenitore del server stia eseguendo una versione meno recente dell'immagine che non aveva ancora incluso il modulo BigQuery. Esegui di nuovo il deployment del container del server con le stesse impostazioni utilizzando il nostro script di deployment. Il modulo verrà incluso automaticamente al termine dell'operazione.
Un errore non di inserzione in genere include un oggetto con una chiave reason
:
[{reason: 'invalid'}]
Un errore di inserimento può contenere più oggetti di errore con un array errors
e un oggetto row
. Di seguito è riportato un esempio di risposta di errore derivante dall'inserimento di due righe in cui una sola riga contiene un errore:
[
{
"errors": [
{
"reason":"invalid"
}
],
"row": {
"string_col":"otherString",
"number_col":-3,
"bool_col":3
}
},
{
"errors": [
{
"reason":"stopped"
}
],
"row": {
"string_col":"stringValue",
"number_col":5,
"bool_col:false
}
}
]
Esempio
const BigQuery = require('BigQuery');
const connectionInfo = {
'projectId': 'gcp-cloud-project-id',
'datasetId': 'destination-dataset',
'tableId': 'destination-table',
};
const rows = [{
'column1': 'String1',
'column2': 1234,
}];
const options = {
'ignoreUnknownValues': true,
'skipInvalidRows': false,
};
BigQuery.insert(connectionInfo, rows, options)
.then(data.gtmOnSuccess, data.gtmOnFailure);
Autorizzazioni associate
Firestore
Restituisce un oggetto che fornisce funzioni Firestore.
Questa API supporta solo Firestore in modalità Native, non Firestore in modalità Datastore. Inoltre, l'API supporta solo l'uso del database predefinito.
Firestore.read
La funzione Firestore.read
legge i dati da un documento Firestore e restituisce una promessa che si risolve in un oggetto contenente due chiavi: id
e data
. Se il documento non esiste, la promessa viene rifiutata con un oggetto contenente una chiave reason
uguale a not_found
.
Sintassi
Firestore.read(path[, options]);
Parametro | Tipo | Descrizione |
---|---|---|
path |
stringa | Il percorso del documento o della raccolta. Non deve iniziare o terminare con "/". |
options |
oggetto | Opzioni di richiesta facoltative. Le opzioni supportate sono: projectId, disableCache e transaction. Le chiavi di opzione sconosciute vengono ignorate. (vedi Opzioni di seguito). |
Parametro | Tipo | Descrizione |
---|---|---|
projectId |
stringa | (Facoltativo) ID progetto della piattaforma Google Cloud. Se omesso, projectId viene recuperato dalla variabile di ambiente GOOGLE_CLOUD_PROJECT purché l'impostazione dell'autorizzazione access_firestore per l'ID progetto sia impostata su * o GOOGLE_CLOUD_PROJECT . Se il contenitore del server è in esecuzione su Google Cloud, il valore GOOGLE_CLOUD_PROJECT sarà già impostato sull'ID del progetto Google Cloud. |
disableCache |
boolean | (Facoltativo) Determina se disattivare o meno la cache. La memorizzazione nella cache è abilitata per impostazione predefinita e memorizza nella cache i risultati per l'intera durata della richiesta. |
transaction |
stringa | (Facoltativo) Il valore recuperato da Firestore.runTransaction(). Contrassegna l'operazione da utilizzare in una transazione. |
Esempio
const Firestore = require('Firestore');
return Firestore.read('collection/document', {
projectId: 'gcp-cloud-project-id',
}).then((result) => result.data.key, () => undefined);
Firestore.write
La funzione Firestore.write
scrive i dati in un documento o una raccolta Firestore. Se il percorso è una raccolta, verrà creato un documento con un ID generato in modo casuale. Se il percorso riguarda un documento e non esiste, verrà creato. Questa API restituisce una promessa che si risolve nell'ID del
documento aggiunto o modificato. Se viene utilizzata l'opzione di transazione, l'API restituisce comunque una promessa, ma non conterrà l'ID poiché le scritture sono in batch.
Sintassi
Firestore.write(path, input[, options]);
Parametri
Parametro | Tipo | Descrizione |
---|---|---|
path |
stringa | Il percorso del documento o della raccolta. Non deve iniziare o terminare con "/". |
input |
oggetto | Il valore da scrivere nel documento. Se l'opzione di unione è impostata, l'API unirà le chiavi dall'input nel documento. |
options |
oggetto | Opzioni di richiesta facoltative. Le opzioni supportate sono: projectId, merge e transaction. Le chiavi di opzione sconosciute vengono ignorate. (vedi Opzioni di seguito). |
Parametro | Tipo | Descrizione |
---|---|---|
projectId |
stringa | (Facoltativo) ID progetto della piattaforma Google Cloud. Se omesso, projectId viene recuperato dalla variabile di ambiente GOOGLE_CLOUD_PROJECT purché l'impostazione dell'autorizzazione access_firestore per l'ID progetto sia impostata su * o GOOGLE_CLOUD_PROJECT . Se il contenitore del server è in esecuzione su Google Cloud, il valore GOOGLE_CLOUD_PROJECT sarà già impostato sull'ID del progetto Google Cloud. |
merge |
boolean | (Facoltativo) Se impostato su true , unisci le chiavi dall'input al documento, altrimenti il metodo sostituirà l'intero documento. Il valore predefinito è
false . |
transaction |
stringa | (Facoltativo) Il valore recuperato da Firestore.runTransaction(). Contrassegna l'operazione da utilizzare in una transazione. |
Esempio
const Firestore = require('Firestore');
const input = {key1: 'value1', key2: 12345};
Firestore.write('collection/document', input, {
projectId: 'gcp-cloud-project-id',
merge: true,
}).then((id) => {
data.gtmOnSuccess();
}, data.gtmOnFailure);
Firestore.query
La funzione Firestore.query
esegue una query sulla raccolta specificata e restituisce una
promessa che si risolve in un array di documenti Firestore che soddisfano le condizioni
della query. L'oggetto documento Firestore è uguale a quello elencato sopra in Firestore.read
. Se non esistono documenti che corrispondono alle condizioni della query,
la promessa restituita verrà risolta in un array vuoto.
Sintassi
Firestore.query(collection, queryConditions[, options]);
Parametro | Tipo | Descrizione |
---|---|---|
collection |
stringa | Il percorso della raccolta. Non deve iniziare o terminare con "/". |
queryConditions |
Array | Un array di condizioni di query. Ogni query si presenta sotto forma di un array con tre valori: key, operator e expectedValue. E.g.:
[[‘id’, ‘<’, ‘5’], [‘state’, ‘==", ‘CA’]]. Le condizioni sono unite per creare il risultato della query. Consulta gli operatori di query di Firestore per un elenco di operatori di query compatibili. |
options |
oggetto | Opzioni di richiesta facoltative. Le opzioni supportate sono: projectId, disableCache, limit e transaction. Le chiavi di opzione sconosciute vengono ignorate. (vedi Opzioni di seguito). |
Parametro | Tipo | Descrizione |
---|---|---|
projectId |
stringa | (Facoltativo) ID progetto della piattaforma Google Cloud. Se omesso, projectId viene recuperato dalla variabile di ambiente GOOGLE_CLOUD_PROJECT purché l'impostazione dell'autorizzazione access_firestore per l'ID progetto sia impostata su * o GOOGLE_CLOUD_PROJECT . Se il contenitore del server è in esecuzione su Google Cloud, il valore GOOGLE_CLOUD_PROJECT sarà già impostato sull'ID del progetto Google Cloud. |
disableCache |
boolean | (Facoltativo) Determina se disattivare o meno la cache. La memorizzazione nella cache è abilitata per impostazione predefinita e memorizza nella cache i risultati per l'intera durata della richiesta. |
limit |
numero | (Facoltativo) Modifica il numero massimo di risultati restituiti dalla query. Il valore predefinito è 5. |
transaction |
stringa | (Facoltativo) Il valore recuperato da Firestore.runTransaction(). Contrassegna l'operazione da utilizzare in una transazione. |
Esempio
const Firestore = require('Firestore');
const queries = const queries = [['id', '==', '5']];
return Firestore.query('collection', queries, {
projectId: 'gcp-cloud-project-id',
limit: 1,
}).then((documents) => documents[0].data.key, () => undefined);
Firestore.runTransaction
La funzione Firestore.runTransaction
consente all'utente di
leggere e scrivere atomicamente da Firestore. In caso di scrittura simultanea o altro conflitto di transazione, la transazione verrà ritentata fino a due volte. Se non riesce
dopo tre tentativi totali, l'API rifiuta con un errore. Questa API restituisce una promessa che si risolve in un array di ID documento, per ogni operazione di scrittura, se la transazione ha esito positivo, e, in caso di esito negativo, viene rifiutata con l'errore.
Sintassi
Firestore.runTransaction(callback[, options]);
Parametri
Parametro | Tipo | Descrizione |
---|---|---|
callback |
funzione | Un callback che viene invocato con un ID transazione stringa. L'ID transazione può essere passato nelle chiamate API di lettura/scrittura/query. Questa funzione di callback deve restituire una promessa. La richiamata può essere eseguita fino a tre volte prima di non riuscire. |
options |
oggetto | Opzioni di richiesta facoltative. L'unica opzione supportata è projectId. Le chiavi di opzione sconosciute vengono ignorate. (vedi Opzioni di seguito). |
Parametro | Tipo | Descrizione |
---|---|---|
projectId |
stringa | (Facoltativo) ID progetto della piattaforma Google Cloud. Se omesso, projectId viene recuperato dalla variabile di ambiente GOOGLE_CLOUD_PROJECT purché l'impostazione dell'autorizzazione access_firestore per l'ID progetto sia impostata su * o GOOGLE_CLOUD_PROJECT . Se il contenitore del server è in esecuzione su Google Cloud, il valore GOOGLE_CLOUD_PROJECT sarà già impostato sull'ID del progetto Google Cloud. |
Esempio
const Firestore = require('Firestore');
const path = 'collection/document';
const projectId = 'gcp-cloud-project-id';
Firestore.runTransaction((transaction) => {
const transactionOptions = {
projectId: projectId,
transaction: transaction,
};
// Must return a promise.
return Firestore.read(path, transactionOptions).then((result) => {
const newInputCount = result.data.inputCount + 1;
const input = {key1: 'value1', inputCount: newInputCount};
return Firestore.write(path, input, transactionOptions);
});
}, {
projectId: projectId
}).then((ids) => {
data.gtmOnSuccess();
}, data.gtmOnFailure);
Gli errori sono disponibili in ogni funzione Firestore verranno rifiutati con un oggetto contenente una chiave reason
:
Firestore.read(...).then(onSuccess, (error) => {
if (error.reason === 'unknown') {
// Handle the unknown error here.
}
});
I motivi dell'errore possono contenere, a titolo esemplificativo, i codici di errore dell'API REST di Firestore.
Autorizzazioni associate
JSON
Restituisce un oggetto che fornisce funzioni JSON.
La funzione parse()
analizza una stringa JSON per creare il valore o l'oggetto
descritto dalla stringa. Se il valore non può essere analizzato (ad es. un JSON in un formato non valido), la funzione restituirà 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 esempio, l'oggetto ha un ciclo), il metodo restituirà undefined
.
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'});
Sintassi
JSON.parse(stringInput);
JSON.stringify(value);
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.
Messages
Le seguenti API operano insieme per consentire il passaggio dei messaggi tra le diverse parti di un container.
addMessageListener
Aggiunge una funzione che rimane in ascolto di un messaggio di un determinato tipo. Quando un messaggio di questo tipo viene inviato utilizzando l'API sendMessage
(in genere tramite un tag), il callback verrà eseguito in modo sincrono. Il callback viene eseguito con due parametri:
messageType:string
message:Object
Se il callback viene aggiunto in un client, il callback riceverà messaggi in
tutti gli eventi creati dal client. Se il callback deve ricevere i messaggi
solo da un determinato evento, associa questa API all'evento utilizzando bindToEvent
nella funzione onStart
dell'API runContainer
. Guarda l'esempio.
Sintassi
const addMessageListener = require('addMessageListener');
addMessageListener('send_pixel', (messageType, message) => {
// This will be run whenever something sends a 'send_pixel' message.
});
Parametri
Parametro | Tipo | Descrizione |
---|---|---|
messageType |
stringa | Il tipo di messaggio da ascoltare. Se il valore non è una stringa, verrà forzato in una stringa. |
callback |
funzione | Il callback da eseguire quando viene inviato un messaggio del tipo di messaggio applicabile. Se il callback non è una funzione, l'API non farà nulla. |
Esempio
const addMessageListener = require('addMessageListener');
const claimRequest = require('claimRequest');
const extractEventsFromMpv1 = require('extractEventsFromMpv1');
const returnResponse = require('returnResponse');
const runContainer = require('runContainer');
claimRequest();
addMessageListener('send_pixel', (messageType, message) => {
// This will be run whenever a tag sends a 'send_pixel' message.
});
const events = extractEventsFromMpv1();
let eventsCompleted = 0;
events.forEach((event, i) => {
runContainer(events[i], /* onComplete= */ () => {
if (events.length === ++eventsCompleted) {
returnResponse();
}
}, /* onStart= */ (bindToEvent) => {
if (i === 0) {
bindToEvent(addMessageListener)('send_pixel', (messageType, message) => {
// This will be called whenever a tag for the first event sends a
// 'send_pixel' message.
});
}
});
});
Autorizzazioni associate
Richiede l'autorizzazione use_message
. L'autorizzazione deve essere configurata in modo da consentire almeno:
- Un tipo di messaggio con
Usage
dilisten
olisten_and_send
.
hasMessageListener
Restituisce true se è stato aggiunto un listener di messaggi per il tipo di messaggio specificato. Restituisce false negli altri casi.
Sintassi
const hasMessageListener = require('hasMessageListener');
hasMessageListener('send_pixel');
Autorizzazioni associate
Nessuna.
sendMessage
Invia un messaggio del tipo specificato a un listener registrato. Può essere utilizzato per inviare i messaggi da un tag al client che ha eseguito il container.
Sintassi
const sendMessage = require('sendMessage');
sendMessage('send_pixel', {url: 'https://analytics.example.com/collect'});
Parametri
Parametro | Tipo | Descrizione |
---|---|---|
messageType |
stringa | Il tipo di messaggio da inviare. Se il valore non è una stringa, verrà forzato in stringa. |
message |
oggetto | Il messaggio da inviare. Se il messaggio non è un oggetto, l'API non farà nulla. |
Autorizzazioni associate
Richiede l'autorizzazione use_message
. L'autorizzazione deve essere configurata in modo da consentire almeno:
- Un tipo di messaggio con
Usage
dilisten_and_send
osend
.
Object
Restituisce un oggetto che fornisce metodi Object
.
Il metodo keys()
fornisce il comportamento Object.keys() della libreria standard. Restituisce un array dei nomi 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 a trasformarlo 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 a trasformarlo 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 a trasformarlo in un oggetto.
Il metodo freeze()
fornisce il comportamento Object.freeze() della libreria standard. Un oggetto bloccato non può più essere modificato. Il blocco di un oggetto impedisce l'aggiunta di nuove proprietà, la rimozione di proprietà esistenti e la modifica dei valori delle proprietà esistenti. freeze()
restituisce lo stesso oggetto passato. Un argomento primitivo o nullo verrà trattato come
se fosse un oggetto bloccato e verrà 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 venga bloccato.
Come l'operatore di eliminazione della libreria standard, restituisce true
se il primo valore di input (objectInput
) è un oggetto che non è bloccato anche se il secondo valore di input (keyToDelete
) specifica una chiave che non esiste. Restituisce false
in
tutti gli altri casi. 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 trasformarlo in 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 trasformarlo in 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 a trasformarlo in un oggetto. |
Object.freeze
Parametro | Tipo | Descrizione |
---|---|---|
objectInput | qualsiasi | L'oggetto da bloccare. Se l'input non è un oggetto, verrà considerato 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.
Promise
Restituisce un oggetto che fornisce metodi per interagire con le promesse.
Le promesse sono funzionalmente equivalenti alle promesse JavaScript. Ogni istanza ha tre metodi che restituiscono una promessa che consente ulteriori azioni quando una promessa si risolve:
.then()
- Gestisce sia le richieste risolte che quelle rifiutate. Richiede due callback come parametri: uno per il caso di successo e uno per il caso di errore..catch()
: gestisce solo le richieste rifiutate. Prende un callback come parametro..finally()
: offre un modo per eseguire il codice indipendentemente dal fatto che la promessa sia stata risolta o rifiutata. Prende un callback come parametro che viene richiamato senza argomento.
Una variabile che restituisce una promessa equivale al valore risolto della promessa o
false
se la promessa viene rifiutata.
Esempio
promise.then((resolvedValue) => {
// Handles when promise resolves.
}, (rejectedValue) => {
// Handles when promise rejects.
});
promise.catch((rejectedValue) => {
// Handles when promise rejects.
});
promise.finally(() => {
// Runs regardless of whether or not the previous promise resolves or
// rejects.
});
Promise.all
Restituisce una promessa che:
- si risolve quando tutti gli input sono stati risolti oppure
- rifiuta quando uno qualsiasi degli input rifiuta
Sintassi
Promise.all(inputs);
Parametri
Parametro | Tipo | Descrizione |
---|---|---|
inputs |
Array | Un array di valori o promesse. Se un input non è una promessa, l'input viene trasmesso come se fosse il valore risolto di una promessa. Genera un errore se l'input non è un array. |
Esempio
const Promise = require('Promise');
const sendHttpGet = require('sendHttpGet');
return Promise.all(['a', sendHttpGet('https://example.com')])
.then((results) => {
// results will equal: ['a', {statusCode: 200, headers: {}, body: ''}]
});
Autorizzazioni associate
Nessuna.
Promise.create
Crea una promessa funzionalmente equivalente a una promessa JavaScript.
Sintassi
Promise.create(resolver);
Parametri
Parametro | Tipo | Descrizione |
---|---|---|
resolver |
funzione | Una funzione richiamata con due funzioni: risoluzione e rifiuto. La promessa restituita verrà risolta o rifiutata quando viene richiamato il parametro corrispondente. Genera un errore se il resolver non è una funzione. |
Esempio
const Promise = require('Promise');
return Promise.create((resolve, reject) => {
// Do asynchronous work that eventually calls resolve() or reject()
});
Autorizzazioni associate
Nessuna.
Testa le API
Queste API funzionano con i test JavaScript con sandbox per creare test per modelli
personalizzati in Google Tag Manager. Queste API di test non hanno bisogno di un'istruzione
require()
. [Scopri di più sui test con modelli personalizzati].
assertApi
Restituisce un oggetto matcher che può essere utilizzato per effettuare in modo fluido le asserzioni relative a una determinata API.
Sintassi
assertApi(apiName)
Parametri
Parametro | Tipo | Descrizione |
---|---|---|
apiName |
stringa | Il nome dell'API da verificare; la stessa stringa passata a
require() .
|
Corrispondenza
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 in base alla libreria [Truth] di Google. Restituisce un oggetto che può essere utilizzato per fare fluenti asserzioni sul valore di un soggetto. Un errore di asserzione interrompe immediatamente il test e lo contrassegna come non riuscito. Tuttavia, l'esito negativo di 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 fluenti. |
opt_message |
stringa | Messaggio facoltativo da stampare se l'asserzione non riesce. |
Corrispondenza
Corrispondenza | Descrizione |
---|---|
isUndefined() |
Dichiara che il soggetto è undefined . |
isDefined() |
Dichiara che il soggetto non è undefined . |
isNull() |
Dichiara che il soggetto è null . |
isNotNull() |
Dichiara che il soggetto non è null . |
isFalse() |
Dichiara che il soggetto è false . |
isTrue() |
Dichiara che il soggetto è true . |
isFalsy() |
Dichiara che il soggetto è falso. I valori falsi sono
undefined , null , false ,
NaN , 0 e "' (stringa vuota). |
isTruthy() |
Dichiara che l'oggetto è veritiero. I valori falsi sono
undefined , null , false ,
NaN , 0 e "' (stringa vuota). |
isNaN() |
Dichiara che il soggetto è il valore NaN. |
isNotNaN() |
Dichiara che il soggetto è qualsiasi valore diverso da NaN. |
isInfinity() |
Dichiara che il soggetto è un infinito positivo o negativo. |
isNotInfinity() |
Dichiara che il soggetto è qualsiasi valore diverso dall'infinito positivo o negativo. |
isEqualTo(expected) |
Dichiara che il soggetto è uguale al valore specificato. Si tratta di un confronto di valori, non di un riferimento. I contenuti di oggetti e array vengono confrontati in modo ricorsivo. |
isNotEqualTo(expected) |
Dichiara che il soggetto non è uguale al valore specificato. Si tratta di un confronto di valori, non di un riferimento. I contenuti di oggetti e array vengono confrontati in modo ricorsivo. |
isAnyOf(...expected) |
Dichiara che il soggetto è uguale a uno dei valori specificati. Si tratta di un confronto di valori, non di un 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. Si tratta di un confronto di valori, non di un riferimento. I contenuti di oggetti e array vengono confrontati in modo ricorsivo. |
isStrictlyEqualTo(expected) |
Dichiara che l'oggetto è strettamente uguale (=== ) al valore specificato. |
isNotStrictlyEqualTo(expected) |
Dichiara che l'oggetto non è strettamente uguale (!== ) al valore specificato. |
isGreaterThan(expected) |
Dichiara che il soggetto è maggiore di (> ) il valore specificato in un confronto ordinato. |
isGreaterThanOrEqualTo(expected) |
Dichiara che l'oggetto è maggiore o uguale a (>= ) del valore specificato in un confronto ordinato. |
isLessThan(expected) |
Dichiara che il soggetto è inferiore a (< ) il valore specificato in un confronto ordinato. |
isLessThanOrEqualTo(expected) |
Dichiara che il soggetto è minore o uguale a (<= ) del valore specificato in un confronto ordinato. |
contains(...expected) |
Dichiara che il soggetto è un array o una stringa che contiene tutti i valori specificati in qualsiasi ordine. Si tratta di un confronto di valori, non di un riferimento. I contenuti di oggetti e array vengono confrontati in modo ricorsivo. |
doesNotContain(...expected) |
Dichiara che il soggetto è un array o una stringa che non contiene nessuno dei valori specificati. Si tratta di un confronto di valori, non di un 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 specificati in qualsiasi ordine e nessun altro valore. Si tratta di un confronto di valori, non di un riferimento. I contenuti di oggetti e array vengono confrontati in modo ricorsivo. |
doesNotContainExactly(...expected) |
Dichiara che il soggetto è un array contenente un insieme di valori diverso rispetto ai valori specificati in qualsiasi ordine. Si tratta di un confronto di valori, non di un 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 il soggetto è 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 del soggetto è un valore booleano. |
isFunction() |
Dichiara che il tipo del soggetto è una funzione. |
isNumber() |
Dichiara che il tipo del soggetto è un numero. |
isObject() |
Dichiara che il tipo del soggetto è un oggetto. |
isString() |
Dichiara che il tipo del soggetto è 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 facoltativo del messaggio di errore. |
Esempio
fail('This test has failed.');
mock
L'API mock
ti consente di ignorare il comportamento delle API con sandbox. L'API fittizia è sicura da utilizzare nel codice del modello, ma non è operativa quando 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 funzione viene chiamata al posto dell'API con sandbox; se returnValue è diverso da una funzione, quel valore viene restituito al posto dell'API con 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 il contenuto della scheda Codice, nell'ambiente di test attuale 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 modelli.
Esempio
runCode({field1: 123, field2: 'value'});