Quyền đối với mẫu tuỳ chỉnh

Tài liệu này trình bày các quyền đối với mẫu tuỳ chỉnh trên web.

Mỗi quyền là:

  • Kiểm tra bởi các API yêu cầu chúng.
  • Tự động phát hiện trong JavaScript hộp cát, dựa trên API nào được sử dụng. Điều này xảy ra khi các nội dung chỉnh sửa được thực hiện trong trình chỉnh sửa mẫu tuỳ chỉnh (đối với vòng lặp phản hồi nhanh) và khi mã được biên dịch (để xác thực rằng các quyền chính xác đã được thực thi).
  • Có thể chỉnh sửa trong trình chỉnh sửa mẫu tuỳ chỉnh để quyền cụ thể hơn.
  • Có thể truy vấn trong JavaScript hộp cát qua API queryPermission.

access_globals

Tên hiển thị: Truy cập vào các biến toàn cục

Mô tả: Cho phép truy cập vào một biến toàn cục (có thể bao gồm các API nhạy cảm).

Cấu hình: Danh sách các khoá có thể truy cập. Mỗi khoá là một đường dẫn được phân tách bằng dấu chấm. Ví dụ: foo.bar Mã thông báo đầu tiên trong mỗi đường dẫn không được là khoá được xác định trước trong phạm vi toàn cục của trình duyệt cũng như không được là từ khoá JavaScript. Có các hộp đánh dấu đọc, ghi và thực thi để quản lý quyền truy cập.

Được yêu cầu bởi: setInWindow, copyFromWindow, callInWindow, createQueue, createArgumentsQueue

Chữ ký truy vấn: queryPermission('access_globals', 'read', <key to read from>), queryPermission('access_globals', 'write', <key to write to>) hoặc queryPermission('access_globals', 'readwrite', <key to read and write>) hoặc queryPermission('access_globals', 'execute', <key of function to execute>)

Lưu ý: Kiểm soát việc một mẫu tuỳ chỉnh có thể đọc và/hoặc ghi vào các giá trị chung hay không.

Mã ví dụ

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

access_local_storage

Tên hiển thị: Truy cập vào bộ nhớ cục bộ

Mô tả: Cho phép truy cập vào các khoá đã chỉ định trong bộ nhớ cục bộ.

Cấu hình: Danh sách các khoá bộ nhớ cục bộ có thể truy cập được. Đây là một mảng khoá đơn giản không có ký tự đại diện. Có các hộp đánh dấu đọc và ghi để quản lý quyền truy cập.

Được yêu cầu bởi: localStorage

Chữ ký truy vấn: queryPermission('access_local_storage', 'read', <key to read from>), queryPermission('access_local_storage', 'write', <key to write to>) hoặc queryPermission('access_local_storage', 'readwrite', <key to read and write>)

Mã ví dụ

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

Tên hiển thị: Truy cập vào bộ nhớ mẫu

Mô tả: Cho phép truy cập vào bộ nhớ tạm thời đối với các mẫu có thể tồn tại trong toàn bộ thời gian của trang.

Cấu hình: Không có

Được yêu cầu bởi: templateStorage

Chữ ký truy vấn: queryPermission('access_template_storage')

Mã ví dụ

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

get_cookies

Tên hiển thị: Đọc(các) giá trị cookie

Mô tả: Đọc giá trị của các cookie có tên đã chỉ định.

Cấu hình: Danh sách tên cookie được phép đọc.

Được yêu cầu bởi: getCookieValues

Chữ ký truy vấn: queryPermission('get_cookies', <name>)

Lưu ý: Quy định việc cookie có thể đọc được hay không, tuỳ thuộc vào tên của cookie.

Mã ví dụ

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

get_referrer

Tên hiển thị: Đọc URL của đường liên kết giới thiệu

Mô tả: Cho phép quyền đọc đối với các phần thu hẹp của đường liên kết giới thiệu.

Cấu hình: Các giá trị boolean sau đây chi phối phần nào của liên kết giới thiệu có thể được đọc. Bạn chỉ có thể đọc một phần nhất định của đường liên kết giới thiệu nếu phần tương ứng là true. Phương thức gọi có thể gọi getReferrerUrl mà không cần chỉ định thành phần để lấy URL liên kết giới thiệu đầy đủ nếu tất cả các boolean này được đặt thành true. Nếu không có giá trị nào được đặt, thì giá trị mặc định sẽ là all. Nếu bạn đặt một giá trị, thì giá trị phải là một mảng thành phần, trong đó thành phần là một trong các thành phần sau: protocol, host, port, path, query hoặc extension.

queryKeys: Nếu bạn chọn truy vấn, thì tác giả mẫu có thể giới hạn thêm tập hợp khoá truy vấn mà họ có thể đọc. Đây là một mảng các khoá đơn giản, không có ký tự đại diện.

Được yêu cầu bởi: getReferrerUrl, getReferrerQueryParameters

Chữ ký truy vấn: queryPermission('get_referrer', <url_component>)

Mã ví dụ

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

get_url

Tên hiển thị: Đọc URL

Mô tả: Trả về một phần hoặc toàn bộ URL của trang hiện tại.

Cấu hình: Các giá trị boolean sau đây quy định phần nào của URL có thể được đọc. Hệ thống chỉ có thể đọc một phần nhất định của URL nếu phần tương ứng là đúng. Phương thức gọi có thể gọi getUrl mà không cần chỉ định thành phần nào để lấy toàn bộ URL khi và chỉ khi tất cả giá trị boolean này được đặt thành true. Nếu không có giá trị nào được đặt, thì giá trị mặc định sẽ là all. Nếu bạn đặt một giá trị, thì giá trị đó phải là một mảng các thành phần, trong đó thành phần là một trong các thành phần sau: protocol, host, port, path, query, extension hoặc fragment.

queryKeys: Nếu bạn chọn truy vấn, thì tác giả mẫu có thể giới hạn thêm tập hợp khoá truy vấn mà họ có thể đọc. Đây là một mảng các khoá đơn giản, không có ký tự đại diện.

Được yêu cầu bởi: getUrl

Chữ ký truy vấn: queryPermission('get_url', <optional url component>, <optional query key>)

Nếu được cung cấp, thành phần URL phải là một trong các giá trị 'protocol', 'host', 'port', 'path', 'query', 'extension', 'fragment'. Nếu bị bỏ qua, truy vấn quyền sẽ là một yêu cầu truy cập vào toàn bộ URL.

Nếu được cung cấp, khoá truy vấn phải là đối số chuỗi truy vấn mà mã mẫu muốn đọc.

Lưu ý: Kiểm soát việc một mẫu tuỳ chỉnh có thể đọc từ vị trí hiện tại hay không. Cho phép giới hạn ở một phần cụ thể của vị trí.

Mã ví dụ

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

inject_hidden_iframe

Tên hiển thị: Chèn các iframe ẩn

Mô tả: Chèn một iframe ẩn với một URL nhất định.

Cấu hình: Danh sách các mẫu URL

Được yêu cầu bởi: injectHiddenIframe

Chữ ký truy vấn: queryPermission('inject_hidden_iframe', <url>)

Lưu ý: Quy định việc mẫu tuỳ chỉnh có thể chèn iFrame vô hình hay không và từ nguồn nào mà mẫu đó có thể chèn iframe.

Mã ví dụ

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

Tên hiển thị: Chèn tập lệnh

Mô tả: Chèn một tập lệnh vào trang.

Cấu hình: Danh sách các mẫu URL

Được yêu cầu bởi: injectScript

Chữ ký truy vấn: queryPermission('inject_script', <url>)

Lưu ý: Quy định việc một mẫu tuỳ chỉnh có thể chèn JavaScript hay không và từ nguồn gốc mà mẫu đó có thể chèn JavaScript.

Mã ví dụ

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

ghi nhật ký

Tên hiển thị: Ghi nhật ký vào bảng điều khiển

Mô tả: Ghi nhật ký vào bảng điều khiển dành cho nhà phát triển và chế độ xem trước của GTM.

Cấu hình: Tuỳ chọn bật tính năng ghi nhật ký trong phiên bản chính thức. Chế độ mặc định là chỉ bật tính năng ghi nhật ký trong gỡ lỗi/xem trước. Nếu quyền bị từ chối, logToConsole sẽ không gửi lỗi nhưng sẽ chặn thông điệp nhật ký.

Được yêu cầu bởi: logToConsole

Chữ ký truy vấn: queryPermission('logging')

Lưu ý: Kiểm soát việc một mẫu tuỳ chỉnh có thể đăng nhập vào bảng điều khiển dành cho nhà phát triển hay không.

Mã ví dụ

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

Tên hiển thị: Đọc lớp dữ liệu

Nội dung mô tả: Đọc dữ liệu của dataLayer.

Cấu hình: Tập hợp các biểu thức so khớp khoá, trong đó kết quả trùng khớp khoá có thể là một chuỗi tham chiếu có dấu chấm ở đầu, với một ký tự đại diện đứng sau. Biểu thức so khớp khoá chi phối thuộc tính nào có thể được đọc từ lớp dữ liệu.

Được yêu cầu bởi: copyFromDataLayer

Chữ ký truy vấn: queryPermission('read_data_layer', <data layer key to read from>)

Lưu ý: Kiểm soát việc một mẫu tuỳ chỉnh có thể đọc từ lớp dữ liệu hay không.

Mã ví dụ

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

Tên hiển thị: Đọc bộ ký tự tài liệu

Mô tả: Đọc document.characterSet.

Cấu hình: Không có

Được yêu cầu bởi: readCharacterSet

Chữ ký truy vấn: queryPermission('read_character_set')

Lưu ý: Quy định việc mẫu tuỳ chỉnh có thể đọc document.characterSet hay không.

Mã ví dụ

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

read_container_data

Tên hiển thị: Đọc dữ liệu vùng chứa

Nội dung mô tả: Đọc dữ liệu về vùng chứa.

Cấu hình: Không có

Được yêu cầu bởi: getContainerVersion

Chữ ký truy vấn: queryPermission('read_container_data')

Lưu ý: Kiểm soát việc một mẫu tuỳ chỉnh có thể đọc dữ liệu về vùng chứa hay không.

Mã ví dụ

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

read_event_metadata

Tên hiển thị: Đọc siêu dữ liệu sự kiện

Mô tả: Đọc siêu dữ liệu sự kiện trong Lệnh gọi lại sự kiện

Cấu hình: Không có

Được yêu cầu bởi: addEventCallback

Chữ ký truy vấn: queryPermission('read_event_metadata')

Lưu ý: Kiểm soát việc một mẫu tuỳ chỉnh có thể đọc siêu dữ liệu sự kiện trong các lệnh gọi lại hay không.

Mã ví dụ

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

read_title

Tên hiển thị: Đọc tiêu đề tài liệu

Mô tả: Đọc document.title.

Cấu hình: Không có

Được yêu cầu bởi: readTitle

Chữ ký truy vấn: queryPermission('read_title')

Lưu ý: Quy định việc mẫu tuỳ chỉnh có thể đọc document.title hay không.

Mã ví dụ

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

send_pixel

Tên hiển thị: Gửi pixel

Mô tả: Gửi yêu cầu GET đến một URL đã chỉ định. Phản hồi không được xử lý.

Cấu hình: Danh sách các mẫu URL được phép.

Được yêu cầu bởi: sendPixel

Chữ ký truy vấn: queryPermission('send_pixel', <url>)

Lưu ý: Quy định việc mẫu tuỳ chỉnh có thể gửi yêu cầu GET hay không và gửi đến nguồn gốc nào.

Mã ví dụ

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

Tên hiển thị: Đặt cookie

Mô tả: Đặt một cookie có tên và thông số được chỉ định.

Cấu hình: Bảng tên cookie được phép, mỗi tên có các hạn chế không bắt buộc về tên, miền, đường dẫn, thuộc tính secure và thời hạn.

Được yêu cầu bởi: setCookie

Chữ ký truy vấn: queryPermission('set_cookies', <name>, <options>)

Lưu ý: Quy định việc có thể viết cookie hay không, tuỳ thuộc vào tên cookie, miền, đường dẫn, thuộc tính secure và thời hạn.

Mã ví dụ

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

Tên hiển thị: Ghi lớp dữ liệu

Mô tả: Ghi dữ liệu vào DataLayer.

Cấu hình: Tập hợp các biểu thức so khớp khoá, trong đó kết quả trùng khớp khoá có thể là một chuỗi tham chiếu có dấu chấm ở đầu, với một ký tự đại diện đứng sau. Biểu thức so khớp khoá chi phối thuộc tính nào có thể ghi vào lớp dữ liệu.

Được yêu cầu bởi: gtagSet

Chữ ký truy vấn: queryPermission('write_data_layer', <data layer key to write from>)

Lưu ý: Kiểm soát việc một mẫu tuỳ chỉnh có thể ghi vào lớp dữ liệu hay không.

Mã ví dụ

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