หน้านี้ได้รับการแปลโดย Cloud Translation API

สิทธิ์เทมเพลตที่กำหนดเองฝั่งเซิร์ฟเวอร์

เอกสารนี้ระบุสิทธิ์สําหรับเทมเพลตที่กําหนดเองฝั่งเซิร์ฟเวอร์

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

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

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> คือสตริงและมีค่าได้ดังนี้

read - ให้สิทธิ์เข้าถึงการอ่านและค้นหา API
write - ให้สิทธิ์เข้าถึง 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);
}

การบันทึก

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

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

การกําหนดค่า: ตัวเลือกในการเปิดใช้การบันทึกในเวอร์ชันที่ใช้งานจริง ค่าเริ่มต้นคือเปิดใช้การบันทึกในการแก้ไขข้อบกพร่อง/แสดงตัวอย่างเท่านั้น หากถูกปฏิเสธสิทธิ์ 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');

use_message

ชื่อที่แสดง: ใช้ข้อความ

คำอธิบาย: ส่งหรือรับข้อความโดยใช้ addMessageListener หรือ sendMessage API

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

กำหนดโดย: 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

ชื่อที่แสดง: แสดงผลลัพธ์

คําอธิบาย: ส่งคำตอบกลับไปยังผู้เรียกใช้

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

กำหนดโดย: 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>)

หมายเหตุ: ควบคุมว่าจะเพิ่มส่วนหัว "Set-Cookie" หนึ่งๆ ลงในคําตอบได้หรือไม่ โดยขึ้นอยู่กับชื่อคุกกี้ โดเมน เส้นทาง แอตทริบิวต์ 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>)

หมายเหตุ: จำกัดขอบเขต OAuth 2.0 ของ Google ที่อนุญาตเพื่อใช้กับ 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);
}