Tài liệu này trình bày các API để gắn thẻ phía máy chủ.
addEventCallback
Đăng ký một hàm gọi lại sẽ được gọi khi kết thúc một sự kiện. Lệnh gọi lại sẽ được gọi khi tất cả thẻ cho sự kiện đã thực thi. Lệnh gọi lại được truyền hai giá trị: mã nhận dạng của vùng chứa gọi hàm và một đối tượng chứa thông tin về sự kiện.
Khi được sử dụng trong một thẻ, API này sẽ được liên kết với sự kiện hiện tại. Khi sử dụng API này trong ứng dụng, bạn phải liên kết API này với một sự kiện cụ thể bằng cách sử dụng hàm bindToEvent của API runContainer. Hãy xem ví dụ để biết thêm thông tin chi tiết.
Cú pháp
const addEventCallback = require('addEventCallback');
addEventCallback((containerId, eventData) => {
// Take some action based on the event data.
});
Tham số
| Thông số | Loại | Mô tả |
|---|---|---|
callback |
hàm | Hàm để gọi khi sự kiện kết thúc. |
Đối tượng eventData chứa dữ liệu sau:
| Tên khóa | Loại | Mô tả |
|---|---|---|
tags |
Mảng |
Một mảng gồm các đối tượng dữ liệu thẻ. Mọi thẻ được kích hoạt trong sự kiện sẽ có một mục nhập trong mảng này. Đối tượng dữ liệu thẻ chứa mã nhận dạng của thẻ (id), trạng thái thực thi của thẻ (status) và thời gian thực thi của thẻ (executionTime). Dữ liệu thẻ cũng sẽ bao gồm siêu dữ liệu thẻ bổ sung đã được định cấu hình trên thẻ.
|
Trong ứng dụng:
const addEventCallback = require('addEventCallback');
const claimRequest = require('claimRequest');
const extractEventsFromMpv1 = require('extractEventsFromMpv1');
const logToConsole = require('logToConsole');
const returnResponse = require('returnResponse');
const runContainer = require('runContainer');
claimRequest();
const events = extractEventsFromMpv1();
let eventsCompleted = 0;
events.forEach((evt, i) => {
runContainer(evt, /* onComplete= */ (bindToEvent) => {
bindToEvent(addEventCallback)((containerId, eventData) => {
logToConsole('Event Number: ' + i);
eventData.tags.forEach((tag) => {
logToConsole('Tag ID: ' + tag.id);
logToConsole('Tag Status: ' + tag.status);
logToConsole('Tag Execution Time: ' + tag.executionTime);
});
});
if (events.length === ++eventsCompleted) {
returnResponse();
}
});
});
Trong thẻ:
const addEventCallback = require('addEventCallback');
addEventCallback((containerId, eventData) => {
// This will be called at the end of the current event.
});
Quyền được liên kết
callLater
Lên lịch gọi một hàm để xảy ra không đồng bộ. Hàm này sẽ được gọi sau khi mã hiện tại trả về. Điều này tương đương với setTimeout(<function>, 0).
Ví dụ
const callLater = require('callLater');
const logToConsole = require('logToConsole');
callLater(() => {
logToConsole('Logged asynchronously');
});
Cú pháp
callLater(function)
Tham số
| Thông số | Loại | Mô tả |
|---|---|---|
function |
hàm | Hàm cần gọi. |
Quyền được liên kết
Không có.
claimRequest
Sử dụng API này trong ứng dụng để xác nhận yêu cầu. Sau khi một yêu cầu được xác nhận, vùng chứa sẽ không chạy thêm ứng dụng khách.
API này sẽ gửi một ngoại lệ nếu được gọi trong một thẻ hoặc biến. API này sẽ gửi một ngoại lệ nếu được gọi sau khi ứng dụng khách trả về (ví dụ: nếu được gọi trong lệnh gọi lại không đồng bộ như trong callLater hoặc hàm runContainer onComplete).
Ứng dụng khách phải xác nhận yêu cầu bằng API này trước khi gọi API runContainer.
Ví dụ
const claimRequest = require('claimRequest');
claimRequest();
Cú pháp
claimRequest();
Quyền được liên kết
Không có.
computeEffectiveTldPlusOne
Trả về miền cấp cao nhất + 1 (eTLD+1) có hiệu lực của miền hoặc URL đã cho. eTLD+1 được tính toán bằng cách đánh giá miền theo các quy tắc trong Danh sách hậu tố công khai. eTLD+1 thường là miền cấp cao nhất mà bạn có thể đặt cookie.
Nếu đối số là rỗng hoặc không xác định, thì giá trị đối số sẽ được trả về mà không bị thay đổi. Nếu không, đối số sẽ được chuyển đổi thành một chuỗi. Nếu đối số không phải là một miền hoặc URL hợp lệ, thì một chuỗi trống sẽ được trả về. Nếu máy chủ không thể tìm nạp danh sách hậu tố công khai, thì giá trị đối số sẽ được trả về mà không bị thay đổi.
Ví dụ
const computeEffectiveTldPlusOne = require('computeEffectiveTldPlusOne');
// Returns 'example.co.uk'
computeEffectiveTldPlusOne('analytics.example.co.uk');
// Returns 'example.co.uk'
computeEffectiveTldPlusOne('https://analytics.example.co.uk/path');
Cú pháp
computeEffectiveTldPlusOne(domainOrUrl);
Tham số
| Thông số | Loại | Mô tả |
|---|---|---|
domainOrUrl |
string | Một miền hoặc URL để tính toán eTLD+1. |
Quyền được liên kết
Không có.
createRegex
Tạo một thực thể biểu thức chính quy mới và trả về thực thể đó được gói trong một đối tượng. Bạn không thể truy cập trực tiếp vào biểu thức chính quy. Tuy nhiên, bạn có thể truyền giá trị này vào API testRegex, String.replace(), String.match() và String.search().
Trả về null nếu biểu thức chính quy không hợp lệ hoặc Re2 không có trên máy chủ.
API này sử dụng phương thức triển khai Re2. Hình ảnh Docker của máy chủ phải ở phiên bản 2.0.0 trở lên.
Ví dụ
const createRegex = require('createRegex');
const domainRegex = createRegex('\\w+\\.com', 'i');
// Returns '/foobar'
'example.com/foobar'.replace(domainRegex, '');
Cú pháp
createRegex(pattern, flags);
Tham số
| Thông số | Loại | Mô tả |
|---|---|---|
pattern |
string | Văn bản của biểu thức chính quy. |
flags |
string | Một chuỗi không bắt buộc chứa các cờ cho biểu thức chính quy đang được tạo. Hỗ trợ "g" (chung) và "i" (không phân biệt chữ hoa chữ thường). Tất cả các ký tự khác sẽ bị bỏ qua. |
Quyền được liên kết
Không có.
Phiên bản hình ảnh tối thiểu
decodeUri
Giải mã mọi ký tự đã mã hoá trong URI đã cung cấp. Trả về một chuỗi đại diện cho URI đã giải mã. Trả về undefined khi được cung cấp dữ liệu đầu vào không hợp lệ.
Ví dụ
const decodeUri = require('decodeUri');
const decodedUrl = decodeUri(data.encodedUrl);
if (decodedUrl) {
// ...
}
Cú pháp
decodeUri(encoded_uri);
Tham số
| Thông số | Loại | Mô tả |
|---|---|---|
encoded_uri |
string |
Một URI đã được mã hoá bằng encodeUri() hoặc bằng các phương thức khác.
|
Quyền được liên kết
Không có.
decodeUriComponent
Giải mã mọi ký tự được mã hoá trong thành phần URI được cung cấp. Trả về một chuỗi đại diện cho thành phần URI đã giải mã. Trả về undefined khi được cung cấp dữ liệu đầu vào không hợp lệ.
Ví dụ
const decodeUriComponent = require('decodeUriComponent');
const decodedQuery = decodeUriComponent(data.query);
if (decodedQuery) {
// ...
}
Cú pháp
decodeUriComponent(encoded_uri_component);
Tham số
| Thông số | Loại | Mô tả |
|---|---|---|
encoded_uri_component |
string |
Một thành phần URI đã được mã hoá bằng encodeUriComponent() hoặc bằng các phương tiện khác.
|
Quyền được liên kết
Không có.
encodeUri
Trả về một Giá trị nhận dạng tài nguyên đồng nhất (URI) đã mã hoá bằng cách thoát các ký tự đặc biệt. Trả về một chuỗi đại diện cho chuỗi đã cung cấp được mã hoá dưới dạng URI.
Ví dụ
const encodeUri = require('encodeUri');
const sendHttpGet = require('sendHttpGet');
sendHttpGet('https://www.example.com/' + encodeUri(pathInput));
Cú pháp
encodeUri(uri);
Tham số
| Thông số | Loại | Mô tả |
|---|---|---|
uri |
string | Một URI hoàn chỉnh. |
Quyền được liên kết
Không có.
encodeUriComponent
Trả về một Giá trị nhận dạng tài nguyên đồng nhất (URI) đã mã hoá bằng cách thoát các ký tự đặc biệt. Trả về một chuỗi đại diện cho chuỗi đã cung cấp được mã hoá dưới dạng URI.
Ví dụ
const encodeUriComponent = require('encodeUriComponent');
const sendHttpGet = require('sendHttpGet');
sendHttpGet('https://www.example.com/?' + encodeUriComponent(queryInput));
Cú pháp
encodeUriComponent(str);
Tham số
| Thông số | Loại | Mô tả |
|---|---|---|
str |
string | Một thành phần của URI. |
Quyền được liên kết
Không có.
extractEventsFromMpv1
Dịch một yêu cầu Measurement Protocol V1 sắp tới thành danh sách sự kiện ở định dạng Giản đồ hợp nhất. Trả về danh sách các sự kiện đã trích xuất. Gửi lỗi nếu yêu cầu không đúng định dạng.
Ví dụ
const extractEventsFromMpv1 = require('extractEventsFromMpv1');
const isRequestMpv1 = require('isRequestMpv1');
if (isRequestMpv1()) {
const events = extractEventsFromMpv1();
for (let i = 0; i < events.length; ++i) {
const event = events[i];
// Process event.
}
}
Cú pháp
extractEventsFromMpv1();
Quyền được liên kết
Yêu cầu quyền read_request. Bạn phải định cấu hình quyền này để cho phép truy cập vào ít nhất:
bodyquery parameters
extractEventsFromMpv2
Dịch một yêu cầu Measurement Protocol V2 sắp tới thành danh sách sự kiện ở định dạng Giản đồ hợp nhất. Trả về danh sách các sự kiện đã trích xuất. Gửi lỗi nếu yêu cầu không đúng định dạng.
Ví dụ
const extractEventsFromMpv2 = require('extractEventsFromMpv2');
const isRequestMpv2 = require('isRequestMpv2');
if (isRequestMpv2()) {
const events = extractEventsFromMpv2();
for (let i = 0; i < events.length; ++i) {
const event = events[i];
// Process event.
}
}
Cú pháp
extractEventsFromMpv2();
Quyền được liên kết
Yêu cầu quyền read_request. Bạn phải định cấu hình quyền này để cho phép truy cập vào ít nhất:
bodyquery parameters
fromBase64
Giải mã chuỗi được mã hoá base64. Trả về undefined nếu dữ liệu đầu vào không hợp lệ.
Cú pháp
fromBase64(base64EncodedString);
Tham số
| Thông số | Loại | Mô tả |
|---|---|---|
base64EncodedString |
string | Chuỗi được mã hoá Base64. |
Ví dụ
const fromBase64 = require('fromBase64');
const greeting = fromBase64('aGVsbG8=');
if (greeting === 'hello') {
// ...
}
Quyền được liên kết
Không có.
generateRandom
Trả về một số (số nguyên) ngẫu nhiên trong phạm vi đã cho.
Ví dụ
const generateRandom = require('generateRandom');
const randomValue = generateRandom(0, 10000000);
Cú pháp
generateRandom(min, max);
Tham số
| Thông số | Loại | Mô tả |
|---|---|---|
min |
số | Giá trị tiềm năng tối thiểu của số nguyên được trả về (bao gồm cả giá trị này). |
max |
số | Giá trị tiềm năng tối đa của số nguyên được trả về (bao gồm cả giá trị này). |
Quyền được liên kết
Không có.
getAllEventData
Trả về một bản sao của dữ liệu sự kiện.
Cú pháp
getAllEventData();
Quyền được liên kết
getClientName
Trả về một chuỗi chứa tên của ứng dụng hiện tại.
Cú pháp
getClientName();
Quyền được liên kết
getContainerVersion
Trả về một đối tượng chứa dữ liệu về vùng chứa hiện tại. Đối tượng được trả về sẽ có các trường sau:
{
containerId: string,
debugMode: boolean,
environmentName: string,
environmentMode: boolean,
previewMode: boolean,
version: string,
}
Ví dụ
const getContainerVersion = require('getContainerVersion');
const containerVersion = getContainerVersion();
const containerId = containerVersion['containerId'];
const isDebug = containerVersion['debugMode'];
Cú pháp
getContainerVersion();
Quyền được liên kết
getCookieValues
Trả về một mảng chứa các giá trị của tất cả cookie có tên đã cho.
Ví dụ
const getCookieValues = require('getCookieValues');
const lastVisit = getCookieValues('lastVisit')[0];
if (lastVisit) {
// ...
}
Cú pháp
getCookieValues(name[, noDecode]);
Tham số
| Thông số | Loại | Mô tả |
|---|---|---|
name |
string | Tên của cookie. |
noDecode |
boolean |
Nếu là true, các giá trị cookie sẽ không được giải mã trước khi được trả về. Giá trị mặc định là false.
|
Quyền được liên kết
getEventData
Trả về bản sao của giá trị tại đường dẫn đã cho trong dữ liệu sự kiện. Trả về undefined nếu không có dữ liệu sự kiện hoặc nếu không có giá trị tại đường dẫn đã cho.
Ví dụ
const getEventData = require('getEventData');
const campaignId = getEventData('campaign.id');
const itemId = getEventData('items.0.id');
const referrer = getEventData('page_referrer');
Tham số
| Thông số | Loại | Mô tả |
|---|---|---|
keyPath |
bất kỳ |
Đường dẫn của khóa, trong đó các thành phần đường dẫn được phân tách bằng dấu chấm. Thành phần của đường dẫn có thể là các khoá trong một đối tượng hoặc chỉ mục trong một mảng. Nếu keyPath không phải là một chuỗi, thì chuỗi này sẽ được chuyển đổi thành một chuỗi.
|
Cú pháp
getEventData(keyPath);
Quyền được liên kết
getGoogleAuth
Trả về một đối tượng uỷ quyền mà khi được sử dụng với sendHttpGet hoặc sendHttpRequest, sẽ bao gồm một tiêu đề uỷ quyền cho các API của Google Cloud. API này sử dụng Thông tin xác thực mặc định của ứng dụng để tự động tìm thông tin xác thực từ môi trường máy chủ.
Ví dụ
const getGoogleAuth = require('getGoogleAuth');
const logToConsole = require('logToConsole');
const sendHttpGet = require('sendHttpGet');
const auth = getGoogleAuth({
scopes: ['https://www.googleapis.com/auth/datastore']
});
sendHttpGet(
'https://firestore.googleapis.com/v1/projects/my-project/databases/(default)/documents/collection/document',
{authorization: auth}
).then((result) => {
if (result.statusCode >= 200 && result.statusCode < 300) {
logToConsole('Result: ' + result.body);
data.gtmOnSuccess();
} else {
data.gtmOnFailure();
}
});
Cú pháp
getGoogleAuth(scopes);
Tham số
| Thông số | Loại | Mô tả |
|---|---|---|
scopes
|
Mảng | Một mảng phạm vi API Google OAuth 2.0 để yêu cầu quyền truy cập. |
Quyền được liên kết
Yêu cầu quyền use_google_credentials. Bạn phải định cấu hình quyền này với một hoặc nhiều phạm vi được cho phép.
getGoogleScript
Truy xuất tài nguyên từ một tập hợp tập lệnh Google được xác định trước và trả về một lời hứa với tập lệnh và siêu dữ liệu liên quan được lưu vào bộ nhớ đệm.
Lời hứa sẽ phân giải thành một đối tượng chứa hai khoá: script và metadata. Nếu yêu cầu không thành công, lời hứa sẽ từ chối bằng khoá reason.
Đối tượng metadata sẽ chứa siêu dữ liệu lưu vào bộ nhớ đệm sau đây dựa trên tiêu đề phản hồi tài nguyên; mỗi trường sẽ chỉ xuất hiện nếu tiêu đề tương ứng có trong phản hồi tài nguyên.
{
'cache-control': string,
'expires': string,
'last-modified': string,
}
Ví dụ
const getGoogleScript = require('getGoogleScript');
getGoogleScript('ANALYTICS').then((result) => {
// Operate on result.script and result.metadata here.
});
Cú pháp
getGoogleScript(script[, options]);
Tham số
| Thông số | Loại | Mô tả |
|---|---|---|
script |
string |
Tên tập lệnh. Các tập lệnh được hỗ trợ là 'ANALYTICS', 'GTAG' và 'GTM'.Tuỳ chọn 'ANALYTICS'
tìm nạp tập lệnh Google Analytics từ
https://www.google-analytics.com/analytics.js.Tuỳ chọn 'GTAG' tìm nạp tập lệnh thẻ toàn trang web (gtag.js) từ https://www.googletagmanager.com/gtag/js.Tuỳ chọn 'GTM' tìm nạp tập lệnh Trình quản lý thẻ của Google
từ https://www.googletagmanager.com/gtm.js.
|
options |
đối tượng | Các tuỳ chọn yêu cầu không bắt buộc. Hãy xem phần bên dưới để biết các tuỳ chọn được hỗ trợ. |
Lựa chọn
| Phương thức | Loại | Mô tả |
|---|---|---|
id |
string |
Áp dụng cho 'GTAG' có mã đo lường gtag và
'GTM' có mã vùng chứa web (ví dụ: GTM-XXXX).
|
debug |
bất kỳ | Nếu đúng, hãy yêu cầu và trả về phiên bản gỡ lỗi của tập lệnh đo lường. |
timeout |
số |
Thời gian chờ yêu cầu tính bằng mili giây; các giá trị không dương tính sẽ bị bỏ qua. Nếu yêu cầu hết thời gian chờ, lệnh gọi lại sẽ được gọi bằng undefined cho giá trị tập lệnh và {} cho đối tượng siêu dữ liệu.
|
Các khoá tuỳ chọn không được nhận dạng sẽ bị bỏ qua.
Quyền được liên kết
Yêu cầu quyền send_http. Bạn phải định cấu hình quyền này để cho phép truy cập vào ít nhất:
- Cho phép Google Domains
getRemoteAddress
Trả về một chuỗi đại diện cho địa chỉ IP nơi yêu cầu bắt nguồn, ví dụ: 12.345.67.890 cho IPv4 hoặc 2001:0db8:85a3:0:0:8a2e:0370:7334 cho IPv6, bằng cách đọc các tiêu đề yêu cầu như Forwarded và X-Forwarded-For.
Lưu ý: API này sẽ cố gắng hết sức để khám phá IP gốc, nhưng không thể đảm bảo kết quả là chính xác.
Cú pháp
getRemoteAddress();
Quyền được liên kết
Yêu cầu quyền read_request. Bạn phải định cấu hình quyền này để cho phép truy cập vào ít nhất:
- Tiêu đề
ForwardedvàX-Forwarded-For - Địa chỉ IP từ xa
getRequestBody
Trả về nội dung yêu cầu dưới dạng chuỗi (nếu có) hoặc undefined (nếu không).
Cú pháp
getRequestBody();
Quyền được liên kết
getRequestHeader
Trả về giá trị của tiêu đề yêu cầu được đặt tên dưới dạng chuỗi, nếu có, hoặc undefined nếu không. Nếu tiêu đề được lặp lại, các giá trị được trả về sẽ được kết hợp với nhau bằng ', '.
Ví dụ
const getRequestHeader = require('getRequestHeader');
const host = getRequestHeader('host');
Cú pháp
getRequestHeader(headerName);
Tham số
| Thông số | Loại | Mô tả |
|---|---|---|
headerName |
string | Tên tiêu đề. Giá trị này không phân biệt chữ hoa chữ thường. |
Quyền được liên kết
getRequestMethod
Trả về phương thức yêu cầu, ví dụ: 'GET' hoặc 'POST', dưới dạng chuỗi.
Ví dụ
const getRequestMethod = require('getRequestMethod');
if (getRequestMethod() === 'POST') {
// Handle the POST request here.
}
Cú pháp
getRequestMethod();
Quyền được liên kết
Không có.
getRequestPath
Trả về đường dẫn yêu cầu không có chuỗi truy vấn. Ví dụ: nếu URL là '/foo?id=123', thì hàm này sẽ trả về '/foo'. Tự động xoá tiền tố URL vùng chứa máy chủ khỏi đường dẫn. Ví dụ: nếu URL vùng chứa phía máy chủ là https://example.com/analytics và đường dẫn yêu cầu là '/analytics/foo', thì thao tác này sẽ trả về '/foo'.
Ví dụ
const getRequestPath = require('getRequestPath');
const requestPath = getRequestPath();
if (requestPath === '/') {
// Handle a request for the root path.
}
Cú pháp
getRequestPath();
Quyền được liên kết
getRequestQueryParameter
Trả về giá trị đã giải mã của tham số chuỗi truy vấn được đặt tên dưới dạng chuỗi hoặc undefined nếu không có tham số. Nếu tham số được lặp lại trong chuỗi truy vấn, thì giá trị đầu tiên xuất hiện trong chuỗi truy vấn sẽ được trả về.
Ví dụ
const getRequestQueryParameter = require('getRequestQueryParameter');
const query = getRequestQueryParameter('query');
if (query) {
// Process query here.
}
Cú pháp
getRequestQueryParameter(name);
Tham số
| Thông số | Loại | Mô tả |
|---|---|---|
name |
string | Tên tham số truy vấn. |
Quyền được liên kết
getRequestQueryParameters
Trả về các tham số truy vấn của yêu cầu HTTP đến dưới dạng một đối tượng ánh xạ tên tham số truy vấn đến giá trị hoặc các giá trị tương ứng. Tên và giá trị của thông số được giải mã.
Ví dụ
const getRequestQueryParameters = require('getRequestQueryParameters');
const queryParameters = getRequestQueryParameters();
if (queryParameters['search']) {
// Handle the search query here.
const maxResults = queryParameters['max_results'];
}
Cú pháp
getRequestQueryParameters();
Quyền được liên kết
getRequestQueryString
Trả về cụm từ tìm kiếm yêu cầu dưới dạng một chuỗi, không có dấu chấm hỏi ở đầu hoặc một chuỗi trống nếu URL yêu cầu không bao gồm chuỗi truy vấn.
Ví dụ
const getRequestQueryString = require('getRequestQueryString');
const queryString = getRequestQueryString();
if (queryString !== '') {
// Handle the query string.
}
Cú pháp
getRequestQueryString();
Quyền được liên kết
getTimestamp
Không dùng nữa. Ưu tiên getTimestampMillis.
Trả về một số biểu thị thời gian hiện tại tính bằng mili giây kể từ thời gian bắt đầu của hệ thống Unix, như được Date.now() trả về.
Cú pháp
getTimestamp();
Quyền được liên kết
Không có.
getTimestampMillis
Trả về một số biểu thị thời gian hiện tại tính bằng mili giây kể từ thời gian bắt đầu của hệ thống Unix, như được Date.now() trả về.
Cú pháp
getTimestampMillis();
Quyền được liên kết
Không có.
getType
Trả về một chuỗi mô tả loại của giá trị đã cho.
| Loại dữ liệu đầu vào | Giá trị trả về |
|---|---|
| string | 'string' |
| số | 'number' |
| boolean | 'boolean' |
| rỗng | 'null' |
| undefined | 'undefined' |
| Mảng | 'array' |
| Đối tượng | 'object' |
| Chức năng | 'function' |
Ví dụ
const getType = require('getType');
const type = getType(value);
if (type === 'string') {
// Handle string input.
} else if (type === 'number') {
// Handle numeric input.
} else {
logToConsole('Unsupported input type: ', type);
}
Cú pháp
getType(value);
Tham số
| Thông số | Loại | Mô tả |
|---|---|---|
value |
bất kỳ | Giá trị nhập. |
Quyền được liên kết
Không có.
hmacSha256
Tính toán chữ ký đã mã hoá bằng Mã xác thực thông báo dựa trên hàm băm (HMAC) với SHA-256. Giá trị mặc định là mã hoá base64url.
Để sử dụng API này, hãy đặt biến môi trường SGTM_CREDENTIALS trên máy chủ thành đường dẫn của tệp khoá JSON được mã hoá UTF-8 theo định dạng sau:
{
"keys": {
"key1": "YWJjZGVmZ2hpamtsbW5vcHFyc3R1dnd4eXowMTIzNDU2Nzg5",
"key2": "OTg3NjU0MzIxMHp5eHd2dXRzcnFwb25tbGtqaWhnZmVkY2Jh",
...
}
}
Các giá trị này là khoá HMAC được mã hoá base64. Văn bản JSON không được bắt đầu bằng dấu thứ tự byte.
Ví dụ
const hmacSha256 = require('hmacSha256');
const toBase64 = require('toBase64');
const header = toBase64('{"alg":"HS256","typ":"JWT"}', {urlEncoding: true});
const claim = toBase64('{"sub":"1234567890","iat":1698164946}', {urlEncoding: true});
const signature = hmacSha256(header + '.' + claim, 'key1');
const jwt = header + "." + claim + '.' + signature;
Cú pháp
hmacSha256(data, keyId, options)
Tham số
| Thông số | Loại | Mô tả |
|---|---|---|
data |
string | Dữ liệu để tính giá trị HMAC. |
keyId
|
string | Mã khoá trong tệp khoá JSON tham chiếu đến khoá cần sử dụng. |
options
|
đối tượng | Cấu hình API không bắt buộc. (Xem phần Tuỳ chọn bên dưới.) |
Lựa chọn
| Phương thức | Loại | Mô tả |
|---|---|---|
outputEncoding
|
string | Chỉ định định dạng mã hoá cho giá trị trả về. Các định dạng được hỗ trợ là hex, base64 hoặc base64url. Mặc định là base64url nếu không được chỉ định. |
Quyền được liên kết
Phiên bản hình ảnh tối thiểu
isRequestMpv1
Trả về true nếu yêu cầu đến là yêu cầu Measurement Protocol phiên bản 1 hoặc false nếu không.
Ví dụ
const isRequestMpv1 = require('isRequestMpv1');
if (isRequestMpv1()) {
// Handle Measurement Protocol V1 request.
const events = extractEventsFromMpv1();
}
Cú pháp
isRequestMpv1();
Quyền được liên kết
Không có.
isRequestMpv2
Trả về true nếu yêu cầu đến là yêu cầu Measurement Protocol phiên bản 2, hoặc false nếu không.
Ví dụ
const isRequestMpv2 = require('isRequestMpv2');
if (isRequestMpv2()) {
// Handle Measurement Protocol V2 request.
const events = extractEventsFromMpv2();
}
Cú pháp
isRequestMpv2();
Quyền được liên kết
Không có.
logToConsole
Ghi(các) đối số của hàm vào bảng điều khiển.
Bạn có thể xem các nhật ký này trong Trình khám phá nhật ký trong Google Cloud Console.
Trong Trình khám phá nhật ký, hãy chạy truy vấn logName =~ "stdout" để xem các mục nhập nhật ký do API này tạo.
Ví dụ
const logToConsole = require('logToConsole');
const that = 123;
const those = { ... };
logToConsole('that is: ', that, ' and those is: ', those);
Cú pháp
logToConsole(argument1[, argument2, ...]);
Tham số
API này nhận một hoặc nhiều đối số, mỗi đối số được chuyển đổi thành một chuỗi (nếu cần) và được ghi vào bảng điều khiển.
Quyền được liên kết
makeInteger
Chuyển đổi giá trị đã cho thành số (số nguyên).
Cú pháp
makeInteger(value);
Tham số
| Thông số | Loại | Mô tả |
|---|---|---|
value |
mọi loại | Giá trị cần chuyển đổi. |
Quyền được liên kết
Không có.
makeNumber
Chuyển đổi giá trị đã cho thành một số.
Cú pháp
makeNumber(value);
Tham số
| Thông số | Loại | Mô tả |
|---|---|---|
value |
mọi loại | Giá trị cần chuyển đổi. |
Quyền được liên kết
Không có.
makeString
Trả về giá trị đã cho dưới dạng chuỗi.
Cú pháp
makeString(value);
Tham số
| Thông số | Loại | Mô tả |
|---|---|---|
value |
mọi loại | Giá trị cần chuyển đổi. |
Quyền được liên kết
Không có.
makeTableMap
Chuyển đổi đối tượng bảng đơn giản có hai cột thành Map. Phương thức này dùng để thay đổi trường mẫu SIMPLE_TABLE có hai cột thành một định dạng dễ quản lý hơn.
Ví dụ: hàm này có thể chuyển đổi đối tượng bảng:
[
{'key': 'k1', 'value': 'v1'},
{'key': 'k2', 'value': 'v2'}
]
vào một Bản đồ:
{
'k1': 'v1',
'k2': 'v2'
}
Trả về một Đối tượng: Map đã chuyển đổi của các cặp khoá-giá trị đã được thêm vào đối tượng đó, hoặc null nếu không.
Cú pháp
makeTableMap(tableObj, keyColumnName, valueColumnName);
Tham số
| Thông số | Loại | Mô tả |
|---|---|---|
tableObj |
List (Danh sách) |
Đối tượng bảng cần chuyển đổi. Đây là danh sách các bản đồ, trong đó mỗi Map đại diện cho một hàng trong bảng. Mỗi tên thuộc tính trong đối tượng hàng là tên cột và giá trị thuộc tính là giá trị cột trong hàng.
|
keyColumnName |
string |
Tên của cột có giá trị sẽ trở thành khoá trong Map đã chuyển đổi.
|
valueColumnName |
string |
Tên của cột có giá trị sẽ trở thành giá trị trong Map đã chuyển đổi.
|
Quyền được liên kết
Không có.
parseUrl
Trả về một đối tượng chứa tất cả các thành phần của một URL nhất định, tương tự như đối tượng URL.
API này sẽ trả về undefined cho mọi URL có định dạng không hợp lệ. Đối với các URL được định dạng đúng cách, các trường không có trong chuỗi URL sẽ có giá trị là một chuỗi trống hoặc trong trường hợp searchParams, một đối tượng trống.
Đối tượng được trả về sẽ có các trường sau:
{
href: string,
origin: string,
protocol: string,
username: string,
password: string,
host: string,
hostname: string,
port: string,
pathname: string,
search: string,
searchParams: Object<string, (string|Array)>,
hash: string,
}
Ví dụ
const parseUrl = require('parseUrl');
const urlObject = parseUrl('https://abc:xyz@example.com:8080/foo?param=val%2Cue#bar');
Cú pháp
parseUrl(url);
Tham số
| Thông số | Loại | Mô tả |
|---|---|---|
url |
string | URL đầy đủ sẽ được phân tích cú pháp. |
Quyền được liên kết
Không có.
returnResponse
Xoá phản hồi mà các mẫu khác đã đặt trước đó bằng cách sử dụng các API sửa đổi phản hồi, bao gồm setCookie, setPixelResponse, setResponseBody, setResponseHeader và setResponseStatus. Mặc định là mã trạng thái HTTP 200, nội dung trống và không có tiêu đề.
Bạn nên sử dụng API này từ mẫu ứng dụng.
Cú pháp
returnResponse();
Ví dụ
Quyền được liên kết
runContainer
Chạy logic vùng chứa (biến, điều kiện kích hoạt, thẻ) trong phạm vi của một sự kiện. Nếu API này được gọi trong quá trình thực thi vùng chứa, thì vùng chứa sẽ được chạy lại.
Lệnh gọi lại onComplete và onStart nhận được một hàm có tên là bindToEvent. Sử dụng bindToEvent để chạy một API trong ngữ cảnh của sự kiện.
Hãy xem ví dụ về addEventCallback để biết thêm thông tin chi tiết.
Bạn nên sử dụng API này từ mẫu ứng dụng.
const returnResponse = require('returnResponse');
const runContainer = require('runContainer');
// Runs the container with a simple pageview event and then returns a response.
runContainer({'event_name': 'pageview'}, () => returnResponse());
Cú pháp
runContainer(event, onComplete, onStart);
Tham số
| Thông số | Loại | Mô tả |
|---|---|---|
event |
đối tượng | Thông số sự kiện. |
onComplete |
hàm | Lệnh gọi lại được gọi sau khi tất cả thẻ kích hoạt xong. |
onStart |
hàm | Lệnh gọi lại được gọi ngay lập tức, trước khi các thẻ bắt đầu kích hoạt. |
Quyền được liên kết
sendEventToGoogleAnalytics
Gửi một sự kiện bằng Dữ liệu sự kiện phổ biến đến Google Analytics và trả về một lời hứa phân giải thành một đối tượng có khoá location hoặc từ chối một đối tượng có khoá reason. Đích đến, Google Analytics 4, dựa trên mã đo lường trong dữ liệu sự kiện.
Trường location được đặt thành tiêu đề location, nếu có.
Ví dụ
const logToConsole = require('logToConsole');
const sendEventToGoogleAnalytics = require('sendEventToGoogleAnalytics');
const setResponseHeader = require('setResponseHeader');
const setResponseStatus = require('setResponseStatus');
// Sends an event to Google Analytics and returns failure if the request did not
// succeed. Additionally, if the request resulted in a redirect request, the
// code nominates a redirect response to be returned.
sendEventToGoogleAnalytics(event).then((response) => {
if (response.location) {
setResponseHeader('location', response.location);
setResponseStatus(302);
} else {
setResponseStatus(200);
}
data.gtmOnSuccess();
}).catch((error) => {
logToConsole(error.reason);
setResponseStatus(500);
data.gtmOnFailure();
});
Cú pháp
sendEventToGoogleAnalytics(event);
Tham số
| Thông số | Loại | Mô tả |
|---|---|---|
event |
đối tượng | Sự kiện ở định dạng Giản đồ hợp nhất. |
Quyền được liên kết
Yêu cầu quyền send_http. Bạn phải định cấu hình quyền này để cho phép truy cập vào ít nhất:
- Cho phép Google Domains
sendHttpGet
Tạo một yêu cầu HTTP GET đến URL đã chỉ định và trả về một lời hứa phân giải kết quả sau khi yêu cầu hoàn tất hoặc hết thời gian chờ.
Kết quả được phân giải là một đối tượng chứa ba khoá: statusCode, headers và body. Nếu yêu cầu không thành công (ví dụ: URL không hợp lệ, không có tuyến đường đến máy chủ lưu trữ, lỗi đàm phán SSL, v.v.), lời hứa sẽ từ chối bằng: {reason:
'failed'}. Nếu bạn đã đặt tuỳ chọn timeout và yêu cầu hết thời gian chờ, thì lời hứa sẽ từ chối bằng: {reason: 'timed_out'}
Ví dụ
const sendHttpGet = require('sendHttpGet');
// Returns the response body as the value for a variable.
return sendHttpGet('https://example.com/item/' + data.itemId, {
headers: {key: 'value'},
timeout: 500,
}).then((result) => result.body, () => undefined);
Cú pháp
sendHttpGet(url[, options]);
Tham số
| Thông số | Loại | Mô tả |
|---|---|---|
url |
string | URL được yêu cầu. |
options
|
đối tượng | Các tuỳ chọn yêu cầu không bắt buộc. (Xem phần Tuỳ chọn bên dưới.) |
Lựa chọn
| Phương thức | Loại | Mô tả |
|---|---|---|
headers |
string | Các tiêu đề yêu cầu bổ sung. |
timeout
|
số | Thời gian chờ, tính bằng mili giây, trước khi yêu cầu bị huỷ. Giá trị mặc định là 15000. |
authorization
|
đối tượng | Đối tượng uỷ quyền không bắt buộc từ lệnh gọi đến getGoogleAuth để đưa vào tiêu đề uỷ quyền khi tạo yêu cầu đến googleapis.com. |
Quyền được liên kết
sendHttpRequest
Tạo một yêu cầu HTTP đến URL đã chỉ định và trả về một lời hứa giải quyết bằng phản hồi sau khi yêu cầu hoàn tất hoặc hết thời gian chờ.
Kết quả được phân giải là một đối tượng chứa ba khoá: statusCode, headers và body. Nếu yêu cầu không thành công (ví dụ: URL không hợp lệ, không có tuyến đường đến máy chủ lưu trữ, lỗi đàm phán SSL, v.v.), lời hứa sẽ từ chối bằng: {reason:
'failed'}. Nếu bạn đã đặt tuỳ chọn timeout và yêu cầu hết thời gian chờ, thì lời hứa sẽ từ chối bằng: {reason: 'timed_out'}
Ví dụ
const sendHttpRequest = require('sendHttpRequest');
const setResponseBody = require('setResponseBody');
const setResponseHeader = require('setResponseHeader');
const setResponseStatus = require('setResponseStatus');
const postBody = 'interaction=click&campaign=promotion&medium=email';
// Sends a POST request and nominates response based on the response to the POST
// request.
sendHttpRequest('https://example.com/collect', {
headers: {key: 'value'},
method: 'POST',
timeout: 500,
}, postBody).then((result) => {
setResponseStatus(result.statusCode);
setResponseBody(result.body);
setResponseHeader('cache-control', result.headers['cache-control']);
});
Cú pháp
sendHttpRequest(url[, options[, body]]);
Tham số
| Thông số | Loại | Mô tả |
|---|---|---|
url |
string | URL được yêu cầu. |
options
|
đối tượng | Các tuỳ chọn yêu cầu không bắt buộc. (Xem phần Tuỳ chọn bên dưới.) |
body |
string | Nội dung yêu cầu không bắt buộc. |
Lựa chọn
| Phương thức | Loại | Mô tả |
|---|---|---|
headers |
string | Các tiêu đề yêu cầu bổ sung. |
method |
đối tượng | Phương thức yêu cầu. Giá trị mặc định là GET. |
timeout
|
số | Thời gian chờ, tính bằng mili giây, trước khi yêu cầu bị huỷ. Giá trị mặc định là 15000. |
authorization
|
đối tượng | Đối tượng uỷ quyền không bắt buộc từ lệnh gọi đến getGoogleAuth để đưa vào tiêu đề uỷ quyền khi tạo yêu cầu đến googleapis.com. |
Quyền được liên kết
sendPixelFromBrowser
Gửi lệnh đến trình duyệt để tải URL đã cung cấp dưới dạng thẻ <img>. Giao thức lệnh này được hỗ trợ trong Thẻ Google cho GA4 và thẻ web Google Analytics: Sự kiện GA. Bạn phải định cấu hình URL vùng chứa máy chủ. Hãy xem hướng dẫn để biết thêm thông tin chi tiết.
API này trả về false nếu yêu cầu đến không hỗ trợ giao thức lệnh hoặc nếu phản hồi đã được xả. Nếu không, API này sẽ trả về true.
Ví dụ:
const sendPixelFromBrowser = require('sendPixelFromBrowser');
sendPixelFromBrowser('https://example.com/?id=123');
Cú pháp
sendPixelFromBrowser(url)
Tham số
| Thông số | Loại | Mô tả |
|---|---|---|
url |
string | URL cần gửi đến trình duyệt. |
Quyền được liên kết
setCookie
Đặt hoặc xoá cookie bằng các tuỳ chọn đã chỉ định.
Để xoá một cookie, bạn phải đặt một cookie có cùng đường dẫn và miền mà cookie đó được tạo, đồng thời chỉ định cho cookie đó một giá trị hết hạn trong quá khứ, ví dụ: "Thu, 01 Jan 1970 00:00:00 GMT".
Xin lưu ý rằng bạn phải gọi returnResponse để hệ thống gửi lại phản hồi cho ứng dụng khách.
Ví dụ
const setCookie = require('setCookie');
// Sets an httpOnly cookie with a max-age of 3600.
setCookie('cookieName', 'cookieValue', {'max-age': 3600, httpOnly: true});
Cú pháp
setCookie(name, value[, options[, noEncode]]);
Tham số
| Thông số | Loại | Mô tả |
|---|---|---|
name |
string | Tên cookie. Tên không phân biệt chữ hoa chữ thường. |
value |
string | Giá trị cookie. |
options |
đối tượng | Các thuộc tính cookie không bắt buộc:domain, expires, fallbackDomain,httpOnly, max- age, path, secure, vàsameSite. (Xem phần Tuỳ chọn bên dưới.) |
noEncode |
boolean |
Nếu đúng, giá trị cookie sẽ không được mã hoá. Giá trị mặc định là false.
|
domain: Máy chủ lưu trữ mà cookie sẽ được gửi đến. Nếu được đặt thành giá trị đặc biệt "auto", thì máy chủ lưu trữ sẽ được tự động tính toán bằng chiến lược sau:
- eTLD+1 của tiêu đề
Forwarded, nếu có. - eTLD+1 của tiêu đề
X-Forwarded-Host, nếu có. - eTLD+1 của tiêu đề
Host.
- eTLD+1 của tiêu đề
expires: Thời gian tồn tại tối đa của cookie. Đây phải là một chuỗi ngày tháng theo định dạng UTC, ví dụ: "Sat, 26 Oct 1985 08:21:00 GMT". Nếu bạn đặt cả
expiresvàmax-age, thìmax-agesẽ được ưu tiên.httpOnly: Cấm JavaScript truy cập vào cookie nếu
true.max-age: Số giây cho đến khi cookie hết hạn. Số 0 hoặc số âm sẽ làm cookie hết hạn ngay lập tức. Nếu bạn đặt cả
expiresvàmax-age, thìmax-agesẽ được ưu tiên.path (đường dẫn): Đường dẫn phải tồn tại trong URL được yêu cầu, nếu không trình duyệt sẽ không gửi tiêu đề Cookie.
secure (an toàn): Nếu được đặt thành
true, cookie chỉ được gửi đến máy chủ khi có yêu cầu được thực hiện từ điểm cuốihttps:.sameSite: Xác nhận rằng không được gửi cookie bằng các yêu cầu trên nhiều nguồn gốc. Phải là
'strict','lax'hoặc'none'.
Quyền được liên kết
setPixelResponse
Đặt nội dung phản hồi thành GIF 1x1, đặt tiêu đề Content-Type thành "image/gif", đặt tiêu đề lưu vào bộ nhớ đệm để các tác nhân người dùng không lưu phản hồi vào bộ nhớ đệm và đặt trạng thái phản hồi thành 200.
Xin lưu ý rằng bạn phải gọi returnResponse để hệ thống gửi lại phản hồi cho ứng dụng khách.
Cú pháp
setPixelResponse();
Quyền được liên kết
Yêu cầu quyền access_response. Bạn phải định cấu hình quyền này để cho phép truy cập vào ít nhất:
headers– Phải cho phép các khoá sau đâycontent-typecache-controlexpirespragma
bodystatus
setResponseBody
Đặt nội dung phản hồi thành đối số.
Xin lưu ý rằng bạn phải gọi returnResponse để hệ thống gửi lại phản hồi cho ứng dụng khách.
Cú pháp
setResponseBody(body[, encoding]);
Tham số
| Thông số | Loại | Mô tả |
|---|---|---|
body |
string | Giá trị cần đặt làm nội dung phản hồi. |
encoding |
string |
Mã hoá ký tự của nội dung phản hồi (mặc định là 'utf8'). Các giá trị được hỗ trợ bao gồm 'ascii', 'utf8', 'utf16le', 'ucs2', 'base64', 'latin1', 'binary' và 'hex'.
|
Quyền được liên kết
Yêu cầu quyền access_response. Bạn phải định cấu hình quyền này để cho phép truy cập vào ít nhất:
body
setResponseHeader
Đặt tiêu đề trong phản hồi sẽ được trả về. Nếu trước đây API này đã đặt một tiêu đề có tên này (không phân biệt chữ hoa chữ thường), thì lệnh gọi sau sẽ ghi đè hoặc xoá giá trị do phương thức gọi trước đặt.
Xin lưu ý rằng bạn phải gọi returnResponse để hệ thống gửi lại phản hồi cho ứng dụng khách.
Cú pháp
setResponseHeader(name, value);
Tham số
| Thông số | Loại | Mô tả |
|---|---|---|
name |
string | Tên tiêu đề. Tên tiêu đề HTTP không phân biệt chữ hoa chữ thường, vì vậy, tên tiêu đề sẽ được viết thường. |
value |
string undefined | Giá trị tiêu đề. Nếu giá trị này là rỗng hoặc không xác định, thì tiêu đề có tên sẽ bị xoá khỏi phản hồi sẽ được trả về. |
Quyền được liên kết
Yêu cầu quyền access_response. Bạn phải định cấu hình quyền này để cho phép truy cập vào ít nhất:
headers
setResponseStatus
Đặt mã trạng thái HTTP của phản hồi sẽ được trả về.
Xin lưu ý rằng bạn phải gọi returnResponse để hệ thống gửi lại phản hồi cho ứng dụng khách.
Cú pháp
setResponseStatus(statusCode);
Tham số
| Thông số | Loại | Mô tả |
|---|---|---|
statusCode |
số | Mã trạng thái HTTP sẽ được trả về. |
Quyền được liên kết
Yêu cầu quyền access_response. Bạn phải định cấu hình quyền này để cho phép truy cập vào ít nhất:
status
sha256
Tính toán hàm băm SHA-256 của dữ liệu đầu vào và gọi lệnh gọi lại với hàm băm được mã hoá theo chuẩn base64, trừ phi đối tượng options chỉ định một phương thức mã hoá đầu ra khác.
Chữ ký và hành vi của API này khớp với API sha256 cho vùng chứa web; tuy nhiên, Mẫu tuỳ chỉnh trong vùng chứa máy chủ phải sử dụng API sha256Sync để có mã đơn giản hơn.
Ví dụ
const encodeUriComponent = require('encodeUriComponent');
const sendHttpGet = require('sendHttpGet');
const sha256 = require('sha256');
sha256('inputString', (digest) => {
sendHttpGet('https://example.com/collect?id=' + encodeUriComponent(digest));
});
sha256('inputString', (digest) => {
sendHttpGet('https://example.com/collect?id=' + encodeUriComponent(digest));
}, {outputEncoding: 'hex'});
Cú pháp
sha256(input, onSuccess, options = undefined);
Tham số
| Thông số | Loại | Mô tả |
|---|---|---|
input |
string | Chuỗi cần băm. |
onSuccess |
hàm |
Được gọi bằng chuỗi đại diện kết quả, được mã hoá bằng base64, trừ phi đối tượng options chỉ định một phương thức mã hoá đầu ra khác.
|
options |
đối tượng |
Đối tượng tuỳ chọn không bắt buộc để chỉ định bộ mã hoá đầu ra. Nếu được chỉ định, đối tượng phải chứa khoá outputEncoding với giá trị là một trong hai giá trị base64 hoặc hex.
|
Quyền được liên kết
Không có.
sha256Sync
Tính toán và trả về hàm băm SHA-256 của dữ liệu đầu vào, được mã hoá theo cơ sở 64, trừ phi đối tượng options chỉ định một phương thức mã hoá đầu ra khác.
Ví dụ
const encodeUriComponent = require('encodeUriComponent');
const sendHttpGet = require('sendHttpGet');
const sha256Sync = require('sha256Sync');
const digestBase64 = sha256Sync('inputString');
const digestHex = sha256Sync('inputString', {outputEncoding: 'hex'});
sendHttpGet('https://example.com/collect?id=' + encodeUriComponent(digestBase64));
sendHttpGet('https://example.com/collect?id=' + encodeUriComponent(digestHex));
Cú pháp
sha256Sync(input, options = undefined);
Tham số
| Thông số | Loại | Mô tả |
|---|---|---|
input |
string | Chuỗi cần băm. |
options |
đối tượng |
Đối tượng tuỳ chọn không bắt buộc để chỉ định bộ mã hoá đầu ra. Nếu được chỉ định, đối tượng phải chứa khoá outputEncoding với giá trị là một trong hai giá trị base64 hoặc hex.
|
Quyền được liên kết
Không có.
templateDataStorage
Trả về một đối tượng có các phương thức để truy cập vào bộ nhớ dữ liệu mẫu. Bộ nhớ dữ liệu mẫu cho phép chia sẻ dữ liệu trên các lần thực thi của một mẫu. Dữ liệu được lưu trữ trong bộ nhớ dữ liệu mẫu vẫn tồn tại trên máy chủ đang chạy vùng chứa. Trong hầu hết các trường hợp, có nhiều máy chủ chạy vùng chứa, vì vậy, việc lưu trữ dữ liệu trong bộ nhớ dữ liệu mẫu không đảm bảo rằng mọi yêu cầu tiếp theo sẽ có quyền truy cập vào dữ liệu.
"Dữ liệu" trong tên "templateDataStorage" đề cập đến việc chỉ có thể lưu trữ các loại dữ liệu thuần tuý, không phải hàm bằng API này. Mọi hàm hoặc tham chiếu đến hàm được truyền đến API sẽ được lưu trữ dưới dạng null.
Cú pháp
const templateDataStorage = require('templateDataStorage');
// Returns a copy of the value stored for the given key, or null if nothing
// is stored with that key.
templateDataStorage.getItemCopy(key);
// Stores a copy of the value for the given key (or removes the data stored
// for the given key if the input value is null).
templateDataStorage.setItemCopy(key, value);
// Removes the value stored for the given key, if present.
templateDataStorage.removeItem(key);
// Deletes all values stored for the current template.
templateDataStorage.clear();
Ví dụ
const sendHttpGet = require('sendHttpGet');
const setResponseBody = require('setResponseBody');
const setResponseStatus = require('setResponseStatus');
const templateDataStorage = require('templateDataStorage');
// Check to see if the item is in the cache.
const cachedBody = templateDataStorage.getItemCopy(data.key);
if (cachedBody) {
setResponseBody(cachedBody);
data.gtmOnSuccess();
return;
}
sendHttpGet(data.url).then((result) => {
if (result.statusCode >= 200 && result.statusCode < 300) {
setResponseBody(result.body);
templateDataStorage.setItemCopy(data.key, result.body);
data.gtmOnSuccess();
} else {
data.gtmOnFailure();
}
setResponseStatus(result.statusCode);
});
Quyền được liên kết
testRegex
Kiểm thử một chuỗi dựa trên biểu thức chính quy được tạo thông qua API createRegex. Trả về true nếu biểu thức chính quy khớp. Nếu không, hãy trả về false.
Biểu thức chính quy được tạo bằng cờ toàn cục có trạng thái. Hãy xem tài liệu về RegExp để biết thông tin chi tiết.
Ví dụ
const createRegex = require('createRegex');
const testRegex = require('testRegex');
const domainRegex = createRegex('\\w+\\.com', 'i');
// createRegex returns null if the regex is invalid or Re2 is not available.
if (domainRegex === null) return;
// Returns true
testRegex(domainRegex, 'example.com/foobar');
Cú pháp
testRegex(regex, string);
Tham số
| Thông số | Loại | Mô tả |
|---|---|---|
regex |
Đối tượng | Biểu thức chính quy để kiểm thử, được trả về từ API createRegex. |
string |
string | Chuỗi kiểm thử để kiểm thử. |
Quyền được liên kết
Không có.
toBase64
Mã hoá một chuỗi dưới dạng base64 hoặc base64url. Mặc định là mã hoá base64.
Cú pháp
toBase64(input, options);
Tham số
| Thông số | Loại | Mô tả |
|---|---|---|
input |
string | Chuỗi cần mã hoá. |
options
|
đối tượng | Cấu hình API không bắt buộc. (Xem phần Tuỳ chọn bên dưới.) |
Lựa chọn
| Phương thức | Loại | Mô tả | Phiên bản tối thiểu |
|---|---|---|---|
urlEncoding
|
boolean | Nếu đúng, kết quả sẽ được mã hoá bằng định dạng base64url. |
1.0.0 |
Ví dụ
const toBase64 = require('toBase64');
const base64Hello = toBase64('hello');
const base64UrlHello = toBase64('hello', {urlEncoding: true});
Quyền được liên kết
Không có.
BigQuery
Trả về một đối tượng cung cấp các hàm BigQuery.
Hàm BigQuery.insert cho phép ghi dữ liệu vào bảng BigQuery. Phương thức này trả về một lời hứa sẽ giải quyết khi chèn thành công hoặc từ chối khi gặp lỗi.
Khi quá trình chèn thành công, lời hứa sẽ phân giải mà không có đối số nào.
Khi không chèn được, lời hứa sẽ từ chối bằng một danh sách đối tượng chứa lý do lỗi và có thể là một đối tượng hàng nếu xảy ra lỗi. Có thể một phần của yêu cầu đã hoàn tất thành công, trong khi các phần khác thì không. Lời hứa bị từ chối trong trường hợp này với danh sách lỗi cho mỗi hàng có đối tượng hàng để giúp phân biệt những hàng đã được chèn (Xem Ví dụ về lỗi bên dưới). Hãy xem tài liệu của BigQuery về thông báo lỗi để biết thêm thông tin.
Cú pháp
BigQuery.insert(connectionInfo, rows[, options]);
| Thông số | Loại | Mô tả |
|---|---|---|
connectionInfo |
đối tượng |
Xác định thông tin cần thiết để kết nối với một bảng BigQuery. Có một tham số không bắt buộc và 2 tham số bắt buộc:
|
rows |
Mảng | Các hàng cần chèn vào bảng. |
options |
đối tượng | Các tuỳ chọn yêu cầu không bắt buộc. Các tuỳ chọn được hỗ trợ là: ignoreUnknownValues và skipInvalidRows. Các khoá tuỳ chọn không xác định sẽ bị bỏ qua. (Xem phần Tuỳ chọn bên dưới.) |
| Thông số | Loại | Mô tả |
|---|---|---|
ignoreUnknownValues |
boolean | Nếu bạn đặt thành true, thì hãy chấp nhận các hàng chứa giá trị không khớp với giản đồ. Hệ thống sẽ bỏ qua các giá trị không xác định. Giá trị mặc định là false. |
skipInvalidRows |
boolean | Nếu bạn đặt thành true, hãy chèn tất cả các hàng hợp lệ của một yêu cầu, ngay cả khi có các hàng không hợp lệ. Giá trị mặc định là false. |
Lỗi không tìm thấy mô-đun có nghĩa là vùng chứa máy chủ của bạn có thể đang chạy phiên bản hình ảnh cũ hơn của chúng tôi chưa bao gồm mô-đun BigQuery. Vui lòng triển khai lại vùng chứa máy chủ của bạn bằng cùng một chế độ cài đặt bằng tập lệnh triển khai của chúng tôi. Mô-đun sẽ tự động được đưa vào sau khi thao tác hoàn tất.
Lỗi không chèn thường có một đối tượng lỗi với khoá reason:
[{reason: 'invalid'}]
Lỗi chèn có thể chứa nhiều đối tượng lỗi với một mảng errors và một đối tượng row. Sau đây là ví dụ về phản hồi lỗi khi chèn hai hàng, trong đó chỉ có một hàng có lỗi:
[
{
"errors": [
{
"reason":"invalid"
}
],
"row": {
"string_col":"otherString",
"number_col":-3,
"bool_col":3
}
},
{
"errors": [
{
"reason":"stopped"
}
],
"row": {
"string_col":"stringValue",
"number_col":5,
"bool_col:false
}
}
]
Ví dụ
const BigQuery = require('BigQuery');
const connectionInfo = {
'projectId': 'gcp-cloud-project-id',
'datasetId': 'destination-dataset',
'tableId': 'destination-table',
};
const rows = [{
'column1': 'String1',
'column2': 1234,
}];
const options = {
'ignoreUnknownValues': true,
'skipInvalidRows': false,
};
BigQuery.insert(connectionInfo, rows, options)
.then(data.gtmOnSuccess, data.gtmOnFailure);
Quyền được liên kết
Firestore
Trả về một đối tượng cung cấp các hàm Firestore.
API này chỉ hỗ trợ Firestore ở chế độ Gốc, chứ không hỗ trợ Firestore ở chế độ Kho dữ liệu. Ngoài ra, API này chỉ hỗ trợ việc sử dụng cơ sở dữ liệu mặc định.
Firestore.read
Hàm Firestore.read đọc dữ liệu từ một tài liệu Firestore và trả về một lời hứa phân giải thành một đối tượng chứa hai khoá: id và data. Nếu tài liệu không tồn tại, lời hứa sẽ từ chối bằng một đối tượng chứa khoá reason bằng not_found.
Cú pháp
Firestore.read(path[, options]);
| Thông số | Loại | Mô tả |
|---|---|---|
path |
string | Đường dẫn đến tài liệu hoặc bộ sưu tập. Không được bắt đầu hoặc kết thúc bằng dấu "/". |
options |
đối tượng | Các tuỳ chọn yêu cầu không bắt buộc. Các tuỳ chọn được hỗ trợ là: projectId, disableCache và transaction. Các khoá tuỳ chọn không xác định sẽ bị bỏ qua. (Xem phần Tuỳ chọn bên dưới.) |
| Thông số | Loại | Mô tả |
|---|---|---|
projectId |
string | Không bắt buộc. Mã dự án trên Google Cloud Platform. Nếu bị bỏ qua, projectId sẽ được truy xuất từ biến môi trường GOOGLE_CLOUD_PROJECT, miễn là chế độ cài đặt quyền access_firestore cho mã dự án được đặt thành * hoặc GOOGLE_CLOUD_PROJECT. Nếu vùng chứa máy chủ đang chạy trên Google Cloud, thì GOOGLE_CLOUD_PROJECT sẽ được đặt thành mã nhận dạng của dự án Google Cloud. |
disableCache |
boolean | Không bắt buộc. Xác định xem có tắt bộ nhớ đệm hay không. Tính năng lưu vào bộ nhớ đệm được bật theo mặc định, tính năng này sẽ lưu kết quả vào bộ nhớ đệm trong thời gian của yêu cầu. |
transaction |
string | Không bắt buộc. Giá trị được truy xuất từ Firestore.runTransaction(). Đánh dấu thao tác sẽ được sử dụng trong một giao dịch. |
Ví dụ
const Firestore = require('Firestore');
return Firestore.read('collection/document', {
projectId: 'gcp-cloud-project-id',
}).then((result) => result.data.key, () => undefined);
Firestore.write
Hàm Firestore.write ghi dữ liệu vào một tài liệu hoặc tập hợp Firestore. Nếu đường dẫn đưa đến một bộ sưu tập, thì một tài liệu sẽ được tạo bằng một mã nhận dạng được tạo ngẫu nhiên. Nếu đường dẫn dẫn đến một tài liệu và tài liệu đó không tồn tại, thì tài liệu đó sẽ được tạo. API này trả về một lời hứa phân giải thành mã nhận dạng của tài liệu đã thêm hoặc sửa đổi. Nếu bạn sử dụng tuỳ chọn giao dịch, API vẫn trả về một lời hứa, nhưng sẽ không chứa mã nhận dạng vì các hoạt động ghi được thực hiện theo lô.
Cú pháp
Firestore.write(path, input[, options]);
Tham số
| Thông số | Loại | Mô tả |
|---|---|---|
path |
string | Đường dẫn đến tài liệu hoặc bộ sưu tập. Không được bắt đầu hoặc kết thúc bằng dấu "/". |
input |
đối tượng | Giá trị cần ghi vào tài liệu. Nếu bạn đặt tuỳ chọn hợp nhất, API sẽ hợp nhất các khoá từ dữ liệu đầu vào vào tài liệu. |
options |
đối tượng | Các tuỳ chọn yêu cầu không bắt buộc. Các tuỳ chọn được hỗ trợ là: projectId, merge và transaction. Các khoá tuỳ chọn không xác định sẽ bị bỏ qua. (Xem phần Tuỳ chọn bên dưới.) |
| Thông số | Loại | Mô tả |
|---|---|---|
projectId |
string | Không bắt buộc. Mã dự án trên Google Cloud Platform. Nếu bị bỏ qua, projectId sẽ được truy xuất từ biến môi trường GOOGLE_CLOUD_PROJECT, miễn là chế độ cài đặt quyền access_firestore cho mã dự án được đặt thành * hoặc GOOGLE_CLOUD_PROJECT. Nếu vùng chứa máy chủ đang chạy trên Google Cloud, thì GOOGLE_CLOUD_PROJECT sẽ được đặt thành mã nhận dạng của dự án Google Cloud. |
merge |
boolean | Không bắt buộc. Nếu bạn đặt thành true, hãy hợp nhất các khoá từ dữ liệu đầu vào vào tài liệu, nếu không phương thức này sẽ ghi đè toàn bộ tài liệu. Giá trị mặc định là false. |
transaction |
string | Không bắt buộc. Giá trị được truy xuất từ Firestore.runTransaction(). Đánh dấu thao tác sẽ được sử dụng trong một giao dịch. |
Ví dụ
const Firestore = require('Firestore');
const input = {key1: 'value1', key2: 12345};
Firestore.write('collection/document', input, {
projectId: 'gcp-cloud-project-id',
merge: true,
}).then((id) => {
data.gtmOnSuccess();
}, data.gtmOnFailure);
Firestore.query
Hàm Firestore.query truy vấn tập hợp đã cho và trả về một lời hứa phân giải thành một mảng tài liệu Firestore khớp với các điều kiện truy vấn. Đối tượng tài liệu Firestore giống như được liệt kê ở trên trong Firestore.read. Nếu không có tài liệu nào khớp với điều kiện truy vấn, thì lời hứa được trả về sẽ phân giải thành một mảng trống.
Cú pháp
Firestore.query(collection, queryConditions[, options]);
| Thông số | Loại | Mô tả |
|---|---|---|
collection |
string | Đường dẫn đến bộ sưu tập. Không được bắt đầu hoặc kết thúc bằng dấu "/". |
queryConditions |
Mảng | Một mảng các điều kiện truy vấn. Mỗi truy vấn có dạng một mảng với ba giá trị: khoá, toán tử và giá trị dự kiến. Ví dụ:
[[‘id’, ‘<’, ‘5’], [‘state’, ‘==’, ‘CA’]]. Các điều kiện được nối với nhau bằng toán tử AND để tạo kết quả truy vấn. Vui lòng tham khảo toán tử truy vấn của Firestore để biết danh sách các toán tử truy vấn tương thích. |
options |
đối tượng | Các tuỳ chọn yêu cầu không bắt buộc. Các tuỳ chọn được hỗ trợ là: projectId, disableCache, limit và transaction. Các khoá tuỳ chọn không xác định sẽ bị bỏ qua. (Xem phần Tuỳ chọn bên dưới.) |
| Thông số | Loại | Mô tả |
|---|---|---|
projectId |
string | Không bắt buộc. Mã dự án trên Google Cloud Platform. Nếu bị bỏ qua, projectId sẽ được truy xuất từ biến môi trường GOOGLE_CLOUD_PROJECT, miễn là chế độ cài đặt quyền access_firestore cho mã dự án được đặt thành * hoặc GOOGLE_CLOUD_PROJECT. Nếu vùng chứa máy chủ đang chạy trên Google Cloud, thì GOOGLE_CLOUD_PROJECT sẽ được đặt thành mã nhận dạng của dự án Google Cloud. |
disableCache |
boolean | Không bắt buộc. Xác định xem có tắt bộ nhớ đệm hay không. Tính năng lưu vào bộ nhớ đệm được bật theo mặc định, tính năng này sẽ lưu kết quả vào bộ nhớ đệm trong thời gian của yêu cầu. |
limit |
số | Không bắt buộc. Thay đổi số lượng kết quả tối đa mà truy vấn trả về, mặc định là 5. |
transaction |
string | Không bắt buộc. Giá trị được truy xuất từ Firestore.runTransaction(). Đánh dấu thao tác sẽ được sử dụng trong một giao dịch. |
Ví dụ
const Firestore = require('Firestore');
const queries = const queries = [['id', '==', '5']];
return Firestore.query('collection', queries, {
projectId: 'gcp-cloud-project-id',
limit: 1,
}).then((documents) => documents[0].data.key, () => undefined);
Firestore.runTransaction
Hàm Firestore.runTransaction cho phép người dùng đọc và ghi một cách nguyên tử từ Firestore. Nếu một hoạt động ghi đồng thời hoặc một xung đột giao dịch khác xảy ra, giao dịch sẽ được thử lại tối đa hai lần. Nếu không thành công sau tổng cộng 3 lần thử, API sẽ từ chối kèm theo lỗi. API này trả về một lời hứa phân giải thành một mảng mã nhận dạng tài liệu, cho mỗi thao tác ghi, nếu giao dịch thành công và sẽ từ chối bằng lỗi nếu giao dịch không thành công.
Cú pháp
Firestore.runTransaction(callback[, options]);
Tham số
| Thông số | Loại | Mô tả |
|---|---|---|
callback |
hàm | Lệnh gọi lại được gọi bằng mã giao dịch dạng chuỗi. Bạn có thể truyền mã giao dịch vào các lệnh gọi API đọc/ghi/truy vấn. Hàm callback này phải trả về một lời hứa. Lệnh gọi lại có thể chạy tối đa 3 lần trước khi không thành công. |
options |
đối tượng | Các tuỳ chọn yêu cầu không bắt buộc. Tuỳ chọn duy nhất được hỗ trợ là projectId. Các khoá tuỳ chọn không xác định sẽ bị bỏ qua. (Xem phần Tuỳ chọn bên dưới.) |
| Thông số | Loại | Mô tả |
|---|---|---|
projectId |
string | Không bắt buộc. Mã dự án trên Google Cloud Platform. Nếu bị bỏ qua, projectId sẽ được truy xuất từ biến môi trường GOOGLE_CLOUD_PROJECT, miễn là chế độ cài đặt quyền access_firestore cho mã dự án được đặt thành * hoặc GOOGLE_CLOUD_PROJECT. Nếu vùng chứa máy chủ đang chạy trên Google Cloud, thì GOOGLE_CLOUD_PROJECT sẽ được đặt thành mã nhận dạng của dự án Google Cloud. |
Ví dụ
const Firestore = require('Firestore');
const path = 'collection/document';
const projectId = 'gcp-cloud-project-id';
Firestore.runTransaction((transaction) => {
const transactionOptions = {
projectId: projectId,
transaction: transaction,
};
// Must return a promise.
return Firestore.read(path, transactionOptions).then((result) => {
const newInputCount = result.data.inputCount + 1;
const input = {key1: 'value1', inputCount: newInputCount};
return Firestore.write(path, input, transactionOptions);
});
}, {
projectId: projectId
}).then((ids) => {
data.gtmOnSuccess();
}, data.gtmOnFailure);
Lỗi có trong mỗi hàm Firestore sẽ bị từ chối bằng một đối tượng chứa khoá reason:
Firestore.read(...).then(onSuccess, (error) => {
if (error.reason === 'unknown') {
// Handle the unknown error here.
}
});
Lý do lỗi có thể bao gồm nhưng không giới hạn ở Mã lỗi API REST Firestore.
Quyền được liên kết
JSON
Trả về một đối tượng cung cấp các hàm JSON.
Hàm parse() phân tích cú pháp một chuỗi JSON để tạo giá trị hoặc đối tượng được mô tả bằng chuỗi đó. Nếu không thể phân tích cú pháp giá trị (ví dụ: JSON không đúng định dạng), hàm sẽ trả về undefined. Nếu giá trị đầu vào không phải là chuỗi, thì giá trị đầu vào sẽ được chuyển đổi thành chuỗi.
Hàm stringify() chuyển đổi dữ liệu đầu vào thành một chuỗi JSON. Nếu không thể phân tích cú pháp giá trị (ví dụ: đối tượng có chu kỳ), phương thức sẽ trả về undefined.
Ví dụ
const JSON = require('JSON');
// The JSON input string is converted to an object.
const object = JSON.parse('{"foo":"bar"}');
// The input object is converted to a JSON string.
const str = JSON.stringify({foo: 'bar'});
Cú pháp
JSON.parse(stringInput);
JSON.stringify(value);
Quyền được liên kết
Không có.
Math
Một đối tượng cung cấp các hàm Math.
Cú pháp
const Math = require('Math');
// Retrieve the absolute value.
const absolute = Math.abs(-3);
// Round the input down to the nearest integer.
const roundedDown = Math.floor(3.6);
// Round the input up to the nearest integer.
const roundedUp = Math.ceil(2.2);
// Round the input to the nearest integer.
const rounded = Math.round(3.1);
// Return the largest argument.
const biggest = Math.max(1, 3);
// Return the smallest argument.
const smallest = Math.min(3, 5);
// Return the first argument raised to the power of the second argument.
const powerful = Math.pow(3, 1);
// Return the square root of the argument.
const unsquared = Math.sqrt(9);
Tham số
Các tham số hàm toán học được chuyển đổi thành số.
Quyền được liên kết
Không có.
Messages
Các API sau đây hoạt động cùng nhau để cho phép truyền thông báo giữa các phần khác nhau của vùng chứa.
addMessageListener
Thêm một hàm để nghe thông báo thuộc một loại cụ thể. Khi một thông báo thuộc loại đó được gửi bằng API sendMessage (thường là bằng thẻ), lệnh gọi lại sẽ chạy đồng bộ. Lệnh gọi lại được chạy với hai tham số:
messageType:stringmessage:Object
Nếu lệnh gọi lại được thêm vào một ứng dụng, thì lệnh gọi lại sẽ nhận được thông báo trên tất cả các sự kiện mà ứng dụng tạo. Nếu lệnh gọi lại chỉ nhận được thông báo từ một sự kiện nhất định, hãy liên kết API này với sự kiện bằng cách sử dụng bindToEvent trong hàm onStart của API runContainer. Xem ví dụ.
Cú pháp
const addMessageListener = require('addMessageListener');
addMessageListener('send_pixel', (messageType, message) => {
// This will be run whenever something sends a 'send_pixel' message.
});
Tham số
| Thông số | Loại | Mô tả |
|---|---|---|
messageType |
string | Loại thông báo cần nghe. Nếu giá trị không phải là một chuỗi, thì giá trị đó sẽ được chuyển đổi thành một chuỗi. |
callback |
hàm | Lệnh gọi lại sẽ chạy khi một thông báo thuộc loại thông báo hiện hành được gửi. Nếu lệnh gọi lại không phải là một hàm, API sẽ không thực hiện hành động nào. |
Ví dụ
const addMessageListener = require('addMessageListener');
const claimRequest = require('claimRequest');
const extractEventsFromMpv1 = require('extractEventsFromMpv1');
const returnResponse = require('returnResponse');
const runContainer = require('runContainer');
claimRequest();
addMessageListener('send_pixel', (messageType, message) => {
// This will be run whenever a tag sends a 'send_pixel' message.
});
const events = extractEventsFromMpv1();
let eventsCompleted = 0;
events.forEach((event, i) => {
runContainer(events[i], /* onComplete= */ () => {
if (events.length === ++eventsCompleted) {
returnResponse();
}
}, /* onStart= */ (bindToEvent) => {
if (i === 0) {
bindToEvent(addMessageListener)('send_pixel', (messageType, message) => {
// This will be called whenever a tag for the first event sends a
// 'send_pixel' message.
});
}
});
});
Quyền được liên kết
Yêu cầu quyền use_message. Bạn phải định cấu hình quyền này để cho phép ít nhất:
- Loại thông báo có
Usagelàlistenhoặclisten_and_send.
hasMessageListener
Trả về true nếu đã thêm trình nghe thông báo cho loại thông báo đã cho. Nếu không, trả về false.
Cú pháp
const hasMessageListener = require('hasMessageListener');
hasMessageListener('send_pixel');
Quyền được liên kết
Không có.
sendMessage
Gửi một thông báo thuộc loại đã chỉ định đến trình nghe đã đăng ký. Bạn có thể sử dụng phương thức này để gửi thông báo từ một thẻ trở lại ứng dụng đã chạy vùng chứa.
Cú pháp
const sendMessage = require('sendMessage');
sendMessage('send_pixel', {url: 'https://analytics.example.com/collect'});
Tham số
| Thông số | Loại | Mô tả |
|---|---|---|
messageType |
string | Loại tin nhắn cần gửi. Nếu giá trị không phải là chuỗi, thì giá trị đó sẽ được chuyển đổi thành chuỗi. |
message |
đối tượng | Tin nhắn cần gửi. Nếu thông báo không phải là một đối tượng, API sẽ không làm gì cả. |
Quyền được liên kết
Yêu cầu quyền use_message. Bạn phải định cấu hình quyền này để cho phép ít nhất:
- Loại thông báo có
Usagelàlisten_and_sendhoặcsend.
Object
Trả về một đối tượng cung cấp các phương thức Object.
Phương thức keys() cung cấp hành vi Object.keys() của Thư viện chuẩn. Hàm này trả về một mảng tên thuộc tính có thể liệt kê của một đối tượng nhất định theo thứ tự mà vòng lặp for...in... sẽ trả về. Nếu giá trị đầu vào không phải là đối tượng, thì giá trị đó sẽ được chuyển đổi thành đối tượng.
Phương thức values() cung cấp hành vi Object.values() của Thư viện chuẩn. Hàm này trả về một mảng các giá trị thuộc tính có thể liệt kê của một đối tượng nhất định theo cùng thứ tự mà vòng lặp for...in... sẽ trả về. Nếu giá trị đầu vào không phải là đối tượng, thì giá trị đó sẽ được chuyển đổi thành đối tượng.
Phương thức entries() cung cấp hành vi Object.entries() của Thư viện chuẩn. Hàm này trả về một mảng các cặp thuộc tính có thể liệt kê [key, value] của một đối tượng nhất định theo cùng thứ tự mà vòng lặp for...in... sẽ trả về. Nếu giá trị đầu vào không phải là đối tượng, thì giá trị đó sẽ được chuyển đổi thành đối tượng.
Phương thức freeze() cung cấp hành vi Object.freeze() của Thư viện chuẩn. Bạn không thể thay đổi đối tượng đã bị đóng băng; việc đóng băng đối tượng sẽ ngăn việc thêm thuộc tính mới vào đối tượng, xoá các thuộc tính hiện có và thay đổi giá trị của các thuộc tính hiện có. freeze() trả về cùng một đối tượng đã được truyền vào. Đối số gốc hoặc rỗng sẽ được coi là đối tượng bị đóng băng và sẽ được trả về.
Phương thức delete() cung cấp hành vi toán tử xoá của Thư viện chuẩn. Phương thức này sẽ xoá khoá đã cho khỏi đối tượng, trừ phi đối tượng bị đóng băng.
Giống như toán tử xoá của Thư viện chuẩn, toán tử này trả về true nếu giá trị đầu vào đầu tiên (objectInput) là một đối tượng không bị đóng băng ngay cả khi giá trị đầu vào thứ hai (keyToDelete) chỉ định một khoá không tồn tại. Hàm này trả về false trong mọi trường hợp khác. Tuy nhiên, toán tử này khác với toán tử xoá của Thư viện chuẩn ở những điểm sau:
keyToDeletekhông được là một chuỗi được phân tách bằng dấu chấm chỉ định khoá lồng nhau.- Không thể dùng
delete()để xoá các phần tử khỏi một mảng. - Không thể dùng
delete()để xoá bất kỳ thuộc tính nào khỏi phạm vi toàn cục.
Cú pháp
Object.keys(objectInput)
Object.values(objectInput)
Object.entries(objectInput)
Object.freeze(objectInput)
Object.delete(objectInput, keyToDelete)
Tham số
Object.keys
| Thông số | Loại | Mô tả |
|---|---|---|
| objectInput | bất kỳ | Đối tượng có các khoá cần liệt kê. Nếu dữ liệu đầu vào không phải là đối tượng, thì dữ liệu đó sẽ được chuyển đổi thành đối tượng. |
Object.values
| Thông số | Loại | Mô tả |
|---|---|---|
| objectInput | bất kỳ | Đối tượng có các giá trị cần liệt kê. Nếu dữ liệu đầu vào không phải là đối tượng, thì dữ liệu đó sẽ được chuyển đổi thành đối tượng. |
Object.entries
| Thông số | Loại | Mô tả |
|---|---|---|
| objectInput | bất kỳ | Đối tượng có các cặp khoá/giá trị cần liệt kê. Nếu dữ liệu đầu vào không phải là đối tượng, thì dữ liệu đó sẽ được chuyển đổi thành đối tượng. |
Object.freeze
| Thông số | Loại | Mô tả |
|---|---|---|
| objectInput | bất kỳ | Đối tượng cần đóng băng. Nếu dữ liệu đầu vào không phải là đối tượng, thì dữ liệu đó sẽ được coi là đối tượng bị đóng băng. |
Object.delete
| Thông số | Loại | Mô tả |
|---|---|---|
| objectInput | bất kỳ | Đối tượng có khoá cần xoá. |
| keyToDelete | string | Khoá cấp cao nhất cần xoá. |
Ví dụ
const Object = require('Object');
// The keys of an object are enumerated in an array.
const keys = Object.keys({foo: 'bar'});
// The values of an object are enumerated in an array.
const values = Object.values({foo: 'bar'});
// The key/value pairs of an object are enumerated in an array.
const entries = Object.entries({foo: 'bar'});
// The input object is frozen.
const frozen = Object.freeze({foo: 'bar'});
// The key is removed from the input object.
const obj1 = {deleteme: 'value'};
Object.delete(obj1, 'deleteme');
// Only a top-level key can be specified as the key to delete.
const obj2 = {nested: {key: 'value'}};
Object.delete(obj2, 'nested.key'); // This has no effect.
Object.delete(obj2.nested, 'key'); // This deletes the nested key.
Promise
Trả về một đối tượng cung cấp các phương thức để tương tác với các lời hứa.
Lời hứa có chức năng tương đương với lời hứa JavaScript. Mỗi thực thể có ba phương thức trả về một Lời hứa cho phép thực hiện hành động khác khi một lời hứa được thực hiện:
.then()– Xử lý cả các trường hợp đã giải quyết và bị từ chối. Phương thức này sẽ lấy hai lệnh gọi lại làm tham số: một lệnh gọi lại cho trường hợp thành công và một lệnh gọi lại cho trường hợp không thành công..catch()– Chỉ xử lý các trường hợp bị từ chối. Lấy một lệnh gọi lại làm tham số..finally()– Cung cấp cách để chạy mã cho dù lời hứa đã được giải quyết hay bị từ chối. Lấy một lệnh gọi lại làm tham số được gọi mà không có đối số.
Biến trả về một lời hứa bằng giá trị đã phân giải của lời hứa hoặc false nếu lời hứa từ chối.
Ví dụ
promise.then((resolvedValue) => {
// Handles when promise resolves.
}, (rejectedValue) => {
// Handles when promise rejects.
});
promise.catch((rejectedValue) => {
// Handles when promise rejects.
});
promise.finally(() => {
// Runs regardless of whether or not the previous promise resolves or
// rejects.
});
Promise.all
Trả về một lời hứa:
- phân giải khi tất cả dữ liệu đầu vào đã phân giải hoặc
- từ chối khi bất kỳ dữ liệu đầu vào nào từ chối
Cú pháp
Promise.all(inputs);
Tham số
| Thông số | Loại | Mô tả |
|---|---|---|
inputs |
Mảng | Một mảng các giá trị hoặc lời hứa. Nếu dữ liệu đầu vào không phải là một lời hứa, thì dữ liệu đầu vào đó sẽ được truyền qua như thể đó là giá trị đã phân giải của một lời hứa. Gửi lỗi nếu dữ liệu đầu vào không phải là mảng. |
Ví dụ
const Promise = require('Promise');
const sendHttpGet = require('sendHttpGet');
return Promise.all(['a', sendHttpGet('https://example.com')])
.then((results) => {
// results will equal: ['a', {statusCode: 200, headers: {}, body: ''}]
});
Quyền được liên kết
Không có.
Promise.create
Tạo một lời hứa có chức năng tương đương với lời hứa JavaScript.
Cú pháp
Promise.create(resolver);
Tham số
| Thông số | Loại | Mô tả |
|---|---|---|
resolver |
hàm | Một hàm được gọi bằng hai hàm – resolve (giải quyết) và reject (từ chối). Lời hứa được trả về sẽ phân giải hoặc từ chối khi tham số tương ứng được gọi. Gửi lỗi nếu trình phân giải không phải là một hàm. |
Ví dụ
const Promise = require('Promise');
return Promise.create((resolve, reject) => {
// Do asynchronous work that eventually calls resolve() or reject()
});
Quyền được liên kết
Không có.
API kiểm thử
Các API này hoạt động với các thử nghiệm JavaScript trong hộp cát để tạo thử nghiệm cho các mẫu tuỳ chỉnh trong Trình quản lý thẻ của Google. Các API kiểm thử này không cần câu lệnh require(). [Tìm hiểu thêm về kiểm thử mẫu tuỳ chỉnh].
assertApi
Trả về một đối tượng trình so khớp có thể dùng để đưa ra các câu nhận định trôi chảy về API đã cho.
Cú pháp
assertApi(apiName)
Tham số
| Thông số | Loại | Mô tả |
|---|---|---|
apiName |
string | Tên của API cần kiểm tra; cùng một chuỗi được truyền đến require().
|
Trình so khớp
Subject.wasCalled()Subject.wasNotCalled()Subject.wasCalledWith(...expected)Subject.wasNotCalledWith(...expected)
Ví dụ
assertApi('sendPixel').wasCalled();
assertApi('getUrl').wasNotCalled();
assertApi('makeNumber').wasCalledWith('8');
assertApi('setInWindow').wasNotCalledWith('myVar', 'theWrongValue');
assertThat
API assertThat được mô hình hoá theo thư viện [Truth] của Google. Phương thức này trả về một đối tượng có thể được dùng để đưa ra các câu nhận định trôi chảy về giá trị của một chủ thể. Một lỗi xác nhận sẽ ngay lập tức dừng kiểm thử và đánh dấu kiểm thử đó là không thành công. Tuy nhiên, lỗi trong một bài kiểm thử sẽ không ảnh hưởng đến các trường hợp kiểm thử khác.
Cú pháp
assertThat(actual, opt_message)
Tham số
| Thông số | Loại | Mô tả |
|---|---|---|
actual |
bất kỳ | Giá trị cần sử dụng trong các lần kiểm tra trôi chảy. |
opt_message |
string | Thông báo không bắt buộc để in nếu câu nhận định không thành công. |
Trình so khớp
| Trình so khớp | Mô tả |
|---|---|
isUndefined() |
Xác nhận rằng chủ đề là undefined. |
isDefined() |
Xác nhận rằng chủ đề không phải là undefined. |
isNull() |
Xác nhận rằng chủ đề là null. |
isNotNull() |
Xác nhận rằng chủ đề không phải là null. |
isFalse() |
Xác nhận rằng chủ đề là false. |
isTrue() |
Xác nhận rằng chủ đề là true. |
isFalsy() |
Xác nhận rằng chủ đề là sai. Các giá trị sai là undefined, null, false, NaN, 0 và "" (chuỗi trống). |
isTruthy() |
Xác nhận rằng chủ đề là đúng. Các giá trị sai là undefined, null, false, NaN, 0 và "" (chuỗi trống). |
isNaN() |
Xác nhận rằng chủ đề là giá trị NaN. |
isNotNaN() |
Xác nhận rằng đối tượng là bất kỳ giá trị nào ngoài NaN. |
isInfinity() |
Xác nhận rằng đối tượng là số vô cực dương hoặc âm. |
isNotInfinity() |
Xác nhận rằng đối tượng là bất kỳ giá trị nào ngoài số vô cực dương hoặc âm. |
isEqualTo(expected) |
Xác nhận rằng chủ đề bằng với giá trị đã cho. Đây là phép so sánh giá trị, chứ không phải phép so sánh tham chiếu. Nội dung của các đối tượng và mảng được so sánh đệ quy. |
isNotEqualTo(expected) |
Xác nhận rằng chủ đề không bằng giá trị đã cho. Đây là một phép so sánh giá trị, chứ không phải phép so sánh tham chiếu. Nội dung của các đối tượng và mảng được so sánh đệ quy. |
isAnyOf(...expected) |
Xác nhận rằng chủ đề bằng một trong các giá trị đã cho. Đây là một phép so sánh giá trị, chứ không phải phép so sánh tham chiếu. Nội dung của các đối tượng và mảng được so sánh đệ quy. |
isNoneOf(...expected) |
Xác nhận rằng chủ đề không bằng bất kỳ giá trị nào đã cho. Đây là một phép so sánh giá trị, chứ không phải phép so sánh tham chiếu. Nội dung của các đối tượng và mảng được so sánh đệ quy. |
isStrictlyEqualTo(expected) |
Xác nhận rằng đối tượng là hoàn toàn bằng (===) với giá trị đã cho. |
isNotStrictlyEqualTo(expected) |
Xác nhận rằng đối tượng không hoàn toàn bằng (!==) với giá trị đã cho. |
isGreaterThan(expected) |
Xác nhận rằng đối tượng lớn hơn (>) giá trị đã cho trong một phép so sánh có thứ tự. |
isGreaterThanOrEqualTo(expected) |
Xác nhận rằng đối tượng lớn hơn hoặc bằng (>=) giá trị đã cho trong một phép so sánh có thứ tự. |
isLessThan(expected) |
Xác nhận rằng đối tượng nhỏ hơn (<) giá trị đã cho trong một phép so sánh có thứ tự. |
isLessThanOrEqualTo(expected) |
Xác nhận rằng đối tượng nhỏ hơn hoặc bằng (<=) giá trị đã cho trong một phép so sánh có thứ tự. |
contains(...expected) |
Xác nhận rằng chủ đề là một mảng hoặc chuỗi chứa tất cả các giá trị đã cho theo thứ tự bất kỳ. Đây là phép so sánh giá trị, chứ không phải phép so sánh tham chiếu. Nội dung của các đối tượng và mảng được so sánhRecursively. |
doesNotContain(...expected) |
Xác nhận rằng chủ đề là một mảng hoặc chuỗi không chứa giá trị nào trong số các giá trị đã cho. Đây là phép so sánh giá trị, chứ không phải phép so sánh tham chiếu. Nội dung của các đối tượng và mảng được so sánh đệ quy. |
containsExactly(...expected) |
Xác nhận rằng đối tượng là một mảng chứa tất cả các giá trị đã cho theo thứ tự bất kỳ và không có giá trị nào khác. Đây là so sánh giá trị, chứ không phải so sánh tham chiếu. Nội dung của các đối tượng và mảng được so sánhRecursively. |
doesNotContainExactly(...expected) |
Xác nhận rằng đối tượng là một mảng chứa một tập hợp giá trị khác với các giá trị đã cho theo thứ tự bất kỳ. Đây là phép so sánh giá trị, không phải phép so sánh tham chiếu. Nội dung của các đối tượng và mảng được so sánh đệ quy. |
hasLength(expected) |
Xác nhận rằng chủ đề là một mảng hoặc chuỗi có độ dài nhất định. Câu nhận định luôn không thành công nếu giá trị không phải là mảng hoặc chuỗi. |
isEmpty() |
Xác nhận rằng chủ đề là một mảng hoặc chuỗi trống (độ dài = 0). Câu nhận định luôn không thành công nếu giá trị không phải là mảng hoặc chuỗi. |
isNotEmpty() |
Xác nhận rằng chủ đề là một mảng hoặc chuỗi không trống (độ dài > 0). Câu nhận định luôn không thành công nếu giá trị không phải là một mảng hoặc chuỗi. |
isArray() |
Xác nhận rằng loại của chủ đề là một mảng. |
isBoolean() |
Xác nhận rằng loại của chủ đề là boolean. |
isFunction() |
Xác nhận rằng loại của đối tượng là một hàm. |
isNumber() |
Xác nhận rằng loại của chủ đề là một số. |
isObject() |
Xác nhận rằng loại của đối tượng là một đối tượng. |
isString() |
Xác nhận rằng loại của chủ đề là một chuỗi. |
Ví dụ
assertThat(undefined).isUndefined();
assertThat(id, 'ID must be defined').isDefined();
assertThat(null).isNull();
assertThat(undefined).isNotNull();
assertThat(true).isTrue();
assertThat(false).isFalse();
assertThat(1).isTruthy();
assertThat('').isFalsy();
assertThat(1/0).isInfinity();
assertThat(0).isNotInfinity();
assertThat(-'foo').isNaN();
assertThat(100).isNotNaN();
assertThat(sentUrl).isEqualTo('https://endpoint.example.com/?account=12345');
assertThat(category).isNotEqualTo('premium');
assertThat(5).isAnyOf(1, 2, 3, 4, 5);
assertThat(42).isNoneOf('the question', undefined, 41.9);
assertThat('value').isStrictlyEqualTo('value');
assertThat('4').isNotStrictlyEqualTo(4);
assertThat(['a', 'b', 'c']).contains('a', 'c');
assertThat(['x', 'y', 'z']).doesNotContain('f');
assertThat(['1', '2', '3']).containsExactly('3', '2', '1');
assertThat(['4', '5']).doesNotContainExactly('4');
assertThat('a string').hasLength(8);
assertThat([]).isEmpty();
assertThat('another string').isNotEmpty();
fail
Ngay lập tức không đạt kiểm thử hiện tại và in thông báo đã cho (nếu có).
Cú pháp
fail(opt_message);
Tham số
| Thông số | Loại | Mô tả |
|---|---|---|
opt_message |
string | Văn bản thông báo lỗi không bắt buộc. |
Ví dụ
fail('This test has failed.');
mock
API mock cho phép bạn ghi đè hành vi của các API trong Hộp cát. Bạn có thể sử dụng API mô phỏng một cách an toàn trong mã mẫu, nhưng API này chỉ hoạt động ở chế độ kiểm thử.
Mô phỏng sẽ được đặt lại trước khi chạy mỗi chương trình kiểm thử.
Cú pháp
mock(apiName, returnValue);
Tham số
| Thông số | Loại | Mô tả |
|---|---|---|
apiName |
string | Tên của API cần mô phỏng; cùng một chuỗi được truyền đến require() |
returnValue |
bất kỳ | Giá trị cần trả về cho API hoặc một hàm được gọi thay cho API. Nếu returnValue là một hàm, thì hàm đó sẽ được gọi thay cho API Hộp cát; nếu returnValue là bất kỳ giá trị nào khác ngoài hàm, thì giá trị đó sẽ được trả về thay cho API Hộp cát. |
Ví dụ
mock('encodeUri', "https://endpoint.example.com/?account=12345");
mock('sendPixel', function(url, onSuccess, onFailure) {
onSuccess();
});
mockObject
API mockObject cho phép bạn ghi đè hành vi của các API Hộp cát trả về một đối tượng. Bạn có thể sử dụng API này một cách an toàn trong mã mẫu, nhưng API này chỉ hoạt động ở chế độ kiểm thử. Mô phỏng sẽ được đặt lại trước khi chạy mỗi chương trình kiểm thử.
Cú pháp
mockObject(apiName, objectMock);
Tham số
| Thông số | Loại | Mô tả |
|---|---|---|
apiName |
string | Tên của API cần mô phỏng; cùng một chuỗi được truyền đến require() |
objectMock |
đối tượng | Giá trị cần trả về cho API hoặc một hàm được gọi thay cho API. Phải là một đối tượng. |
Ví dụ
const storage = {};
let firestoreId = 1;
function asTestPromise(result) {
return {
then: (callback) => callback(result)
};
}
mockObject('Firestore', {
write: (collection, input) => {
storage[collection + '/' + (++firestoreId)] = input;
return asTestPromise(firestoreId);
},
read: (document) => asTestPromise({data: storage[document]})
});
runCode
Chạy mã cho mẫu, tức là nội dung của thẻ Code (Mã), trong môi trường kiểm thử hiện tại với một đối tượng dữ liệu đầu vào nhất định.
Cú pháp
runCode(data)
Tham số
| Thông số | Loại | Mô tả |
|---|---|---|
data |
đối tượng | Đối tượng dữ liệu sẽ được sử dụng trong kiểm thử. |
Giá trị trả về
Trả về giá trị của một biến cho các mẫu biến; trả về undefined cho tất cả các loại mẫu khác.
Ví dụ
runCode({field1: 123, field2: 'value'});