API เทมเพลตที่กำหนดเอง

API หลัก

API เหล่านี้ทำงานร่วมกับ JavaScript แซนด์บ็อกซ์เพื่อสร้างเทมเพลตที่กำหนดเองใน Google Tag Manager โดยจะเพิ่ม API แต่ละรายการพร้อมกับข้อความ require() เช่น

const myAPI = require('myAPI');

addConsentListener

ลงทะเบียนฟังก์ชัน Listener เพื่อเรียกใช้เมื่อสถานะของประเภทความยินยอมที่ระบุ เปลี่ยนแปลง

ระบบจะเรียกใช้ Listener ที่ระบุทุกครั้งที่สถานะของประเภทความยินยอมที่ระบุเปลี่ยนจาก "ปฏิเสธ" เป็น "ให้ความยินยอม" หรือจาก "ให้ความยินยอม" เป็น "ปฏิเสธ" ระบบจะถือว่าประเภทความยินยอมที่ไม่มีสถานะเป็น "ได้รับความยินยอมแล้ว" ดังนั้นระบบจะไม่เรียกใช้ Listener หากมีการอัปเดตประเภทความยินยอมที่ไม่ได้ตั้งค่าเป็น "ได้รับความยินยอมแล้ว" ฟังก์ชัน Listener จะมีหน้าที่ ตรวจสอบว่าโค้ดทำงานตามจำนวนครั้งที่เหมาะสม

ตัวอย่างเช่น

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

ไวยากรณ์

addConsentListener(consentType, listener)

พารามิเตอร์

เมื่อเรียกใช้ Listener ระบบจะส่งประเภทความยินยอมที่กำลังเปลี่ยนแปลงและค่าใหม่ของประเภทความยินยอมนั้น

สิทธิ์ที่เชื่อมโยง

สิทธิ์ access_consent ที่มีสิทธิ์เข้าถึงแบบอ่านสำหรับประเภทความยินยอม

addEventCallback

API addEventCallback ช่วยให้คุณลงทะเบียนฟังก์ชันเรียกกลับที่จะ เรียกใช้เมื่อเหตุการณ์สิ้นสุด ระบบจะเรียกใช้การเรียกกลับเมื่อแท็กทั้งหมดสำหรับเหตุการณ์ทำงานเสร็จ หรือหากถึงการหมดเวลาของเหตุการณ์ในหน้า ระบบจะส่งค่า 2 ค่าไปยังฟังก์ชันเรียกกลับ ได้แก่ รหัสของคอนเทนเนอร์ที่เรียกใช้ฟังก์ชัน และออบเจ็กต์ที่มีข้อมูลเกี่ยวกับเหตุการณ์

ไวยากรณ์

addEventCallback(callback)

พารามิเตอร์

ออบเจ็กต์ eventData มีข้อมูลต่อไปนี้

ตัวอย่าง

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

สิทธิ์ที่เชื่อมโยง

read_event_metadata

aliasInWindow

aliasInWindow API ช่วยให้คุณสร้างนามแฝงได้ (เช่น window.foo = window.bar) ซึ่งจะช่วยรองรับแท็กบางรายการที่ต้องใช้นามแฝง กำหนดค่าในออบเจ็กต์ window ที่พบใน fromPath ให้กับคีย์ในออบเจ็กต์ window ที่ toPath แสดงผล true หากสำเร็จ หรือ false หากไม่สำเร็จ

ไวยากรณ์

aliasInWindow(toPath, fromPath)

พารามิเตอร์

ตัวอย่าง

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

สิทธิ์ที่เชื่อมโยง

access_globals ต้องใช้กับทั้ง toPath และ fromPath โดย toPath ต้องมีสิทธิ์การเขียน ส่วน fromPath ต้องมีสิทธิ์การอ่าน

callInWindow

ช่วยให้คุณเรียกใช้ฟังก์ชันจากเส้นทางที่อยู่นอกออบเจ็กต์ window ได้ในลักษณะที่ควบคุมด้วยนโยบาย เรียกใช้ฟังก์ชันที่เส้นทางที่ระบุใน window โดยมีอาร์กิวเมนต์ที่ระบุ และแสดงผลค่า หากไม่สามารถแมปประเภทการคืนค่ากับ ประเภทที่รองรับใน JavaScript ที่อยู่ในแซนด์บ็อกซ์ได้โดยตรง ระบบจะแสดงผล undefined ประเภทที่รองรับใน JavaScript ที่อยู่ในแซนด์บ็อกซ์มี 8 ประเภท ได้แก่ null, undefined, boolean, number, string, Array, Object และ function หากไม่มีเส้นทางที่ระบุ หรือไม่ได้อ้างอิงฟังก์ชัน ระบบจะแสดงผล undefined

ไวยากรณ์

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

พารามิเตอร์

สิทธิ์ที่เชื่อมโยง

access_globals โดยเปิดใช้สิทธิ์ execute

callLater

กำหนดเวลาการเรียกฟังก์ชันให้เกิดขึ้นแบบไม่พร้อมกัน ระบบจะเรียกใช้ฟังก์ชัน หลังจากที่โค้ดปัจจุบันแสดงผล ซึ่งเทียบเท่ากับ setTimeout(<function>, 0)

ไวยากรณ์

callLater(function)

พารามิเตอร์

copyFromDataLayer

แสดงผลค่าที่กําหนดให้กับคีย์ที่ระบุในชั้นข้อมูลในขณะนี้ ค่าที่พบในคีย์ที่ระบุหากเป็นประเภทพื้นฐาน ฟังก์ชัน หรือออบเจ็กต์ ตามตัวอักษร หรือ undefined ในกรณีอื่นๆ

ไวยากรณ์

copyFromDataLayer(key[, dataLayerVersion])

พารามิเตอร์

สิทธิ์ที่เชื่อมโยง

read_data_layer

copyFromWindow

คัดลอกตัวแปรจากออบเจ็กต์ window หากค่าใน window แมปกับประเภทที่รองรับใน JavaScript ที่แซนด์บ็อกซ์โดยตรงไม่ได้ ระบบจะแสดง undefined ประเภททั้ง 8 ที่รองรับใน JavaScript ที่แซนด์บ็อกซ์ ได้แก่ null, undefined, boolean, number, string, Array, Object และ function แสดงผลค่าที่ดึงข้อมูล (และบังคับ)

ไวยากรณ์

copyFromWindow(key)

พารามิเตอร์

สิทธิ์ที่เชื่อมโยง

access_globals

createArgumentsQueue

สร้างคิวที่ป้อนข้อมูลด้วยออบเจ็กต์อาร์กิวเมนต์ เพื่อรองรับโซลูชันแท็ก ที่ต้องใช้

สร้างฟังก์ชันในขอบเขตส่วนกลาง (เช่น window) โดยใช้อาร์กิวเมนต์ fnKey (มีความหมายเหมือนกับ createQueue) หลังจากสร้างฟังก์ชันแล้ว API นี้จะ สร้างอาร์เรย์ใน window (หากยังไม่มี) โดยใช้อาร์กิวเมนต์ arrayKey

เมื่อมีการเรียกใช้ฟังก์ชันที่สร้างขึ้นภายใต้ fnKey ฟังก์ชันจะส่งอาร์กิวเมนต์ ออบเจ็กต์ไปยังอาร์เรย์ที่สร้างขึ้นภายใต้ arrayKey ค่าที่ API แสดงผลคือฟังก์ชันที่สร้างขึ้นภายใต้ fnKey

ฟังก์ชันนี้ต้องมีการตั้งค่าการอ่านและการเขียนสำหรับ fnKey และ arrayKey ในสิทธิ์ access_globals

ตัวอย่างเช่น

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

ไวยากรณ์

createArgumentsQueue(fnKey, arrayKey)

พารามิเตอร์

สิทธิ์ที่เชื่อมโยง

access_globals

createQueue

สร้างอาร์เรย์ใน window (หากยังไม่มี) และแสดงผลฟังก์ชันที่จะส่งค่าไปยังอาร์เรย์นั้น

ฟังก์ชันนี้ต้องมีการตั้งค่าการอ่านและการเขียนสำหรับ arrayKey ในสิทธิ์ access_globals

ตัวอย่างเช่น

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

ไวยากรณ์

createQueue(arrayKey)

พารามิเตอร์

สิทธิ์ที่เชื่อมโยง

access_globals

decodeUri

ถอดรหัสอักขระที่เข้ารหัสใน URI ที่ระบุ แสดงผลสตริงที่ แสดง URI ที่ถอดรหัสแล้ว แสดงผล undefined เมื่อได้รับอินพุตที่ไม่ถูกต้อง

ตัวอย่างเช่น

const decode = require('decodeUri');

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

ไวยากรณ์

decodeUri(encoded_uri)

พารามิเตอร์

สิทธิ์ที่เชื่อมโยง

ไม่มี

decodeUriComponent

ถอดรหัสอักขระที่เข้ารหัสในคอมโพเนนต์ URI ที่ระบุ แสดงผลสตริงที่แสดงถึงคอมโพเนนต์ URI ที่ถอดรหัสแล้ว แสดงผล undefined เมื่อ ระบุอินพุตที่ไม่ถูกต้อง

ตัวอย่างเช่น

const decode = require('decodeUriComponent');

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

ไวยากรณ์

decodeUriComponent(encoded_uri_component)

พารามิเตอร์

สิทธิ์ที่เชื่อมโยง

ไม่มี

encodeUri

แสดงผล Uniform Resource Identifier (URI) ที่เข้ารหัสโดยหลีกเลี่ยงอักขระพิเศษ แสดงผลสตริงที่แสดงสตริงที่ระบุซึ่งเข้ารหัสเป็น URI แสดงผล undefined เมื่อได้รับอินพุตที่ไม่ถูกต้อง (อักขระแทนตัวเดี่ยว)

ตัวอย่างเช่น

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

ไวยากรณ์

encodeUri(uri)

พารามิเตอร์

สิทธิ์ที่เชื่อมโยง

ไม่มี

encodeUriComponent

แสดงผล Uniform Resource Identifier (URI) ที่เข้ารหัสโดยหลีกเลี่ยงอักขระพิเศษ แสดงผลสตริงที่แสดงสตริงที่ระบุซึ่งเข้ารหัสเป็น URI แสดงผล undefined เมื่อได้รับอินพุตที่ไม่ถูกต้อง (อักขระแทนตัวเดี่ยว)

ตัวอย่างเช่น

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

ไวยากรณ์

encodeUriComponent(str)

พารามิเตอร์

สิทธิ์ที่เชื่อมโยง

ไม่มี

fromBase64

fromBase64 API ช่วยให้คุณถอดรหัสสตริงจากรูปแบบ base64 ได้ แสดงผล undefined เมื่อได้รับอินพุตที่ไม่ถูกต้อง

ไวยากรณ์

fromBase64(base64EncodedString)

พารามิเตอร์

ตัวอย่าง

const fromBase64 = require('fromBase64');

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

สิทธิ์ที่เชื่อมโยง

ไม่มี

generateRandom

แสดงผลตัวเลข (จำนวนเต็ม) แบบสุ่มภายในช่วงที่กำหนด

ไวยากรณ์

generateRandom(min, max)

พารามิเตอร์

สิทธิ์ที่เชื่อมโยง

ไม่มี

getContainerVersion

แสดงผลออบเจ็กต์ที่มีข้อมูลเกี่ยวกับคอนเทนเนอร์ปัจจุบัน ออบเจ็กต์ที่ส่งคืน มีฟิลด์ต่อไปนี้

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

ตัวอย่าง

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

ไวยากรณ์

getContainerVersion();

สิทธิ์ที่เชื่อมโยง

read_container_data

getCookieValues

แสดงผลค่าของคุกกี้ทั้งหมดที่มีชื่อที่ระบุ

ไวยากรณ์

getCookieValues(name[, decode])

พารามิเตอร์

สิทธิ์ที่เชื่อมโยง

get_cookies

getQueryParameters

แสดงพารามิเตอร์แรกหรือทั้งหมดสำหรับ queryKey ของ URL ปัจจุบัน แสดงผลค่าแรกจาก queryKey หรืออาร์เรย์ของค่าจาก queryKey

ไวยากรณ์

getQueryParameters(queryKey[, retrieveAll])

พารามิเตอร์

ตัวอย่างเช่น หาก URL ปัจจุบันคือ https://example.com/path?var=foo&var1=foo1&var=foo2&var=foo

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

สิทธิ์ที่เชื่อมโยง

get_url ต้องอนุญาตคอมโพเนนต์ query และต้องระบุ queryKey ใน คีย์การค้นหาที่อนุญาต (หรืออนุญาตคีย์การค้นหาใดก็ได้)

getReferrerQueryParameters

getReferrerQueryParameters API ทำงานในลักษณะเดียวกับ getQueryParameters แต่จะทำงานกับผู้เข้าชมแทนที่จะเป็น URL ปัจจุบัน แสดงผลพารามิเตอร์แรกหรือพารามิเตอร์ทั้งหมดสำหรับ queryKey ของผู้แนะนำที่ระบุ แสดงผลค่าแรกจาก queryKey หรืออาร์เรย์ของค่าจาก queryKey

ไวยากรณ์

getReferrerQueryParameters(queryKey[, retrieveAll])

พารามิเตอร์

ตัวอย่างเช่น หาก URL ที่มาคือ https://example.com/path?var=foo&var1=foo1&var=foo2&var=foo จะเกิดสิ่งต่อไปนี้

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

สิทธิ์ที่เชื่อมโยง

get_referrer ต้องอนุญาตคอมโพเนนต์ query และต้องระบุ queryKey ในคีย์การค้นหาที่อนุญาต (หรืออนุญาตคีย์การค้นหาใดก็ได้)

getReferrerUrl

เมื่อระบุประเภทคอมโพเนนต์แล้ว API จะอ่านออบเจ็กต์เอกสารสำหรับผู้เข้าชมที่มาและ แสดงผลสตริงที่แสดงส่วนหนึ่งของผู้เข้าชมที่มา หากไม่ได้ระบุคอมโพเนนต์ ระบบจะแสดงผล URL ของผู้เข้าชมทั้งหมด

ไวยากรณ์

getReferrerUrl([component])

พารามิเตอร์

สิทธิ์ที่เชื่อมโยง

get_referrer ต้องอนุญาตคอมโพเนนต์ query และต้องระบุ queryKey ในคีย์การค้นหาที่อนุญาต (หรืออนุญาตคีย์การค้นหาใดก็ได้)

getTimestamp

เลิกใช้งานแล้ว แนะนำให้ใช้ getTimestampMillis

แสดงผลตัวเลขที่แสดงเวลาปัจจุบันเป็นมิลลิวินาทีตั้งแต่ Unix epoch ตามที่ Date.now() แสดงผล

ไวยากรณ์

getTimestamp();

สิทธิ์ที่เชื่อมโยง

ไม่มี

getTimestampMillis

แสดงผลตัวเลขที่แสดงเวลาปัจจุบันเป็นมิลลิวินาทีตั้งแต่ Unix epoch ตามที่ Date.now() แสดงผล

ไวยากรณ์

getTimestampMillis();

สิทธิ์ที่เชื่อมโยง

ไม่มี

getType

แสดงผลสตริงที่อธิบายประเภทของค่าที่ระบุ getType แตกต่างจาก typeof ตรงที่สามารถแยกความแตกต่างระหว่าง array กับ object ได้

ไวยากรณ์

getType(data.someField)

หมายเหตุ

ตารางต่อไปนี้แสดงสตริงที่ส่งคืนสำหรับค่าอินพุตแต่ละค่า

สิทธิ์ที่เชื่อมโยง

ไม่มี

getUrl

แสดงผลสตริงที่แสดงถึง URL ปัจจุบันทั้งหมดหรือบางส่วน โดยพิจารณาจาก ประเภทคอมโพเนนต์และพารามิเตอร์การกำหนดค่าบางอย่าง

ไวยากรณ์

getUrl(component)

พารามิเตอร์

สิทธิ์ที่เชื่อมโยง

get_url

gtagSet

พุชคำสั่ง gtag set ไปยังชั้นข้อมูลเพื่อประมวลผลโดยเร็วที่สุด หลังจากที่เหตุการณ์ปัจจุบันและแท็กที่ทริกเกอร์เสร็จสิ้น การประมวลผล (หรือถึงการหมดเวลาการประมวลผลแท็ก) การอัปเดตจะได้รับการประมวลผลในคอนเทนเนอร์นี้ก่อนรายการที่อยู่ในคิวในคิวของ Data Layer

เช่น หากเรียกใช้โดยแท็กที่เริ่มทํางานในการเริ่มต้นขอความยินยอม ระบบจะใช้การอัปเดตก่อนที่จะประมวลผลเหตุการณ์การเริ่มต้น ตัวอย่าง เช่น ตั้งค่า ads_data_redaction เป็น true หรือ false หรือ url_passthrough ตั้งค่าเป็น true หรือ false

ตัวอย่างเช่น

const gtagSet = require('gtagSet');

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

ไวยากรณ์

gtagSet(object)

พารามิเตอร์

สิทธิ์ที่เชื่อมโยง

write_data_layer จะตรวจสอบสิทธิ์การเขียนของ dataLayer สำหรับคีย์ทั้งหมด ที่ระบุ หากอินพุตไปยัง gtagSet เป็นออบเจ็กต์ธรรมดา API จะตรวจสอบ สิทธิ์เขียนไปยังคีย์ที่ทำให้แบนทั้งหมดภายในออบเจ็กต์นั้น เช่น สำหรับ gtagSet({foo: {bar: 'baz'}}) API จะตรวจสอบสิทธิ์เขียน ไปยัง foo.bar

หากอินพุตไปยัง gtagSet เป็นคีย์และค่าออบเจ็กต์ที่ไม่ใช่ข้อความธรรมดา API จะ ตรวจสอบสิทธิ์เขียนไปยังคีย์นั้น เช่น สำหรับ gtagSet('abc', true) API จะตรวจสอบสิทธิ์เขียนไปยัง 'abc'

โปรดทราบว่าหากมีวงจรในออบเจ็กต์อินพุต ระบบจะตรวจสอบเฉพาะคีย์ก่อนที่จะไปถึงออบเจ็กต์เดียวกัน

injectHiddenIframe

เพิ่ม iframe ที่ซ่อนอยู่ลงในหน้าเว็บ

Callback จะได้รับเป็นอินสแตนซ์ฟังก์ชันและจะรวมอยู่ในฟังก์ชัน JavaScript ที่เรียกผ่านไปยังฟังก์ชันเหล่านั้น

ไวยากรณ์

injectHiddenIframe(url, onSuccess)

พารามิเตอร์

สิทธิ์ที่เชื่อมโยง

inject_hidden_iframe

injectScript

เพิ่มแท็กสคริปต์ลงในหน้าเว็บเพื่อโหลด URL ที่ระบุแบบไม่พร้อมกัน Callback จะได้รับเป็นอินสแตนซ์ฟังก์ชันและจะรวมอยู่ในฟังก์ชัน JavaScript ที่เรียกผ่านไปยังฟังก์ชันเหล่านั้น

ไวยากรณ์

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

พารามิเตอร์

สิทธิ์ที่เชื่อมโยง

inject_script

isConsentGranted

แสดงผลเป็น "จริง" หากได้รับความยินยอมประเภทที่ระบุ

ระบบจะถือว่าได้รับความยินยอมสำหรับประเภทความยินยอมหนึ่งๆ หากมีการตั้งค่าประเภทความยินยอมเป็น "ได้รับความยินยอมแล้ว" หรือไม่ได้ตั้งค่าเลย หากตั้งค่าประเภทความยินยอมเป็นค่าอื่น ระบบจะถือว่าไม่ได้รับความยินยอม

อินเทอร์เฟซผู้ใช้ Tag Manager สำหรับการตั้งค่าแท็กจะมีตัวเลือกให้เรียกใช้เสมอ หากแท็กที่เปิด "เริ่มทำงานเสมอ" ใช้ API นี้ ระบบจะถือว่าได้รับความยินยอมและจะแสดงผล true ไม่ว่าสถานะความยินยอมที่แท้จริงจะเป็นอย่างไรก็ตาม

ตัวอย่างเช่น

const isConsentGranted = require('isConsentGranted');

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

ไวยากรณ์

isConsentGranted(consentType)

พารามิเตอร์

สิทธิ์ที่เชื่อมโยง

สิทธิ์ access_consent ที่มีสิทธิ์เข้าถึงแบบอ่านสำหรับประเภทความยินยอม

JSON

แสดงผลออบเจ็กต์ที่มีฟังก์ชัน JSON

parse() ฟังก์ชันจะแยกวิเคราะห์สตริง JSON เพื่อสร้างค่าหรือออบเจ็กต์ ที่อธิบายโดยสตริง หากแยกวิเคราะห์ค่าไม่ได้ (เช่น JSON ที่มีรูปแบบไม่ถูกต้อง) ฟังก์ชันจะแสดงผล undefined หากค่าอินพุตไม่ใช่สตริง ระบบจะบังคับให้ อินพุตเป็นสตริง

stringify() ฟังก์ชันจะแปลงอินพุตเป็นสตริง JSON หากแยกวิเคราะห์ค่าไม่ได้ (เช่น ออบเจ็กต์มีวงจร) เมธอดจะแสดงผล undefined

ไวยากรณ์

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

พารามิเตอร์

JSON.parse

JSON.stringify

ตัวอย่าง

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

แสดงผลออบเจ็กต์ที่มีเมธอดสำหรับการเข้าถึงที่เก็บข้อมูลในเครื่อง

ไวยากรณ์

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

สิทธิ์ที่เชื่อมโยง

access_local_storage

ตัวอย่าง

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

บันทึกอาร์กิวเมนต์ไปยังคอนโซลเบราว์เซอร์

ไวยากรณ์

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

พารามิเตอร์

สิทธิ์ที่เชื่อมโยง

logging

makeInteger

แปลงค่าที่ระบุเป็นตัวเลข (จำนวนเต็ม)

ไวยากรณ์

makeInteger(value)

พารามิเตอร์

สิทธิ์ที่เชื่อมโยง

ไม่มี

makeNumber

แปลงค่าที่ระบุเป็นตัวเลข

ไวยากรณ์

makeNumber(value)

พารามิเตอร์

สิทธิ์ที่เชื่อมโยง

ไม่มี

makeString

แสดงผลค่าที่ระบุเป็นสตริง

ไวยากรณ์

makeString(value)

พารามิเตอร์

สิทธิ์ที่เชื่อมโยง

ไม่มี

makeTableMap

แปลงออบเจ็กต์ตารางแบบง่ายที่มี 2 คอลัมน์เป็น Map ใช้เพื่อ เปลี่ยนSIMPLE_TABLEฟิลด์เทมเพลตที่มี 2 คอลัมน์เป็นรูปแบบที่จัดการได้ง่ายขึ้น

เช่น ฟังก์ชันนี้อาจแปลงออบเจ็กต์ตารางได้

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

ลงในแผนที่

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

แสดงผลออบเจ็กต์: Map ที่แปลงแล้วหากมีการเพิ่มคู่คีย์-ค่าลงใน ออบเจ็กต์ หรือ null ในกรณีอื่นๆ

ไวยากรณ์

makeTableMap(tableObj, keyColumnName, valueColumnName)

พารามิเตอร์

สิทธิ์ที่เชื่อมโยง

ไม่มี

Math

ออบเจ็กต์ที่ให้ฟังก์ชัน Math

ไวยากรณ์

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

พารามิเตอร์

ระบบจะแปลงพารามิเตอร์ของฟังก์ชันทางคณิตศาสตร์เป็นตัวเลข

สิทธิ์ที่เชื่อมโยง

ไม่มี

Object

แสดงผลออบเจ็กต์ที่มีObjectเมธอด

keys() เมธอดนี้มีลักษณะการทำงานของ Object.keys() ใน Standard Library โดยจะแสดงผลอาร์เรย์ของชื่อพร็อพเพอร์ตี้ที่แจงนับได้ของออบเจ็กต์ที่กำหนด ตามลำดับเดียวกับที่ลูป for...in... จะแสดง หากค่าอินพุตไม่ใช่ออบเจ็กต์ ระบบจะบังคับให้เป็นออบเจ็กต์

เมธอด values() มีลักษณะการทำงานของ Object.values() ในไลบรารีมาตรฐาน โดยจะแสดงผลอาร์เรย์ของค่าพร็อพเพอร์ตี้ที่แจงนับได้ของออบเจ็กต์ที่กำหนด ตามลำดับเดียวกับที่ลูป for...in... จะแสดง หากค่าอินพุตไม่ใช่ ออบเจ็กต์ ระบบจะบังคับให้เป็นออบเจ็กต์

entries() วิธีการนี้มีลักษณะการทำงานของ Object.entries() ในไลบรารีมาตรฐาน โดยจะแสดงผลอาร์เรย์ของคู่[key, value]พร็อพเพอร์ตี้ที่แจงนับได้ของออบเจ็กต์ที่กำหนดตามลำดับเดียวกับที่ลูป for...in... จะแสดง หาก ค่าอินพุตไม่ใช่ออบเจ็กต์ ระบบจะบังคับให้เป็นออบเจ็กต์

freeze() วิธีนี้จะให้ลักษณะการทำงานของ Object.freeze() ในไลบรารีมาตรฐาน คุณจะเปลี่ยนแปลงออบเจ็กต์ที่ตรึงไม่ได้อีกต่อไป การตรึงออบเจ็กต์จะป้องกันไม่ให้มีการเพิ่มพร็อพเพอร์ตี้ใหม่ลงในออบเจ็กต์ดังกล่าว ไม่ให้มีการนำพร็อพเพอร์ตี้ที่มีอยู่ออก และไม่ให้มีการเปลี่ยนแปลงค่าของพร็อพเพอร์ตี้ที่มีอยู่ freeze() จะแสดงผล ออบเจ็กต์เดียวกันกับที่ส่งเข้ามา ระบบจะถือว่าอาร์กิวเมนต์ดั้งเดิมหรืออาร์กิวเมนต์ที่เป็นค่าว่างเป็นออบเจ็กต์ที่ตรึงไว้และจะแสดงผล

delete() เมธอดจะให้ลักษณะการทำงานของตัวดำเนินการลบ ในไลบรารีมาตรฐาน ซึ่งจะนำคีย์ที่ระบุออกจากออบเจ็กต์ เว้นแต่ว่าออบเจ็กต์จะถูกตรึงไว้ เช่นเดียวกับตัวดำเนินการลบของไลบรารีมาตรฐาน ฟังก์ชันนี้จะแสดง true หากอินพุตแรก ค่า (objectInput) เป็นออบเจ็กต์ที่ไม่ได้ตรึง แม้ว่าอินพุตที่สอง ค่า (keyToDelete) จะระบุคีย์ที่ไม่มีอยู่ก็ตาม และจะแสดงผลเป็น false ในกรณีอื่นๆ ทั้งหมด อย่างไรก็ตาม ตัวดำเนินการนี้แตกต่างจากตัวดำเนินการลบของไลบรารีมาตรฐาน ในลักษณะต่อไปนี้

• keyToDelete ต้องไม่ใช่สตริงที่คั่นด้วยจุดซึ่งระบุคีย์ที่ซ้อนกัน
• delete() ใช้เพื่อนำองค์ประกอบออกจากอาร์เรย์ไม่ได้
• delete() ใช้เพื่อนำพร็อพเพอร์ตี้ออกจากขอบเขตส่วนกลางไม่ได้

ไวยากรณ์

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

พารามิเตอร์

Object.keys

Object.values

Object.entries

Object.freeze

Object.delete

ตัวอย่าง

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 ที่ระบุ คล้ายกับออบเจ็กต์ URL

API นี้จะแสดง undefined สำหรับ URL ที่มีรูปแบบไม่ถูกต้อง สำหรับ URL ที่มีรูปแบบถูกต้อง ฟิลด์ที่ไม่มีในสตริง URL จะมีค่าเป็นสตริงว่าง หรือในกรณีของ searchParams จะเป็นออบเจ็กต์ว่าง

ออบเจ็กต์ที่แสดงจะมีฟิลด์ต่อไปนี้

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

ตัวอย่าง

const parseUrl = require('parseUrl');

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

ไวยากรณ์

parseUrl(url);

พารามิเตอร์

สิทธิ์ที่เชื่อมโยง

ไม่มี

queryPermission

ค้นหาสิทธิ์ที่อนุญาตและสิทธิ์ที่จำกัด แสดงผล boolean: true หากได้รับ สิทธิ์ หรือ false ในกรณีอื่นๆ

ไวยากรณ์

queryPermission(permission, functionArgs*)

พารามิเตอร์

อาร์กิวเมนต์ของฟังก์ชัน

sendPixel, injectScript, injectHiddenIframe: พารามิเตอร์ที่สอง ควรเป็นสตริง URL

writeGlobals, readGlobals: พารามิเตอร์ที่ 2 ควรเป็นคีย์ที่กำลังเขียนหรืออ่าน

readUrl: ไม่จำเป็นต้องมีอาร์กิวเมนต์เพิ่มเติมเพื่อสอบถามว่าอ่าน URL ทั้งหมดได้หรือไม่ หากต้องการค้นหาว่าอ่านคอมโพเนนต์ที่ระบุได้หรือไม่ ให้ส่งชื่อคอมโพเนนต์เป็นอาร์กิวเมนต์ที่ 2 ดังนี้

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

หากต้องการตรวจสอบว่าคีย์การค้นหาที่เฉพาะเจาะจงอ่านได้หรือไม่ ให้ส่งคีย์การค้นหาเป็น พารามิเตอร์ที่ 3

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

สิทธิ์ที่เชื่อมโยง

ไม่มี

readAnalyticsStorage

เรียกข้อมูลที่จัดเก็บไว้สำหรับการวิเคราะห์และแสดงผลออบเจ็กต์ที่มี client_id และ sessions

• client_id: สตริงที่แสดง Client-ID ที่ใช้สําหรับการวิเคราะห์
• sessions: อาร์เรย์ของออบเจ็กต์ที่มีข้อมูลเกี่ยวกับเซสชันปัจจุบัน แต่ละออบเจ็กต์ประกอบด้วยข้อมูลต่อไปนี้
  • measurement_id: สตริงที่แสดงรหัสการวัดของ ปลายทาง Analytics
  • session_id: สตริงที่แสดงการประทับเวลาซึ่งระบุเซสชันปัจจุบัน
  • session_number: ตัวเลขที่แสดงจํานวนเซสชันที่ผู้ใช้เริ่มต้นจนถึงเซสชันปัจจุบัน

ไวยากรณ์

const readAnalyticsStorage = require('readAnalyticsStorage');

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

readAnalyticsStorage(cookieOptions);

พารามิเตอร์

สิทธิ์ที่เชื่อมโยง

read_analytics_storage

ตัวอย่าง

const readAnalyticsStorage = require('readAnalyticsStorage');

const analyticsStorageData = readAnalyticsStorage();

sendOfflineEvent(analyticsStorageData.client_id, "tutorial_begin");

readCharacterSet

แสดงผลค่าของ document.characterSet

ไวยากรณ์

readCharacterSet()

พารามิเตอร์

ไม่มี

สิทธิ์ที่เชื่อมโยง

read_character_set

readTitle

แสดงผลค่าของ document.title

ไวยากรณ์

readTitle()

พารามิเตอร์

ไม่มี

สิทธิ์ที่เชื่อมโยง

read_title

require

นำเข้าฟังก์ชันในตัวตามชื่อ แสดงผลฟังก์ชันหรือออบเจ็กต์ ที่เรียกใช้จากโปรแกรมได้ แสดงผล undefined เมื่อเบราว์เซอร์ ไม่รองรับฟังก์ชันในตัว

ไวยากรณ์

require(name)

พารามิเตอร์

ตัวอย่าง

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

สิทธิ์ที่เชื่อมโยง

ไม่มี

sendPixel

ส่งคำขอ GET ไปยังปลายทาง URL ที่ระบุ

ไวยากรณ์

sendPixel(url, onSuccess, onFailure)

พารามิเตอร์

สิทธิ์ที่เชื่อมโยง

send_pixel

setCookie

ตั้งค่าหรือลบคุกกี้ที่มีชื่อ ค่า และตัวเลือกที่ระบุ

ไวยากรณ์

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

พารามิเตอร์

ตัวเลือก

• โดเมน: ตั้งค่าโดยพร็อพเพอร์ตี้ options['domain'] หากมี ตั้งค่านี้ เป็น 'auto' เพื่อพยายามเขียนคุกกี้โดยใช้โดเมนที่กว้างที่สุดเท่าที่จะเป็นไปได้ ตามตำแหน่งของเอกสาร หากไม่สำเร็จ ระบบจะลองใช้ โดเมนย่อยที่แคบลงเรื่อยๆ หากทั้งหมดนี้ไม่สำเร็จ ระบบจะพยายามเขียนคุกกี้ โดยไม่มีโดเมน หากไม่ได้ตั้งค่า ระบบจะพยายามเขียนคุกกี้ โดยไม่ระบุโดเมน หมายเหตุ: เมื่อมีการเขียนคุกกี้ที่ไม่ได้ระบุโดเมนลงใน document.cookie ตัวแทนผู้ใช้จะตั้งค่าเริ่มต้นโดเมนของคุกกี้เป็นโฮสต์ของตำแหน่งเอกสารปัจจุบัน
• เส้นทาง: กำหนดโดย options['path'] หากมี เมื่อมีการเขียนคุกกี้ที่ไม่มีเส้นทาง ที่ระบุไปยัง document.cookie User-agent จะตั้งค่าเริ่มต้น เส้นทางของคุกกี้เป็นเส้นทางของตำแหน่งเอกสารปัจจุบัน
• Max-Age: ตั้งค่าโดย options['max-age'] หากมี
• หมดอายุ: ตั้งค่าโดย options['expires'] (หากมี) หากมีอยู่ สตริงนี้ต้องเป็นสตริงวันที่ที่จัดรูปแบบ UTC Date.toUTCString() ใช้จัดรูปแบบ a Date สำหรับพารามิเตอร์นี้ได้
• ปลอดภัย: ตั้งค่าโดย options['secure'] หากมี
• SameSite: ตั้งค่าโดย options['samesite'] หากมี

สิทธิ์ที่เชื่อมโยง

set_cookies

setDefaultConsentState

พุชการอัปเดตความยินยอมเริ่มต้นไปยังชั้นข้อมูล เพื่อประมวลผลโดยเร็วที่สุดหลังจากเหตุการณ์ปัจจุบันและแท็กใดก็ตามที่ทริกเกอร์เสร็จสิ้นการประมวลผล (หรือถึงการหมดเวลาการประมวลผลแท็ก) รับประกันได้ว่าระบบจะประมวลผลการอัปเดตในคอนเทนเนอร์นี้ก่อนรายการที่อยู่ในคิวในชั้นข้อมูล ดูข้อมูลเพิ่มเติมเกี่ยวกับความยินยอม

ตัวอย่างเช่น

const setDefaultConsentState = require('setDefaultConsentState');

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

ไวยากรณ์

setDefaultConsentState(consentSettings)

พารามิเตอร์

ออบเจ็กต์ consentSettings คือการแมปสตริงประเภทความยินยอมที่กำหนดเองกับ 'granted' หรือ 'denied' อย่างใดอย่างหนึ่ง โดยรองรับค่าต่อไปนี้

สิทธิ์ที่เชื่อมโยง

access_consent ที่มีสิทธิ์เข้าถึงการเขียนสำหรับความยินยอมทุกประเภทในออบเจ็กต์ consentSettings

setInWindow

กำหนดค่าที่ระบุใน window ที่คีย์ที่ระบุ โดยค่าเริ่มต้น วิธีนี้จะไม่ตั้งค่าใน window หากมีค่าอยู่แล้ว ตั้งค่า overrideExisting เป็น true เพื่อตั้งค่าใน window โดยไม่คำนึงถึง ค่าที่มีอยู่ แสดงผล boolean: true หากตั้งค่าสำเร็จ และ false ในกรณีอื่นๆ

ไวยากรณ์

setInWindow(key, value, overrideExisting)

พารามิเตอร์

สิทธิ์ที่เชื่อมโยง

access_globals

sha256

คำนวณข้อมูลสรุป SHA-256 ของอินพุตและเรียกใช้การเรียกกลับพร้อมข้อมูลสรุปที่เข้ารหัสใน base64 เว้นแต่optionsออบเจ็กต์จะระบุการเข้ารหัสเอาต์พุตอื่น

ตัวอย่างเช่น

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

ไวยากรณ์

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

พารามิเตอร์

สิทธิ์ที่เชื่อมโยง

ไม่มี

templateStorage

แสดงผลออบเจ็กต์ที่มีเมธอดสำหรับการเข้าถึงที่เก็บข้อมูลเทมเพลต ที่เก็บข้อมูลเทมเพลต ช่วยให้แชร์ข้อมูลในการดำเนินการเทมเพลตเดียวได้ ข้อมูล ที่จัดเก็บไว้ในที่เก็บเทมเพลตจะยังคงอยู่ตลอดอายุของหน้าเว็บ

ไวยากรณ์

const templateStorage = require('templateStorage');

templateStorage.getItem(key);

templateStorage.setItem(key, value);

templateStorage.removeItem(key);

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

สิทธิ์ที่เชื่อมโยง

access_template_storage

ตัวอย่าง

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 ช่วยให้คุณเข้ารหัสสตริงเป็นรูปแบบ Base64 ได้

ไวยากรณ์

toBase64(input)

พารามิเตอร์

ตัวอย่าง

const toBase64 = require('toBase64');

const base64Hello = toBase64('hello');

สิทธิ์ที่เชื่อมโยง

ไม่มี

updateConsentState

ส่งการอัปเดตความยินยอมไปยังชั้นข้อมูลเพื่อประมวลผลโดยเร็วที่สุด หลังจากที่เหตุการณ์ปัจจุบันและแท็กที่ทริกเกอร์เสร็จสิ้นการประมวลผล (หรือ ถึงการหมดเวลาการประมวลผลแท็ก) รับประกันได้ว่าระบบจะประมวลผลการอัปเดตในคอนเทนเนอร์นี้ก่อนรายการที่อยู่ในคิวในชั้นข้อมูล ดูข้อมูลเพิ่มเติม เกี่ยวกับความยินยอม

ตัวอย่างเช่น

const updateConsentState = require('updateConsentState');

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

ไวยากรณ์

updateConsentState(consentSettings)

พารามิเตอร์

ออบเจ็กต์ consentSettings คือการแมปสตริงประเภทความยินยอมที่กำหนดเองกับ 'granted' หรือ 'denied' อย่างใดอย่างหนึ่ง โดยรองรับค่าต่อไปนี้

สิทธิ์ที่เชื่อมโยง

access_consent ที่มีสิทธิ์เข้าถึงการเขียนสำหรับความยินยอมทุกประเภทในออบเจ็กต์ consentSettings

Test API

API เหล่านี้ทำงานร่วมกับการทดสอบ JavaScript ที่แยกจากกันเพื่อสร้างการทดสอบสำหรับเทมเพลตที่กำหนดเองใน Google Tag Manager API สำหรับการทดสอบเหล่านี้ไม่จำเป็นต้องมีrequire() ข้อความ ดูข้อมูลเพิ่มเติมเกี่ยวกับการทดสอบเทมเพลตที่กำหนดเอง

assertApi

แสดงผลออบเจ็กต์ Matcher ที่ใช้เพื่อยืนยันเกี่ยวกับ API ที่ระบุได้อย่างราบรื่น

ไวยากรณ์

assertApi(apiName)

พารามิเตอร์

เครื่องมือจับคู่

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

ตัวอย่าง

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

assertThat

assertThat API ได้รับการออกแบบตามไลบรารี [Truth] ของ Google โดยจะแสดงผลออบเจ็กต์ที่ใช้เพื่อยืนยันค่าของออบเจ็กต์ได้อย่างราบรื่น การยืนยันไม่สำเร็จจะหยุดการทดสอบทันทีและทำเครื่องหมายว่าไม่สำเร็จ อย่างไรก็ตาม การทดสอบหนึ่งไม่สำเร็จจะไม่ส่งผลต่อกรณีทดสอบอื่นๆ

ไวยากรณ์

assertThat(actual, opt_message)

พารามิเตอร์

เครื่องมือจับคู่

ตัวอย่าง

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

ทำให้การทดสอบปัจจุบันล้มเหลวทันทีและพิมพ์ข้อความที่ระบุ หากมี

ไวยากรณ์

fail(opt_message);

พารามิเตอร์

ตัวอย่าง

fail('This test has failed.');

mock

mock API ช่วยให้คุณลบล้างลักษณะการทำงานของ Sandboxed API ได้ API จำลอง ใช้ในโค้ดเทมเพลตได้อย่างปลอดภัย แต่จะใช้งานได้ในโหมดทดสอบเท่านั้น ระบบจะรีเซ็ตการจำลองก่อนเรียกใช้การทดสอบแต่ละครั้ง

ไวยากรณ์

mock(apiName, returnValue);

พารามิเตอร์

ตัวอย่าง

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

mockObject

mockObject API ช่วยให้คุณลบล้างลักษณะการทำงานของ Sandboxed API ที่ แสดงผลออบเจ็กต์ได้ API นี้ใช้ในโค้ดเทมเพลตได้อย่างปลอดภัย แต่จะใช้งานได้ในโหมดทดสอบเท่านั้น ระบบจะรีเซ็ตการจำลองก่อนเรียกใช้การทดสอบแต่ละครั้ง

ไวยากรณ์

mockObject(apiName, objectMock);

พารามิเตอร์

ตัวอย่าง

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

runCode

เรียกใช้โค้ดสำหรับเทมเพลต ซึ่งก็คือเนื้อหาของแท็บโค้ดใน สภาพแวดล้อมการทดสอบปัจจุบันที่มีออบเจ็กต์ข้อมูลอินพุตที่ระบุ

ไวยากรณ์

runCode(data)

พารามิเตอร์

ค่าที่ส่งคืน

แสดงค่าของตัวแปรสำหรับเทมเพลตตัวแปร และแสดง undefined สำหรับ เทมเพลตประเภทอื่นๆ ทั้งหมด

ตัวอย่าง

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