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. Örneğin:
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üne ilişkin durum "reddedildi" veya "verildi" olarak "reddedildi" olarak her değiştiğinde, belirtilen işleyici çağrılır. Durumu olmayan bir izin türü, verildi olarak kabul edilir. Bu nedenle, ayarlanmayan bir izin türü verildi olarak güncellenirse işleyici çağrılmaz. İşleyici işlevler, kodlarının doğru sayıda çalışmasını sağlamaktan sorumludur.
Ö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 bu izin türünün yeni değeri iletilir:
Parametre | Tür | Açıklama |
---|---|---|
consentType |
dize | Değiştirilmekte olan izin türü. |
granted |
boolean | Belirtilen izin türü verildi olarak değiştiriliyorsa true (doğru) olan bir boole değeridir. |
İlişkilendirilmiş izinler
İzin türü için okuma erişimi ile access_consent
izni.
addEventCallback
addEventCallback
API, bir etkinliğin sonunda çağrılacak bir geri çağırma işlevini kaydetmenize olanak tanır. Geri çağırma, etkinliğin tüm etiketleri yürütüldüğünde veya bir sayfa içi etkinlik zaman aşımına ulaşıldığında çağrılır.
Geri çağırma işlevi iki değer iletir: işlevi çağıran kapsayıcının kimliği ve etkinlikle ilgili bilgileri içeren bir nesne.
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 etiketin bu dizide bir girişi olur. Etiket veri nesnesi etiketin kimliğini (id ), yürütme durumunu (status ) ve yürütme zamanını (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
aliasInWindow
aliasInWindow
API, bir takma ad (ör.window.foo =
window.bar
) oluşturmanıza olanak tanır. Böylece, takma ad gerektiren belirli etiketler desteklenir. fromPath
konumunda bulunan window
nesnesindeki değeri, toPath
konumundaki window
nesnesinde bulunan anahtara atar. Başarılıysa 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 kopyalanacağı, noktayla ayrılmış yol. Son bileşene kadar olan yoldaki tüm bileşenler zaten window nesnesinde mevcut olmalıdır. |
fromPath |
dize | Kopyalanacak değere window 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, verilen 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 şunlardır: null
, undefined
, boolean
, number
, string
, Array
, Object
ve function
. Belirtilen yol mevcut değilse veya bir işleve başvuruda bulunmuyorsa 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 eşzamansız olarak gerçekleşecek bir çağrı planlar. İşlev, mevcut kod döndürüldükten sonra çağrılacaktı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ğeri ya da undefined
değilse ilgili anahtarda bulunan değer.
Söz dizimi
copyFromDataLayer(key[, dataLayerVersion])
Parametreler
Parametre | Tür | Açıklama |
---|---|---|
key |
dize | "a.b.c" biçimindeki anahtar. |
dataLayerVersion |
numara | İ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
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 | Değerinin kopyalanacağı window içindeki anahtar. |
İlişkilendirilmiş izinler
createArgumentsQueue
Kendisini gerektiren etiket çözümlerini desteklemek için 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 bir dizi (önceden yoksa) oluşturur.
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 | Mevcut değilse window içinde işlevin ayarlandığı yol. Bu bağımsız değişken standart nokta gösterimini destekler. Anahtarın yolu mevcut değilse bir istisna yapılır. Yani fnKey , 'one.two' ise bir istisna oluşturur. |
arrayKey |
dize | Zaten mevcut değilse window alanında dizinin ayarlandığı yol. Bu bağımsız değişken standart nokta gösterimini destekler. Anahtarın yolu mevcut değilse bir istisna yapılır. Yani arrayKey , 'one.two' ise ve 'one' adlı genel nesne yoksa bir istisna oluşturur. |
İlişkilendirilmiş izinler
createQueue
window
işlevinde bir dizi oluşturur (önceden mevcut değilse) ve değerleri bu diziye aktaracak bir işlev döndürür.
Bu işlev, access_globals
izninde arrayKey
için okuma ve yazma ayarını gerektiriyor.
Örnek:
const dataLayerPush = createQueue('dataLayer');
dataLayerPush({'currency': 'USD'}, {'event': 'myConversion'});
Söz dizimi
createQueue(arrayKey)
Parametreler
Parametre | Tür | Açıklama |
---|---|---|
arrayKey |
dize | Mevcut değilse window alanında dizinin ayarlandığı anahtar. Bu bağımsız değişken standart nokta gösterimini destekler. Anahtarın yolu mevcut değilse bir istisna yapılır. Örneğin, arrayKey , 'one.two' ise ve 'one' adlı genel nesne yoksa bir istisna oluşturur. |
İlişkilendirilmiş izinler
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
değerini 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() veya başka yöntemlerle kodlanmış bir 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() veya başka yöntemlerle 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 | URI bileşeni. |
İlişkilendirilmiş izinler
Yok.
fromBase64
fromBase64
API, dizelerin base64 gösteriminden kodunu çözebilmenizi sağlar. Geçersiz girişle sağlandığında undefined
değerini 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ık dahilinde rastgele bir sayı (tam sayı) döndürür.
Söz dizimi
generateRandom(min, max)
Parametreler
Parametre | Tür | Açıklama |
---|---|---|
min |
numara | Döndürülen tam sayının minimum potansiyel değeri. |
max |
numara | Döndürülen tam sayının maksimum potansiyel değeri. |
İlişkilendirilmiş izinler
Yok.
getContainerVersion
Geçerli kapsayıcı hakkında 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
getCookieValues
Verilen 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 |
boolean | Çerez değerlerinin kodunun JavaScript'in
decodeURIComponent() ile çözülemeyeceğini kontrol eder. Varsayılan olarak true değerine ayarlanır. |
İlişkilendirilmiş izinler
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
öğesinden bir değer dizisi döndürür.
Söz dizimi
getQueryParameters(queryKey[, retrieveAll])
Parametreler
Parametre | Tür | Açıklama |
---|---|---|
queryKey |
dize | Sorgu parametrelerinden okunacak anahtar. |
retrieveAll |
boolean | Tüm değerlerin alınıp alınmayacağını belirtir. |
Örneğin, geçerli 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 hareket etmesi haricinde 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
aracılığıyla bir değer dizisi döndürür.
Söz dizimi
getReferrerQueryParameters(queryKey[, retrieveAll])
Parametreler
Parametre | Tür | Açıklama |
---|---|---|
queryKey |
dize | Sorgu parametrelerinden okunacak anahtar. |
retrieveAll |
boolean | Tüm değerlerin alınıp alınmayacağını belirtir. |
Örneğin, yönlendiren URL'si 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 belge nesnesini okur ve yönlendirenin bir kısmını temsil eden bir dize döndürür. Herhangi bir bileşen belirtilmezse tam yönlendiren URL'si 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 veya null ise ya da 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 tercih edilir.
Date.now()
tarafından döndürülen, Unix sıfır noktasından bu yana geçen geçerli süreyi 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, Unix sıfır noktasından bu yana geçen geçerli süreyi milisaniye cinsinden temsil eden bir sayı döndürür.
Söz dizimi
getTimestampMillis();
İlişkilendirilmiş izinler
Yok.
getType
Verilen değerin türünü açıklayan bir dize döndürür. typeof
'in aksine getType
, array
ile object
birbirinden ayırt edilir.
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 |
"null" |
true |
'boolean' |
12 |
"number" |
'string' |
"dize" |
{ a: 3 } |
"object" |
[ 1, 3 ] |
"dizi" |
(x) => x + 1 |
"function" |
İlişkilendirilmiş izinler
Yok.
getUrl
Bileşen türü ve bazı yapılandırma parametrelerine göre geçerli URL'nin tamamını veya bir kısmını temsil eden dize değerini 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 veya null ise veya bu bileşenlerden biriyle eşleşmiyorsa href değerinin tamamı döndürülür. |
İlişkilendirilmiş izinler
gtagSet
Mevcut etkinlik ve tetiklediği tüm 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 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ı özellikleri için genel durumu 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, söz konusu 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 iznini kontrol eder.
gtagSet
girişi bir anahtar ve düz olmayan bir nesne değeriyse 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 bunlara çağrı yapan 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
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çin sarmalanır.
Söz dizimi
injectScript(url, onSuccess, onFailure[, cacheToken])
Parametreler
Parametre | Tür | Açıklama |
---|---|---|
url |
dize | Eklenecek 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. Ek yükleme denemeleri, komut dosyası yüklenene kadar belirtilen onSuccess ve onFailure yöntemlerinin sıraya alınmasına neden olur. |
İlişkilendirilmiş izinler
isConsentGranted
Belirtilen izin türü verilirse true (doğru) değerini döndürür.
Belirli bir izin türü için izin, "verildi" olarak ayarlanmışsa veya hiç ayarlanmadıysa verilmiş olarak kabul edilir. İzin türü başka bir değere ayarlanırsa izin verilmedi olarak kabul edilir.
Etiket ayarları için Etiket Yöneticisi kullanıcı arayüzü, her zaman tetikleme seçeneği sunar. Her zaman etkinleşmenin açık olduğu bir etiket bu API'yi kullanıyorsa izin verilmiş kabul edilir ve gerçek izin durumundan bağımsız olarak 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şimi ile 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. hatalı biçimlendirilmiş JSON) işlev, undefined
değerini döndürür. Girdi değeri dize değilse giriş dize olmaya 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 |
---|---|---|
stringInput | herhangi bir | 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 bir | 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
Ö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 bir | Bağımsız değişkenler |
İlişkilendirilmiş izinler
makeInteger
Belirli bir değeri sayıya (tamsayı) dönüştürür.
Söz dizimi
makeInteger(value)
Parametreler
Parametre | Tür | Açıklama |
---|---|---|
value |
herhangi bir | 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 bir | Dönüştürülecek değer. |
İlişkilendirilmiş izinler
Yok.
makeString
Verilen değeri dize olarak döndürür.
Söz dizimi
makeString(value)
Parametreler
Parametre | Tür | Açıklama |
---|---|---|
value |
herhangi bir | Dönüştürülecek değer. |
İlişkilendirilmiş izinler
Yok.
makeTableMap
İki sütunlu basit bir tablo nesnesini Map
biçimine 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'}
]
içine girer:
{
'k1': 'v1',
'k2': 'v2'
}
Bir Nesne döndürür: Anahtar/değer çiftleri eklenmişse dönüştürülen Map
, aksi takdirde null
döndürülür.
Söz dizimi
makeTableMap(tableObj, keyColumnName, valueColumnName)
Parametreler
Parametre | Tür | Açıklama |
---|---|---|
tableObj |
Listele | Dönüştürülecek tablo nesnesi. Bu, her Map öğesinin tablodaki bir satırı temsil ettiği bir haritalar 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 içinde anahtar haline gelecek sütunun adı. |
valueColumnName |
dize | Değerleri dönüştürülen Map öğesinde 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 fonksiyonlar parametreleri sayılara dönüştürülür.
İlişkilendirilmiş izinler
Yok.
Object
Object
yöntemleri 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, bir for...in...
döngüsünün yapacağı sırayla döndürür. Giriş değeri nesne değilse bir nesne olmaya zorlanır.
values()
yöntemi, Standart Kitaplık Object.values() davranışını sağlar. Belirli bir nesnenin kendi numaralandırılabilir özellik değerlerinin bir dizisini, bir for...in...
döngüsüyle aynı sırada döndürür. Giriş değeri nesne değilse bir nesneye zorlanır.
entries()
yöntemi, Standart Kitaplık Object.entries() davranışını sağlar. Belirli bir nesnenin kendi numaralandırılabilir özellik çiftlerinin [key, value]
dizisini, bir for...in...
döngüsünün yapacağı sırayla döndürür. Giriş değeri nesne değilse nesneye zorlanır.
freeze()
yöntemi, Standart Kitaplık Object.freeze() davranışını sağlar. Dondurulmuş bir nesne artık değiştirilemez. Bir nesnenin dondurması, yeni özelliklerin bu nesneye eklenmesini, mevcut özelliklerin kaldırılmasını ve mevcut özelliklerin değerlerinin değiştirilmesini önler. freeze()
, aktarılan 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 belirtilen anahtarı nesneden kaldırır.
Standart Kitaplık silme operatöründe olduğu gibi, ilk giriş değeri (objectInput
) ikinci giriş değeri (keyToDelete
) var olmayan bir anahtarı belirtse bile dondurulmayan bir nesneyse true
değerini döndürür. Diğer tüm durumlarda false
değerini döndürür. Ancak bu yöntem, Standart Kitaplık silme operatöründen aşağıdaki yönleriyle farklıdır:
keyToDelete
, iç içe yerleştirilmiş bir anahtar belirten noktayla ayrı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
Object.keys
Parametre | Tür | Açıklama |
---|---|---|
objectInput | herhangi bir | Anahtarları numaralanacak nesne. Giriş bir nesne değilse bir nesneye zorlanır. |
Object.values
Parametre | Tür | Açıklama |
---|---|---|
objectInput | herhangi bir | Değerleri numaralanacak nesne. Giriş bir nesne değilse bir nesneye zorlanır. |
Object.entries
Parametre | Tür | Açıklama |
---|---|---|
objectInput | herhangi bir | Anahtar/değer çiftleri numaralanacak nesne. Giriş bir nesne değilse bir nesneye zorlanır. |
Object.freeze
Parametre | Tür | Açıklama |
---|---|---|
objectInput | herhangi bir | Dondurulacak nesne. Giriş bir nesne değilse donmuş nesne olarak değerlendirilir. |
Object.delete
Parametre | Tür | Açıklama |
---|---|---|
objectInput | herhangi bir | Anahtarı silinecek nesne. |
keyToDelete | 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
URL
nesnesine benzer şekilde, belirli bir URL'nin tüm bileşen parçalarını içeren bir nesne döndürür.
Bu API, bozuk URL'ler için undefined
değerini döndürür. Doğru şekilde biçimlendirilmiş URL'ler için URL dizesinde bulunmayan alanlar, boş dize değeri veya searchParams
durumunda boş nesne değeri içerir.
Döndürülen nesne aşağıdaki alanları içerir:
{
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. Bir boolean döndürür: İzin verilirse true
, aksi takdirde false
.
Söz dizimi
queryPermission(permission, functionArgs*)
Parametreler
Parametre | Tür | Açıklama |
---|---|---|
permission |
dize | İznin adı. |
functionArgs |
herhangi bir | İşlev bağımsız değişkenleri, sorgulanan izne bağlı olarak 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 iletin:
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
readTitle
document.title
değerini döndürür.
Söz dizimi
readTitle()
Parametreler
Yok.
İlişkilendirilmiş izinler
require
Yerleşik bir işlevi ada göre içe aktarır. Programınızdan çağrılabilecek 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 komutunun çalışması 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
setCookie
Belirtilen ad, değer ve seçeneklerle çerezi 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 |
boolean | Çerez değerinin JavaScript encodeURIComponent() ile kodlanıp kodlanmayacağını kontrol eder.
Varsayılan olarak true değerine ayarlanır. |
- Alan: Varsa
options['domain']
mülkü tarafından ayarlanır. Çerezi, belge konumuna göre mümkün olan en geniş alanı kullanarak yazmaya çalışmak 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 adı olmadan yazmaya çalışır. Herhangi bir değer ayarlanmazsa çerezi alan adı belirtilmeden yazmaya çalışır. Not: Alan adı belirtilmemiş bir çerezdocument.cookie
adresine yazıldığında kullanıcı aracısı, çerezin alan adını varsayılan olarak geçerli belge konumunun ana makinesine ayarlar. - Yol: Varsa
options['path']
tarafından ayarlanır.document.cookie
adresine yolu belirtilmiş olmayan bir çerez yazıldığında kullanıcı aracısı, çerezin yolunu varsayılan olarak geçerli belge konumunun yolu olarak ayarlar. - Max-Age: Varsa
options['max-age']
tarafından ayarlanır. - Sona erme: Varsa
options['expires']
tarafından ayarlanır. Varsa bu, UTC biçimli bir tarih dizesi olmalıdır. Bu parametre için birDate
biçimlendirmek üzereDate.toUTCString()
kullanılabilir. - Güvenli: Varsa
options['secure']
tarafından ayarlanır. - SameSite: Varsa
options['samesite']
tarafından ayarlanır.
İlişkilendirilmiş izinler
setDefaultConsentState
Geçerli etkinlik ve tetiklediği tüm etiketlerin işlenmesi bittikten (veya etiket işleme zaman aşımına ulaşıldıktan) mümkün olan en kısa sürede işlenmek üzere, veri katmanına varsayılan bir izin güncellemesini aktarır. Güncellemenin, veri katmanında sıraya alınmış öğelerden önce bu kapsayıcıda işlenmesi garanti edilir. İzin 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 nesnedir. |
consentSettings
nesnesi, rastgele izin türü dizelerinin 'granted'
veya 'denied'
özelliklerinden 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 "granted"" veya "denied"" olarak ayarlanabilir. "granted" (alındı) dışındaki tüm değerler, "denied" (reddedildi) olarak değerlendirilir. Değerin "undefined" olarak ayarlanması, önceki değer üzerinde herhangi bir etkiye sahip olmaz. |
region |
Dizi | İzin ayarlarının hangi bölgeye uygulandığını belirten isteğe bağlı bir bölge kodu dizisi. Bölge kodları, ISO 3166-2 biçiminde ülke ve/veya alt bölümler kullanılarak ifade edilir. |
wait_for_update |
numara | Veriler gönderilmeden önce ne kadar bekleneceğini kontrol etmek için milisaniyelik bir değer 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
window
içindeki verilen değeri verilen anahtarda ayarlar. Zaten bir değer varsa bu yöntem varsayılan olarak window
içindeki değeri ayarlamaz. window
öğesinde değeri, mevcut bir değerin varlığından bağımsız olarak ayarlamak için overrideExisting
değerini true
olarak ayarlayın. Bir boolean 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 |
boolean | Değerin window içinde ayarlanması gerektiğini belirten işaret, orada bir değer olup olmadığına bakılmaksızın. |
İlişkilendirilmiş izinler
sha256
Girişin SHA-256 özetini hesaplar ve options
nesnesi farklı bir çıkış kodlaması belirtmedikçe base64'te kodlanmış özetle bir geri çağırma yapar.
Ö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 | Karması 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ıda sha256 için yerel destek 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 Optional options nesnesi. Belirtilirse nesne, base64 veya hex değerlerinden biriyle 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
Ö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, dizeleri base64 temsili olacak şekilde 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
Geçerli etkinliğin ve tetiklediği tüm etiketlerin işlenmesi tamamlandıktan (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üncellemesini aktarır. Güncellemenin, veri katmanında sıraya alınmış öğelerden önce bu kapsayıcıda işlenmesi 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'
özelliklerinden 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 "verildi" veya "reddedildi" olarak ayarlanabilir. "granted" (verildi) dışındaki değerler "denied" [reddedildi] olarak değerlendirilir. Değerin "undefined" 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 alınmış JavaScript testleriyle çalışır. Bu test API'leri için require()
ifadesi gerekmez. Özel şablon testleri hakkında daha fazla bilgi
assertApi
Belirli bir API hakkında akıcı ş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. Onaylama hatası, testi hemen durdurur ve başarısız olarak işaretler. 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 bir | Akıcı kontrollerde kullanılacak değer. |
opt_message |
dize | Onaylama başarısız olursa yazdırılacak isteğe bağlı mesaj. |
Eşleştiriciler
Eşleştirici | Açıklama |
---|---|
isUndefined() |
Konunun undefined olduğunu iddia ediyor. |
isDefined() |
Konunun undefined olmadığı iddia ediliyor. |
isNull() |
Konunun null olduğunu iddia ediyor. |
isNotNull() |
Konunun null olmadığı iddia ediliyor. |
isFalse() |
Konunun false olduğunu iddia ediyor. |
isTrue() |
Konunun true olduğunu iddia ediyor. |
isFalsy() |
Konunun yanlış olduğunu iddia eder. Yanlış değerler undefined , null , false , NaN , 0 ve '' (boş dize) şeklindedir. |
isTruthy() |
Konunun doğru olduğunu iddia eder. Yanlış 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 Sonsuz dışında herhangi bir değer olduğunu iddia eder. |
isEqualTo(expected) |
Konunun verilen değere eşit 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 yinelemeli olarak karşılaştırılır. |
isNotEqualTo(expected) |
Konunun verilen değere eşit olmadığını 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 yinelemeli olarak karşılaştırılır. |
isAnyOf(...expected) |
Konunun verilen değerden birine eşit 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 yinelemeli olarak karşılaştırılır. |
isNoneOf(...expected) |
Konunun verilen değerlerin hiçbirine eşit olmadığını 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 yinelemeli olarak karşılaştırılır. |
isStrictlyEqualTo(expected) |
Konunun belirtilen değere (=== ) kesinlikle eşit olduğunu iddia eder. |
isNotStrictlyEqualTo(expected) |
Konunun verilen değere tam olarak 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 bu değere eşit olduğunu iddia eder. |
isLessThan(expected) |
Konunun sıralı 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 bu değere eşit olduğunu iddia eder. |
contains(...expected) |
Konunun verilen değerlerin tümü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çerikleri, yinelemeli olarak karşılaştırılır. |
doesNotContain(...expected) |
Konunun belirtilen değerlerin 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 yinelemeli olarak karşılaştırılır. |
containsExactly(...expected) |
Konunun, belirtilen tüm değerleri herhangi bir sırada içeren ve başka hiçbir değer içermeyen bir dizi 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, yinelemeli olarak karşılaştırılır. |
doesNotContainExactly(...expected) |
Konunun, herhangi bir sırada belirtilen değerlerden farklı bir değer grubuna sahip bir dizi 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 yinelemeli olarak karşılaştırılır. |
hasLength(expected) |
Konunun 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 olduğunu iddia eder (uzunluk = 0). 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() |
Konu türünün dizi olduğunu iddia eder. |
isBoolean() |
Konu türünün boole olduğunu iddia eder. |
isFunction() |
Konu türünün işlev olduğunu iddia eder. |
isNumber() |
Konu türünün bir sayı olduğunu iddia eder. |
isObject() |
Öznenin türünün 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 test 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 yürütülmeden ö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 bir | API için döndürülecek değer veya API'nin yerine çağrılan bir işlev. returnValue bir işlevse bu işlev Sandboxed API'nin yerine çağrılır; returnValue bir işlev dışında bir şeyse Sandboxed API'nin yerine söz konusu 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ş veri 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'});