เอกสารนี้จะระบุสิทธิ์สำหรับเทมเพลตที่กำหนดเองฝั่งเซิร์ฟเวอร์
สิทธิ์แต่ละรายการมีดังนี้
- ตรวจสอบโดย API ที่จำเป็นต้องใช้แอปดังกล่าว
- ตรวจหาโดยอัตโนมัติใน JavaScript ที่ทำแซนด์บ็อกซ์ โดยอิงตาม API ที่ใช้ ซึ่งจะเกิดขึ้นเมื่อมีการแก้ไขในเครื่องมือแก้ไขเทมเพลตที่กำหนดเอง (สำหรับ ลูปความคิดเห็น) และเมื่อมีการคอมไพล์โค้ด (เพื่อตรวจสอบว่าโค้ด (มีการบังคับใช้)
- แก้ไขได้ในเครื่องมือแก้ไขเทมเพลตที่กำหนดเองเพื่อทำให้สิทธิ์มีความเฉพาะเจาะจงมากขึ้น
- ค้นหาได้ใน JavaScript ที่ทำแซนด์บ็อกซ์ผ่าน API ของ
queryPermission
access_bigquery
ชื่อที่แสดง: เข้าถึง BigQuery
คำอธิบาย: อนุญาตการเข้าถึง BigQuery ใน Google Cloud Platform
การกำหนดค่า: ตัวเลือกในการอนุญาตโปรเจ็กต์ ชุดข้อมูล และตารางที่ระบุ
ชุดค่าผสมที่จะใช้กับ BigQuery กำลังตั้งค่าการกำหนดค่ารหัสโปรเจ็กต์
GOOGLE_CLOUD_PROJECT
จะอนุญาตให้ใช้สภาพแวดล้อม GOOGLE_CLOUD_PROJECT
เป็นรหัสโปรเจ็กต์เมื่อยกเว้น projectId
จาก BigQuery API
parameter
ต้องระบุโดย BigQuery
ลายเซ็นคำค้นหา:
queryPermission('access_bigquery', <operation>, <options>)
หมายเหตุ: <operation>
เป็นสตริงและมีค่าต่อไปนี้ได้
- เขียน
<options>
เป็นออบเจ็กต์ที่มีรายการต่อไปนี้
{
'projectId': <project_id>,
'datasetId': <dataset_id>,
'tableId': <table_id>
}
โค้ดตัวอย่าง
const BigQuery = require('BigQuery');
const queryPermission = require('queryPermission');
const connectionInfo = {
'projectId': 'gcp-cloud-project-id',
'datasetId': 'destination-dataset',
'tableId': 'destination-table',
};
if (queryPermission('access_bigquery', 'write', connectionInfo)) {
const rows = [{
'column1': 'String1',
'column2': 1234,
}];
const options = {
'ignoreUnknownValues': true,
'skipInvalidRows': false,
};
BigQuery.insert(connectionInfo, rows, options)
.then(data.gtmOnSuccess, data.gtmOnFailure);
}
access_firestore
ชื่อที่แสดง: เข้าถึง Google Firestore
คำอธิบาย: อนุญาตให้เข้าถึง Google Firestore
การกำหนดค่า: ตัวเลือกสำหรับอนุญาตโปรเจ็กต์และเส้นทางที่ระบุ (ไวยากรณ์ไวลด์การ์ด)
) ชุดค่าผสมที่จะใช้กับ Firestore การตั้งค่ารหัสโปรเจ็กต์
GOOGLE_CLOUD_PROJECT
จะอนุญาตให้ใช้เมธอด
ตัวแปรสภาพแวดล้อม GOOGLE_CLOUD_PROJECT
เป็นรหัสโปรเจ็กต์เมื่อ projectId
ไม่รวมอยู่ใน Firestore API parameter
ต้องระบุโดย Firestore
ลายเซ็นคำค้นหา:
queryPermission('access_firestore', <operation>, <options>)
หมายเหตุ: <operation>
เป็นสตริงและมีค่าต่อไปนี้ได้
- อ่าน - มอบสิทธิ์เข้าถึงเพื่ออ่านและค้นหา API
- เขียน - ให้สิทธิ์เข้าถึงเพื่อเขียน API
- Read_write - ให้สิทธิ์การเข้าถึงเพื่ออ่าน เขียน และค้นหา API
<options>
เป็นออบเจ็กต์ที่มีรายการต่อไปนี้
{
'projectId': <project_id>,
'path': <path>
}
โค้ดตัวอย่าง
const Firestore = require('Firestore');
const queryPermission = require('queryPermission');
const options = {
'projectId': 'gcp-cloud-project-id',
'path': 'collection/document',
};
if (queryPermission('access_firestore', 'read', options)) {
Firestore.read('collection/document', {
projectId: 'gcp-cloud-project-id',
}).then(data.gtmOnSuccess, data.gtmOnFailure);
}
access_response
ชื่อที่แสดง: เข้าถึงคำตอบ
คำอธิบาย: เข้าถึงเนื้อหา ส่วนหัว หรือสถานะของการตอบกลับ
การกำหนดค่า: ตัวเลือกในการอนุญาตการเข้าถึงที่เฉพาะเจาะจงหรือบางส่วน พร้อมตัวเลือกย่อยสำหรับ การควบคุมการเข้าถึงคอมโพเนนต์ย่อยต่างๆ
ต้องระบุโดย: setPixelResponse
, setResponseBody
setResponseHeader
setResponseStatus
ลายเซ็นคำค้นหา:
queryPermission('access_response', 'write', <component>[, <optional component name>])
หมายเหตุ: ควบคุมว่าจะให้เข้าถึงคอมโพเนนต์การตอบสนอง HTTP ขาออกได้หรือไม่
โค้ดตัวอย่าง
const queryPermission = require('queryPermission');
const setResponseBody = require('setResponseBody');
const setResponseHeader = require('setResponseHeader');
const setResponseStatus = require('setResponseStatus');
if (queryPermission('access_response', 'write', 'header', 'Content-Type')) {
setResponseHeader('Content-Type', 'text/plain');
}
if (queryPermission('access_response', 'write', 'body')) {
setResponseBody('Not Found');
}
if (queryPermission('access_response', 'write', 'status')) {
setResponseStatus(404);
}
access_template_storage
ชื่อที่แสดง: เข้าถึงพื้นที่เก็บข้อมูลเทมเพลต
คำอธิบาย: อนุญาตการเข้าถึงพื้นที่เก็บข้อมูลชั่วคราวสำหรับเทมเพลตที่สามารถ คงอยู่ตลอดอายุการใช้งานของกระบวนการฝั่งเซิร์ฟเวอร์
การกำหนดค่า: ไม่มี
ต้องระบุโดย templateDataStorage
ลายเซ็นคำค้นหา: queryPermission('access_template_storage')
โค้ดตัวอย่าง
const queryPermission = require('queryPermission');
const templateDataStorage = require('templateDataStorage');
const key = 'my_key';
if (queryPermission('access_template_storage')) {
const value = templateDataStorage.getItemCopy(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);
}
การบันทึก
ชื่อที่แสดง: บันทึกไปยังคอนโซล
คำอธิบาย: บันทึกไปที่ Developer Console และโหมดแสดงตัวอย่างของ Tag Manager
การกำหนดค่า: ตัวเลือกในการเปิดใช้การเข้าสู่ระบบในเวอร์ชันที่ใช้งานจริง ค่าเริ่มต้นคือเท่านั้น
เปิดใช้การแก้ไขข้อบกพร่อง/แสดงตัวอย่าง หากถูกปฏิเสธสิทธิ์ 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');
use_message
ชื่อที่แสดง: ใช้ข้อความ
คำอธิบาย: ส่งหรือรับข้อความโดยใช้ addMessageListener
หรือ
sendMessage
API
การกำหนดค่า: ตัวเลือกสำหรับระบุประเภทข้อความและเทมเพลต จะฟัง ส่ง หรือทั้ง 2 อย่างก็ได้
ต้องระบุโดย: addMessageListener
, sendMessage
ลายเซ็นคำค้นหา: queryPermission('use_message', <usage>, <message type>)
หมายเหตุ: การใช้งานอาจเป็น listen
, send
หรือ listen_and_send
ก็ได้
โค้ดตัวอย่าง
const queryPermission = require('queryPermission');
const sendMessage = require('sendMessage');
if (queryPermission('use_message', 'send', 'set_cookie')) {
sendMessage('set_cookie', {name: 'foo', value: 'bar'});
}
read_container_data
ชื่อที่แสดง: อ่านข้อมูลคอนเทนเนอร์
คําอธิบาย: อ่านข้อมูลเกี่ยวกับคอนเทนเนอร์
การกำหนดค่า: ไม่มี
ต้องระบุโดย: getClientName
, getContainerVersion
ลายเซ็นคำค้นหา: queryPermission('read_container_data')
หมายเหตุ: ควบคุมว่าเทมเพลตที่กำหนดเองจะอ่านข้อมูลคอนเทนเนอร์ได้หรือไม่
โค้ดตัวอย่าง
const getContainerVersion = require('getContainerVersion');
const queryPermission = require('queryPermission');
if (queryPermission('read_container_data')) {
return getContainerVersion();
}
read_event_data
ชื่อที่แสดง: อ่านข้อมูลเหตุการณ์
คำอธิบาย: อ่านข้อมูลจากเหตุการณ์
การกำหนดค่า: ตัวเลือกในการอนุญาตให้เข้าถึงทั้งหมด หรือการเข้าถึงบางอย่างที่ควบคุมโดย รายการเส้นทางคีย์ที่อนุญาต (รองรับไวยากรณ์ไวลด์การ์ด)
ต้องระบุโดย: getAllEventData
, getEventData
ลายเซ็นคำค้นหา: queryPermission('read_event_data'[, <optional key>])
หมายเหตุ: ควบคุมว่าเทมเพลตที่กําหนดเองจะอ่านข้อมูลเหตุการณ์ที่เส้นทางคีย์ที่ระบุได้หรือไม่ (หรือข้อมูลเหตุการณ์ทั้งหมด หากไม่ได้ระบุเส้นทางคีย์)
โค้ดตัวอย่าง
const getAllEventData = require('getAllEventData');
const queryPermission = require('queryPermission');
if (queryPermission('read_event_data')) {
return getAllEventData();
}
const getEventData = require('getEventData');
const queryPermission = require('queryPermission');
const keyPath = 'parentField.childField';
if (queryPermission('read_event_data', keyPath)) {
return getEventData(keyPath);
}
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_request
ชื่อที่แสดง: อ่านคำขอ HTTP
คำอธิบาย: อ่านส่วนหัวของคำขอ พารามิเตอร์การค้นหา เนื้อหา เส้นทาง หรือ ที่อยู่ IP ระยะไกล
การกำหนดค่า: ตัวเลือกในการอนุญาตการเข้าถึงที่เฉพาะเจาะจงหรือบางส่วน พร้อมตัวเลือกย่อยสำหรับ การควบคุมการเข้าถึงคอมโพเนนต์ย่อยต่างๆ
ต้องระบุโดย: extractEventsFromMpv1
, extractEventsFromMpv2
getRemoteAddress
, getRequestBody
, getRequestHeader
getRequestPath
, getRequestQueryParameter
, getRequestQueryParameters
getRequestQueryString
ลายเซ็นคำค้นหา:
queryPermission('read_request', <component>[, <optional component name>])
หมายเหตุ: ควบคุมว่าจะเข้าถึงคอมโพเนนต์การตอบสนอง HTTP ขาเข้าได้หรือไม่
โค้ดตัวอย่าง
const queryPermission = require('queryPermission');
const getRequestBody = require('getRequestBody');
const getRequestHeader = require('getRequestHeader');
let body, contentType;
if (queryPermission('read_request', 'body')) {
body = getRequestBody();
}
if (queryPermission('read_request', 'header', 'content-type')) {
contentType = getRequestHeader('content-type');
}
if (body && contentType == 'application/json') { ... }
return_response
Display name: แสดงผลคำตอบ
คำอธิบาย: ส่งคืนคำตอบไปยังผู้โทร
การกำหนดค่า: ไม่มี
ต้องระบุโดย returnResponse
ลายเซ็นคำค้นหา: queryPermission('return_response')
หมายเหตุ: สิทธิ์นี้ไม่มีช่องให้จำกัดและมักไม่มีการค้นหา สำหรับ
run_container
ชื่อที่แสดง: เรียกใช้คอนเทนเนอร์
คำอธิบาย: เรียกใช้คอนเทนเนอร์ที่มีเหตุการณ์
การกำหนดค่า: ไม่มี
ต้องระบุโดย runContainer
ลายเซ็นคำค้นหา: queryPermission('run_container')
หมายเหตุ: สิทธิ์นี้ไม่มีช่องให้จำกัดขอบเขต และโดยทั่วไปจะไม่ได้รับการค้นหา
send_http
ชื่อที่แสดง: ส่งคำขอ HTTP
คําอธิบาย: ส่งคําขอ HTTP ไปยัง URL ที่ระบุ
ต้องระบุโดย: getGoogleScript
, sendEventToGoogleAnalytics
sendHttpGet
sendHttpRequest
ลายเซ็นคำค้นหา: queryPermission('send_http', <url>)
หมายเหตุ: ควบคุมว่าจะส่งคำขอ HTTP ได้หรือไม่ โดยขึ้นอยู่กับ URL เพื่อให้มั่นใจถึงการเชื่อมต่อที่ปลอดภัย จะอนุญาตเฉพาะ URL ที่ปลอดภัย (HTTPS) เท่านั้น
โค้ดตัวอย่าง
const queryPermission = require('queryPermission');
const sendHttpGet = require('sendHttpGet');
const url = 'https://example.com/search?query=foo&results=10';
if (queryPermission('send_http', url)) {
sendHttpGet(url);
}
send_pixel_from_browser
ชื่อที่แสดง: ส่งพิกเซลจากเบราว์เซอร์
คำอธิบาย: ส่งคำขอ GET ไปยัง URL ที่ระบุจากเบราว์เซอร์
กำหนดโดย: sendPixelFromBrowser
ลายเซ็นคำค้นหา: queryPermission('send_pixel_from_browser', <url>)
หมายเหตุ: ควบคุมว่าจะส่งคำขอจากเบราว์เซอร์ได้หรือไม่ โดยขึ้นอยู่กับ URL
โค้ดตัวอย่าง
const queryPermission = require('queryPermission');
const sendPixelFromBrowser = require('sendPixelFromBrowser');
const url = 'https://example.com/search?query=foo&results=10';
if (queryPermission('send_pixel_from_browser', url)) {
sendPixelFromBrowser(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);
}
use_custom_private_keys
ชื่อที่แสดง: ใช้คีย์ส่วนตัวที่กำหนดเอง
คําอธิบาย: ใช้คีย์ส่วนตัวจากไฟล์คีย์ JSON สําหรับการดำเนินการเข้ารหัส
การกำหนดค่า: รายการรหัสคีย์ที่อนุญาต รหัสต้องตรงกับคีย์ใน
ไฟล์คีย์ JSON ที่อ้างอิงโดยตัวแปรสภาพแวดล้อม SGTM_CREDENTIALS
บนเซิร์ฟเวอร์
ต้องระบุโดย hmacSha256
ลายเซ็นคำค้นหา: queryPermission('use_custom_private_keys', <key id>)
หมายเหตุ: ควบคุมรายการคีย์ส่วนตัวที่อนุญาต
โค้ดตัวอย่าง
const hmacSha256= require('hmacSha256');
const queryPermission = require('queryPermission');
const keyId = 'key1';
let result;
if (queryPermission('use_custom_private_keys', keyId)) {
result = hmacSha256('my_data', keyId);
}
use_google_credentials
ชื่อที่แสดง: ใช้ข้อมูลเข้าสู่ระบบเริ่มต้นของแอปพลิเคชันของ Google
คำอธิบาย: ใช้ข้อมูลเข้าสู่ระบบเริ่มต้นของ Google เพื่อโทรหา Google API
การกำหนดค่า: รายการขอบเขต OAuth 2.0 ของ Google ที่อนุญาต
กำหนดโดย: getGoogleAuth
ลายเซ็นคำค้นหา: queryPermission('use_google_credentials', <scopes>)
หมายเหตุ: จำกัดขอบเขต Google OAuth 2.0 ที่อนุญาตเพื่อใช้กับ Google API
โค้ดตัวอย่าง
const getGoogleAuth = require('getGoogleAuth');
const queryPermission = require('queryPermission');
const scopes = [
'https://www.googleapis.com/auth/datastore'
];
let auth;
if (queryPermission('use_google_credentials', scopes)) {
auth = getGoogleAuth(scopes);
}