W tym dokumencie opisujemy uprawnienia szablonów niestandardowych po stronie serwera.
Każde uprawnienie:
- Sprawdzane przez interfejsy API, które ich wymagają.
- Automatycznie wykrywany w JavaScripcie w trybie piaskownicy na podstawie używanych interfejsów API. Dzieje się tak, gdy wprowadzasz zmiany w edytorze niestandardowego szablonu (aby szybko uzyskać informacje zwrotne) i gdy kompilujesz kod (aby sprawdzić, czy są stosowane odpowiednie uprawnienia).
- Można je edytować w edytorze szablonów niestandardowych, aby dostosować uprawnienia.
- Dostępny w sandboxowanym środowisku JavaScript za pomocą interfejsu
queryPermission
API.
access_bigquery
Wyświetlana nazwa: dostęp do BigQuery.
Opis: umożliwia dostęp do BigQuery w Google Cloud Platform.
Konfiguracja: opcja umożliwiająca używanie w BigQuery określonych kombinacji projektu, zbioru danych i tabeli. Ustawienie konfiguracji identyfikatora projektu na GOOGLE_CLOUD_PROJECT
umożliwi używanie zmiennej środowiskowej GOOGLE_CLOUD_PROJECT
jako identyfikatora projektu, gdy projectId
jest wykluczone z BigQuery API
parameter
.
Wymagane przez: BigQuery
Podpis zapytania:
queryPermission('access_bigquery', <operation>, <options>)
Uwagi: <operation>
to ciąg znaków, który może mieć te wartości:
- zapis
<options>
to obiekt zawierający te elementy:
{
'projectId': <project_id>,
'datasetId': <dataset_id>,
'tableId': <table_id>
}
Przykładowy kod
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
Wyświetlana nazwa: dostęp do Google Firestore
Opis: umożliwia dostęp do Google Firestore.
Konfiguracja: opcja zezwolenia na używanie określonych kombinacji projektów i ścieżek (z obsługą składni symboli wieloznacznych) w Firestore. Ustawienie konfiguracji identyfikatora projektu GOOGLE_CLOUD_PROJECT
pozwoli używać zmiennej środowiskowej GOOGLE_CLOUD_PROJECT
jako identyfikatora projektu, jeśli projectId
jest wykluczone z Firestore API parameter
.
Wymagane przez: Firestore
Podpis zapytania:
queryPermission('access_firestore', <operation>, <options>)
Uwagi: <operation>
to ciąg znaków, który może mieć te wartości:
- read – przyznaje uprawnienia do odczytu i wykonywanych zapytań do interfejsów API
- zapis – przyznaje uprawnienia do zapisu interfejsu API
- read_write – przyznaje uprawnienia do odczytu, zapisu i wykonania zapytania do interfejsów API
<options>
to obiekt zawierający następujące elementy:
{
'projectId': <project_id>,
'path': <path>
}
Przykładowy kod
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
Wyświetlana nazwa: uzyskuje dostęp do odpowiedzi.
Opis: uzyskuje dostęp do treści, nagłówków i stanu odpowiedzi.
Konfiguracja: opcja zezwalająca na dostęp ogólny lub konkretny, z opcjami podrzędnymi umożliwiającymi kontrolowanie dostępu do różnych podkomponentów.
Wymagane przez: setPixelResponse
, setResponseBody
,
setResponseHeader
, setResponseStatus
Podpis zapytania:
queryPermission('access_response', 'write', <component>[, <optional component name>])
Uwagi: określa, czy można uzyskać dostęp do wychodzącego komponentu odpowiedzi HTTP.
Przykładowy kod
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
Wyświetlana nazwa: uzyskuje dostęp do pamięci szablonów
Opis: umożliwia dostęp do tymczasowego miejsca na dysku dla szablonów, które mogą przetrwać przez cały czas trwania procesu po stronie serwera.
Konfiguracja: brak.
Wymagane przez: templateDataStorage
Podpis zapytania: queryPermission('access_template_storage')
Przykładowy kod
const queryPermission = require('queryPermission');
const templateDataStorage = require('templateDataStorage');
const key = 'my_key';
if (queryPermission('access_template_storage')) {
const value = templateDataStorage.getItemCopy(key);
}
get_cookies
Wyświetlana nazwa: odczytuje wartości plików cookie.
Opis: odczytuje wartości plików cookie o określonej nazwie.
Konfiguracja: lista nazw plików cookie dozwolonych do odczytu.
Wymagane przez: getCookieValues
Podpis zapytania: queryPermission('get_cookies', <name>)
Uwagi: określa, czy plik cookie może być odczytywany, w zależności od jego nazwy.
Przykładowy kod
const queryPermission = require('queryPermission');
const getCookieValues = require('getCookieValues');
const cookieName = 'info';
let cookieValues;
if (queryPermission('get_cookies', cookieName)) {
cookieValues = getCookieValues(cookieName);
}
logowanie
Wyświetlana nazwa: logowanie do konsoli.
Opis: logowanie do konsoli programisty i trybu podglądu Menedżera tagów.
Konfiguracja: opcja włączenia logowania w wersji produkcyjnej. Domyślnie włączone jest tylko rejestrowanie podczas debugowania lub wyświetlania podglądu. Jeśli nie zostaną przyznane uprawnienia, logToConsole
nie zgłosi błędu, ale zablokuje komunikat logu.
Wymagane przez: logToConsole
Podpis zapytania: queryPermission('logging')
Uwagi: określa, czy szablon niestandardowy może logować się w konsoli programisty.
Przykładowy kod
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
Wyświetlana nazwa: korzysta z wiadomości.
Opis: wysyła lub odbiera wiadomości za pomocą interfejsów API addMessageListener
lub sendMessage
.
Konfiguracja: opcja pozwalająca określić typ wiadomości oraz określić, czy szablon może nasłuchiwać, wysyłać czy obie te opcje.
Wymagane przez: addMessageListener
, sendMessage
Podpis zapytania: queryPermission('use_message', <usage>, <message type>)
Uwagi: użycie może być listen
, send
lub listen_and_send
.
Przykładowy kod
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
Wyświetlana nazwa: odczytuje dane kontenera.
Opis: odczytuje dane o kontenerze.
Konfiguracja: brak.
Wymagane przez: getClientName
, getContainerVersion
Podpis zapytania: queryPermission('read_container_data')
Uwagi: określa, czy szablon niestandardowy może odczytywać dane kontenera.
Przykładowy kod
const getContainerVersion = require('getContainerVersion');
const queryPermission = require('queryPermission');
if (queryPermission('read_container_data')) {
return getContainerVersion();
}
read_event_data
Nazwa wyświetlana: odczytuje dane zdarzenia.
Opis: odczytuje dane ze zdarzenia.
Konfiguracja: opcja umożliwiająca dostęp do wszystkich elementów lub dostęp do określonych elementów kontrolowany przez listę dozwolonych ścieżek kluczy (obsługiwana jest składnia z znakami wieloznacznymi).
Wymagane przez: getAllEventData
, getEventData
Podpis zapytania: queryPermission('read_event_data'[, <optional key>])
Uwagi: określa, czy szablon niestandardowy może odczytywać dane zdarzenia na danej ścieżce klucza (lub wszystkie dane zdarzenia, jeśli nie jest podana ścieżka klucza).
Przykładowy kod
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
Nazwa wyświetlana: odczytuje metadane zdarzenia.
Opis: odczytywanie metadanych zdarzeń w wywołaniach zwrotnych zdarzeń
Konfiguracja: brak.
Wymagane przez: addEventCallback
Podpis zapytania: queryPermission('read_event_metadata')
Uwagi: określa, czy szablon niestandardowy może odczytywać metadane zdarzeń w wywołaniach zwrotnych.
Przykładowy kod
const queryPermission = require('queryPermission');
const addEventCallback = require('addEventCallback');
if (queryPermission('read_event_metadata')) {
addEventCallback((containerId, eventMetadata) => {
// Read event metadata.
});
}
read_request
Wyświetlana nazwa: odczytuje żądanie HTTP.
Opis: odczytuje nagłówki żądania, parametry zapytania, treść, ścieżkę lub zdalny adres IP.
Konfiguracja: opcja zezwalająca na dostęp ogólny lub konkretny, z opcjami podrzędnymi umożliwiającymi kontrolowanie dostępu do różnych podkomponentów.
Wymagany przez: extractEventsFromMpv1
, extractEventsFromMpv2
,
getRemoteAddress
, getRequestBody
, getRequestHeader
,
getRequestPath
, getRequestQueryParameter
, getRequestQueryParameters
,
getRequestQueryString
Podpis zapytania:
queryPermission('read_request', <component>[, <optional component name>])
Uwagi: określa, czy można uzyskać dostęp do przychodzącego elementu odpowiedzi HTTP.
Przykładowy kod
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
Wyświetlana nazwa: zwraca odpowiedź.
Opis: zwraca odpowiedź rozmówcy.
Konfiguracja: brak
Wymagane przez: returnResponse
Podpis zapytania: queryPermission('return_response')
Uwagi: to uprawnienie nie ma pól, które można zawęzić, i zwykle nie jest wysyłane w zapytaniach.
run_container
Wyświetlana nazwa: uruchamia kontener.
Opis: uruchamia kontener ze zdarzeniem.
Konfiguracja: brak.
Wymagane przez: runContainer
Podpis zapytania: queryPermission('run_container')
Uwagi: to uprawnienie nie zawiera pól, które można zawęzić, i zwykle nie jest wymagane.
send_http
Wyświetlana nazwa: wysyła żądania HTTP.
Opis: wysyła żądanie HTTP do określonego adresu URL.
Wymagane przez: getGoogleScript
, sendEventToGoogleAnalytics
,
sendHttpGet
, sendHttpRequest
Podpis zapytania: queryPermission('send_http', <url>)
Uwagi: określa, czy żądanie HTTP może zostać wysłane, w zależności od adresu URL. Aby zapewnić bezpieczne połączenie, zezwalamy tylko na adresy URL zabezpieczone (HTTPS).
Przykładowy kod
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
Wyświetlana nazwa: wysyła piksele z przeglądarek.
Opis: wysyła z przeglądarki żądanie GET do określonego adresu URL.
Wymagane przez: sendPixelFromBrowser
Podpis zapytania: queryPermission('send_pixel_from_browser', <url>)
Uwagi: określa, czy żądanie może być wysyłane z przeglądarki, w zależności od adresu URL.
Przykładowy kod
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
Wyświetlana nazwa: ustawia plik cookie.
Opis: ustawia plik cookie z określonymi nazwą i parametrami.
Konfiguracja: tabela z dozwolonymi nazwami plików cookie, z opcjonalnymi ograniczeniami dotyczącymi nazwy, domeny, ścieżki, atrybutu secure
i okresu ważności.
Wymagane przez: setCookie
Podpis zapytania: queryPermission('set_cookies', <name>, <options>)
Uwagi: określa, czy do odpowiedzi można dodać nagłówek „Set-Cookie” (w zależności od nazwy pliku cookie, domeny, ścieżki, atrybutu secure
i czasu wygaśnięcia).
Przykładowy kod
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
Wyświetlana nazwa: używa niestandardowych kluczy prywatnych.
Opis: używanie kluczy prywatnych z pliku kluczy JSON na potrzeby operacji kryptograficznych.
Konfiguracja: lista dozwolonych identyfikatorów kluczy. Identyfikatory muszą być zgodne z kluczami w pliku kluczy JSON, do którego odwołuje się zmienna środowiskowa SGTM_CREDENTIALS
na serwerze.
Wymagane przez: hmacSha256
Podpis zapytania: queryPermission('use_custom_private_keys', <key id>)
Uwagi: zarządza listą dozwolonych kluczy prywatnych.
Przykładowy kod
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
Nazwa wyświetlana: używa domyślnych danych logowania aplikacji Google.
Opis: domyślne dane logowania Google do wywoływania interfejsów API Google.
Konfiguracja: lista dozwolonych zakresów OAuth 2.0 Google.
Wymagane przez: getGoogleAuth
Podpis zapytania: queryPermission('use_google_credentials', <scopes>)
Uwagi: ogranicza dozwolone zakresy OAuth 2.0 Google do korzystania z interfejsów API Google.
Przykładowy kod
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);
}