สิทธิ์เทมเพลตที่กำหนดเอง

เอกสารนี้ระบุสิทธิ์สำหรับเทมเพลตที่กำหนดเองของเว็บ

สิทธิ์แต่ละรายการมีดังนี้

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

access_globals

ชื่อที่แสดง: เข้าถึงตัวแปรร่วม

Description: อนุญาตการเข้าถึงตัวแปรร่วม (อาจรวมถึง API ที่มีความละเอียดอ่อน)

การกําหนดค่า: รายการคีย์ที่เข้าถึงได้ คีย์แต่ละรายการคือเส้นทางที่คั่นด้วยจุด ตัวอย่างเช่น foo.bar โทเค็นแรกในแต่ละเส้นทางต้องไม่ใช่คีย์ที่กําหนดไว้ล่วงหน้าในขอบเขตทั้งหมดของเบราว์เซอร์ หรือคีย์เวิร์ด JavaScript มีช่องทําเครื่องหมายอ่าน เขียน และเรียกใช้ที่ควบคุมการเข้าถึง

ต้องระบุโดย: setInWindow, copyFromWindow, callInWindow, createQueue, createArgumentsQueue

ลายเซ็นการค้นหา: queryPermission('access_globals', 'read', <key to read from>) หรือ queryPermission('access_globals', 'write', <key to write to>) หรือ queryPermission('access_globals', 'readwrite', <key to read and write>) หรือ queryPermission('access_globals', 'execute', <key of function to execute>)

หมายเหตุ: ควบคุมว่าเทมเพลตที่กำหนดเองจะอ่านและ/หรือเขียนเป็นค่าส่วนกลางได้หรือไม่

ตัวอย่างโค้ด

const queryPermission = require('queryPermission');
const createQueue = require('createQueue');
if (queryPermission('access_globals', 'readwrite', 'dataLayer')) {
  const dataLayerPush = createQueue('dataLayer');
}

access_local_storage

ชื่อที่แสดง: เข้าถึงพื้นที่เก็บข้อมูลในเครื่อง

คำอธิบาย: อนุญาตการเข้าถึงคีย์ที่ระบุในพื้นที่เก็บข้อมูลในเครื่อง

การกําหนดค่า: รายการคีย์พื้นที่เก็บข้อมูลในเครื่องที่เข้าถึงได้ นี่เป็นอาร์เรย์คีย์แบบง่ายที่ไม่มีไวลด์การ์ด มีช่องทําเครื่องหมายอ่านและเขียนที่ควบคุมการเข้าถึง

กำหนดโดย: localStorage

ลายเซ็นการค้นหา: queryPermission('access_local_storage', 'read', <key to read from>) หรือ queryPermission('access_local_storage', 'write', <key to write to>) หรือ queryPermission('access_local_storage', 'readwrite', <key to read and write>)

ตัวอย่างโค้ด

const queryPermission = require('queryPermission');
const localStorage = require('localStorage');
const key = 'my_key';
if (queryPermission('access_local_storage', 'read', key)) {
  const value = localStorage.getItem(key);
}

access_template_storage

ชื่อที่แสดง: เข้าถึงพื้นที่เก็บข้อมูลเทมเพลต

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

การกําหนดค่า: ไม่มี

ต้องระบุโดย templateStorage

ลายเซ็นการค้นหา: queryPermission('access_template_storage')

โค้ดตัวอย่าง

const queryPermission = require('queryPermission');
const templateStorage = require('templateStorage');
const key = 'my_key';
if (queryPermission('access_template_storage')) {
  const value = templateStorage.getItem(key);
}

get_cookies

ชื่อที่แสดง: อ่านค่าคุกกี้

คำอธิบาย: อ่านค่าของคุกกี้ที่มีชื่อที่ระบุ

การกําหนดค่า: รายการชื่อคุกกี้ที่ได้รับอนุญาตให้อ่าน

กำหนดโดย: getCookieValues

ลายเซ็นการค้นหา: queryPermission('get_cookies', <name>)

หมายเหตุ: ควบคุมว่าจะอ่านคุกกี้ได้หรือไม่ โดยขึ้นอยู่กับชื่อของคุกกี้

โค้ดตัวอย่าง

const queryPermission = require('queryPermission');
const getCookieValues = require('getCookieValues');
const cookieName = 'info';
let cookieValues;
if (queryPermission('get_cookies', cookieName)) {
  cookieValues = getCookieValues(cookieName);
}

get_referrer

ชื่อที่แสดง: อ่าน URL ที่มา

คําอธิบาย: อนุญาตให้เข้าถึงส่วนที่มีการจํากัดของ URL ที่มาเพื่ออ่าน

การกำหนดค่า: บูลีนต่อไปนี้จะควบคุมส่วนของ URL ที่อ่านได้ ระบบจะอ่านส่วนใดส่วนหนึ่งของ URL ที่มาได้ก็ต่อเมื่อส่วนนั้นคือ true ผู้โทรจะเรียก getReferrerUrl ได้โดยไม่ต้องระบุคอมโพเนนต์เพื่อรับ URL ผู้อ้างอิงที่สมบูรณ์ หากตั้งค่าบูลีนเหล่านี้เป็น true ทั้งหมด หากไม่ได้ตั้งค่าค่าไว้ ค่าเริ่มต้นจะเป็น all หากมีการตั้งค่า ค่าต้องเป็นอาร์เรย์ของคอมโพเนนต์ โดยคอมโพเนนต์ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้ protocol, host, port, path, query หรือ extension

queryKeys: หากเลือกคำค้นหา ผู้เขียนเทมเพลตอาจจำกัดชุดคีย์คำค้นหาที่อ่านได้ ซึ่งเป็นอาร์เรย์ของคีย์แบบง่ายๆ โดยไม่มีไวลด์การ์ด

กำหนดโดย: getReferrerUrl, getReferrerQueryParameters

ลายเซ็นการค้นหา: queryPermission('get_referrer', <url_component>)

ตัวอย่างโค้ด

const queryPermission = require('queryPermission');
const getReferrerUrl = require('getReferrerUrl');
let referrer;
if (queryPermission('get_referrer', 'query')) {
  referrer = getReferrerUrl('queryParams');
}

get_url

ชื่อที่แสดง: อ่าน URL

คําอธิบาย: แสดงผล URL ของหน้าปัจจุบันบางส่วนหรือทั้งหมด

การกําหนดค่า: บูลีนต่อไปนี้จะควบคุมว่า URL บางส่วนใดที่อ่านได้ ระบบจะอ่าน URL บางส่วนได้ก็ต่อเมื่อส่วนที่เกี่ยวข้องเป็น "จริง" ผู้เรียกสามารถเรียกใช้ getUrl โดยไม่ระบุคอมโพเนนต์เพื่อรับ URL ทั้งหมดได้ก็ต่อเมื่อตั้งค่าบูลีนทั้งหมดเหล่านี้เป็น true หากไม่ได้ตั้งค่าค่าใด ค่าเริ่มต้นจะเป็น all หากมีการตั้งค่า ค่าดังกล่าวต้องเป็นอาร์เรย์ของคอมโพเนนต์ที่คอมโพเนนต์เป็นหนึ่งในค่าใดค่าหนึ่งต่อไปนี้ protocol, host, port, path, query, extension หรือ fragment

queryKeys: หากเลือก "การค้นหา" ผู้เขียนเทมเพลตอาจจํากัดชุดคีย์การค้นหาที่อ่านได้เพิ่มเติม ซึ่งเป็นอาร์เรย์ของคีย์แบบง่ายๆ โดยไม่มีไวลด์การ์ด

กำหนดโดย: getUrl

ลายเซ็นการค้นหา: queryPermission('get_url', <optional url component>, <optional query key>)

หากระบุไว้ คอมโพเนนต์ URL ควรเป็นหนึ่งใน 'protocol', 'host', 'port', 'path', 'query', 'extension', 'fragment' หากไม่ระบุ การค้นหาสิทธิ์จะเป็นคำขอเข้าถึง URL ทั้งหมด

หากระบุ คีย์การค้นหาควรเป็นอาร์กิวเมนต์สตริงการค้นหาที่เทมเพลตโค้ดต้องการอ่าน

หมายเหตุ: ควบคุมว่าเทมเพลตที่กำหนดเองจะอ่านจากตำแหน่งปัจจุบันได้หรือไม่ อนุญาตให้จํากัดเฉพาะบางส่วนของสถานที่

โค้ดตัวอย่าง

const queryPermission = require('queryPermission');
const getUrl = require('getUrl');
if (queryPermission('get_url', 'query', 'gclid')) {
  const gclid = getUrl('query', false, null, 'gclid');
}

inject_hidden_iframe

ชื่อที่แสดง: แทรก iframe ที่ซ่อนไว้

คำอธิบาย: ใส่ iframe ล่องหนด้วย URL ที่ให้มา

การกําหนดค่า: รายการรูปแบบ URL

กำหนดโดย: injectHiddenIframe

ลายเซ็นคำค้นหา: queryPermission('inject_hidden_iframe', <url>)

หมายเหตุ: ควบคุมว่าจะให้เทมเพลตที่กำหนดเองแทรก iframe ที่มองไม่เห็นได้หรือไม่ และต้นทางใดที่ทำได้

โค้ดตัวอย่าง

const queryPermission = require('queryPermission');
const injectHiddenIframe = require('injectHiddenIframe');
const url = 'https://www.example.com/iframes';
if (queryPermission('inject_hidden_iframe', url)) {
  injectHiddenIframe(url);
}

inject_script

ชื่อที่แสดง: แทรกสคริปต์

คําอธิบาย: แทรกสคริปต์ลงในหน้าเว็บ

การกําหนดค่า: รายการรูปแบบ URL

กำหนดโดย: injectScript

ลายเซ็นการค้นหา: queryPermission('inject_script', <url>)

หมายเหตุ: ควบคุมว่าเทมเพลตที่กําหนดเองจะแทรก JavaScript ได้หรือไม่ และจากต้นทางใด

ตัวอย่างโค้ด

const queryPermission = require('queryPermission');
const injectScript = require('injectScript');
const url = 'https://www.example.com?api.js';
if (queryPermission('inject_script', url)) {
  injectScript(url);
}

การบันทึก

ชื่อที่แสดง: บันทึกไปยังคอนโซล

คําอธิบาย: บันทึกไปที่คอนโซลของนักพัฒนาซอฟต์แวร์และโหมดแสดงตัวอย่างของ GTM

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

ต้องระบุโดย logToConsole

ลายเซ็นการค้นหา: queryPermission('logging')

หมายเหตุ: ควบคุมว่าเทมเพลตที่กำหนดเองจะบันทึกลงในคอนโซลของนักพัฒนาแอปได้หรือไม่

ตัวอย่างโค้ด

const queryPermission = require('queryPermission');
const logToConsole = require('logToConsole');
// Note that it's fine to call log, since the log call will be ignored if
// logging isn't permitted in the current environment.
logToConsole('diagnostic info');

read_data_layer

ชื่อที่แสดง: อ่านชั้นข้อมูล

คําอธิบาย: อ่านข้อมูลจากชั้นข้อมูล

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

ต้องระบุโดย copyFromDataLayer

ลายเซ็นการค้นหา: queryPermission('read_data_layer', <data layer key to read from>)

หมายเหตุ: ควบคุมว่าเทมเพลตที่กําหนดเองจะอ่านจากเลเยอร์ข้อมูลได้หรือไม่

ตัวอย่างโค้ด

const queryPermission = require('queryPermission');
const copyFromDataLayer = require('copyFromDataLayer');
const dlKey = 'foo.bar';
if (queryPermission('read_data_layer', dlKey)) {
  const dlContents = copyFromDataLayer(dlKey);
}

read_character_set

ชื่อที่แสดง: อ่านชุดอักขระของเอกสาร

คำอธิบาย: อ่าน document.characterSet

การกําหนดค่า: ไม่มี

กำหนดโดย: readCharacterSet

ลายเซ็นคำค้นหา: queryPermission('read_character_set')

หมายเหตุ: ควบคุมว่าเทมเพลตที่กำหนดเองจะอ่าน document.characterSet ได้หรือไม่

ตัวอย่างโค้ด

const queryPermission = require('queryPermission');
const readCharacterSet = require('readCharacterSet');
if (queryPermission('read_character_set')) {
  const characterSet = readCharacterSet();
}

read_container_data

ชื่อที่แสดง: อ่านข้อมูลคอนเทนเนอร์

คําอธิบาย: อ่านข้อมูลเกี่ยวกับคอนเทนเนอร์

การกําหนดค่า: ไม่มี

กำหนดโดย: getContainerVersion

ลายเซ็นการค้นหา: queryPermission('read_container_data')

หมายเหตุ: ควบคุมว่าเทมเพลตที่กำหนดเองจะอ่านข้อมูลเกี่ยวกับคอนเทนเนอร์ได้หรือไม่

ตัวอย่างโค้ด

const queryPermission = require('queryPermission');
const getCookieValues = require('getContainerVersion');
let version;
if (queryPermission('read_container_data')) {
  version = getContainerVersion();
}

read_event_metadata

ชื่อที่แสดง: อ่านข้อมูลเมตาของเหตุการณ์

คําอธิบาย: อ่านข้อมูลเมตาของเหตุการณ์ใน Callback ของเหตุการณ์

การกําหนดค่า: ไม่มี

กำหนดโดย: addEventCallback

ลายเซ็นการค้นหา: queryPermission('read_event_metadata')

หมายเหตุ: ควบคุมว่าเทมเพลตที่กําหนดเองจะอ่านข้อมูลเมตาของเหตุการณ์ใน callback ได้หรือไม่

ตัวอย่างโค้ด

const queryPermission = require('queryPermission');
const addEventCallback = require('addEventCallback');
if (queryPermission('read_event_metadata')) {
  addEventCallback((containerId, eventMetadata) => {
    // Read event metadata.
  });
}

read_title

ชื่อที่แสดง: อ่านชื่อเอกสาร

คำอธิบาย: อ่าน document.title

การกำหนดค่า: ไม่มี

กำหนดโดย: readTitle

ลายเซ็นคำค้นหา: queryPermission('read_title')

หมายเหตุ: ควบคุมว่าเทมเพลตที่กำหนดเองจะอ่าน document.title ได้หรือไม่

ตัวอย่างโค้ด

const queryPermission = require('queryPermission');
const readTitle = require('readTitle');
if (queryPermission('read_title')) {
  const title = readTitle();
}

send_pixel

ชื่อที่แสดง: ส่งพิกเซล

คําอธิบาย: ส่งคําขอ GET ไปยัง URL ที่ระบุ ระบบไม่ประมวลผลคําตอบ

การกำหนดค่า: รายการรูปแบบ URL ที่อนุญาต

กำหนดโดย: sendPixel

ลายเซ็นการค้นหา: queryPermission('send_pixel', <url>)

หมายเหตุ: ควบคุมว่าจะให้เทมเพลตที่กำหนดเองส่งคำขอ GET ได้หรือไม่ รวมถึงต้นทางที่ทำได้

ตัวอย่างโค้ด

const queryPermission = require('queryPermission');
const sendPixel = require('sendPixel');
const url = 'https://www.example.com?foo=3';
if (queryPermission('send_pixel', url)) {
  sendPixel(url);
}

set_cookies

ชื่อที่แสดง: ตั้งค่าคุกกี้

คําอธิบาย: ตั้งค่าคุกกี้โดยใช้ชื่อและพารามิเตอร์ที่ระบุ

การกําหนดค่า: ตารางชื่อคุกกี้ที่อนุญาต โดยแต่ละชื่อจะมีข้อจํากัดที่ไม่บังคับเกี่ยวกับชื่อ โดเมน เส้นทาง แอตทริบิวต์ secure และการหมดอายุ

กำหนดโดย: setCookie

ลายเซ็นการค้นหา: queryPermission('set_cookies', <name>, <options>)

หมายเหตุ: ควบคุมว่าจะเขียนคุกกี้ได้หรือไม่ โดยขึ้นอยู่กับชื่อ โดเมน เส้นทาง แอตทริบิวต์ secure และวันหมดอายุของคุกกี้

ตัวอย่างโค้ด

const queryPermission = require('queryPermission');
const setCookie = require('setCookie');
const options = {
  'domain': 'www.example.com',
  'path': '/',
  'max-age': 60*60*24*365,
  'secure': true
};
if (queryPermission('set_cookies', 'info', options)) {
  setCookie('info', 'xyz', options);
}

write_data_layer

ชื่อที่แสดง: เขียนชั้นข้อมูล

คําอธิบาย: เขียนข้อมูลลงในชั้นข้อมูล

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

กำหนดโดย: gtagSet

ลายเซ็นการค้นหา: queryPermission('write_data_layer', <data layer key to write from>)

หมายเหตุ: ควบคุมว่าเทมเพลตที่กําหนดเองจะเขียนลงในเลเยอร์ข้อมูลได้หรือไม่

ตัวอย่างโค้ด

const queryPermission = require('queryPermission');
const gtagSet = require('gtagSet');
const dlKey = 'foo.bar';
if (queryPermission('write_data_layer', dlKey)) {
  gtagSet({dlKey: 'baz'});
}