Özel şablon API'leri

Temel API'ler

Bu API'ler, Google Etiket Yöneticisi'nde özel şablonlar oluşturmak için korumalı alana sahip JavaScript ile çalışır. Her API bir require() ifadesiyle eklenir.Ör.

const myAPI = require('myAPI');

addConsentListener

Belirtilen izin türünün durumu değiştiğinde yürütülecek bir işleyici işlevi kaydeder.

Belirtilen izin türünün durumu "reddedildi" veya "verildi" yerine "reddedildi" olarak her değiştiğinde, belirtilen işleyici çağrılır. Durumu olmayan bir izin türü verilmiş olarak kabul edilir. Bu nedenle, ayarlanmamış bir izin türü "verildi" olarak güncellenirse işleyici çağrılmaz. İşleyici işlevleri, kodlarının doğru sayıda çalıştırmasını sağlamaktan sorumlu olur.

Örnek:

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

Söz dizimi

addConsentListener(consentType, listener)

Parametreler

Parametre Tür Açıklama
consentType dize Durum değişikliklerini dinlenecek izin türü.
listener işlev Belirtilen izin türünün durumu değiştiğinde çalıştırılacak işlev.

İşleyici çağrıldığında, değiştirilen izin türü ve o izin türünün yeni değeri iletilir:

Parametre Tür Açıklama
consentType dize Değiştirilen izin türü.
granted boole Belirtilen izin türü "verildi" olarak değiştiriliyorsa doğru olan boole değeridir.

İlişkilendirilmiş izinler

İzin türü için okuma erişimiyle access_consent izni.

addEventCallback

addEventCallback API, bir etkinliğin sonunda çağrılacak bir geri çağırma işlevini kaydetmenize olanak tanır. Etkinliğin tüm etiketleri yürütüldüğünde veya bir sayfa içi etkinlik zaman aşımına ulaşıldığında geri çağırma çağrılır. Geri çağırma işlevine, işlevi çağıran kapsayıcının kimliği ve etkinlikle ilgili bilgileri içeren bir nesne olmak üzere iki değer iletilir.

Söz dizimi

addEventCallback(callback)

Parametreler

Parametre Tür Açıklama
callback işlev Etkinliğin sonunda çağrılacak işlev.

eventData nesnesi aşağıdaki verileri içerir:

Anahtar Adı Tür Açıklama
tags Dizi Etiket veri nesneleri dizisi. Etkinlik sırasında tetiklenen her etiket bu dizide bir girişe sahip olur. Etiket veri nesnesi, etiketin kimliğini (id), yürütme durumunu (status) ve yürütme süresini (executionTime) içerir. Etiket verileri, etiket üzerinde yapılandırılmış ek etiket meta verilerini de içerir.

Örnek

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

İlişkilendirilmiş izinler

read_event_metadata

aliasInWindow

aliasInWindow API, takma ad gerektiren belirli etiketlerin desteklenmesine yardımcı olan bir takma ad (ör. window.foo = window.bar) oluşturmanıza olanak tanır. fromPath öğesinde bulunan window nesnesindeki değeri, toPath konumundaki window nesnesindeki anahtara atar. Başarılı olursa true değerini, aksi takdirde false değerini döndürür.

Söz dizimi

aliasInWindow(toPath, fromPath)

Parametreler

Parametre Tür Açıklama
toPath dize window nesnesi için, bir değerin kopyalanması gereken noktayla ayrılmış yol. Son bileşene kadarki yoldaki tüm bileşenler zaten window nesnesinde bulunmalıdır.
fromPath dize window içine, kopyalanacak değere giden noktayla ayrılmış yol. Değer mevcut değilse işlem başarısız olur.

Örnek

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

İlişkilendirilmiş izinler

access_globals hem toPath hem de fromPath için gereklidir; toPath yazma erişimi, fromPath okuma erişimi gerektirir.

callInWindow

Politika kontrollü bir şekilde, window nesnesinin dışındaki bir yoldan işlevleri çağırmanıza olanak tanır. İşlevi, belirtilen bağımsız değişkenlerle window içinde belirtilen yolda çağırır ve değeri döndürür. Döndürme türü, korumalı alana sahip JavaScript'te desteklenen bir türle doğrudan eşlenemezse undefined döndürülür. Korumalı alana sahip JavaScript'te desteklenen sekiz tür: null, undefined, boolean, number, string, Array, Object ve function. Belirtilen yol mevcut değilse veya bir işleve başvurmuyorsa undefined döndürülür.

Söz dizimi

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

Parametreler

Parametre Tür Açıklama
pathToFunction dize Çağrı yapılacak window işlevine giden, noktayla ayrılmış yol.
args * İşleve geçirilecek bağımsız değişkenler.

İlişkilendirilmiş izinler

execute izni etkin halde access_globals.

callLater

Bir işleve yapılan çağrıyı eşzamansız olarak gerçekleşecek şekilde planlar. İşlev, mevcut kod döndürüldükten sonra çağrılır. Bu, setTimeout(<function>, 0) işlevine eş değerdir.

Söz dizimi

callLater(function)

Parametreler

Parametre Tür Açıklama
function işlev Çağrılacak işlev.

copyFromDataLayer

Veri katmanındaki belirli bir anahtara atanmış durumda olan değeri döndürür: Söz konusu anahtar temel tür, işlev veya nesne değişmez değeriyse belirtilen anahtarda bulunan değer ya da değilse undefined değeri.

Söz dizimi

copyFromDataLayer(key[, dataLayerVersion])

Parametreler

Parametre Tür Açıklama
key dize "a.b.c" biçimindeki anahtar.
dataLayerVersion sayı İsteğe bağlı veri katmanı sürümü. Varsayılan değer 2'dir. 1 değerinin kullanılması kesinlikle önerilmez.

İlişkilendirilmiş izinler

read_data_layer

copyFromWindow

window nesnesinden bir değişken kopyalar. window içindeki değer, korumalı alana sahip JavaScript'te desteklenen bir türle doğrudan eşlenemezse undefined döndürülür. Korumalı alana sahip JavaScript'te desteklenen sekiz tür null, undefined, boolean, number, string, Array, Object ve function'dir. Getirilen (ve zorlanan) değeri döndürür.

Söz dizimi

copyFromWindow(key)

Parametreler

Parametre Tür Açıklama
key dize window öğesinde değerinin kopyalanacağı anahtar.

İlişkilendirilmiş izinler

access_globals

createArgumentsQueue

Bunu gerektiren etiket çözümlerini desteklemek üzere, bağımsız değişken nesneleriyle doldurulan bir sıra oluşturur.

fnKey bağımsız değişkenini kullanarak (createQueue ile aynı anlamsal) global kapsamda (ör. window) bir işlev oluşturur. İşlev oluşturulduktan sonra bu API, arrayKey bağımsız değişkenini kullanarak window içinde (önceden mevcut değilse) bir dizi oluşturur (zaten mevcut değilse).

fnKey altında oluşturulan işlev çağrıldığında, bağımsız değişken nesnesini arrayKey altında oluşturulan diziye aktarır. API'nin döndürdüğü değer, fnKey altında oluşturulan işlevdir.

Bu işlev, access_globals izninde fnKey ve arrayKey için okuma ve yazma ayarını gerektirir.

Örnek:

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

Söz dizimi

createArgumentsQueue(fnKey, arrayKey)

Parametreler

Parametre Tür Açıklama
fnKey dize Zaten mevcut değilse window bölgesinde işlevin ayarlandığı yol. Bu bağımsız değişken, standart nokta gösterimini destekler. Anahtarın yolu mevcut değilse istisna oluşturulur. Yani fnKey, 'one.two' ise bir istisna oluşturur.
arrayKey dize Zaten yoksa window içinde dizinin ayarlandığı yol. Bu bağımsız değişken, standart nokta gösterimini destekler. Anahtarın yolu mevcut değilse istisna oluşturulur. Yani arrayKey, 'one.two' ise ve 'one' adlı bir global nesne yoksa istisna oluşturur.

İlişkilendirilmiş izinler

access_globals

createQueue

window içinde bir dizi oluşturur (zaten yoksa) ve değerleri bu diziye aktaracak bir işlev döndürür.

Bu işlev için access_globals izninde arrayKey için okuma ve yazma ayarı gerekiyor.

Örnek:

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

Söz dizimi

createQueue(arrayKey)

Parametreler

Parametre Tür Açıklama
arrayKey dize Zaten mevcut değilse window içinde dizinin ayarlandığı anahtar. Bu bağımsız değişken, standart nokta gösterimini destekler. Anahtarın yolu mevcut değilse istisna oluşturulur. Örneğin, arrayKey, 'one.two' ise ve 'one' adlı bir global nesne yoksa bir istisna oluşturur.

İlişkilendirilmiş izinler

access_globals

decodeUri

Sağlanan URI'daki kodlanmış karakterlerin kodunu çözer. Kodu çözülmüş URI'yı temsil eden bir dize döndürür. Geçersiz giriş sağlandığında undefined sonucunu döndürür.

Örnek:

const decode = require('decodeUri');

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

Söz dizimi

decodeUri(encoded_uri)

Parametreler

Parametre Tür Açıklama
encoded_uri dize encodeUri() tarafından veya başka şekilde kodlanmış URI.

İlişkilendirilmiş izinler

Yok.

decodeUriComponent

Sağlanan URI bileşenindeki kodlanmış karakterlerin kodunu çözer. Kodu çözülmüş URI bileşenini temsil eden bir dize döndürür. Geçersiz girişle sağlandığında undefined değerini döndürür.

Örnek:

const decode = require('decodeUriComponent');

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

Söz dizimi

decodeUriComponent(encoded_uri_component)

Parametreler

Parametre Tür Açıklama
encoded_uri_component dize encodeUriComponent() tarafından veya başka yollarla kodlanmış bir URI bileşeni.

İlişkilendirilmiş izinler

Yok.

encodeUri

Özel karakterlere çıkış karakteri ekleyerek kodlanmış bir Tekdüzen Kaynak Tanımlayıcısı (URI) döndürür. URI olarak kodlanmış, sağlanan dizeyi temsil eden bir dize döndürür. Geçersiz giriş (tek vekil) ile sağlandığında undefined değerini döndürür.

Örnek:

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

Söz dizimi

encodeUri(uri)

Parametreler

Parametre Tür Açıklama
uri dize Tam bir URI.

İlişkilendirilmiş izinler

Yok.

encodeUriComponent

Özel karakterlere çıkış karakteri ekleyerek kodlanmış bir Tekdüzen Kaynak Tanımlayıcısı (URI) döndürür. URI olarak kodlanmış, sağlanan dizeyi temsil eden bir dize döndürür. Geçersiz giriş (tek vekil) ile sağlandığında undefined değerini döndürür.

Örnek:

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

Söz dizimi

encodeUriComponent(str)

Parametreler

Parametre Tür Açıklama
str dize Bir URI bileşeni.

İlişkilendirilmiş izinler

Yok.

fromBase64

fromBase64 API, dizelerin base64 gösteriminden kodunu çözmenizi sağlar. Geçersiz girişle sağlandığında undefined sonucunu döndürür.

Söz dizimi

fromBase64(base64EncodedString)

Parametreler

Parametre Tür Açıklama
base64EncodedString dize Base64 olarak kodlanmış dize.

Örnek

const fromBase64 = require('fromBase64');

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

İlişkilendirilmiş izinler

Yok

generateRandom

Belirli bir aralıkta rastgele bir sayı (tam sayı) döndürür.

Söz dizimi

generateRandom(min, max)

Parametreler

Parametre Tür Açıklama
min sayı Döndürülen tam sayının minimum potansiyel değeri.
max sayı Döndürülen tam sayının maksimum potansiyel değeri.

İlişkilendirilmiş izinler

Yok.

getContainerVersion

Geçerli kapsayıcıyla ilgili veriler içeren bir nesne döndürür. Döndürülen nesne aşağıdaki alanlara sahiptir:

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

Örnek

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

Söz dizimi

getContainerVersion();

İlişkilendirilmiş izinler

read_container_data

getCookieValues

Belirtilen ada sahip tüm çerezlerin değerlerini döndürür.

Söz dizimi

getCookieValues(name[, decode])

Parametreler

Parametre Tür Açıklama
name dize Çerezin adı.
decode boole Çerez değerlerinin kodunun JavaScript'in decodeURIComponent() ile çözülüp çözülmeyeceğini kontrol eder. Varsayılan olarak true değerine ayarlanır.

İlişkilendirilmiş izinler

get_cookies

getQueryParameters

Geçerli URL'nin queryKey parametresi için parametrelerin ilkini veya tümünü döndürür. queryKey öğesinden ilk değeri veya queryKey değerindeki bir değer dizisini döndürür.

Söz dizimi

getQueryParameters(queryKey[, retrieveAll])

Parametreler

Parametre Tür Açıklama
queryKey dize Sorgu parametrelerinden okunacak anahtar.
retrieveAll boole Tüm değerlerin alınıp alınmayacağını belirtir.

Örneğin, mevcut URL https://example.com/path?var=foo&var1=foo1&var=foo2&var=foo ise:

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

İlişkilendirilmiş izinler

get_url, query bileşenine izin vermeli ve izin verilen sorgu anahtarlarında queryKey öğesini belirtmelidir (veya herhangi bir sorgu anahtarına izin vermelidir).

getReferrerQueryParameters

getReferrerQueryParameters API, mevcut URL yerine yönlendiren üzerinde işlem yapmak dışında getQueryParameters ile aynı şekilde davranır. Belirtilen yönlendirenin queryKey parametresi için parametrelerin ilkini veya tümünü döndürür. queryKey öğesinden ilk değeri veya queryKey değerindeki bir değer dizisini döndürür.

Söz dizimi

getReferrerQueryParameters(queryKey[, retrieveAll])

Parametreler

Parametre Tür Açıklama
queryKey dize Sorgu parametrelerinden okunacak anahtar.
retrieveAll boole Tüm değerlerin alınıp alınmayacağını belirtir.

Örneğin, yönlendiren URL https://example.com/path?var=foo&var1=foo1&var=foo2&var=foo ise:

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

İlişkilendirilmiş izinler

get_referrer, query bileşenine izin vermeli ve izin verilen sorgu anahtarlarında queryKey öğesini belirtmelidir (veya herhangi bir sorgu anahtarına izin vermelidir).

getReferrerUrl

Bir bileşen türü belirtildiğinde API, yönlendiren için doküman nesnesini okur ve yönlendirenin bir bölümünü temsil eden bir dize döndürür. Hiçbir bileşen belirtilmezse tam yönlendiren URL döndürülür.

Söz dizimi

getReferrerUrl([component])

Parametreler

Parametre Tür Açıklama
component dize URL'den döndürülecek bileşen. Şunlardan biri olabilir: protocol, host, port, path, query, extension. component değeri undefined ya da null ise veya bu bileşenlerden biriyle eşleşmiyorsa URL'nin tamamı döndürülür.

İlişkilendirilmiş izinler

get_referrer, query bileşenine izin vermeli ve izin verilen sorgu anahtarlarında queryKey öğesini belirtmelidir (veya herhangi bir sorgu anahtarına izin vermelidir).

getTimestamp

Kullanımdan kaldırıldı. getTimestampMillis değerini tercih edin.

Date.now() tarafından döndürülen şekilde, Unix sıfır zamanından beri geçen zamanı milisaniye cinsinden temsil eden bir sayı döndürür.

Söz dizimi

getTimestamp();

İlişkilendirilmiş izinler

Yok.

getTimestampMillis

Date.now() tarafından döndürülen şekilde, Unix sıfır zamanından beri geçen zamanı milisaniye cinsinden temsil eden bir sayı döndürür.

Söz dizimi

getTimestampMillis();

İlişkilendirilmiş izinler

Yok.

getType

Belirtilen değerin türünü açıklayan bir dize döndürür. typeof'in aksine getType, array ile object arasındaki farkları belirtir.

Söz dizimi

getType(data.someField)

Notes

Aşağıdaki tabloda, her bir giriş değeri için döndürülen dizeler listelenmiştir.

Giriş Değeri Sonuç
undefined "tanımsız" [undefined]
null "boş"
true "boole"
12 "number"
'string' "dize"
{ a: 3 } "object" (nesne)
[ 1, 3 ] "dizi"
(x) => x + 1 "işlev"

İlişkilendirilmiş izinler

Yok.

getUrl

Belirli bir bileşen türü ve bazı yapılandırma parametreleri için geçerli URL'nin tamamını veya bir kısmını temsil eden bir dize değeri döndürür.

Söz dizimi

getUrl(component)

Parametreler

Parametre Tür Açıklama
component dize URL'den döndürülecek bileşen. Şunlardan biri olmalıdır: protocol, host, port, path, query, extension, fragment. Bileşen undefined, null ise veya bu bileşenlerden biriyle eşleşmiyorsa href değerinin tamamı döndürülür.

İlişkilendirilmiş izinler

get_url

gtagSet

Mevcut etkinlik ve tetiklediği tüm etiketlerin işlenmesi (veya etiket işleme zaman aşımına ulaşıldıktan) sonra mümkün olan en kısa sürede işlenmek üzere veri katmanına bir gtag set komutu aktarır. Güncellemenin, veri katmanı sırasında sıraya alınmış öğelerden önce bu kapsayıcıda işlenmesi garanti edilir.

Örneğin, İzin Başlatma'da tetiklenen bir etiket tarafından çağrılırsa güncelleme başlatma etkinliği işlenmeden önce uygulanır. ads_data_redaction öğesinin true veya false olarak ayarlanması ya da url_passthrough değerinin true veya false olarak ayarlanması örnek olarak verilebilir.

Örnekler:

const gtagSet = require('gtagSet');

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

Söz dizimi

gtagSet(object)

Parametreler

Parametre Tür Açıklama
Object object (nesne) Kapsayıcı özelliklerinin genel durumunu güncelleyen bir nesne.

İlişkilendirilmiş izinler

write_data_layer, belirtilen tüm anahtarlar için dataLayer öğesine yazma iznini kontrol eder. gtagSet girişi düz bir nesneyse API bu nesnenin içindeki tüm birleştirilmiş anahtarlara yazma izni olup olmadığını kontrol eder. Örneğin gtagSet({foo: {bar: 'baz'}}) için, API foo.bar öğesine yazma izni olup olmadığını kontrol eder.

gtagSet girişi bir anahtar ve bazı düz olmayan nesne değerleriyse API bu anahtara yazma izni olup olmadığını kontrol eder. Örneğin gtagSet('abc', true) için API, 'abc' öğesine yazma izni olup olmadığını kontrol eder.

Giriş nesnesinde bir döngü varsa yalnızca aynı nesneye ulaşmadan önceki anahtarların kontrol edileceğini unutmayın.

injectHiddenIframe

Sayfaya görünmez bir iframe ekler.

Geri çağırmalar, işlev örnekleri olarak verilir ve bunları çağıran JavaScript işlevleri içinde sarmalanır.

Söz dizimi

injectHiddenIframe(url, onSuccess)

Parametreler

Parametre Tür Açıklama
url dize iframe'in src özelliğinin değeri olarak kullanılacak URL.
onSuccess işlev Çerçeve başarıyla yüklendiğinde çağrılır.

İlişkilendirilmiş izinler

inject_hidden_iframe

injectScript

Belirtilen URL'yi eşzamansız olarak yüklemek için sayfaya bir komut dosyası etiketi ekler. Geri çağırmalar, işlev örnekleri olarak verilir ve bunlara çağrı yapan JavaScript işlevleri içinde sarmalanır.

Söz dizimi

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

Parametreler

Parametre Tür Açıklama
url dize Yerleştirilecek komut dosyasının adresi.
onSuccess işlev Komut dosyası başarıyla yüklendiğinde çağrılır.
onFailure işlev Komut dosyası yüklenemediğinde çağrılır.
cacheToken dize Belirtilen URL'yi belirtmek için kullanılan isteğe bağlı dize önbelleğe alınmalıdır. Bu değer belirtilirse JavaScript'i istemek için yalnızca bir komut dosyası öğesi oluşturulur. Diğer tüm yükleme denemeleri, belirtilen onSuccess ve onFailure yöntemlerinin komut dosyası yüklenene kadar sıraya alınmasına neden olur.

İlişkilendirilmiş izinler

inject_script

isConsentGranted

Belirtilen izin türü verilmişse true değerini döndürür.

İzin türü "verildi" olarak ayarlanmışsa veya hiç ayarlanmazsa belirli bir izin türü için izin verilmiş olarak kabul edilir. İzin türü başka bir değere ayarlanırsa izin verilmemiş kabul edilir.

Etiket ayarları için Etiket Yöneticisi kullanıcı arayüzü, her zaman etkinleşme seçeneği sunar. Her zaman etkin olan bir etiket bu API'yi kullanıyorsa izin verilmiş kabul edilir ve true döndürülür.

Örnek:

const isConsentGranted = require('isConsentGranted');

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

Söz dizimi

isConsentGranted(consentType)

Parametreler

Parametre Tür Açıklama
consentType dize Durumunun kontrol edileceği izin türü.

İlişkilendirilmiş izinler

İzin türü için okuma erişimiyle access_consent izni.

JSON

JSON işlevleri sağlayan bir nesne döndürür.

parse() işlevi, dizeyle açıklanan değeri veya nesneyi oluşturmak için bir JSON dizesini ayrıştırır. Değer ayrıştırılamazsa (ör. bozuk JSON) işlev undefined değerini döndürür. Giriş değeri dize değilse giriş dizeye zorlanır.

stringify() işlevi, girişi bir JSON dizesine dönüştürür. Değer ayrıştırılamazsa (ör. nesnenin bir döngüsü varsa) yöntem undefined değerini döndürür.

Söz dizimi

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

Parametreler

JSON.parse

Parametre Tür Açıklama
Dize Girişi herhangi biri Dönüştürülecek değer. Değer bir dize değilse giriş, dize olmaya zorlanır.

JSON.stringify

Parametre Tür Açıklama
value herhangi biri Dönüştürülecek değer.

Örnek

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

Yerel depolamaya erişim yöntemlerine sahip bir nesne döndürür.

Söz dizimi

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

İlişkilendirilmiş izinler

access_local_storage

Örnek

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

Bağımsız değişkenleri tarayıcı konsoluna kaydeder.

Söz dizimi

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

Parametreler

Parametre Tür Açıklama
obj1 [, obj2,... objN] herhangi biri Bağımsız değişkenler

İlişkilendirilmiş izinler

logging

makeInteger

Belirli bir değeri sayıya (tam sayıya) dönüştürür.

Söz dizimi

makeInteger(value)

Parametreler

Parametre Tür Açıklama
value herhangi biri Dönüştürülecek değer.

İlişkilendirilmiş izinler

Yok.

makeNumber

Belirli bir değeri sayıya dönüştürür.

Söz dizimi

makeNumber(value)

Parametreler

Parametre Tür Açıklama
value herhangi biri Dönüştürülecek değer.

İlişkilendirilmiş izinler

Yok.

makeString

Belirtilen değeri dize olarak döndürür.

Söz dizimi

makeString(value)

Parametreler

Parametre Tür Açıklama
value herhangi biri Dönüştürülecek değer.

İlişkilendirilmiş izinler

Yok.

makeTableMap

İki sütunlu basit bir tablo nesnesini Map öğesine dönüştürür. Bu işlev, iki sütunlu bir SIMPLE_TABLE şablon alanını daha yönetilebilir bir biçime dönüştürmek için kullanılır.

Örneğin, şu işlev bir tablo nesnesini dönüştürebilir:

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

bir haritaya ekleme:

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

Bir Nesne döndürür: Anahtar/değer çiftleri ona eklenmişse dönüştürülen Map, aksi takdirde null değerini döndürür.

Söz dizimi

makeTableMap(tableObj, keyColumnName, valueColumnName)

Parametreler

Parametre Tür Açıklama
tableObj Listele Dönüştürülecek tablo nesnesi. Her Map değerinin tablodaki bir satırı temsil ettiği bir harita listesidir. Bir satır nesnesindeki her özellik adı sütun adıdır ve özellik değeri, satırdaki sütun değeridir.
keyColumnName dize Değerleri dönüştürülen Map öğesinde anahtar haline gelecek sütunun adı.
valueColumnName dize Değerleri dönüştürülen Map özelliğinde değer haline gelecek sütunun adı.

İlişkilendirilmiş izinler

Yok.

Math

Math işlevleri sağlayan bir nesne.

Söz dizimi

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

Parametreler

Matematiksel fonksiyon parametreleri sayılara dönüştürülür.

İlişkilendirilmiş izinler

Yok.

Object

Object yöntemlerini sağlayan bir nesne döndürür.

keys() yöntemi, Standart Kitaplık Object.keys() davranışını sağlar. Belirli bir nesnenin kendi numaralandırılabilir özellik adlarının bir dizisini, for...in... döngüsünün alacağı sırayla döndürür. Giriş değeri nesne değilse nesneye zorlanır.

values() yöntemi, Standart Kitaplık Object.values() davranışını sağlar. Belirli bir nesnenin kendi numaralandırılabilir özellik değerlerinden oluşan bir dizi, for...in... döngüsünün alacağı sırayla döndürür. Giriş değeri bir nesne değilse nesneye zorlanır.

entries() yöntemi, Standart Kitaplık Object.entries() davranışını sağlar. Belirli bir nesnenin kendi numaralandırılabilir özellik çiftlerinden oluşan diziyi, for...in... döngüsünün yapacağı sırayla döndürür.[key, value] Giriş değeri nesne değilse nesneye zorlanır.

freeze() yöntemi, Standart Kitaplık Object.resolve() davranışını sağlar. Dondurulmuş bir nesne artık değiştirilemez. Bir nesnenin dondurulması, yeni özelliklerin bu nesneye eklenmesini, mevcut özelliklerin kaldırılmasını ve mevcut özelliklerin değerlerinin değiştirilmesini engeller. freeze(), içine geçirilen nesneyi döndürür. Temel veya null bağımsız değişken, donmuş bir nesne gibi değerlendirilir ve döndürülür.

delete() yöntemi, Standart Kitaplık silme operatörü davranışını sağlar. Nesne donmadığı sürece verilen anahtarı nesneden kaldırır. Standart Kitaplık silme operatörü gibi, ilk giriş değeri (objectInput) ikinci giriş değeri (keyToDelete) var olmayan bir anahtarı belirtse bile dondurulmamış bir nesneyse true sonucunu döndürür. Diğer tüm durumlarda false değerini döndürür. Ancak bu operatör, şu özellikleri açısından Standart Kitaplık silme operatöründen farklıdır:

  • keyToDelete, iç içe yerleştirilmiş bir anahtarı belirten noktayla sınırlandırılmış bir dize olamaz.
  • delete(), bir diziden öğe kaldırmak için kullanılamaz.
  • delete(), genel kapsamdan herhangi bir mülkü kaldırmak için kullanılamaz.

Söz dizimi

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

Parametreler

Nesne.anahtarları

Parametre Tür Açıklama
Nesne Girişi herhangi biri Anahtarları numaralanacak nesne. Giriş bir nesne değilse nesne olmaya zorlanır.

Nesne.değerleri

Parametre Tür Açıklama
Nesne Girişi herhangi biri Değerleri numaralanacak nesne. Giriş bir nesne değilse nesne olmaya zorlanır.

Object.entries

Parametre Tür Açıklama
Nesne Girişi herhangi biri Numaralanacak anahtar/değer çiftleri olan nesne. Giriş bir nesne değilse nesneye zorlanır.

Nesne.dondurun

Parametre Tür Açıklama
Nesne Girişi herhangi biri Dondurulacak nesne. Giriş bir nesne değilse donmuş nesne olarak değerlendirilir.

Object.delete

Parametre Tür Açıklama
Nesne Girişi herhangi biri Anahtarı silinecek nesne.
tuşuToDelete dize Silinecek üst düzey anahtar.

Örnek

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

Belirli bir URL'nin tüm bileşen parçalarını (URL nesnesine benzer) içeren bir nesne döndürür.

Bu API, bozuk URL'ler için undefined hatası döndürür. Doğru şekilde biçimlendirilmiş URL'ler için URL dizesinde bulunmayan alanlar, boş bir dize değerine veya searchParams durumunda boş bir nesne değerine sahip olur.

Döndürülen nesne aşağıdaki alanlara sahip olur:

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

Örnek

const parseUrl = require('parseUrl');

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

Söz dizimi

parseUrl(url);

Parametreler

Parametre Tür Açıklama
url dize Ayrıştırılacak tam URL.

İlişkilendirilmiş izinler

Yok.

queryPermission

İzin verilen ve daraltılan izinleri sorgulayın. İzin verilirse boole değeri döndürür: true, izin verilmişse false.

Söz dizimi

queryPermission(permission, functionArgs*)

Parametreler

Parametre Tür Açıklama
permission dize İznin adı.
functionArgs herhangi biri İşlev bağımsız değişkenleri, sorgulanan izne göre değişiklik gösterir. Aşağıdaki İşlev Bağımsız Değişkenleri bölümüne bakın.

İşlev Bağımsız Değişkenleri

sendPixel, injectScript, injectHiddenIframe: İkinci parametre bir URL dizesi olmalıdır.

writeGlobals, readGlobals: İkinci parametre, yazılan veya okunan anahtar olmalıdır.

readUrl: URL'nin tamamının okunup okunamayacağını sorgulamak için ek bağımsız değişkenlere gerek yoktur. Belirli bir bileşenin okunup okunamayacağını sorgulamak için bileşen adını ikinci bağımsız değişken olarak iletin:

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

Belirli bir sorgu anahtarının okunabilir olup olmadığını kontrol etmek için sorgu anahtarını üçüncü parametre olarak geçirin:

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

İlişkilendirilmiş izinler

Yok.

readCharacterSet

document.characterSet değerini döndürür.

Söz dizimi

readCharacterSet()

Parametreler

Yok.

İlişkilendirilmiş izinler

read_character_set

readTitle

document.title değerini döndürür.

Söz dizimi

readTitle()

Parametreler

Yok.

İlişkilendirilmiş izinler

read_title

require

Yerleşik bir işlevi ada göre içe aktarır. Programınızdan çağrılabilen bir işlev veya nesne döndürür. Tarayıcı yerleşik işlevi desteklemediğinde undefined değerini döndürür.

Söz dizimi

require(name)

Parametreler

Parametre Tür Açıklama
name dize İçe aktarılacak işlevin adı.

Örnek

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

İlişkilendirilmiş izinler

Yok.

sendPixel

Belirli bir URL uç noktasına GET isteği gönderir.

Söz dizimi

sendPixel(url, onSuccess, onFailure)

Parametreler

Parametre Tür Açıklama
url dize Pikselin gönderileceği yer.
onSuccess işlev Piksel başarıyla yüklendiğinde çağrılır. Not: İstek başarıyla gönderilse bile, tarayıcılar onSuccess çalıştırılması için geçerli bir resim yanıtı gerektirebilir.
onFailure işlev Piksel yüklenemediğinde çağrılır. Not: İstek başarıyla gönderilse bile, sunucu geçerli bir resim yanıtı döndürmezse onFailure çalışabilir.

İlişkilendirilmiş izinler

send_pixel

setCookie

Çerezi belirtilen ad, değer ve seçeneklerle ayarlar veya siler.

Söz dizimi

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

Parametreler

Parametre Tür Açıklama
name dize Çerezin adı.
value dize Çerezin değeri.
options object (nesne) Domain, Path, Expiration, Max-Age, Secure ve SameSite özelliklerini belirtir. (Aşağıdaki Seçenekler bölümüne bakın.)
encode boole Çerez değerinin JavaScript'in encodeURIComponent() öğesiyle kodlanıp kodlanmayacağını kontrol eder. Varsayılan olarak true değerine ayarlanır.

Seçenekler

  • Alan: Varsa options['domain'] mülkü tarafından ayarlanır. Çerezi, belge konumuna göre mümkün olan en geniş alanı kullanarak yazmayı denemek için bu değeri 'auto' olarak ayarlayın. Bu başarısız olursa, arka arkaya daha dar alt alan adlarını dener. Bunların tümü başarısız olursa çerezi alan olmadan yazmaya çalışır. Herhangi bir değer ayarlanmazsa çerezi bir alan adı belirtilmeden yazmaya çalışır. Not: Alan adı belirtilmemiş bir çerez document.cookie adresine yazılırsa kullanıcı aracısı, çerezin alan adını varsayılan olarak mevcut belge konumunun ana makinesine ayarlar.
  • Yol: Varsa options['path'] tarafından ayarlanır. Yolu belirtilmemiş bir çerez document.cookie adresine yazıldığında kullanıcı aracısı, çerezin yolunu varsayılan olarak mevcut belge konumunun yolu olarak ayarlar.
  • Max-Age: Varsa options['max-age'] tarafından ayarlanır.
  • Geçerlilik sonu: Varsa options['expires'] tarafından ayarlanır. Varsa bu değer, UTC biçimli bir tarih dizesi olmalıdır. Bu parametre için bir Date biçimlendirmek üzere Date.toUTCString() kullanılabilir.
  • Güvenli: Varsa options['secure'] tarafından ayarlanır.
  • SameSite: Varsa options['samesite'] tarafından ayarlanır.

İlişkilendirilmiş izinler

set_cookies

setDefaultConsentState

Mevcut etkinlik ve tetiklediği tüm etiketlerin işlenmesi (veya etiket işleme zaman aşımına ulaşıldıktan) sonra mümkün olan en kısa sürede işlenmek üzere veri katmanına bir varsayılan izin güncellemesi aktarır. Güncellemenin, veri katmanında sıraya alınmış öğelerden önce bu kapsayıcıda işlenmesi garanti edilir. İzin verme hakkında daha fazla bilgi edinin.

Örnek:

const setDefaultConsentState = require('setDefaultConsentState');

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

Söz dizimi

setDefaultConsentState(consentSettings)

Parametreler

Parametre Tür Açıklama
consentSettings object (nesne) Belirtilen izin türleri için varsayılan durumu tanımlayan bir nesnedir.

consentSettings nesnesi, rastgele izin türü dizelerinin 'granted' veya 'denied' değerlerinden biriyle eşlenmesidir. Aşağıdaki değerleri destekler:

Anahtar Adı Tür Açıklama
consentType dize Her izin türünün değeri "granted"" (izin verildi) veya "denied" (reddedildi) olarak ayarlanabilir. "granted" (verildi) dışındaki tüm değerler "reddedildi" olarak değerlendirilir. Değerin "undefined" olarak ayarlanmasının önceki değeri üzerinde herhangi bir etkisi olmaz.
region Dizi İzin ayarlarının hangi bölgeye uygulanacağını belirten isteğe bağlı bir bölge kodu dizisi. Bölge kodları, ISO 3166-2 biçimindeki ülke ve/veya alt bölümler kullanılarak ifade edilir.
wait_for_update sayı Veriler gönderilmeden önce ne kadar bekleneceğini kontrol etmek için milisaniye değerini belirtir. Eşzamansız olarak yüklenen izin araçlarıyla kullanılır.

İlişkilendirilmiş izinler

ConsentSettings nesnesindeki tüm izin türleri için yazma erişimiyle access_consent izni.

setInWindow

Belirtilen anahtardaki window içinde verilen değeri ayarlar. Zaten mevcut bir değer varsa bu yöntem varsayılan olarak window içindeki değeri ayarlamaz. window içindeki değeri, mevcut bir değerin varlığından bağımsız olarak ayarlamak için overrideExisting değerini true olarak ayarlayın. boole döndürür: Değer başarıyla ayarlanmışsa true, aksi takdirde false.

Söz dizimi

setInWindow(key, value, overrideExisting)

Parametreler

Parametre Tür Açıklama
key dize window alanında değerin yerleştirileceği anahtar.
value * window içinde ayarlanacak değer.
overrideExisting boole Değerin window içinde ayarlanması gerektiğini belirten işaret, orada bir değer olup olmamasından bağımsız olarak.

İlişkilendirilmiş izinler

access_globals

sha256

Girişin SHA-256 özetini hesaplar ve options nesnesi farklı bir çıkış kodlaması belirtmediği sürece base64'te kodlanmış özetle bir geri çağırma çağırır.

Örnek:

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

Söz dizimi

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

Parametreler

Parametre Tür Açıklama
input dize Karma değeri hesaplanacak dize.
onSuccess işlev options nesnesi farklı bir çıkış kodlaması belirtmediği sürece base64'te kodlanmış sonuç özetiyle çağrılır.
onFailure işlev Özet hesaplanırken hata oluşursa veya tarayıcının sha256 için yerel desteği yoksa çağrılır. Geri çağırma, hatanın adını ve mesajı içeren bir nesneyle çağrılır.
options object (nesne) Çıkış kodlamasını belirtmek için İsteğe bağlı seçenekler nesnesi. Belirtilirse nesne, base64 veya hex değerine sahip outputEncoding anahtarını içermelidir.

İlişkilendirilmiş izinler

Yok.

templateStorage

Şablon depolama alanına erişim yöntemlerine sahip bir nesne döndürür. Şablon depolama, verilerin tek bir şablonun yürütme işlemleri arasında paylaşılmasını sağlar. Şablon depolama alanında depolanan veriler sayfanın ömrü boyunca kalır.

Söz dizimi

const templateStorage = require('templateStorage');

templateStorage.getItem(key);

templateStorage.setItem(key, value);

templateStorage.removeItem(key);

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

İlişkilendirilmiş izinler

access_template_storage

Örnek

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

toBase64 API, bir dizeyi base64 gösterimi olarak kodlamanızı sağlar.

Söz dizimi

toBase64(input)

Parametreler

Parametre Tür Açıklama
input dize Kodlanacak dize.

Örnek

const toBase64 = require('toBase64');

const base64Hello = toBase64('hello');

İlişkilendirilmiş izinler

Yok

updateConsentState

Mevcut etkinliğin ve tetiklediği etiketlerin işlenmesi bittikten (veya etiket işleme zaman aşımına ulaşıldıktan) sonra, mümkün olan en kısa sürede işlenmek üzere veri katmanına bir izin güncellemesi aktarır. Güncellemenin, veri katmanında sıraya alınmış öğelerden önce bu kapsayıcıda işleneceği garanti edilir. İzin hakkında daha fazla bilgi edinin.

Örnek:

const updateConsentState = require('updateConsentState');

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

Söz dizimi

updateConsentState(consentSettings)

Parametreler

Parametre Tür Açıklama
consentSettings object (nesne) Belirtilen izin türleri için durumu güncelleyen bir nesne.

consentSettings nesnesi, rastgele izin türü dizelerinin 'granted' veya 'denied' değerlerinden biriyle eşlenmesidir. Aşağıdaki değerleri destekler:

Anahtar Adı Tür Açıklama
consentType dize Her bir izin türünün değeri "verildi" veya "reddedildi" olarak ayarlanabilir. "granted" dışındaki değerler "reddedildi" olarak değerlendirilir. Değerin "tanımsız" olarak ayarlanmasının önceki değeri üzerinde herhangi bir etkisi olmaz.

İlişkilendirilmiş izinler

ConsentSettings nesnesindeki tüm izin türleri için yazma erişimiyle access_consent izni.

API'leri test etme

Bu API'ler, Google Etiket Yöneticisi'nde özel şablonlar için testler oluşturmak üzere korumalı alana sahip JavaScript testleriyle birlikte çalışır. Bu test API'lerinin require() ifadesine ihtiyacı yoktur. Özel şablon testleri hakkında daha fazla bilgi

assertApi

Belirli API hakkında akıcı bir şekilde iddialarda bulunmak için kullanılabilecek bir eşleştirici nesne döndürür.

Söz dizimi

assertApi(apiName)

Parametreler

Parametre Tür Açıklama
apiName dize Kontrol edilecek API'nin adı; require() işlevine iletilen dize.

Eşleştiriciler

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

Örnekler

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

assertThat

assertThat API, Google'ın [Truth] kitaplığına göre modellenmiştir. Öznenin değeri hakkında akıcı bir şekilde iddialarda bulunmak için kullanılabilecek bir nesne döndürür. Onay başarısız olduğunda, test hemen durdurulur ve başarısız olarak işaretlenir. Bununla birlikte, bir testteki başarısızlık diğer test durumlarını etkilemez.

Söz dizimi

assertThat(actual, opt_message)

Parametreler

Parametre Tür Açıklama
actual herhangi biri Akıcı kontrollerde kullanılacak değer.
opt_message dize Onaylama başarısız olursa yazdırılacak isteğe bağlı ileti.

Eşleştiriciler

Eşleştirici Açıklama
isUndefined() Konunun undefined olduğunu iddia eder.
isDefined() Konunun undefined olmadığını iddia eder.
isNull() Konunun null olduğunu iddia eder.
isNotNull() Konunun null olmadığını iddia eder.
isFalse() Konunun false olduğunu iddia eder.
isTrue() Konunun true olduğunu iddia eder.
isFalsy() Öznenin yanlış olduğunu iddia eder. Hatalı değerler undefined, null, false, NaN, 0 ve '' (boş dize) şeklindedir.
isTruthy() Öznenin doğru olduğunu iddia eder. Hatalı değerler undefined, null, false, NaN, 0 ve '' (boş dize) şeklindedir.
isNaN() Öznenin NaN değeri olduğunu iddia eder.
isNotNaN() Öznenin NaN dışında herhangi bir değer olduğunu iddia eder.
isInfinity() Öznenin pozitif veya negatif Sonsuz olduğunu iddia eder.
isNotInfinity() Öznenin, pozitif veya negatif Sonsuzluk dışında herhangi bir değer olduğunu iddia eder.
isEqualTo(expected) Konunun verilen değere eşit olduğunu iddia eder. Bu bir değer karşılaştırmasıdır, bir referans karşılaştırması değildir. Nesnelerin ve dizilerin içeriği, tekrarlı olarak karşılaştırılır.
isNotEqualTo(expected) Konunun verilen değere eşit olmadığını iddia eder. Bu bir değer karşılaştırmasıdır, bir referans karşılaştırması değildir. Nesnelerin ve dizilerin içeriği, tekrarlı olarak karşılaştırılır.
isAnyOf(...expected) Konunun verilen değerden birine eşit olduğunu iddia eder. Bu bir değer karşılaştırmasıdır, bir referans karşılaştırması değildir. Nesnelerin ve dizilerin içeriği, tekrarlı olarak karşılaştırılır.
isNoneOf(...expected) Konunun verilen değerlerin hiçbirine eşit olmadığını iddia eder. Bu bir değer karşılaştırmasıdır, bir referans karşılaştırması değildir. Nesnelerin ve dizilerin içeriği, tekrarlı olarak karşılaştırılır.
isStrictlyEqualTo(expected) Konunun verilen değere kesinlikle eşit (===) olduğunu iddia eder.
isNotStrictlyEqualTo(expected) Öznenin verilen değere kesinlikle eşit olmadığını (!==) iddia eder.
isGreaterThan(expected) Konunun sıralı karşılaştırmada belirtilen değerden (>) büyük olduğunu iddia eder.
isGreaterThanOrEqualTo(expected) Konunun sıralı karşılaştırmada belirtilen değerden (>=) büyük veya ona eşit olduğunu iddia eder.
isLessThan(expected) Konunun sıralı bir karşılaştırmada belirtilen değerden (<) küçük olduğunu iddia eder.
isLessThanOrEqualTo(expected) Konunun sıralı karşılaştırmada belirtilen değerden küçük veya ona eşit (<=) olduğunu iddia eder.
contains(...expected) Konunun, belirtilen değerlerin tamamını herhangi bir sırada içeren bir dizi veya dize olduğunu iddia eder. Bu bir referans karşılaştırması değil, bir değer karşılaştırmasıdır. Nesnelerin ve dizilerin içeriği, tekrarlı olarak karşılaştırılır.
doesNotContain(...expected) Konunun, belirtilen değerlerden hiçbirini içermeyen bir dizi veya dize olduğunu iddia eder. Bu bir referans karşılaştırması değil, bir değer karşılaştırmasıdır. Nesnelerin ve dizilerin içerikleri tekrarlı olarak karşılaştırılır.
containsExactly(...expected) Konunun, belirtilen değerlerin tümünü herhangi bir sırada içeren ve başka hiçbir değer içermeyen bir dizi olduğunu iddia eder. Bu bir değer karşılaştırmasıdır, bir referans karşılaştırması değildir. Nesnelerin ve dizilerin içeriği, tekrarlı olarak karşılaştırılır.
doesNotContainExactly(...expected) Konunun, herhangi bir sırada belirtilen değerlerden farklı bir değer grubu içeren bir dizi olduğunu iddia eder. Bu bir değer karşılaştırmasıdır, bir referans karşılaştırması değildir. Nesnelerin ve dizilerin içeriği, tekrarlı olarak karşılaştırılır.
hasLength(expected) Öznenin belirtilen uzunlukta bir dizi veya dize olduğunu iddia eder. Değer bir dizi veya dize değilse onaylama işlemi her zaman başarısız olur.
isEmpty() Konunun boş bir dizi veya dize (uzunluk = 0) olduğunu iddia eder. Değer bir dizi veya dize değilse onaylama işlemi her zaman başarısız olur.
isNotEmpty() Konunun boş olmayan bir dizi veya dize olduğunu iddia eder (uzunluk > 0). Değer bir dizi veya dize değilse onaylama işlemi her zaman başarısız olur.
isArray() Öznenin türünün bir dizi olduğunu iddia eder.
isBoolean() Özne türünün boole olduğunu iddia eder.
isFunction() Öznenin türünün bir işlev olduğunu iddia eder.
isNumber() Konu türünün bir sayı olduğunu iddia eder.
isObject() Öznenin türünün bir nesne olduğunu iddia eder.
isString() Konu türünün bir dize olduğunu iddia eder.

Örnekler

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

Geçerli testte hemen başarısız olur ve sağlanmışsa belirtilen iletiyi yazdırır.

Söz dizimi

fail(opt_message);

Parametreler

Parametre Tür Açıklama
opt_message dize İsteğe bağlı hata mesajı metni.

Örnek

fail('This test has failed.');

mock

mock API, Korumalı Alana Sahip API'lerin davranışını geçersiz kılmanıza olanak tanır. Örnek API, şablon kodunda güvenle kullanılabilir ancak test modunda değilken çalışmaz. Her test çalıştırılmadan önce örnekler sıfırlanır.

Söz dizimi

mock(apiName, returnValue);

Parametreler

Parametre Tür Açıklama
apiName dize Taklit edilecek API'nin adı; require() öğesine iletilen dizenin aynısı
returnValue herhangi biri API veya API'nin yerine çağrılan bir işlev için döndürülecek değer. returnValue bir işlevse bu işlev, Korumalı Alana Sahip API'nin yerine çağrılır; returnValue, bir işlevden başka bir şeyse Korumalı Alana Sahip API'nin yerine bu değer döndürülür.

Örnekler

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

runCode

Belirli bir giriş verisi nesnesiyle geçerli test ortamında şablon için kodu (yani Kod sekmesinin içeriğini) çalıştırır.

Söz dizimi

runCode(data)

Parametreler

Parametre Tür Açıklama
data object (nesne) Testte kullanılacak veri nesnesi.

Dönüş Değeri

Değişken şablonları için bir değişkenin değerini döndürür; diğer tüm şablon türleri için undefined değerini döndürür.

Örnek

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