APIs für benutzerdefinierte Vorlagen

Kern-APIs

Diese APIs funktionieren mit JavaScript-Sandbox, um benutzerdefinierte Vorlagen in Google Tag Manager zu erstellen. Jede API wird mit einer require()-Anweisung hinzugefügt. Beispiel:

const myAPI = require('myAPI');

addConsentListener

Registriert eine Listener-Funktion, die ausgeführt wird, wenn sich der Status des angegebenen Einwilligungstyps ändert.

Der angegebene Listener wird jedes Mal aufgerufen, wenn sich der Status für den angegebenen Einwilligungstyp von „Abgelehnt“ zu „Gewährt“ oder von „Zugegeben“ zu „Abgelehnt“ ändert. Ein Einwilligungstyp ohne Status gilt als gewährt. Der Listener wird also nicht aufgerufen, wenn ein nicht festgelegter Einwilligungstyp auf „Erteilt“ aktualisiert wird. Listener-Funktionen sind dafür verantwortlich, dass ihr Code die richtige Häufigkeit ausführt.

Beispiel:

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);
  });
}

Syntax

addConsentListener(consentType, listener)

Parameter

Parameter Typ Beschreibung
consentType String Der Einwilligungstyp, auf den sich Statusänderungen auswirken.
listener Funktion Die Funktion, die ausgeführt werden soll, wenn sich der Status des angegebenen Einwilligungstyps ändert.

Wenn ein Listener aufgerufen wird, wird der geänderte Einwilligungstyp und der neue Wert dieses Einwilligungstyps übergeben:

Parameter Typ Beschreibung
consentType String Der Typ der Einwilligung, die geändert wird.
granted Boolesch Ein boolescher Wert, der „true“ ist, wenn der angegebene Einwilligungstyp in „Gewährt“ geändert wird.

Verknüpfte Berechtigungen

Berechtigung „access_consent“ mit Lesezugriff für den Einwilligungstyp.


addEventCallback

Mit der addEventCallback API können Sie eine Callback-Funktion registrieren, die am Ende eines Ereignisses aufgerufen wird. Der Callback wird aufgerufen, wenn alle Tags für das Ereignis ausgeführt wurden oder wenn ein Zeitlimit für In-Page-Ereignisse erreicht wurde. An den Callback werden zwei Werte übergeben: die ID des Containers, der die Funktion aufruft, und ein Objekt, das Informationen zum Ereignis enthält.

Syntax

addEventCallback(callback)

Parameter

Parameter Typ Beschreibung
callback Funktion Die Funktion, die am Ende des Ereignisses aufgerufen werden soll.

Das Objekt eventData enthält die folgenden Daten:

Schlüsselname Typ Beschreibung
tags Array Ein Array mit Tag-Datenobjekten. Jedes Tag, das während des Ereignisses ausgelöst wurde, hat einen Eintrag in diesem Array. Das Tag-Datenobjekt enthält die ID des Tags (id), den Ausführungsstatus (status) und die Ausführungszeit (executionTime). Die Tag-Daten enthalten auch zusätzliche Tag-Metadaten, die für das Tag konfiguriert wurden.

Beispiel

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

Verknüpfte Berechtigungen

read_event_metadata


aliasInWindow

Mit der aliasInWindow API können Sie einen Alias erstellen (z.B. window.foo = window.bar), der bestimmte Tags unterstützt, für die ein Alias erforderlich ist. Weist den Wert im window-Objekt unter fromPath dem Schlüssel im window-Objekt im toPath zu. Gibt true zurück, wenn der Vorgang erfolgreich war, andernfalls false.

Syntax

aliasInWindow(toPath, fromPath)

Parameter

Parameter Typ Beschreibung
toPath String Ein durch Punkte getrennter Pfad zum Objekt window, in das ein Wert kopiert werden soll. Alle Komponenten im Pfad bis zur letzten Komponente müssen bereits im Objekt window vorhanden sein.
fromPath String Ein durch Punkte getrennter Pfad zu window zum zu kopierenden Wert. Wenn der Wert nicht vorhanden ist, schlägt der Vorgang fehl.

Beispiel

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

Verknüpfte Berechtigungen

access_globals ist sowohl für toPath als auch für fromPath erforderlich. toPath erfordert Schreibzugriff, fromPath benötigt Lesezugriff.


callInWindow

Ermöglicht das Aufrufen von Funktionen aus einem Pfad außerhalb des window-Objekts auf richtliniengesteuerte Weise. Ruft die Funktion unter dem angegebenen Pfad in window mit den angegebenen Argumenten auf und gibt den Wert zurück. Wenn der Rückgabetyp nicht direkt einem Typ zugeordnet werden kann, der in JavaScript in einer Sandbox unterstützt wird, wird undefined zurückgegeben. In JavaScript-Sandboxes werden die folgenden Typen unterstützt: null, undefined, boolean, number, string, Array, Object und function. Wenn der angegebene Pfad nicht vorhanden ist oder nicht auf eine Funktion verweist, wird undefined zurückgegeben.

Syntax

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

Parameter

Parameter Typ Beschreibung
pathToFunction String Ein durch Punkte getrennter Pfad zur Funktion in window, der aufgerufen werden soll.
args * An die Funktion zu übergebende Argumente.

Verknüpfte Berechtigungen

access_globals mit execute-Berechtigung aktiviert.


callLater

Plant den Aufruf einer Funktion, die asynchron ausgeführt werden soll. Die Funktion wird aufgerufen, nachdem der aktuelle Code zurückgegeben wurde. Dies entspricht setTimeout(<function>, 0).

Syntax

callLater(function)

Parameter

Parameter Typ Beschreibung
function Funktion Die aufzurufende Funktion.

copyFromDataLayer

Gibt den Wert zurück, der dem Schlüssel derzeit in der Datenschicht zugewiesen ist: der Wert, der am angegebenen Schlüssel gefunden wird, wenn es sich um einen primitiven Typ, eine Funktion oder ein Objektliteral handelt, oder andernfalls um undefined.

Syntax

copyFromDataLayer(key[, dataLayerVersion])

Parameter

Parameter Typ Beschreibung
key String Der Schlüssel im Format „a.b.c“.
dataLayerVersion number Die optionale Datenschichtversion. Der Standardwert liegt bei 2. Wir raten dringend davon ab, den Wert 1 zu verwenden.

Verknüpfte Berechtigungen

read_data_layer


copyFromWindow

Kopiert eine Variable aus dem window-Objekt. Wenn der Wert in window nicht direkt einem Typ zugeordnet werden kann, der in JavaScript in einer Sandbox unterstützt wird, wird undefined zurückgegeben. Die acht Typen, die in einer Sandbox in JavaScript unterstützt werden, sind null, undefined, boolean, number, string, Array, Object und function. Gibt den abgerufenen (und erzwungenen) Wert zurück.

Syntax

copyFromWindow(key)

Parameter

Parameter Typ Beschreibung
key String Der Schlüssel im window, dessen Wert kopiert werden soll.

Verknüpfte Berechtigungen

access_globals


createArgumentsQueue

Erstellt eine Warteschlange, die mit Argumentobjekten gefüllt wird, um Tag-Lösungen zu unterstützen, die dies erfordern.

Erstellt eine Funktion im globalen Bereich (d.h. window) mit dem Argument fnKey (gleiche Semantik wie createQueue). Nachdem die Funktion erstellt wurde, erstellt diese API mit dem Argument arrayKey ein Array in window (falls noch nicht vorhanden).

Wenn die unter fnKey erstellte Funktion aufgerufen wird, überträgt sie ihr Argumentobjekt in das unter arrayKey erstellte Array. Der Rückgabewert der API ist die unter fnKey erstellte Funktion.

Diese Funktion erfordert die Lese- und Schreibeinstellung für fnKey und arrayKey für die Berechtigung access_globals.

Beispiel:

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

Syntax

createArgumentsQueue(fnKey, arrayKey)

Parameter

Parameter Typ Beschreibung
fnKey String Der Pfad in window, in dem die Funktion festgelegt ist, falls noch nicht vorhanden. Dieses Argument unterstützt die Standardpunktnotation. Wenn der Pfad des Schlüssels nicht vorhanden ist, wird eine Ausnahme ausgelöst. Das heißt, wenn fnKey 'one.two' ist, wird eine Ausnahme ausgelöst.
arrayKey String Der Pfad in window, in dem das Array festgelegt ist, falls noch nicht vorhanden. Dieses Argument unterstützt die Standardpunktnotation. Wenn der Pfad des Schlüssels nicht vorhanden ist, wird eine Ausnahme ausgelöst. Wenn arrayKey also 'one.two' ist und es kein globales Objekt namens 'one' gibt, wird eine Ausnahme ausgelöst.

Verknüpfte Berechtigungen

access_globals


createQueue

Erstellt ein Array in window (falls noch nicht vorhanden) und gibt eine Funktion zurück, die Werte in dieses Array überträgt.

Für diese Funktion ist die Lese- und Schreibeinstellung für arrayKey in der Berechtigung access_globals erforderlich.

Beispiel:

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

Syntax

createQueue(arrayKey)

Parameter

Parameter Typ Beschreibung
arrayKey String Der Schlüssel in window, für den das Array festgelegt ist (falls noch nicht vorhanden). Dieses Argument unterstützt die Standardpunktnotation. Wenn der Pfad des Schlüssels nicht vorhanden ist, wird eine Ausnahme ausgelöst. Wenn arrayKey beispielsweise 'one.two' ist und kein globales Objekt mit dem Namen 'one' vorhanden ist, wird eine Ausnahme ausgelöst.

Verknüpfte Berechtigungen

access_globals


decodeUri

Decodiert alle codierten Zeichen im angegebenen URI. Gibt einen String zurück, der den decodierten URI darstellt. Gibt undefined zurück, wenn die Eingabe ungültig ist.

Beispiel:

const decode = require('decodeUri');

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

Syntax

decodeUri(encoded_uri)

Parameter

Parameter Typ Beschreibung
encoded_uri String Ein URI, der durch encodeUri() oder auf andere Weise codiert wurde.

Verknüpfte Berechtigungen

Keine.


decodeUriComponent

Decodiert alle codierten Zeichen in der angegebenen URI-Komponente. Gibt einen String zurück, der die decodierte URI-Komponente darstellt. Gibt undefined zurück, wenn die Eingabe ungültig ist.

Beispiel:

const decode = require('decodeUriComponent');

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

Syntax

decodeUriComponent(encoded_uri_component)

Parameter

Parameter Typ Beschreibung
encoded_uri_component String Eine URI-Komponente, die mit encodeUriComponent() oder auf andere Weise codiert wurde.

Verknüpfte Berechtigungen

Keine.


encodeUri

Gibt einen codierten URI (Uniform Resource Identifier) zurück, in dem Sonderzeichen maskiert werden. Gibt einen string zurück, der den bereitgestellten String darstellt, der als URI codiert ist.

Beispiel:

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

Syntax

encodeUri(uri)

Parameter

Parameter Typ Beschreibung
uri String Ein vollständiger URI.

Verknüpfte Berechtigungen

Keine.


encodeUriComponent

Gibt einen codierten URI (Uniform Resource Identifier) zurück, in dem Sonderzeichen maskiert werden. Gibt einen string zurück, der den bereitgestellten String darstellt, der als URI codiert ist.

Beispiel:

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

Syntax

encodeUriComponent(str)

Parameter

Parameter Typ Beschreibung
str String Eine Komponente eines URI.

Verknüpfte Berechtigungen

Keine.


fromBase64

Mit der fromBase64 API können Sie Strings aus ihrer base64-Darstellung decodieren. Gibt undefined zurück, wenn die Eingabe ungültig ist.

Syntax

fromBase64(base64EncodedString)

Parameter

Parameter Typ Beschreibung
base64EncodedString String Base64-codierter String.

Beispiel

const fromBase64 = require('fromBase64');

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

Verknüpfte Berechtigungen


generateRandom

Gibt eine zufällige Zahl (Ganzzahl) innerhalb des angegebenen Bereichs zurück.

Syntax

generateRandom(min, max)

Parameter

Parameter Typ Beschreibung
min number Minimaler potenzieller Wert der zurückgegebenen Ganzzahl.
max number Maximaler potenzieller Wert der zurückgegebenen Ganzzahl.

Verknüpfte Berechtigungen

Keine.


getContainerVersion

Gibt ein Objekt mit Daten zum aktuellen Container zurück. Das zurückgegebene Objekt hat die folgenden Felder:

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

Beispiel

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);
  }
}

Syntax

getContainerVersion();

Verknüpfte Berechtigungen

read_container_data


getCookieValues

Gibt die Werte aller Cookies mit dem angegebenen Namen zurück.

Syntax

getCookieValues(name[, decode])

Parameter

Parameter Typ Beschreibung
name String Name des Cookies.
decode Boolesch Steuert, ob die Cookiewerte mit decodeURIComponent() von JavaScript decodiert werden sollen. Die Standardeinstellung ist true.

Verknüpfte Berechtigungen

get_cookies


getQueryParameters

Gibt den ersten oder alle Parameter für queryKey der aktuellen URL zurück. Gibt den ersten Wert aus queryKey oder ein Array von Werten aus queryKey zurück.

Syntax

getQueryParameters(queryKey[, retrieveAll])

Parameter

Parameter Typ Beschreibung
queryKey String Der Schlüssel, der aus den Abfrageparametern gelesen werden soll.
retrieveAll Boolesch Gibt an, ob alle Werte abgerufen werden sollen.

Wenn die aktuelle URL beispielsweise https://example.com/path?var=foo&var1=foo1&var=foo2&var=foo lautet, dann gilt:

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

Verknüpfte Berechtigungen

get_url muss die Komponente query zulassen und queryKey in den zulässigen Abfrageschlüsseln (oder jedem Abfrageschlüssel) angeben.


getReferrerQueryParameters

Die getReferrerQueryParameters API verhält sich genauso wie getQueryParameters, nur dass sie sich auf die Verweis-URL und nicht auf die aktuelle URL auswirkt. Gibt den ersten oder alle Parameter für die queryKey des angegebenen Verweis-URLs zurück. Gibt den ersten Wert aus queryKey oder ein Array von Werten aus queryKey zurück.

Syntax

getReferrerQueryParameters(queryKey[, retrieveAll])

Parameter

Parameter Typ Beschreibung
queryKey String Der Schlüssel, der aus den Abfrageparametern gelesen werden soll.
retrieveAll Boolesch Gibt an, ob alle Werte abgerufen werden sollen.

Wenn die Verweis-URL beispielsweise https://example.com/path?var=foo&var1=foo1&var=foo2&var=foo lautet, dann gilt:

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

Verknüpfte Berechtigungen

get_referrer muss die Komponente query zulassen und queryKey in den zulässigen Abfrageschlüsseln angeben (oder einen beliebigen Abfrageschlüssel zulassen).


getReferrerUrl

Bei einem Komponententyp liest die API das Dokumentobjekt für die Verweis-URL und gibt einen String zurück, der einen Teil der Verweis-URL darstellt. Wenn keine Komponente angegeben ist, wird die vollständige Verweis-URL zurückgegeben.

Syntax

getReferrerUrl([component])

Parameter

Parameter Typ Beschreibung
component String Die Komponente, die von der URL zurückgegeben werden soll. Mögliche Werte sind: protocol, host, port, path, query, extension. Wenn component den Wert undefined oder null hat oder mit keiner dieser Komponenten übereinstimmt, wird die gesamte URL zurückgegeben.

Verknüpfte Berechtigungen

get_referrer muss die Komponente query zulassen und queryKey in den zulässigen Abfrageschlüsseln angeben (oder einen beliebigen Abfrageschlüssel zulassen).


getTimestamp

Veraltet. getTimestampMillis bevorzugen.

Gibt eine Zahl zurück, die die aktuelle Zeit in Millisekunden seit der Unix-Epoche darstellt, wie sie von Date.now() zurückgegeben wird.

Syntax

getTimestamp();

Verknüpfte Berechtigungen

Keine.


getTimestampMillis

Gibt eine Zahl zurück, die die aktuelle Zeit in Millisekunden seit der Unix-Epoche darstellt, wie sie von Date.now() zurückgegeben wird.

Syntax

getTimestampMillis();

Verknüpfte Berechtigungen

Keine.


getType

Gibt einen string zurück, der den Typ des angegebenen Werts beschreibt. Anders als bei typeof unterscheidet getType zwischen array und object.

Syntax

getType(data.someField)

Notizen

In der folgenden Tabelle sind die Strings aufgeführt, die für jeden Eingabewert zurückgegeben werden.

Eingabewert Ergebnis
undefined 'Nicht definiert'
null „null“
true „Boolesch“
12 „number“
'string' „string“
{ a: 3 } „object“
[ 1, 3 ] „Array“
(x) => x + 1 'Funktion'

Verknüpfte Berechtigungen

Keine.


getUrl

Gibt einen String zurück, der die gesamte URL oder einen Teil davon anhand eines Komponententyps und einiger Konfigurationsparameter darstellt.

Syntax

getUrl(component)

Parameter

Parameter Typ Beschreibung
component String Die Komponente, die von der URL zurückgegeben werden soll. Muss einer der folgenden Werte sein: protocol, host, port, path, query, extension oder fragment. Wenn die Komponente undefined oder null ist oder mit keiner dieser Komponenten übereinstimmt, wird der gesamte Wert für href zurückgegeben.

Verknüpfte Berechtigungen

get_url


gtagSet

Überträgt einen gtag-set-Befehl an die Datenschicht, der so schnell wie möglich verarbeitet wird, nachdem das aktuelle Ereignis und alle ausgelösten Tags die Verarbeitung abgeschlossen haben (oder das Zeitlimit für die Tag-Verarbeitung erreicht wurde). Die Aktualisierung wird in diesem Container garantiert vor allen in der Warteschlange befindlichen Elementen in der Datenschichtwarteschlange verarbeitet.

Wenn beispielsweise ein Tag aufgerufen wird, das bei der Initialisierung einer Einwilligung ausgelöst wurde, wird die Aktualisierung angewendet, bevor das Initialisierungsereignis verarbeitet wird. Beispiele: ads_data_redaction wird auf true oder false oder url_passthrough auf true oder false festgelegt.

Beispiele:

const gtagSet = require('gtagSet');

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

Syntax

gtagSet(object)

Parameter

Parameter Typ Beschreibung
Object Objekt Ein Objekt, das den globalen Status für seine enthaltenen Attribute aktualisiert.

Verknüpfte Berechtigungen

write_data_layer prüft die Schreibberechtigung für alle angegebenen Schlüssel in dataLayer. Wenn die Eingabe in gtagSet ein einfaches Objekt ist, prüft die API die Schreibberechtigung für alle vereinfachten Schlüssel innerhalb des Objekts, z.B. für gtagSet({foo: {bar: 'baz'}}), ob die API Schreibberechtigungen für foo.bar hat.

Wenn die Eingabe in gtagSet ein Schlüssel und ein Objektwert ist, der nicht einfach ist, prüft die API die Schreibberechtigung für diesen Schlüssel. Beispiel: Bei gtagSet('abc', true) prüft die API, ob eine Schreibberechtigung für 'abc' vorliegt.

Wenn es im Eingabeobjekt einen Zyklus gibt, werden nur Schlüssel überprüft, bevor das gleiche Objekt erreicht wird.


injectHiddenIframe

Fügt der Seite einen unsichtbaren iFrame hinzu.

Callbacks werden als Funktionsinstanzen angegeben und in JavaScript-Funktionen eingebunden, die sie aufrufen.

Syntax

injectHiddenIframe(url, onSuccess)

Parameter

Parameter Typ Beschreibung
url String Die URL, die als Wert für das src-Attribut des iFrames verwendet werden soll.
onSuccess Funktion Wird aufgerufen, wenn der Frame erfolgreich geladen wurde.

Verknüpfte Berechtigungen

inject_hidden_iframe


injectScript

Fügt der Seite ein Skript-Tag hinzu, um die angegebene URL asynchron zu laden. Die Callbacks werden als Funktionsinstanzen angegeben und in JavaScript-Funktionen eingebunden, die sie aufrufen.

Syntax

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

Parameter

Parameter Typ Beschreibung
url String Die Adresse des einzufügenden Skripts.
onSuccess Funktion Wird aufgerufen, wenn das Skript erfolgreich geladen wurde.
onFailure Funktion Wird aufgerufen, wenn das Skript nicht geladen wird.
cacheToken String Optionaler String, der die angegebene URL im Cache speichert. Wenn dieser Wert angegeben ist, wird nur ein Skriptelement erstellt, um den JavaScript-Code anzufordern. Alle weiteren Ladeversuche führen dazu, dass die angegebenen onSuccess- und onFailure-Methoden in die Warteschlange gestellt werden, bis das Skript geladen ist.

Verknüpfte Berechtigungen

inject_script


isConsentGranted

Gibt „true“ zurück, wenn der angegebene Einwilligungstyp gewährt wurde.

Die Einwilligung für einen bestimmten Einwilligungstyp gilt als erteilt, wenn der Einwilligungstyp auf „Gewährt“ oder gar nicht festgelegt wurde. Wenn der Einwilligungstyp auf einen anderen Wert festgelegt ist, wird er als nicht gewährt betrachtet.

Die Tag Manager-Benutzeroberfläche für die Tag-Einstellungen bietet eine Option, die immer ausgelöst werden kann. Wenn diese API bei einem Tag mit ausgelöstem Auslösen immer verwendet wird, gilt die Einwilligung als erteilt und unabhängig von der tatsächlichen Einwilligung wird true zurückgegeben.

Beispiel:

const isConsentGranted = require('isConsentGranted');

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

Syntax

isConsentGranted(consentType)

Parameter

Parameter Typ Beschreibung
consentType String Der Einwilligungstyp, dessen Status Sie prüfen möchten.

Verknüpfte Berechtigungen

Berechtigung „access_consent“ mit Lesezugriff für den Einwilligungstyp.


JSON

Gibt ein Objekt zurück, das JSON-Funktionen bereitstellt.

Die Funktion parse() parst einen JSON-String, um den vom String beschriebenen Wert oder das entsprechende Objekt zu erstellen. Wenn der Wert nicht geparst werden kann (z.B. ein fehlerhaftes JSON-Format), gibt die Funktion undefined zurück. Wenn der Eingabewert kein String ist, wird die Eingabe zu einem String gezwungen.

Die Funktion stringify() konvertiert die Eingabe in einen JSON-String. Wenn der Wert nicht geparst werden kann (z.B. wenn das Objekt einen Zyklus hat), gibt die Methode undefined zurück.

Syntax

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

Parameter

JSON.parse

Parameter Typ Beschreibung
String-Eingabe Beliebig Wert, der konvertiert werden soll Wenn der Wert kein String ist, wird die Eingabe zu einem String erzwungen.

JSON.stringify

Parameter Typ Beschreibung
Wert Beliebig Wert, der konvertiert werden soll

Beispiel

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

Gibt ein Objekt mit Methoden für den Zugriff auf den lokalen Speicher zurück.

Syntax

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);

Verknüpfte Berechtigungen

access_local_storage

Beispiel

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

Protokolliert Argumente in der Browserkonsole.

Syntax

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

Parameter

Parameter Typ Beschreibung
obj1 [, obj2,... objN] Beliebig Argumente

Verknüpfte Berechtigungen

logging


makeInteger

Wandelt den angegebenen Wert in eine Zahl (Ganzzahl) um.

Syntax

makeInteger(value)

Parameter

Parameter Typ Beschreibung
value Beliebig Wert, der konvertiert werden soll

Verknüpfte Berechtigungen

Keine.


makeNumber

Wandelt den angegebenen Wert in eine Zahl um.

Syntax

makeNumber(value)

Parameter

Parameter Typ Beschreibung
value Beliebig Wert, der konvertiert werden soll

Verknüpfte Berechtigungen

Keine.


makeString

Gibt den angegebenen Wert als String zurück.

Syntax

makeString(value)

Parameter

Parameter Typ Beschreibung
value Beliebig Wert, der konvertiert werden soll

Verknüpfte Berechtigungen

Keine.


makeTableMap

Konvertiert ein einfaches Tabellenobjekt mit zwei Spalten in einen Map. Dadurch wird das Vorlagenfeld SIMPLE_TABLE mit zwei Spalten in ein überschaubares Format geändert.

Die folgende Funktion könnte beispielsweise ein Tabellenobjekt konvertieren:

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

in eine Karte:

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

Gibt ein Objekt zurück: das konvertierte Map, wenn ihm Schlüssel/Wert-Paare hinzugefügt wurden. Andernfalls wird null zurückgegeben.

Syntax

makeTableMap(tableObj, keyColumnName, valueColumnName)

Parameter

Parameter Typ Beschreibung
tableObj Auflisten Das Tabellenobjekt, das konvertiert werden soll. Es handelt sich um eine Liste von Karten, wobei jede Map eine Zeile in der Tabelle darstellt. Jeder Attributname in einem Zeilenobjekt ist der Spaltenname und der Attributwert ist der Spaltenwert in der Zeile.
keyColumnName String Name der Spalte, deren Werte in Konvertierungen in Map umgewandelt werden.
valueColumnName String Name der Spalte, deren Werte in Werte der konvertierten Map umgewandelt werden.

Verknüpfte Berechtigungen

Keine.


Math

Ein Objekt, das Math-Funktionen bereitstellt.

Syntax

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);

Parameter

Parameter für mathematische Funktionen werden in Zahlen umgewandelt.

Verknüpfte Berechtigungen

Keine.


Object

Gibt ein Objekt zurück, das Object-Methoden bietet.

Die Methode keys() bietet das Verhalten der Standardbibliothek Object.keys(). Sie gibt ein Array der eigenen Aufzählungsnamen eines bestimmten Objekts in derselben Reihenfolge zurück wie eine for...in...-Schleife. Wenn der Eingabewert kein Objekt ist, wird er zu einem Objekt gezwungen.

Die Methode values() bietet das Verhalten der Standardbibliothek Object.values(). Sie gibt ein Array mit den eigenen Aufzählungswerten eines bestimmten Objekts in derselben Reihenfolge zurück wie in einer for...in...-Schleife. Wenn der Eingabewert kein Objekt ist, wird er zu einem Objekt gezwungen.

Die Methode entries() verhält sich wie die Standardbibliothek Object.entry(). Sie gibt ein Array mit den eigenen [key, value]-Attributpaaren eines bestimmten Objekts in derselben Reihenfolge zurück wie in einer for...in...-Schleife. Wenn der Eingabewert kein Objekt ist, wird er zu einem Objekt gezwungen.

Die Methode freeze() verhält sich in der Standardbibliothek unter Object.Fix(). Ein eingefrorenes Objekt kann nicht mehr geändert werden. Durch das Einfrieren eines Objekts können keine neuen Attribute mehr hinzugefügt, vorhandene Attribute nicht entfernt und die Werte vorhandener Attribute nicht mehr geändert werden. freeze() gibt dasselbe übergebene Objekt zurück. Ein einfaches oder null-Argument wird so behandelt, als wäre es ein fixiertes Objekt, und wird zurückgegeben.

Mit der Methode delete() wird das Löschoperator für die Standardbibliothek angegeben. Der angegebene Schlüssel wird aus dem Objekt entfernt, sofern das Objekt nicht eingefroren ist. Wie beim Standardbibliotheksoperator zum Löschen gibt es true zurück, wenn der erste Eingabewert (objectInput) ein Objekt ist, das nicht fixiert ist, auch wenn der zweite Eingabewert (keyToDelete) einen nicht vorhandenen Schlüssel angibt. In allen anderen Fällen wird false zurückgegeben. Es unterscheidet sich jedoch in folgenden Punkten vom Löschoperator der Standardbibliothek:

  • keyToDelete darf kein punktgetrennter String sein, der einen verschachtelten Schlüssel angibt.
  • delete() kann nicht zum Entfernen von Elementen aus einem Array verwendet werden.
  • delete() kann nicht verwendet werden, um Properties aus dem globalen Bereich zu entfernen.

Syntax

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

Parameter

Objektschlüssel

Parameter Typ Beschreibung
Objekteingabe Beliebig Das Objekt, dessen Schlüssel aufgezählt werden sollen. Wenn die Eingabe kein Objekt ist, wird sie zu einem Objekt gezwungen.

Objektwerte

Parameter Typ Beschreibung
Objekteingabe Beliebig Das Objekt, dessen Werte aufgezählt werden sollen. Wenn die Eingabe kein Objekt ist, wird sie zu einem Objekt gezwungen.

Objekteinträge.

Parameter Typ Beschreibung
Objekteingabe Beliebig Das Objekt, dessen Schlüssel/Wert-Paare aufgezählt werden sollen. Wenn die Eingabe kein Objekt ist, wird sie zu einem Objekt gezwungen.

Object.Einfrieren

Parameter Typ Beschreibung
Objekteingabe Beliebig Das zu fixierende Objekt. Wenn die Eingabe kein Objekt ist, wird sie als eingefrorenes Objekt behandelt.

Object.delete

Parameter Typ Beschreibung
Objekteingabe Beliebig Das Objekt, dessen Schlüssel gelöscht werden soll.
Schlüssel löschen String Der zu löschende Schlüssel auf oberster Ebene.

Beispiel

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

Gibt ein Objekt zurück, das alle Komponenten einer bestimmten URL enthält, ähnlich wie das Objekt URL.

Diese API gibt undefined für jede fehlerhafte URL zurück. Bei richtig formatierten URLs haben Felder, die nicht im URL-String vorhanden sind, einen Wert für einen leeren String oder im Fall von searchParams ein leeres Objekt.

Das zurückgegebene Objekt hat die folgenden Felder:

{
  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,
}

Beispiel

const parseUrl = require('parseUrl');

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

Syntax

parseUrl(url);

Parameter

Parameter Typ Beschreibung
url String Die vollständige URL, die geparst wird.

Verknüpfte Berechtigungen

Keine.


queryPermission

Fragen Sie die zulässigen und eingeschränkten Berechtigungen ab. Gibt einen boolenen zurück: true, wenn eine Berechtigung erteilt wurde. Andernfalls wird false zurückgegeben.

Syntax

queryPermission(permission, functionArgs*)

Parameter

Parameter Typ Beschreibung
permission String Name der Berechtigung.
functionArgs Beliebig Funktionsargumente variieren je nach abgefragter Berechtigung. Siehe Funktionsargumente unten.

Funktionsargumente

sendPixel, injectScript, injectHiddenIframe: Der zweite Parameter sollte ein URL-String sein.

writeGlobals, readGlobals: Der zweite Parameter sollte der Schlüssel sein, der geschrieben oder gelesen wird.

readUrl: Es sind keine zusätzlichen Argumente erforderlich, um abzufragen, ob die gesamte URL gelesen werden kann. Um abzufragen, ob eine bestimmte Komponente gelesen werden kann, übergeben Sie den Komponentennamen als zweites Argument:

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

Um zu prüfen, ob ein bestimmter Abfrageschlüssel lesbar ist, übergeben Sie den Abfrageschlüssel als dritten Parameter:

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

Verknüpfte Berechtigungen

Keine.


readCharacterSet

Gibt den Wert von document.characterSet zurück.

Syntax

readCharacterSet()

Parameter

Keine.

Verknüpfte Berechtigungen

read_character_set


readTitle

Gibt den Wert von document.title zurück.

Syntax

readTitle()

Parameter

Keine.

Verknüpfte Berechtigungen

read_title


require

Importiert eine integrierte Funktion nach Name. Gibt eine Funktion oder ein Objekt zurück, das aus Ihrem Programm aufgerufen werden kann. Gibt undefined zurück, wenn der Browser die integrierte Funktion nicht unterstützt.

Syntax

require(name)

Parameter

Parameter Typ Beschreibung
name String Der Name der Funktion, die importiert werden soll.

Beispiel

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

Verknüpfte Berechtigungen

Keine.


sendPixel

Sendet eine GET-Anfrage an einen angegebenen URL-Endpunkt.

Syntax

sendPixel(url, onSuccess, onFailure)

Parameter

Parameter Typ Beschreibung
url String Wohin soll das Pixel gesendet werden?
onSuccess Funktion Wird aufgerufen, wenn das Pixel erfolgreich geladen wurde. Hinweis: Auch wenn die Anfrage erfolgreich gesendet wird, benötigen Browser möglicherweise eine gültige Bildantwort, um onSuccess auszuführen.
onFailure Funktion Wird aufgerufen, wenn das Pixel nicht geladen wird. Hinweis: Selbst wenn die Anfrage erfolgreich gesendet wird, kann onFailure ausgeführt werden, wenn der Server keine gültige Bildantwort zurückgibt.

Verknüpfte Berechtigungen

send_pixel


setCookie

Legt das Cookie mit dem angegebenen Namen, Wert und den verfügbaren Optionen fest oder löscht es.

Syntax

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

Parameter

Parameter Typ Beschreibung
name String Name des Cookies.
value String Wert des Cookies.
options Objekt Gibt die Attribute Domain, Pfad, Ablaufdatum, Höchstalter, Sicheres und SameSite an. Weitere Informationen finden Sie unten im Abschnitt Optionen.
encode Boolesch Steuert, ob der Cookiewert mit encodeURIComponent() von JavaScript codiert werden soll. Die Standardeinstellung ist true.

Optionen

  • Domain: Wird von options['domain']-Property festgelegt, falls vorhanden. Setzen Sie diesen Wert auf 'auto', um das Cookie mit der größtmöglichen Domain basierend auf dem Dokumentspeicherort zu schreiben. Wenn dies fehlschlägt, wird versucht, die Subdomains nacheinander einzugrenzen. Wenn alles fehlschlägt, wird versucht, das Cookie ohne Domain zu schreiben. Wenn kein Wert festgelegt ist, wird versucht, das Cookie ohne angegebene Domain zu schreiben. Hinweis: Wenn ein Cookie ohne angegebene Domain in document.cookie geschrieben wird, wird die Domain des Cookies standardmäßig vom Host des aktuellen Speicherorts des Dokuments festgelegt.
  • Pfad: Von options['path'] festgelegt, falls vorhanden. Wenn ein Cookie ohne angegebenen Pfad in document.cookie geschrieben wird, legt der User-Agent den Pfad des Cookies standardmäßig auf den Pfad des aktuellen Dokumentspeicherorts fest.
  • Max-Age: Wird von options['max-age'] festgelegt, falls vorhanden.
  • Läuft ab:Wird von options['expires'] festgelegt, sofern vorhanden. Falls vorhanden, muss dies ein Datumsstring im UTC-Format sein. Mit Date.toUTCString() kann ein Date für diesen Parameter formatiert werden.
  • Sicher:Wird von options['secure'] festgelegt, falls vorhanden.
  • SameSite: Wird von options['samesite'] festgelegt, sofern vorhanden.

Verknüpfte Berechtigungen

set_cookies


setDefaultConsentState

Sendet eine standardmäßige Aktualisierung der Einwilligung an die Datenschicht, die so schnell wie möglich nach dem Abschluss des aktuellen Ereignisses und aller ausgelösten Tags verarbeitet wird (oder das Zeitlimit für die Tag-Verarbeitung erreicht wurde). Die Aktualisierung wird in diesem Container garantiert vor allen Elementen in der Warteschlange verarbeitet. Weitere Informationen zur Einwilligung

Beispiel:

const setDefaultConsentState = require('setDefaultConsentState');

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

Syntax

setDefaultConsentState(consentSettings)

Parameter

Parameter Typ Beschreibung
consentSettings Objekt Ein Objekt, das den Standardstatus für die angegebenen Einwilligungsarten definiert.

Das consentSettings-Objekt ist eine Zuordnung von beliebigen Strings für den Einwilligungstyp zu 'granted' oder 'denied'. Folgende Werte werden unterstützt:

Schlüsselname Typ Beschreibung
consentType String Der Wert für jeden Einwilligungstyp kann auf „Erteilt“ oder „Abgelehnt“ festgelegt werden. Jeder Wert außer „Erteilt“ wird als „Abgelehnt“ behandelt. Wenn Sie den Wert auf „Nicht definiert“ festlegen, hat das keine Auswirkungen auf den vorherigen Wert.
region Array Ein optionales Array von Regionscodes, die angeben, für welche Region die Einwilligungseinstellungen gelten. Regionscodes werden nach Land und/oder Unterteilungen im ISO 3166-2-Format ausgedrückt.
wait_for_update number Gibt einen Millisekundenwert an, um festzulegen, wie lange vor dem Senden von Daten gewartet werden soll. Wird bei Einwilligungstools verwendet, die asynchron geladen werden.

Verknüpfte Berechtigungen

Berechtigung access_consent mit Schreibzugriff für alle Einwilligungsarten im Objekt „consentSettings“.


setInWindow

Legt den angegebenen Wert in window für den angegebenen Schlüssel fest. Standardmäßig wird durch diese Methode der Wert für window nicht festgelegt, wenn bereits ein Wert vorhanden ist. Legen Sie overrideExisting auf true fest, um den Wert in window festzulegen, unabhängig davon, ob ein Wert vorhanden ist. Gibt einen boolenen zurück: true, wenn der Wert erfolgreich festgelegt wurde, andernfalls false.

Syntax

setInWindow(key, value, overrideExisting)

Parameter

Parameter Typ Beschreibung
key String Der Schlüssel in window, an dem der Wert platziert werden soll.
value * Der Wert, der in window festgelegt werden soll.
overrideExisting Boolesch Das Flag, das angibt, dass der Wert in window festgelegt werden sollte, unabhängig davon, ob dort ein Wert vorhanden ist.

Verknüpfte Berechtigungen

access_globals


sha256

Berechnet den SHA-256-Digest der Eingabe und ruft einen Callback mit dem in base64 codierten Digest auf, sofern das options-Objekt keine andere Ausgabecodierung angibt.

Beispiel:

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'});

Syntax

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

Parameter

Parameter Typ Beschreibung
input String String, für den der Hash berechnet werden soll.
onSuccess Funktion Wird mit dem resultierenden Digest aufgerufen, der in base64 codiert ist, sofern das options-Objekt keine andere Ausgabecodierung angibt.
onFailure Funktion Wird aufgerufen, wenn beim Berechnen des Digests ein Fehler auftritt oder der Browser keine native Unterstützung für sha256 bietet. Der Callback wird mit einem Objekt aufgerufen, das den Fehlernamen und die Nachricht enthält.
options Objekt Optionales Optionsobjekt zur Angabe der Ausgabecodierung. Wenn angegeben, sollte das Objekt den Schlüssel outputEncoding mit dem Wert base64 oder hex enthalten.

Verknüpfte Berechtigungen

Keine.


templateStorage

Gibt ein Objekt mit Methoden für den Zugriff auf den Vorlagenspeicher zurück. Mit dem Vorlagenspeicher können Daten für die Ausführung einer einzelnen Vorlage freigegeben werden. Im Vorlagenspeicher gespeicherte Daten bleiben für die gesamte Lebensdauer der Seite bestehen.

Syntax

const templateStorage = require('templateStorage');

templateStorage.getItem(key);

templateStorage.setItem(key, value);

templateStorage.removeItem(key);

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

Verknüpfte Berechtigungen

access_template_storage

Beispiel

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

Mit der toBase64 API können Sie einen String in eine base64-Darstellung codieren.

Syntax

toBase64(input)

Parameter

Parameter Typ Beschreibung
input String Zu codierender String.

Beispiel

const toBase64 = require('toBase64');

const base64Hello = toBase64('hello');

Verknüpfte Berechtigungen


updateConsentState

Aktualisiert eine Einwilligungsaktualisierung an die Datenschicht, die so schnell wie möglich verarbeitet wird, nachdem das aktuelle Ereignis und alle ausgelösten Tags die Verarbeitung abgeschlossen haben (oder das Zeitlimit für die Tag-Verarbeitung erreicht wurde). Die Aktualisierung wird in diesem Container garantiert vor allen in der Warteschlange enthaltenen Elementen in der Datenschicht verarbeitet. Weitere Informationen zur Einwilligung.

Beispiel:

const updateConsentState = require('updateConsentState');

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

Syntax

updateConsentState(consentSettings)

Parameter

Parameter Typ Beschreibung
consentSettings Objekt Ein Objekt, das den Status für die angegebenen Einwilligungstypen aktualisiert.

Das consentSettings-Objekt ist eine Zuordnung von beliebigen Strings für den Einwilligungstyp zu 'granted' oder 'denied'. Folgende Werte werden unterstützt:

Schlüsselname Typ Beschreibung
consentType String Für jeden Einwilligungstyp kann der Wert „Gewährt“ oder „Abgelehnt“ festgelegt werden. Jeder Wert außer „Gewährt“ wird mit „Abgelehnt“ behandelt. Wenn Sie den Wert auf „undefined“ setzen, hat dies keine Auswirkungen auf den vorherigen Wert.

Verknüpfte Berechtigungen

Berechtigung access_consent mit Schreibzugriff für alle Einwilligungsarten im Objekt „consentSettings“.


APIs testen

Diese APIs funktionieren mit in einer Sandbox ausgeführten JavaScript-Tests, um Tests für benutzerdefinierte Vorlagen in Google Tag Manager zu erstellen. Für diese Test-APIs ist keine require()-Anweisung erforderlich. Weitere Informationen zu Tests für benutzerdefinierte Vorlagen


assertApi

Gibt ein Matcher-Objekt zurück, mit dem fließend Assertions zur angegebenen API erstellt werden können.

Syntax

assertApi(apiName)

Parameter

Parameter Typ Beschreibung
apiName String Der Name der zu prüfenden API. Derselbe String, der an require() übergeben wird.

Matcher

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

Beispiele

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

assertThat

Die assertThat API ist dem Modell der [Truth]-Bibliothek von Google nachempfunden. Sie gibt ein Objekt zurück, mit dem fließend Äußerungen über den Wert eines Subjekts erstellt werden können. Bei einem Fehlschlagen wird der Test sofort beendet und als fehlgeschlagen markiert. Ein Fehler in einem Test hat jedoch keine Auswirkungen auf andere Testläufe.

Syntax

assertThat(actual, opt_message)

Parameter

Parameter Typ Beschreibung
actual Beliebig Der Wert für die flüssige Überprüfung.
opt_message String Optionale Nachricht, die ausgegeben wird, wenn die Assertion fehlschlägt.

Matcher

Matcher Beschreibung
isUndefined() Gelten, dass das Thema undefined ist.
isDefined() Es wird behauptet, dass das Thema nicht undefined ist.
isNull() Gelten, dass das Thema null ist.
isNotNull() Es wird behauptet, dass das Thema nicht null ist.
isFalse() Gelten, dass das Thema false ist.
isTrue() Gelten, dass das Thema true ist.
isFalsy() Erklärt, dass das Subjekt fälschlich ist Falsche Werte sind undefined, null, false, NaN, 0 und '' (leerer String).
isTruthy() Gelten, dass das Subjekt der Wahrheit entspricht. Falsche Werte sind undefined, null, false, NaN, 0 und '' (leerer String).
isNaN() Gilt, dass das Subjekt der Wert NaN ist.
isNotNaN() Gilt, dass das Subjekt neben NaN ein beliebiger Wert ist.
isInfinity() Gibt an, dass das Subjekt positiv oder negativ unendlich ist.
isNotInfinity() Gibt an, dass das Subjekt neben einem positiven oder negativen Infinity-Wert ein beliebiger Wert ist.
isEqualTo(expected) Gilt, dass das Subjekt dem angegebenen Wert entspricht. Dies ist ein Wertvergleich, kein Referenzvergleich. Der Inhalt von Objekten und Arrays wird rekursiv verglichen.
isNotEqualTo(expected) Gibt an, dass der Betreff nicht mit dem angegebenen Wert übereinstimmt. Dies ist ein Wertvergleich, kein Referenzvergleich. Der Inhalt von Objekten und Arrays wird rekursiv verglichen.
isAnyOf(...expected) Gibt an, dass das Thema einem der angegebenen Werte entspricht. Dies ist ein Wertvergleich, kein Referenzvergleich. Der Inhalt von Objekten und Arrays wird rekursiv verglichen.
isNoneOf(...expected) Gibt an, dass der Betreff keiner der angegebenen Werte entspricht. Dies ist ein Wertvergleich, kein Referenzvergleich. Der Inhalt von Objekten und Arrays wird rekursiv verglichen.
isStrictlyEqualTo(expected) Geltt, dass das Subjekt strikt dem angegebenen Wert (===) entspricht.
isNotStrictlyEqualTo(expected) Gibt an, dass das Thema nicht genau gleich dem angegebenen Wert (!==) ist.
isGreaterThan(expected) Gibt an, dass das Thema größer als (>) der angegebene Wert in einem geordneten Vergleich ist.
isGreaterThanOrEqualTo(expected) Gibt an, dass das Thema größer oder gleich (>=) den angegebenen Wert in einem geordneten Vergleich ist.
isLessThan(expected) Gibt an, dass das Thema kleiner als (<) der angegebene Wert in einem geordneten Vergleich ist.
isLessThanOrEqualTo(expected) Gibt an, dass das Thema kleiner oder gleich (<=) dem angegebenen Wert in einem geordneten Vergleich ist.
contains(...expected) Gibt an, dass der Betreff ein Array oder ein String ist, der alle angegebenen Werte in beliebiger Reihenfolge enthält. Dies ist ein Wertvergleich, kein Referenzvergleich. Der Inhalt von Objekten und Arrays wird rekursiv verglichen.
doesNotContain(...expected) Gibt an, dass das Thema ein Array oder String ist, der keinen der angegebenen Werte enthält. Dies ist ein Wertevergleich, kein Referenzvergleich. Der Inhalt von Objekten und Arrays wird rekursiv verglichen.
containsExactly(...expected) Gibt an, dass der Betreff ein Array ist, das alle angegebenen Werte in beliebiger Reihenfolge und keine anderen Werte enthält. Dies ist ein Wertevergleich, kein Referenzvergleich. Der Inhalt von Objekten und Arrays wird rekursiv verglichen.
doesNotContainExactly(...expected) Gibt an, dass das Thema ein Array ist, das eine andere Gruppe von Werten von den angegebenen Werten in beliebiger Reihenfolge enthält. Dies ist ein Wertvergleich, kein Referenzvergleich. Der Inhalt von Objekten und Arrays wird rekursiv verglichen.
hasLength(expected) Gibt an, dass das Thema ein Array oder String mit der angegebenen Länge ist. Die Assertion schlägt immer fehl, wenn der Wert kein Array oder String ist.
isEmpty() Gibt an, dass das Thema ein Array oder ein String ist, der leer ist (Länge = 0). Die Assertion schlägt immer fehl, wenn der Wert kein Array oder String ist.
isNotEmpty() Gibt an, dass das Thema ein Array oder String ist, der nicht leer ist (Länge > 0). Die Assertion schlägt immer fehl, wenn der Wert kein Array oder String ist.
isArray() Gibt an, dass der Typ des Themas ein Array ist.
isBoolean() Gibt an, dass der Typ des Themas ein boolescher Wert ist.
isFunction() Gibt an, dass der Typ des Themas eine Funktion ist.
isNumber() Es wird behauptet, dass das Thema eine Zahl ist.
isObject() Es wird behauptet, dass das Subjekt des Objekts ein Objekt ist.
isString() Damit wird bestätigt, dass der Betreff ein String ist.

Beispiele

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

Der aktuelle Test schlägt sofort fehl und die angegebene Nachricht wird ausgegeben, sofern vorhanden.

Syntax

fail(opt_message);

Parameter

Parameter Typ Beschreibung
opt_message String Optionaler Text der Fehlermeldung.

Beispiel

fail('This test has failed.');

mock

Mit der mock API können Sie das Verhalten von Sandbox-APIs überschreiben. Die Mock API kann im Vorlagencode sicher verwendet werden, funktioniert aber nicht im Testmodus. Modelle werden vor jedem Test zurückgesetzt.

Syntax

mock(apiName, returnValue);

Parameter

Parameter Typ Beschreibung
apiName String Der Name der zu simulierenden API. Derselbe String wie an require() übergeben
returnValue Beliebig Der Wert, der für die API oder eine Funktion, die anstelle der API aufgerufen wird, zurückgegeben werden soll. Wenn returnValue eine Funktion ist, wird diese Funktion anstelle der Sandboxed API aufgerufen. Wenn returnValue etwas anderes als eine Funktion ist, wird dieser Wert anstelle der Sandboxed API zurückgegeben.

Beispiele

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

runCode

Führt den Code für die Vorlage, also den Inhalt des Tabs Code, in der aktuellen Testumgebung mit einem bestimmten Eingabedatenobjekt aus.

Syntax

runCode(data)

Parameter

Parameter Typ Beschreibung
data Objekt Datenobjekt, das im Test verwendet werden soll.

Rückgabewert

Gibt den Wert einer Variablen für Variablenvorlagen zurück. Für alle anderen Vorlagentypen wird undefined zurückgegeben.

Beispiel

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