Özel şablon API'leri

Temel API'ler

Bu API'ler, Google Etiket Yöneticisi'nde özel şablonlar oluşturmak için korumalı alanlı JavaScript ile çalışır. Her API, 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 dinleyici, belirtilen izin türünün durumu reddedildi'den verildi'ye veya verildi'den reddedildi'ye her değiştiğinde çağrılır. Durumu olmayan bir izin türü verilmiş olarak kabul edilir. Bu nedenle, ayarlanmamış bir izin türü verilmiş olarak güncellenirse dinleyici çağrılmaz. Dinleyici işlevleri, kodlarının uygun 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

Bir dinleyici çağrıldığında, değiştirilen izin türü ve bu izin türünün yeni değeri dinleyiciye iletilir:

İlişkili izinler

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

addEventCallback

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

Söz dizimi

addEventCallback(callback)

Parametreler

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

Örnek

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

İlişkili izinler

read_event_metadata

aliasInWindow

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

Söz dizimi

aliasInWindow(toPath, fromPath)

Parametreler

Örnek

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

İlişkili izinler

toPath ve fromPath için access_globals gereklidir. toPath için yazma erişimi, fromPath için okuma erişimi gerekir.

callInWindow

Politika kontrollü bir şekilde, window nesnesinin dışındaki bir yoldan işlevleri çağırmanıza olanak tanır. window içinde verilen yoldaki işlevi, verilen bağımsız değişkenlerle çağırır ve değeri döndürür. Dönüş türü, korumalı alan JavaScript'te desteklenen bir türle doğrudan eşlenemiyorsa undefined döndürülür. Korumalı alandaki JavaScript'te desteklenen sekiz tür null, undefined, boolean, number, string, Array, Object ve function'dür. Belirtilen yol yoksa veya bir işlevi referans vermiyorsa undefined döndürülür.

Söz dizimi

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

Parametreler

İlişkili izinler

execute izni etkinleştirilmiş access_globals.

callLater

Bir işlevin eşzamansız olarak çağrılmasını planlar. İşlev, mevcut kod döndürüldükten sonra çağrılır. Bu, setTimeout(<function>, 0) etiketine eş değerdir.

Söz dizimi

callLater(function)

Parametreler

copyFromDataLayer

Veri katmanında belirtilen anahtara şu anda atanmış değeri döndürür: İlkel tür, işlev veya nesne değişmezi ise belirtilen anahtarda bulunan değer, aksi takdirde undefined.

Söz dizimi

copyFromDataLayer(key[, dataLayerVersion])

Parametreler

İlişkili izinler

read_data_layer

copyFromWindow

window nesnesinden bir değişkeni kopyalar. window içindeki değer, doğrudan korumalı alan JavaScript'te desteklenen bir türle eşlenemiyorsa undefined döndürülür. Koruma alanına alınmış 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

İlişkili izinler

access_globals

createArgumentsQueue

Gerekli olan etiket çözümlerini desteklemek için bağımsız değişken nesneleriyle doldurulmuş bir sıra oluşturur.

fnKey bağımsız değişkenini kullanarak (createQueue ile aynı semantik) genel kapsamda (yani 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 oluşturur (daha önce yoksa).

fnKey altında oluşturulan işlev çağrıldığında bağımsız değişkenlerini arrayKey altında oluşturulan diziye gönderir. API'nin dönüş değeri, fnKey altında oluşturulan işlevdir.

Bu işlev için access_globals izninde fnKey ve arrayKey okuma ve yazma ayarının etkin olması gerekir.

Örnek:

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

Söz dizimi

createArgumentsQueue(fnKey, arrayKey)

Parametreler

İlişkili izinler

access_globals

createQueue

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

Bu işlev için arrayKey ayarının access_globals izninde okunması ve yazılması gerekir.

Örnek:

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

Söz dizimi

createQueue(arrayKey)

Parametreler

İlişkili izinler

access_globals

decodeUri

Belirtilen URI'deki kodlanmış karakterlerin kodunu çözer. Kodu çözülmüş URI'yi 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

İlişkili izinler

Yok.

decodeUriComponent

Belirtilen URI bileşenindeki kodlanmış karakterlerin kodunu çözer. Kod çözümü yapılmış URI bileşenini temsil eden bir dize döndürür. Geçersiz giriş sağlandığında undefined döndürülüyor.

Örnek:

const decode = require('decodeUriComponent');

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

Söz dizimi

decodeUriComponent(encoded_uri_component)

Parametreler

İlişkili izinler

Yok.

encodeUri

Özel karakterlerden kaçarak kodlanmış bir Tekdüzen Kaynak Tanımlayıcısı (URI) döndürür. Belirtilen dizenin URI olarak kodlanmış halini temsil eden bir dize döndürür. Geçersiz giriş (yalnız bir yedek karakter) sağlandığında undefined değerini döndürür.

Örnek:

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

Söz dizimi

encodeUri(uri)

Parametreler

İlişkili izinler

Yok.

encodeUriComponent

Özel karakterlerden kaçarak kodlanmış bir Tekdüzen Kaynak Tanımlayıcısı (URI) döndürür. Belirtilen dizenin URI olarak kodlanmış halini temsil eden bir dize döndürür. Geçersiz giriş (yalnız bir yedek karakter) sağlandığında undefined değerini döndürür.

Örnek:

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

Söz dizimi

encodeUriComponent(str)

Parametreler

İlişkili izinler

Yok.

fromBase64

fromBase64 API, dizelerin base64 gösteriminden kodunu çözmenize olanak tanır. Geçersiz giriş sağlandığında undefined değerini döndürür.

Söz dizimi

fromBase64(base64EncodedString)

Parametreler

Örnek

const fromBase64 = require('fromBase64');

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

İlişkili izinler

Yok

generateRandom

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

Söz dizimi

generateRandom(min, max)

Parametreler

İlişkili izinler

Yok.

getContainerVersion

Geçerli kapsayıcıyla ilgili verileri içeren bir nesne döndürür. Döndürülen nesnede aşağıdaki alanlar bulunur:

{
  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şkili izinler

read_container_data

getCookieValues

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

Söz dizimi

getCookieValues(name[, decode])

Parametreler

İlişkili izinler

get_cookies

getQueryParameters

Geçerli URL'nin queryKey parametrelerinin ilkini veya tamamını döndürür. queryKey öğesinden ilk değeri veya queryKey öğesinden bir değer dizisini döndürür.

Söz dizimi

getQueryParameters(queryKey[, retrieveAll])

Parametreler

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

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

İlişkili izinler

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

getReferrerQueryParameters

getReferrerQueryParameters API, geçerli URL yerine yönlendiren üzerinde işlem yapması dışında getQueryParameters ile aynı şekilde çalışır. Belirtilen yönlendirenin queryKey için parametrelerin ilkini veya tümünü döndürür. queryKey içindeki ilk değeri veya queryKey içindeki değer dizisini döndürür.

Söz dizimi

getReferrerQueryParameters(queryKey[, retrieveAll])

Parametreler

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

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

İlişkili izinler

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

getReferrerUrl

Bir bileşen türü verildiğinde API, yönlendirenin belge nesnesini okur ve yönlendirenin bir bölümünü temsil eden bir dize döndürür. Hiçbir bileşen belirtilmezse yönlendiren URL'sinin tamamı döndürülür.

Söz dizimi

getReferrerUrl([component])

Parametreler

İlişkili izinler

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

getTimestamp

Kullanımdan kaldırıldı. getTimestampMillis'i tercih edin.

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

Söz dizimi

getTimestamp();

İlişkili izinler

Yok.

getTimestampMillis

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

Söz dizimi

getTimestampMillis();

İlişkili izinler

Yok.

getType

Belirtilen değerin türünü açıklayan bir dize döndürür. typeof'ın aksine, getType, array ile object arasında ayrım yapar.

Söz dizimi

getType(data.someField)

Notlar

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

İlişkili izinler

Yok.

getUrl

Bir bileşen türü ve bazı yapılandırma parametreleri verildiğinde geçerli URL'nin tamamını veya bir bölümünü temsil eden bir dize döndürür.

Söz dizimi

getUrl(component)

Parametreler

İlişkili izinler

get_url

gtagSet

Mevcut etkinlik ve tetiklediği tüm etiketlerin işlenmesi tamamlandıktan (veya etiket işleme zaman aşımı süresine 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ındaki sıraya alınmış öğelerden önce bu kapsayıcıda işleneceği garanti edilir.

Örneğin, izin başlatma sırasında etkinleşen bir etiket tarafından çağrılırsa güncelleme, başlatma etkinliği işlenmeden önce uygulanır. Örneğin, ads_data_redaction öğesinin true veya false olarak ayarlanması ya da url_passthrough öğesinin true veya false olarak ayarlanması.

Örnekler:

const gtagSet = require('gtagSet');

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

Söz dizimi

gtagSet(object)

Parametreler

İlişkili izinler

write_data_layer, belirtilen tüm anahtarlar için dataLayer üzerinde yazma iznini kontrol eder. gtagSet girişinde düz bir nesne varsa API, bu nesnenin içindeki tüm düzleştirilmiş anahtarlar için yazma iznini kontrol eder. Örneğin, gtagSet({foo: {bar: 'baz'}}) için API, foo.bar yazma iznini kontrol eder.

gtagSet girişinde bir anahtar ve düz olmayan bir nesne değeri varsa API, bu anahtar için yazma iznini kontrol eder. Örneğin, gtagSet('abc', true) için API, 'abc' yazma iznini kontrol eder.

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

injectHiddenIframe

Sayfaya görünmez bir iframe ekler.

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

Söz dizimi

injectHiddenIframe(url, onSuccess)

Parametreler

İlişkili izinler

inject_hidden_iframe

injectScript

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

Söz dizimi

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

Parametreler

İlişkili izinler

inject_script

isConsentGranted

Belirtilen izin türü verildiyse true değerini döndürür.

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

Etiket ayarları için Etiket Yöneticisi kullanıcı arayüzünde her zaman tetikleme seçeneği sunulur. Her zaman tetikleme özelliği etkin olan bir etiket bu API'yi kullanıyorsa izin verilmiş kabul edilir ve iznin gerçek durumundan bağımsız olarak true değeri döndürülür.

Örnek:

const isConsentGranted = require('isConsentGranted');

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

Söz dizimi

isConsentGranted(consentType)

Parametreler

İlişkili izinler

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

JSON

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

parse() işlevi, dize tarafından 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. Giriş değeri dize değilse giriş, 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. nesnede döngü varsa) yöntem undefined döndürür.

Söz dizimi

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

Parametreler

JSON.parse

JSON.stringify

Ö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 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şkili izinler

access_local_storage

Örnek

const localStorage = require('localStorage');
if (localStorage) {
  const value = localStorage.getItem('my_key');
  if (value) {
    const success = localStorage.setItem('my_key', 'new_value');
    if (success) {
      localStorage.removeItem('my_key');
    }
  }
}

logToConsole

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

Söz dizimi

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

Parametreler

İlişkili izinler

logging

makeInteger

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

Söz dizimi

makeInteger(value)

Parametreler

İlişkili izinler

Yok.

makeNumber

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

Söz dizimi

makeNumber(value)

Parametreler

İlişkili izinler

Yok.

makeString

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

Söz dizimi

makeString(value)

Parametreler

İlişkili izinler

Yok.

makeTableMap

İki sütunlu basit bir tablo nesnesini Map öğesine dönüştürür. Bu, 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, bu işlev bir tablo nesnesini dönüştürebilir:

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

Harita:

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

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

Söz dizimi

makeTableMap(tableObj, keyColumnName, valueColumnName)

Parametreler

İlişkili 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

Matematik işlevlerinin parametreleri sayılara dönüştürülür.

İlişkili izinler

Yok.

Object

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

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

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

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

freeze() yöntemi, Standart Kitaplık Object.freeze() davranışını sağlar. Dondurulmuş bir nesne artık değiştirilemez. Nesnenin dondurulması, nesneye yeni özellikler eklenmesini, mevcut özelliklerin kaldırılmasını ve mevcut özelliklerin değerlerinin değiştirilmesini engeller. freeze(), iletilen nesnenin aynısını döndürür. Bir ilkel veya boş bağımsız değişken, dondurulmuş bir nesneymiş gibi değerlendirilir ve döndürülür.

delete() yöntemi, Standart Kitaplık delete operatörünün davranışını sağlar. Nesne dondurulmamışsa belirtilen anahtarı nesneden kaldırır. Standart kitaplık silme operatörü gibi, ikinci giriş değeri (keyToDelete) mevcut olmayan bir anahtarı belirtse bile ilk giriş değeri (objectInput) dondurulmamış bir nesne ise true değerini döndürür. Diğer tüm durumlarda false değerini döndürür. Ancak, Standart Kitaplık silme operatöründen şu yönleriyle farklıdır:

• keyToDelete, iç içe yerleştirilmiş bir anahtarı belirten nokta ile ayrılmış bir dize olamaz.
• delete(), bir diziden öğe kaldırmak için kullanılamaz.
• delete(), global kapsamdaki mülkleri 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

Object.values

Object.entries

Object.freeze

Object.delete

Örnek

const Object = require('Object');

// The keys of an object are enumerated in an array.
const keys = Object.keys({foo: 'bar'});

// The values of an object are enumerated in an array.
const values = Object.values({foo: 'bar'});

// The key/value pairs of an object are enumerated in an array.
const entries = Object.entries({foo: 'bar'});

// The input object is frozen.
const frozen = Object.freeze({foo: 'bar'});

// The key is removed from the input object.
const obj1 = {deleteme: 'value'};
Object.delete(obj1, 'deleteme');
// Only a top-level key can be specified as the key to delete.
const obj2 = {nested: {key: 'value'}};
Object.delete(obj2, 'nested.key'); // This has no effect.
Object.delete(obj2.nested, 'key'); // This deletes the nested key.

parseUrl

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

Bu API, hatalı biçimlendirilmiş URL'ler için undefined değerini döndürür. Doğru biçimlendirilmiş URL'lerde, URL dizesinde bulunmayan alanların değeri boş bir dize veya searchParams durumunda boş bir nesne olur.

Döndürülen nesnede aşağıdaki alanlar bulunur:

{
  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

İlişkili izinler

Yok.

queryPermission

İzin verilen ve daraltılmış izinleri sorgulayın. Boole değeri döndürür: İzin verildiyse true, aksi takdirde false.

Söz dizimi

queryPermission(permission, functionArgs*)

Parametreler

İş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şken gerekmez. 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şkili izinler

Yok.

readAnalyticsStorage

Analiz için depolanan verileri alır ve client_id ile sessions içeren bir nesne döndürür.

• client_id: Analytics için kullanılan istemci kimliğini temsil eden bir dize.
• sessions: Mevcut oturumlarla ilgili bilgileri içeren bir nesne dizisi. Her nesne şunları içerir:
  • measurement_id: Analytics hedefinin ölçüm kimliğini temsil eden bir dize.
  • session_id: Geçerli oturumu tanımlayan zaman damgasını temsil eden bir dize.
  • session_number: Kullanıcının geçerli oturuma kadar başlattığı oturum sayısını gösteren bir sayı.

Söz dizimi

const readAnalyticsStorage = require('readAnalyticsStorage');

const cookieOptions = {
  cookie_prefix: "xyz",
  cookie_domain: "google.com",
  cookie_path: "/",
};

readAnalyticsStorage(cookieOptions);

Parametreler

İlişkili izinler

read_analytics_storage

Örnek

const readAnalyticsStorage = require('readAnalyticsStorage');

const analyticsStorageData = readAnalyticsStorage();

sendOfflineEvent(analyticsStorageData.client_id, "tutorial_begin");

readCharacterSet

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

Söz dizimi

readCharacterSet()

Parametreler

Yok.

İlişkili izinler

read_character_set

readTitle

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

Söz dizimi

readTitle()

Parametreler

Yok.

İlişkili izinler

read_title

require

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

Söz dizimi

require(name)

Parametreler

Örnek

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

İlişkili izinler

Yok.

sendPixel

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

Söz dizimi

sendPixel(url, onSuccess, onFailure)

Parametreler

İlişkili izinler

send_pixel

setCookie

Belirtilen ad, değer ve seçeneklere sahip çerezi ayarlar veya siler.

Söz dizimi

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

Parametreler

Seçenekler

• Alan: Varsa options['domain'] özelliği tarafından ayarlanır. Bu değeri 'auto' olarak ayarlayarak doküman konumuna göre mümkün olan en geniş alanı kullanarak çerez yazmayı deneyin. Bu başarısız olursa sırayla daha dar alt alan adları denenir. Bunların hepsi başarısız olursa çerez, alan olmadan yazılmaya çalışılır. Değer ayarlanmamışsa bu, çerezi alan adı belirtilmeden yazmaya çalışır. Not: Alan adı belirtilmemiş bir çerez document.cookie konumuna yazıldığında kullanıcı aracısı, çerezin alan adını varsayılan olarak mevcut doküman konumunun ana makinesi olarak ayarlar.
• Yol: Varsa options['path'] tarafından ayarlanır. Yolu belirtilmemiş bir çerez document.cookie konumuna yazıldığında kullanıcı aracısı, çerezin yolunu varsayılan olarak geçerli belge konumunun yoluyla değiştirir.
• Max-Age: Varsa options['max-age'] tarafından ayarlanır.
• Varsa options['expires'] tarafından belirlenen geçerlilik sonu. Varsa bu, UTC biçimli bir tarih dizesi olmalıdır. Date.toUTCString(), bu parametre için Date biçimlendirmek üzere kullanılabilir.
• Güvenli: Varsa options['secure'] tarafından ayarlanır.
• SameSite: Varsa options['samesite'] tarafından ayarlanır.

İlişkili izinler

set_cookies

setDefaultConsentState

Mevcut etkinlik ve tetiklediği 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 varsayılan bir izin güncellemesi gönderir. Güncellemenin, veri katmanındaki sıraya alınmış öğelerden önce bu kapsayıcıda işleneceği 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

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

İlişkili izinler

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

setInWindow

window içinde belirtilen değeri belirtilen anahtara ayarlar. Varsayılan olarak bu yöntem, window içinde zaten bir değer varsa değeri ayarlamaz. Mevcut bir değerin olup olmadığına bakılmaksızın window içindeki değeri ayarlamak için overrideExisting değerini true olarak ayarlayın. Boole değeri döndürür: değer başarıyla ayarlandıysa true, aksi takdirde false.

Söz dizimi

setInWindow(key, value, overrideExisting)

Parametreler

İlişkili izinler

access_globals

sha256

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

Örnek:

sha256('inputString', (digest) => {
  sendPixel('https://example.com/collect?id=' + digest);
  data.gtmOnSuccess();
}, data.gtmOnFailure);

sha256('inputString', (digest) => {
  sendPixel('https://example.com/collect?id=' + digest);
  data.gtmOnSuccess();
}, data.gtmOnFailure, {outputEncoding: 'hex'});

Söz dizimi

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

Parametreler

İlişkili izinler

Yok.

templateStorage

Şablon depolama alanına erişme yöntemlerini içeren bir nesne döndürür. Şablon depolama alanı, verilerin tek bir şablonun yürütülmeleri arasında paylaşılmasına olanak tanır. Şablon depolama alanında saklanan veriler, sayfanın kullanım süresi 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şkili izinler

access_template_storage

Örnek

const templateStorage = require('templateStorage');
const sendPixel = require('sendPixel');

// Ensure sendPixel is called only once per page.
if (templateStorage.getItem('alreadyRan')) {
  data.gtmOnSuccess();
  return;
}

templateStorage.setItem('alreadyRan', true);

sendPixel(
  data.oncePerPagePixelUrl,
  data.gtmOnSuccess,
  () => {
    templateStorage.setItem('alreadyRan', false);
    data.gtmOnFailure();
  });

toBase64

toBase64 API, bir dizeyi base64 gösterimine kodlamanıza olanak tanır.

Söz dizimi

toBase64(input)

Parametreler

Örnek

const toBase64 = require('toBase64');

const base64Hello = toBase64('hello');

İlişkili izinler

Yok

updateConsentState

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

Örnek:

const updateConsentState = require('updateConsentState');

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

Söz dizimi

updateConsentState(consentSettings)

Parametreler

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

İlişkili izinler

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

Test API'leri

Bu API'ler, Google Etiket Yöneticisi'ndeki özel şablonlar için testler oluşturmak üzere korumalı alan JavaScript testleriyle birlikte çalışır. Bu test API'leri için require() beyan gerekmez. Özel şablon testleri hakkında daha fazla bilgi edinin.

assertApi

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

Söz dizimi

assertApi(apiName)

Parametreler

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'si, Google'ın [Truth] kitaplığına göre modellenmiştir. Bir konuyla ilgili değer hakkında akıcı bir şekilde iddialarda bulunmak için kullanılabilecek bir nesne döndürür. Bir onaylama hatası, testi hemen 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

Eşleştiriciler

Ö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 testi hemen başarısız kılar ve sağlanan iletiyi (varsa) yazdırır.

Söz dizimi

fail(opt_message);

Parametreler

Örnek

fail('This test has failed.');

mock

mock API, korumalı alan API'lerinin davranışını geçersiz kılmanıza olanak tanır. Mock API, şablon kodunda güvenle kullanılabilir ancak yalnızca test modunda çalışır. Her test çalıştırılmadan önce sahte veriler sıfırlanır.

Söz dizimi

mock(apiName, returnValue);

Parametreler

Örnekler

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

mockObject

mockObject API, nesne döndüren korumalı alan API'lerinin davranışını geçersiz kılmanıza olanak tanır. API, şablon kodunda güvenle kullanılabilir ancak yalnızca test modunda çalışır. Her test çalıştırılmadan önce sahte veriler sıfırlanır.

Söz dizimi

mockObject(apiName, objectMock);

Parametreler

Örnekler

const storage = {};
mockObject('localStorage', {
  setItem: (key, value) => {storage[key] = value;},
  getItem: (key) => storage[key],
});

runCode

Şablonun kodunu (ör. Kod sekmesinin içeriği) belirli bir giriş verisi nesnesiyle mevcut test ortamında çalıştırır.

Söz dizimi

runCode(data)

Parametreler

Dönüş Değeri

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

Örnek

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