เอกสารนี้สรุปสิทธิ์สำหรับเทมเพลตที่กำหนดเองบนเว็บ
สิทธิ์แต่ละรายการมีดังนี้
- ตรวจสอบโดย API ที่จำเป็นต้องใช้แอปดังกล่าว
- ตรวจหาโดยอัตโนมัติใน JavaScript ที่ทำแซนด์บ็อกซ์ โดยอิงตาม API ที่ใช้ ซึ่งจะเกิดขึ้นเมื่อมีการแก้ไขในเครื่องมือแก้ไขเทมเพลตที่กำหนดเอง (สำหรับ ลูปความคิดเห็น) และเมื่อมีการคอมไพล์โค้ด (เพื่อตรวจสอบว่าโค้ด (มีการบังคับใช้)
- แก้ไขได้ในเครื่องมือแก้ไขเทมเพลตที่กำหนดเองเพื่อทำให้สิทธิ์มีความเฉพาะเจาะจงมากขึ้น
- ค้นหาได้ใน JavaScript ที่ทำแซนด์บ็อกซ์ผ่าน API ของ
queryPermission
access_globals
ชื่อที่แสดง: เข้าถึงตัวแปรร่วม
คำอธิบาย: อนุญาตการเข้าถึงตัวแปรร่วม (อาจรวมถึง 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 ที่มา
ให้อ่านได้ อ่านส่วนที่กำหนดของผู้อ้างอิงได้ก็ต่อเมื่อส่วนที่เกี่ยวข้อง
มีค่า 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 ส่วนที่กำหนดได้ก็ต่อเมื่อส่วนที่เกี่ยวข้องคือ
true ผู้โทรจะโทรหา 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);
}
การบันทึก
ชื่อที่แสดง: บันทึกไปยังคอนโซล
คำอธิบาย: บันทึกไปที่ Play Console และโหมดแสดงตัวอย่างของ GTM
การกำหนดค่า: ตัวเลือกในการเปิดใช้การเข้าสู่ระบบในเวอร์ชันที่ใช้งานจริง ค่าเริ่มต้นคือเท่านั้น
เปิดใช้การแก้ไขข้อบกพร่อง/แสดงตัวอย่าง หากถูกปฏิเสธสิทธิ์ logToConsole
จะไม่แสดงข้อผิดพลาด แต่จะระงับข้อความบันทึก
ต้องระบุโดย logToConsole
ลายเซ็นคำค้นหา: queryPermission('logging')
หมายเหตุ: ควบคุมว่าเทมเพลตที่กำหนดเองสามารถเข้าสู่ระบบ Play Console ได้หรือไม่
โค้ดตัวอย่าง
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
ชื่อที่แสดง: อ่านชั้นข้อมูล
คำอธิบาย: อ่านข้อมูลจาก dataLayer
การกำหนดค่า: ชุดนิพจน์การจับคู่คีย์ ซึ่งการจับคู่คีย์สามารถเป็น ชุดการอ้างอิงแบบจุดนำหน้า พร้อมด้วยไวลด์การ์ดต่อท้าย นิพจน์การจับคู่คีย์จะกําหนดพร็อพเพอร์ตี้ที่อาจอ่านได้จากชั้นข้อมูล
ต้องระบุโดย 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'});
}