Temel API'ler
Bu API'ler, Google'da özel şablonlar oluşturmak için korumalı alana alınmış JavaScript ile çalışır
Etiket Yöneticisi. Her API, bir require()
ifadesiyle eklenir. Örneğin:
const myAPI = require('myAPI');
addConsentListener
Belirtilen izin durumu olduğunda yürütülecek bir işleyici işlevi kaydeder türü değişiklikleridir.
Belirtilen işleyici, belirtilen durum için her seferinde çağrılır "reddedildi" olan izin türü "verildi" veya "verildi" olan izin türü "reddedildi" olarak değişir. İzin türü olmayan bir tür, verilmiş olarak kabul edilir. Böylece "ayarlanmadı" durumunda, izin türünün "verildi" olarak güncellenmesini sağlayın. Dinleyici işlevleri kontrol edilecek ne kadar süreceğini test etmektir.
Ö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 dinleyecek izin türü. |
listener |
işlev | Belirtilen izin türünün durumu şu olduğunda çalıştırılacak işlev: anlamına gelir. |
Bir dinleyici çağrıldığında, o anda geçerli olan izin türü ve bu izin türünün yeni değeri:
Parametre | Tür | Açıklama |
---|---|---|
consentType |
dize | Değiştirilen izin türü. |
granted |
boole | Belirtilen izin türü değiştirilirse doğru olan boole değeri olarak kabul edilir. |
İlişkilendirilmiş izinler
İzin türü için okuma erişimiyle access_consent
izni.
addEventCallback
addEventCallback
API, şunu yapacak bir geri çağırma işlevi kaydetmenize olanak tanır:
bir etkinliğin sonunda çağrılması gerekir. Tüm
etkinlik etiketleri yürütülürse veya bir sayfa içi etkinlik zaman aşımına ulaşılırsa.
Geri çağırma iki değer iletir:
işlevi ve etkinlikle ilgili bilgileri içeren bir nesne içerir.
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 verisi nesneleri dizisi. Etkinlik sırasında tetiklenen her etiket
bu dizide bir giriş olacaktır. Etiket veri nesnesi,
etiketin kimliği (id ), yürütme durumu
(status ) ve yürütme zamanı
(executionTime ). Etiket verileri,
etiket meta verileri için geçerlidir. |
Örnek
addEventCallback(function(ctid, eventData) {
logToConsole('Tag count for container ' + ctid + ': ' + eventData['tags'].length);
});
İlişkilendirilmiş izinler
aliasInWindow
aliasInWindow
API'si, takma ad (ör. window.foo =
window.bar
) oluşturmanıza olanak tanıyarak takma ad gerektiren belirli etiketlerin desteklenmesini sağlar. Atamalar
fromPath
konumundaki window
nesnesindeki değer
toPath
konumunda window
nesne var. Başarılı olursa true
değerini döndürür, false
aksi takdirde.
Söz dizimi
aliasInWindow(toPath, fromPath)
Parametreler
Parametre | Tür | Açıklama |
---|---|---|
toPath |
dize | window nesnesine giden noktayla ayrılmış bir yol; burada bir değer
öğesine kopyalanması gerekir. Son bileşene kadar yoldaki tüm bileşenler
window nesnesinde zaten bulunmalıdır. |
fromPath |
dize | Kopyalanacak değerin window alanıyla, noktayla ayrılmış yol. Eğer
değer yoksa 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 gerektiriyor, fromPath
için okuma erişimi gerekiyor.
callInWindow
Bir politika içinde, window
nesnesinin dışındaki bir yoldan işlev çağırmanıza izin verir
bir şekilde kontrol edilir. window
işlevinde verilen yolda işlevi verilen
bağımsız değişkenlerini kullanır ve değeri döndürür. İade türü doğrudan
korumalı alana alınmış JavaScript'te desteklenen bir tür olursa undefined
döndürülür. İlgili içeriği oluşturmak için kullanılan
korumalı alana alınan JavaScript'te desteklenen sekiz tür şunlardır: null
, undefined
,
boolean
, number
, string
, Array
, Object
ve function
. Verilen
yolu mevcut değilse veya bir işleve başvuruda bulunmuyorsa undefined
,
geri döndü.
Söz dizimi
callInWindow(pathToFunction, argument [, argument2,... argumentN])
Parametreler
Parametre | Tür | Açıklama |
---|---|---|
pathToFunction |
dize | window hücresindeki işlevin noktayla ayrılmış yolu
çağrısına bir tıklama URL'si eklemeniz gerekir. |
args |
* | İşleve geçirilecek bağımsız değişkenlerdir. |
İlişkilendirilmiş izinler
execute
izni etkin olan access_globals
.
callLater
Bir işleve eşzamansız olarak gerçekleşecek bir çağrı planlar. Fonksiyon
çağrılması gerekir. Bu,
setTimeout(<function>, 0)
Söz dizimi
callLater(function)
Parametreler
Parametre | Tür | Açıklama |
---|---|---|
function |
işlev | Çağrılacak işlev. |
copyFromDataLayer
Veri katmanında belirtilen anahtara şu anda atanmış olan değeri döndürür:
temel tür, işlev veya nesne olduğunda belirtilen anahtarda bulunan değer
değişmez, aksi halde undefined
değerini alır.
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ı veriler katman sürümü ekleyin. Varsayılan değer 2'dir. Bu nedenle, 1 değerini kullanın. |
İlişkilendirilmiş izinler
copyFromWindow
window
nesnesinden bir değişkeni kopyalar. window
alanındaki değer
doğrudan korumalı alana alınmış JavaScript'te desteklenen bir türle eşlendiğinde, undefined
geri döndü. Korumalı alana sahip JavaScript'te desteklenen sekiz tür şunlardır: null
,
undefined
, boolean
, number
, string
, Array
, Object
ve function
.
Getirilen (ve zorlanan) değeri döndürür.
Söz dizimi
copyFromWindow(key)
Parametreler
Parametre | Tür | Açıklama |
---|---|---|
key |
dize | window içindeki anahtar, değerini kopyalayacak. |
İlişkilendirilmiş izinler
createArgumentsQueue
Etiketi desteklemek amacıyla bağımsız değişken nesneleriyle doldurulan bir sıra oluşturur çözümler geliştirir.
fnKey
bağımsız değişkenini kullanarak genel kapsamda bir işlev (ör. window
) oluşturur
(createQueue
ile aynı anlamlar). İşlev oluşturulduktan sonra bu API,
arrayKey
öğesini kullanarak window
içinde bir dizi oluşturur (zaten yoksa)
bağımsız değişkeninin önüne geçer.
fnKey
altında oluşturulan işlev çağrıldığında, bağımsız değişkenlerini aktarır
nesnesini arrayKey
altında oluşturulan diziye ekleyin. API'nin döndürdüğü değer
işlevi fnKey
altında oluşturulmuştur.
Bu işlev, şurada fnKey
ve arrayKey
için okuma ve yazma ayarını gerektirir:
access_globals
izni.
Örnek:
const gtag = createArgumentsQueue('gtag', 'dataLayer');
gtag('set', {'currency': 'USD'});
Söz dizimi
createArgumentsQueue(fnKey, arrayKey)
Parametreler
Parametre | Tür | Açıklama |
---|---|---|
fnKey |
dize | Varsa, window içinde işlevin ayarlandığı yol
zaten mevcut değil. Bu bağımsız değişken standart nokta gösterimini destekler. Öğe
anahtarın yolu mevcut değilse bir istisna oluşur. Yani,
fnKey 'one.two' . Şu yayını atacak:
kabul edersiniz. |
arrayKey |
dize | Ayarlanmadıysa window alanında dizinin ayarlandığı yol
zaten mevcut. Bu bağımsız değişken standart nokta gösterimini destekler. Öğe
anahtarın yolu mevcut değilse bir istisna oluşur. Yani,
arrayKey 'one.two' ve yok
'one' adlı global nesne bir araya getirildiğinde
kabul edersiniz. |
İlişkilendirilmiş izinler
createQueue
window
içinde bir dizi oluşturur (mevcut değilse) ve
fonksiyonudur.
Bu işlev şurada arrayKey
için okuma ve yazma ayarını gerektirir:
access_globals
izni.
Örnek:
const dataLayerPush = createQueue('dataLayer');
dataLayerPush({'currency': 'USD'}, {'event': 'myConversion'});
Söz dizimi
createQueue(arrayKey)
Parametreler
Parametre | Tür | Açıklama |
---|---|---|
arrayKey |
dize | Ayarlanmadıysa window alanında dizinin ayarlandığı anahtar
zaten mevcut. Bu bağımsız değişken standart nokta gösterimini destekler. Öğe
anahtarın yolu mevcut değilse bir istisna oluşur. Örneğin,
arrayKey 'one.two' ve yok
'one' adlı global nesne bir araya getirildiğinde
kabul edersiniz. |
İlişkilendirilmiş izinler
decodeUri
Sağlanan URI'daki kodlanmış karakterlerin kodunu çözer. Şu dizeyi döndürür: dize
kodu çözülmüş URI'yı temsil eder. Geçersiz değer sağlandığında undefined
değerini döndürür
giriş.
Ö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 | Aşağıdakiler tarafından kodlanan bir URI
encodeUri()
başka yollarla bilgilendirilmez. |
İlişkilendirilmiş izinler
Yok.
decodeUriComponent
Sağlanan URI bileşenindeki kodlanmış karakterlerin kodunu çözer. Şunu döndürür:
string (dize kodu çözülmüş URI bileşenini temsil eder). Şu durumda undefined
değerini döndürür:
geçersiz giriş sağlandı.
Ö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 | Aşağıdakiler tarafından kodlanan bir URI bileşeni:
encodeUriComponent()
başka yollarla bilgilendirilmez. |
İlişkilendirilmiş izinler
Yok.
encodeUri
Özel çıkış yaparak kodlanmış Tekdüzen Kaynak Tanımlayıcısı (URI) döndürür.
karakteri ekleyin. Aşağıdaki şekilde kodlanmış, sağlanan dizeyi temsil eden bir dize değerini döndürür:
URI'dır. Geçersiz giriş (tek vekil) 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 URI. |
İlişkilendirilmiş izinler
Yok.
encodeUriComponent
Özel çıkış yaparak kodlanmış Tekdüzen Kaynak Tanımlayıcısı (URI) döndürür.
karakteri ekleyin. Aşağıdaki şekilde kodlanmış, sağlanan dizeyi temsil eden bir dize değerini döndürür:
URI'dır. Geçersiz giriş (tek vekil) 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'nın bir bileşeni. |
İlişkilendirilmiş izinler
Yok.
fromBase64
fromBase64
API, base64 dizelerinin kodunu çözmenizi sağlar
temsil eder. Geçersiz giriş 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 içinde 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 verileri içeren bir nesne döndürür. Döndürülen nesnesi aşağıdaki alanları içerir:
{
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
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 çözülüp çözülmeyeceğini kontrol eder
JavaScript'in
decodeURIComponent() değerleridir. Varsayılan değer:
true |
İlişkilendirilmiş izinler
getQueryParameters
Geçerli URL'nin queryKey
parametresi için ilk veya tüm parametreleri döndürür.
queryKey
veya içinden bir değerler dizisindeki ilk değeri döndürür
queryKey
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, geçerli URL
https://example.com/path?var=foo&var1=foo1&var=foo2&var=foo
, ardından:
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 içinde queryKey
belirtmelidir
izin verilen sorgu anahtarlarını tıklayın (veya herhangi bir sorgu anahtarına izin verin.)
getReferrerQueryParameters
getReferrerQueryParameters
API, getQueryParameters
ile aynı şekilde çalışır.
ancak geçerli URL yerine yönlendirene göre hareket eder. İlk veya sonraki
belirtilen yönlendirenin queryKey
parametresine ait tüm parametreler. İlk
queryKey
içindeki değer veya queryKey
içindeki bir değerler dizisi.
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
, ardından:
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
İzin verilen sorgu anahtarlarında queryKey
(veya herhangi bir sorgu anahtarına izin verin.)
getReferrerUrl
Bileşen türü verildiğinde API, yönlendiren için belge nesnesini okur ve yönlendirenin bir bölümünü temsil eden bir dize döndürür. Hiçbir bileşen belirtildiğinde, 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. Aşağıdakilerden biri olabilir:
protocol , host , port ,
path , query , extension . Eğer
component , undefined , null veya
bu bileşenlerden biriyle eşleşmezse URL'nin tamamı
geri döndü. |
İlişkilendirilmiş izinler
get_referrer
, query
bileşenine izin vermeli ve
İzin verilen sorgu anahtarlarında queryKey
(veya herhangi bir sorgu anahtarına izin verin.)
getTimestamp
Kullanımdan kaldırıldı. getTimestampMillis'i tercih edin.
Unix'ten bu yana geçen geçerli süreyi milisaniye cinsinden temsil eden sayı değerini döndürür
dönem, Date.now()
tarafından döndürülen tarih.
Söz dizimi
getTimestamp();
İlişkilendirilmiş izinler
Yok.
getTimestampMillis
Unix'ten bu yana geçen geçerli süreyi milisaniye cinsinden temsil eden sayı değerini döndürür
dönem, Date.now()
tarafından döndürülen tarih.
Söz dizimi
getTimestampMillis();
İlişkilendirilmiş izinler
Yok.
getType
Belirli bir değerin türünü açıklayan dize değerini döndürür. typeof
'in aksine,
getType
, array
ile object
arasındaki değerleri ayırt eder.
Söz dizimi
getType(data.someField)
Notlar
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" |
null |
"null" |
true |
"boole" |
12 |
"number" |
'string' |
"dize" |
{ a: 3 } |
"nesne" |
[ 1, 3 ] |
"dizi" |
(x) => x + 1 |
"fonksiyon" |
İlişkilendirilmiş izinler
Yok.
getUrl
Belirtilen URL'ye göre geçerli URL'nin tamamını veya bir kısmını temsil eden bir dize değerini döndürür bileşen türünü ve bazı yapılandırma parametrelerini içerir.
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 ise
null veya bu bileşenlerden biriyle eşleşmeyen
href değerinin tamamı döndürülür. |
İlişkilendirilmiş izinler
gtagSet
Veri katmanına bir gtag set komutu aktarıp hemen işlenmek üzere olası etkinlik ve bunun tetiklediği tüm etiketler tamamlandıktan sonra olduğunda (veya etiket işleme zaman aşımına ulaşıldığında). Güncelleme garanti edilir veri katmanında sıraya alınmış öğelerden önce bu kapsayıcıda işlenecek sıra.
Örneğin, İzin Başlatma sırasında tetiklenen bir etiket tarafından çağrılırsa
güncelleme, Başlatma etkinliği işlenmeden önce uygulanır. Örnekler
ads_data_redaction
değeri, true
veya false
ya da url_passthrough
olarak ayarlanır.
true
veya false
olarak ayarlanıyor.
Ö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 |
nesne | Kapsayıcı özellikleri için genel durumu güncelleyen bir nesne. |
İlişkilendirilmiş izinler
write_data_layer
, tümü için dataLayer
öğesine yazma iznini kontrol ediyor
belirtilen anahtarları kullanın. gtagSet
girişi düz nesneyse API bunu kontrol eder
Bu nesnenin içindeki tüm düzleştirilmiş anahtarlara yazma izni (ör. şunun için:
gtagSet({foo: {bar: 'baz'}})
, API yazma olup olmadığını kontrol edecek
foo.bar
izni.
gtagSet
girdisi bir anahtar ve düz olmayan bir nesne değeriyse API
bu anahtara yazma izni olup olmadığını kontrol edin, ör. gtagSet('abc', true)
için,
API, 'abc'
öğesine yazma iznini kontrol edecek.
Giriş nesnesinde bir döngü varsa yalnızca emin olun.
injectHiddenIframe
Sayfaya görünmez bir iframe ekler.
Geri çağırmalar işlev örnekleri olarak verilir ve JavaScript'te sarmalanır işlevleridir.
Söz dizimi
injectHiddenIframe(url, onSuccess)
Parametreler
Parametre | Tür | Açıklama |
---|---|---|
url |
dize | iframe'in src değeri olarak kullanılacak URL
özelliğini gönderin. |
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. İlgili içeriği oluşturmak için kullanılan geri çağırmalar işlev örnekleri olarak verilir ve JavaScript'te sarmalanır işlevleridir.
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. Eğer
değeri belirtildiğinde, veri tabanı için yalnızca bir komut dosyası öğesi
JavaScript'i isteyin. Başka yükleme denemeleri durumunda
belirtilen onSuccess ve onFailure yöntemleri
beklemeye alınır. |
İlişkilendirilmiş izinler
isConsentGranted
Belirtilen izin türü verilirse true değerini döndürür.
Belirli bir izin türü için izin, söz konusu rızanın type "granted" (izin verildi) olarak ayarlandı veya hiç ayarlanmamış olabilir. İzin türü verilmemiş olarak kabul edilecek diğer tüm değerler.
Etiket ayarlarının Etiket Yöneticisi kullanıcı arayüzünde,
etkinleşir. Her zaman etkin durumdaki bir etiket bu API'yi kullanıyorsa izin,
verildi ve true
, gerçek izin durumundan bağımsız olarak 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, değeri veya nesneyi oluşturmak için bir JSON dizesini ayrıştırır.
dizeyle açıklanır. Değer ayrıştırılamıyorsa (ör. bozuk JSON),
işlev undefined
değerini döndürür. Giriş değeri bir dize değilse
girdi dizeye dönüştürülür.
stringify()
işlevi, girişi bir JSON dizesine dönüştürür. Değer
ayrıştırılamıyorsa (ör. nesnenin bir döngüsü varsa) yöntem,
undefined
Söz dizimi
JSON.parse(stringInput)
JSON.stringify(value);
Parametreler
JSON.parse
Parametre | Tür | Açıklama |
---|---|---|
stringInput | herhangi biri | Dönüştürülecek değer. Değer bir dize değilse giriş dizeye dönüştürülü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 depolama alanına erişim yöntemleri içeren bir nesneyi 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 biri | Bağımsız değişkenler |
İlişkilendirilmiş izinler
makeInteger
Belirtilen değeri bir sayıya (tam sayı) 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
Verilen 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
biçimine dönüştürür. Bu,
iki sütunlu bir SIMPLE_TABLE
şablon alanını daha yönetilebilir bir hale getirmek
biçimindedir.
Örneğin, bu işlev bir tablo nesnesini dönüştürebilir:
[
{'key': 'k1', 'value': 'v1'},
{'key': 'k2', 'value': 'v2'}
]
aşağıdakileri yapabilirsiniz:
{
'k1': 'v1',
'k2': 'v2'
}
Bir Nesne döndürür: Map
girin veya null
.
Söz dizimi
makeTableMap(tableObj, keyColumnName, valueColumnName)
Parametreler
Parametre | Tür | Açıklama |
---|---|---|
tableObj |
Listele | Dönüştürülecek tablo nesnesi. Her birinin
Map , tablodaki bir satırı temsil eder.
satır nesnesi sütun adı, özellik değeri ise sütundur.
değerini girin. |
keyColumnName |
dize | Değerleri dönüştürülen sütunda anahtara dönüşecek olan sütunun adı
Map |
valueColumnName |
dize | Değerleri dönüştürülen sütunda değerlere dönüşecek sütunun adı
Map |
İ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öntemleri sağlayan bir nesneyi döndürür.
keys()
yöntemi, Standart Kitaplık Object.keys()'i sağlar
gösterir. Belirli bir nesnenin kendi numaralandırılabilir özelliğinin bir dizisini döndürür
adları for...in...
döngüsüyle aynı sırayla gösterilmiştir. Giriş değeri
bir nesneye geçmeye zorlanır.
values()
yöntemi, Standart Kitaplık Object.values() öğesini sağlar
gösterir. Belirli bir nesnenin kendi numaralanabilir özellik değerleri dizisini döndürür
aynı sırayla bir for...in...
döngüsüne sahip olabilir. Giriş değeri
bir nesneye geçmeye zorlanır.
entries()
yöntemi, Standart Kitaplık Object.entries() öğesini sağlar
gösterir. Belirli bir nesnenin kendi numaralandırılabilir özelliğinin bir dizisini döndürür
[key, value]
, bir for...in...
döngüsüyle aynı sırada eşlenir. Öğe
girdi değeri bir nesne değil, bir nesneye dönüştürülür.
freeze()
yöntemi, Standart Kitaplık Object.freeze()'i sağlar
gösterir. Donmuş bir nesne artık değiştirilemez; bir nesnenin dondurulması,
veya mevcut mülklerin kaldırılmasını ya da
ve mevcut özelliklerin değerlerinin değiştirilmesini engeller. freeze()
şunu döndürür:
ele alacağız. Temel veya boş bağımsız değişken olarak
geri döner ve donmuş bir nesne olursa döndürülür.
delete()
yöntemi, Standart Kitaplık silme operatörünü sağlar
gösterir. Nesne donmadığı sürece belirtilen anahtarı nesneden kaldırır.
Standart Kitaplık silme operatörü gibi, ilk girişse true
değerini döndürür
değer (objectInput
), ikinci giriş olsa bile donmayan bir nesnedir
değeri (keyToDelete
) mevcut olmayan bir anahtarı belirtiyor. Şu kadar süre içinde false
döndürür:
durumlardan biridir. Ancak bu, Standart Kitaplık silme operatöründen farklıdır
aşağıdaki şekillerde kullanabilirsiniz:
keyToDelete
, iç içe yerleştirilmiş bir anahtar belirten ve noktayla ayrılmış bir dize olamaz.delete()
, bir diziden öğe kaldırmak için kullanılamaz.delete()
, herhangi bir mülkü global kapsamdan 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 biri | Anahtarlarının numaralandırılacağı nesne. Giriş bir nesne değilse zorlamaya zorlanır. |
Object.values
Parametre | Tür | Açıklama |
---|---|---|
objectInput | herhangi biri | Değerleri numaralandırılacak nesne. Giriş bir nesne değilse bir nesneye geçmeye zorlanır. |
Object.entries
Parametre | Tür | Açıklama |
---|---|---|
objectInput | herhangi biri | Anahtar/değer çiftleri numaralandırılacak nesne. Giriş bir bir nesneye geçmeye zorlanır. |
Object.freeze
Parametre | Tür | Açıklama |
---|---|---|
objectInput | herhangi biri | Dondurulacak nesne. Giriş bir nesne değilse bu, donmuş bir nesne olarak değerlendirilir. |
Object.delete
Parametre | Tür | Açıklama |
---|---|---|
objectInput | herhangi biri | 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
Aşağıdakine benzer şekilde, belirli bir URL'nin bileşen parçalarının tümünü içeren bir nesneyi döndürür:
URL
nesnesini tanımlayın.
Bu API, hatalı oluşturulmuş URL'ler için undefined
değerini döndürür. Düzgün biçimlendirme için
URL'ler için, URL dizesinde bulunmayan alanlar boş dize değerine sahip olur
veya searchParams
durumunda boş bir nesne olarak görünür.
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 boole değeri döndürür: true
için izin verilmez. Aksi takdirde 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şir. Görüntüleyin İşlev Bağımsız Değişkenleri'ni inceleyin. |
İşlev Bağımsız Değişkenleri
sendPixel
, injectScript
, injectHiddenIframe
: İkinci parametre
bir URL dizesi olmalıdır.
writeGlobals
, readGlobals
: İkinci parametre,
görüntülenebilir.
readUrl
: Tamamının
URL okunabiliyor. Belirli bir bileşenin okunup okunamayacağını sorgulamak için
bileşen adını kullanın:
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:
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. Bir işlev veya nesne döndürür temel bir numara. Tarayıcı, şu durumlarda undefined değerini döndürür yerleşik işlevi desteklemiyor.
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: bir resim sağlayabilmek için tarayıcının doğru bir resim yanıtı başarılı bir şekilde çalıştırmanız gerekir. |
onFailure |
işlev | Piksel yüklenemediğinde çağrılır. Not: sunucu bir kod döndürmezse onFailure çalışabilir. geçerli bir resim yanıtı ekleyin. |
İlişkilendirilmiş izinler
setCookie
Belirtilen ada, değere ve seçeneklere sahip ç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 |
nesne | Alan, Path, Expiration, Max-Age, Secure ve SameSite özellikleri. (Aşağıdaki Seçenekler'e bakın.) |
encode |
boole | Çerez değerinin
JavaScript'in
encodeURIComponent() .
Varsayılan olarak true değerine ayarlanır. |
- Alan adı: Varsa
options['domain']
mülkü tarafından belirlenir. Bu değeri ayarla Çerezi mümkün olan en geniş alan adını kullanarak yazmayı denemek için'auto'
adresine farklı olabilir. Başarısız olursa sırayla tekrar denenecek daha dar alt alan adları kullanır. Bunların hiçbiri başarısız olursa çerezi yazmaya çalışır. alan olmadan. Herhangi bir değer ayarlanmazsa bu işlem çerezi yazmaya çalışır alan adı belirtilmemiş. Not: Alan adı belirtilmemiş bir çerezdocument.cookie
adresine yazıldığında, kullanıcı aracısı varsayılan olarak çerezin alan adını belirler ana makine konumuna taşıma işlemini gerçekleştirebilirsiniz. - Yol: Varsa
options['path']
tarafından ayarlanır. Yolu olmayan bir çerezdocument.cookie
operatörüne yazıldığında kullanıcı aracısı varsayılan olarak yolunu belirtmek için kullanılır. - Max-Age (Maksimum Yaş): Varsa
options['max-age']
tarafından belirlenir. - Geçerlilik sonu: Varsa
options['expires']
tarafından belirlenir. Varsa UTC biçiminde bir tarih dizesi olmalıdır.Date.toUTCString()
, aşağıdaki biçimi biçimlendirmek için kullanılabilir: Bu parametre içinDate
. - Güvenli: Varsa
options['secure']
tarafından ayarlanır. - SameSite: Varsa
options['samesite']
tarafından ayarlanır.
İlişkilendirilmiş izinler
setDefaultConsentState
Veri katmanına, varsayılan izin güncellemesini aktararak en kısa sürede işlenmesini sağlar olası etkinlik ve bunun tetiklediği tüm etiketler tamamlandıktan sonra olduğunda (veya etiket işleme zaman aşımına ulaşıldığında). Güncelleme garanti edilir veri katmanında sıraya alınmış öğeden önce bu kapsayıcıda işlenecek. İ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 |
nesne | Belirtilen izin için varsayılan durumu tanımlayan bir nesne bulunur. |
consentSettings
nesnesi, rastgele izin türü dizelerinin
'granted'
veya 'denied'
seçeneklerinden biri. Aşağıdaki değerleri destekler:
Anahtar Adı | Tür | Açıklama |
---|---|---|
consentType |
dize | Her izin türünün değeri "granted" veya "denied" olarak ayarlanabilir. "granted" dışındaki değerler "denied" olarak değerlendirilir. Ayar "tanımsız" olarak belirlediğiniz değerin önceki değeri üzerinde herhangi bir etkisi olmayacaktır. |
region |
Dizi | Bölgenin hangi bölgeye ait olduğunu belirten isteğe bağlı bir bölge izin ayarlarının geçerli olmasını sağlayın. Bölge kodları ülke kullanılarak ifade edilir ve/veya alt bölümler dahildir. |
wait_for_update |
sayı | Veriler kaybolmadan önce ne kadar bekleneceğini kontrol etmek için bir milisaniye değeri belirtir. gönderilir. Eşzamansız olarak yüklenen izin araçlarıyla kullanılır. |
İlişkilendirilmiş izinler
Şuradaki tüm izin türleri için yazma erişimiyle access_consent
izni:
ConsentSettings nesnesi.
setInWindow
Verilen anahtarda window
öğesinde verilen değeri ayarlar. Bu yöntem varsayılan olarak
halihazırda bir değer varsa window
öğesindeki değeri ayarlayın. Ayarla
window
içindeki değeri ayarlamak için overrideExisting
- true
bir değer olacaktır. boole: Değer şu şekildeyse true
döndürür:
başarıyla ayarlandı, aksi halde false
.
Söz dizimi
setInWindow(key, value, overrideExisting)
Parametreler
Parametre | Tür | Açıklama |
---|---|---|
key |
dize | window içinde değerin yerleştirileceği anahtar. |
value |
* | window içinde ayarlanacak değer. |
overrideExisting |
boole | Değerin window içinde ayarlanması gerektiğini gösteren işaret
burada bir değer olup olmadığına bakılmaz. |
İlişkilendirilmiş izinler
sha256
Girişin SHA-256 özetini hesaplar ve
options
nesnesi farklı bir değer belirtmedikçe, base64'te kodlanmış özet
çıkış kodlaması.
Ö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ı belirtiyor. |
onFailure |
işlev | Özet hesaplanırken bir hata oluşursa veya tarayıcı sha256 için yerel destek sunmuyor. Geri çağırmaya hatanın adını ve iletiyi içeren bir nesne ile birlikte kullanılır. |
options |
nesne | Çıkış kodlamasını belirtmek için kullanılan İsteğe bağlı seçenekler nesnesi. Eğer
belirtildiğinde, nesne outputEncoding anahtarını içermelidir
base64 veya hex değerine sahip olmalıdır. |
İlişkilendirilmiş izinler
Yok.
templateStorage
Şablon depolama alanına erişim yöntemleri içeren bir nesneyi döndürür. Şablon Storage, verilerin tek bir şablonun yürütme işlemleri arasında paylaşılmasına olanak tanır. Veri sayfa ömrü boyunca saklanı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'si, bir dizeyi base64 gösterimi 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
Bir izin güncellemesini mümkün olan en kısa sürede işlenmek üzere veri katmanına aktarır ve bunun tetiklediği tüm etiketlerin işlenmesi tamamlandıktan sonra (veya etiket işleme zaman aşımına ulaşıldığından). Güncellemenin veri katmanında sıraya alınmış öğeden önce bu kapsayıcıda işlenir. Daha fazla bilgi göz önünde bulundurun.
Ö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 |
nesne | Belirtilen izin türleri için durumu güncelleyen bir nesne. |
consentSettings
nesnesi, rastgele izin türü dizelerinin
'granted'
veya 'denied'
seçeneklerinden biri. 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) olarak ayarlanabilir veya 'reddedildi'. "granted" dışındaki herhangi bir değer "reddedildi" olarak değerlendirilir. Ayar değeri "undefined" olarak değiştirin önceki değeri üzerinde herhangi bir etkisi olmaz. |
İlişkilendirilmiş izinler
Şuradaki tüm izin türleri için yazma erişimiyle access_consent
izni:
ConsentSettings nesnesi.
API'leri test et
Bu API'ler, özel verilere yönelik testler oluşturmak üzere korumalı alana alınmış JavaScript testleriyle çalışır
Google Etiket Yöneticisi'ndeki şablonlar. Bu test API'leri için require()
gerekmez
ifade eder. Özel şablon testleri hakkında daha fazla bilgi edinin.
assertApi
görebilirsiniz.
Söz dizimi
assertApi(apiName)
Parametreler
Parametre | Tür | Açıklama |
---|---|---|
apiName |
dize | Kontrol edilecek API'nin adı; iletilecek dizeyle aynı
require() .
|
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. Şunun bir değerini döndürür:
bir öznenin değeri hakkında akıcı bir şekilde iddiada bulunmak için kullanılabilecek nesnedir.
onay hatası, testi anında durdurur ve başarısız olarak işaretler. Ancak,
bir testteki hata 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ı mesaj. |
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() |
Konunun yanlış olduğunu iddia eder. Sahte değerler
undefined , null , false ,
NaN , 0 ve '' (boş dize). |
isTruthy() |
Konunun doğru olduğunu iddia ediyor. Sahte değerler
undefined , null , false ,
NaN , 0 ve '' (boş dize). |
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 Sonsuzluk olduğunu iddia eder. |
isNotInfinity() |
Konunun pozitif veya negatif dışında herhangi bir değer olduğunu iddia eder Sonsuzluk. |
isEqualTo(expected) |
Öznenin verilen değere eşit olduğunu iddia eder. Bu bir değerdir karşılaştırma yapmayın. Nesnelerin ve dizilerin içeriği yinelemeli olarak karşılaştırılır. |
isNotEqualTo(expected) |
Öznenin verilen değere eşit olmadığını iddia eder. Bu, referans karşılaştırması değil, değer karşılaştırmasıdır. Nesnelerin ve yinelemeli olarak karşılaştırılır. |
isAnyOf(...expected) |
Öznenin, verilen değerlerden birine eşit olduğunu iddia eder. Bu, referans karşılaştırması değil, değer karşılaştırmasıdır. Nesnelerin ve yinelemeli olarak karşılaştırılır. |
isNoneOf(...expected) |
Konunun, verilen değerlerin herhangi birine eşit olmadığını iddia eder. Bu referans karşılaştırması değil, değer karşılaştırmasıdır. Nesnelerin içeriği ve diziler yinelemeli olarak karşılaştırılır. |
isStrictlyEqualTo(expected) |
Konunun===
değer. |
isNotStrictlyEqualTo(expected) |
Öznenin tam olarak eşit olmadığını iddia eder (!== )
verilen değer. |
isGreaterThan(expected) |
Konunun belirtilenden (> ) büyük olduğunu iddia eder
değeri için de kullanılabilir. |
isGreaterThanOrEqualTo(expected) |
Konunun şundan büyük veya şuna eşit olduğunu iddia eder:
Sıralı karşılaştırmada belirtilen değer (>= ). |
isLessThan(expected) |
Konunun, belirtilenden (< ) küçük olduğunu iddia eder
değeri için de kullanılabilir. |
isLessThanOrEqualTo(expected) |
Konunun (<= ) değerinden küçük veya ona eşit olduğunu iddia eder
sıralı karşılaştırmada verilen değer. |
contains(...expected) |
Konunun, şunların tümünü içeren bir dizi veya dize olduğunu iddia eder gösterilen değerleri herhangi bir sırada gösterir. Bu bir referans değil, değer karşılaştırmasıdır isteyebilirsiniz. Nesnelerin ve dizilerin içerikleri karşılaştırılır yinelemeli olarak. |
doesNotContain(...expected) |
Konunun, aşağıdakilerden hiçbirini içermeyen bir dizi veya dize olduğunu iddia eder anlamına gelir. Bu bir referans karşılaştırması değil, değer karşılaştırmasıdır. Nesnelerin ve dizilerin içerikleri yinelemeli olarak karşılaştırılır. |
containsExactly(...expected) |
Konunun, verilen tüm öğeleri içeren bir dizi olduğunu iddia eder herhangi bir sırada olan ve başka hiçbir değer içermeyen. Bu bir değer karşılaştırmasıdır, referans karşılaştırması yapabilirsiniz. Nesnelerin ve dizilerin içerikleri karşılaştırılır yinelemeli olarak. |
doesNotContainExactly(...expected) |
Konunun, farklı bir küme içeren bir dizi olduğunu iddia eder sayısındaki değerleri ifade eder. Bu bir değer karşılaştırmasıdır. bir referans karşılaştırması değildir. Nesnelerin ve dizilerin içerikleri yinelenen bir şekilde 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 onay her zaman başarısız olur. |
isEmpty() |
Konunun boş bir dizi veya dize olduğunu iddia eder (uzunluk = 0) gösterilir. Onaylama, değer bir dizi değilse veya dize. |
isNotEmpty() |
Konunun boş olmayan bir dizi veya dize olduğunu iddia eder (uzunluk > 0). Değer bir dizi değilse onay işlemi her zaman başarısız olur veya dize. |
isArray() |
Konu türünün bir dizi olduğunu iddia eder. |
isBoolean() |
Konu türünün boole olduğunu iddia eder. |
isFunction() |
Özne türünün bir fonksiyon olduğunu iddia eder. |
isNumber() |
Özne türünün bir sayı olduğunu iddia eder. |
isObject() |
Özne 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 test hemen başarısız olur ve sağlanmışsa verilen 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. Model
API, şablon kodunda güvenle kullanılabilir ancak yalnızca test modunda çalışır.
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 | Örnek alınacak API'nin adı; iletilecek dizeyle aynı
require() |
returnValue |
herhangi biri | API için döndürülecek değer veya
API'ye gidin. returnValue bir fonksiyon ise, bu işlev
Sandboxed API'nin yerine geçer. returnValue başka bir şeyse
değeri Korumalı Alan'ın yerine döndürülür.
API'ye gidin. |
Örnekler
mock('encodeUri', "https://endpoint.example.com/?account=12345");
mock('sendPixel', function(url, onSuccess, onFailure) {
onSuccess();
});
mockObject
mockObject
API, Korumalı Alana Sahip API'lerin davranışını geçersiz kılmanıza olanak tanır.
bir nesne döndürür. API, şablon kodunda güvenle kullanılabilir ancak çalışır durumdadır
yalnızca test modunda kullanın. Her test çalıştırılmadan önce örnekler sıfırlanır.
Söz dizimi
mockObject(apiName, objectMock);
Parametreler
Parametre | Tür | Açıklama |
---|---|---|
apiName |
dize | Örnek alınacak API'nin adı; iletilecek dizeyle aynı
require() |
objectMock |
nesne | API için döndürülecek değer veya API'ye gidin. Bir nesne olmalıdır. |
Örnekler
const storage = {};
mockObject('localStorage', {
setItem: (key, value) => {storage[key] = value;},
getItem: (key) => storage[key],
});
runCode
Şablonun kodunu (ör. Kod sekmesinin içeriğini) mevcut test ortamını temsil eder.
Söz dizimi
runCode(data)
Parametreler
Parametre | Tür | Açıklama |
---|---|---|
data |
nesne | Testte kullanılacak veri nesnesi. |
Döndürülen Değer
Değişken şablonları için bir değişkenin değerini döndürür; şunun için undefined
değerini döndürür:
şablon türünde olması gerekir.
Örnek
runCode({field1: 123, field2: 'value'});