本頁面由 Cloud Translation API 翻譯而成。

伺服器端自訂範本權限

本文件概述伺服器端自訂範本的權限。

每個權限皆為：

由需要這類 API 的 API 進行檢查。
在沙箱機制的 JavaScript 中自動偵測，視使用的 API 而定。這是因為在自訂範本編輯器中進行編輯 (可快速提供意見回饋循環)，以及編譯程式碼 (驗證是否強制執行正確權限) 時，就會發生這種情況。
可透過自訂範本編輯器編輯，以設定更精確的權限。
可透過 queryPermission API 在沙箱 JavaScript 中查詢。

access_bigquery

顯示名稱：存取 BigQuery

說明：允許在 Google Cloud Platform 上存取 BigQuery。

設定：可選擇允許在 BigQuery 中使用特定專案、資料集和資料表組合。如果將專案 ID 設定為 GOOGLE_CLOUD_PROJECT，當 BigQuery API parameter 中排除 projectId 時，即可使用 GOOGLE_CLOUD_PROJECT 環境變數做為專案 ID。

必填資料欄： BigQuery

查詢簽名： queryPermission('access_bigquery', <operation>, <options>)

注意： <operation> 是字串，且具有下列值：

write

<options> 是包含下列項目的物件：

{
  'projectId': <project_id>,
  'datasetId': <dataset_id>,
  'tableId': <table_id>
}

範例程式碼

const BigQuery = require('BigQuery');
const queryPermission = require('queryPermission');

const connectionInfo = {
  'projectId': 'gcp-cloud-project-id',
  'datasetId': 'destination-dataset',
  'tableId': 'destination-table',
};

if (queryPermission('access_bigquery', 'write', connectionInfo)) {
  const rows = [{
    'column1': 'String1',
    'column2': 1234,
  }];
  const options = {
    'ignoreUnknownValues': true,
    'skipInvalidRows': false,
  };

  BigQuery.insert(connectionInfo, rows, options)
      .then(data.gtmOnSuccess, data.gtmOnFailure);
}

access_firestore

顯示名稱：存取 Google Firestore

說明：允許存取 Google Firestore。

設定：允許將指定專案與路徑 (支援萬用字元語法) 組合與 Firestore 搭配使用的選項。如果設定 GOOGLE_CLOUD_PROJECT 的專案 ID 設定，當 projectId 已從 Firestore API parameter 中排除時，您就能使用 GOOGLE_CLOUD_PROJECT 環境變數做為專案 ID。

必填資料欄： Firestore

查詢簽名： queryPermission('access_firestore', <operation>, <options>)

注意： <operation> 是字串，且具有下列值：

讀取 - 授予讀取和查詢 API 的權限
寫入 - 授予 API 寫入權限
read_write - 授予讀取、寫入和查詢 API 的權限

<options> 是包含下列項目的物件：

{
  'projectId': <project_id>,
  'path': <path>
}

範例程式碼

const Firestore = require('Firestore');
const queryPermission = require('queryPermission');

const options = {
  'projectId': 'gcp-cloud-project-id',
  'path': 'collection/document',
};

if (queryPermission('access_firestore', 'read', options)) {
  Firestore.read('collection/document', {
    projectId: 'gcp-cloud-project-id',
  }).then(data.gtmOnSuccess, data.gtmOnFailure);
}

access_response

顯示名稱：存取回應

說明：存取回應內文、標頭或狀態。

設定：允許任何或特定存取權的選項，並提供控制各種子元件存取權的子選項。

必填屬性： setPixelResponse、setResponseBody、setResponseHeader、setResponseStatus

查詢簽名： queryPermission('access_response', 'write', <component>[, <optional component name>])

注意：管理是否可存取傳出 HTTP 回應元件。

範例程式碼

const queryPermission = require('queryPermission');
const setResponseBody = require('setResponseBody');
const setResponseHeader = require('setResponseHeader');
const setResponseStatus = require('setResponseStatus');
if (queryPermission('access_response', 'write', 'header', 'Content-Type')) {
  setResponseHeader('Content-Type', 'text/plain');
}
if (queryPermission('access_response', 'write', 'body')) {
  setResponseBody('Not Found');
}
if (queryPermission('access_response', 'write', 'status')) {
  setResponseStatus(404);
}

access_template_storage

顯示名稱：存取範本儲存空間

說明：針對可保存於伺服器端程序生命週期的範本，允許存取臨時儲存空間。

設定：無

必填資料欄： templateDataStorage

查詢簽名： queryPermission('access_template_storage')

範例程式碼

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

get_cookies

顯示名稱：讀取 Cookie 值

說明：讀取含指定名稱的 Cookie 值。

設定：列出允許讀取的 Cookie 名稱清單。

必填資料欄： getCookieValues

查詢簽名： queryPermission('get_cookies', <name>)

注意：根據 Cookie 名稱，控管是否可以讀取 Cookie。

範例程式碼

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

記錄

顯示名稱：記錄到控制台

說明：記錄至 Play 管理中心和代碼管理工具的預覽模式。

設定：可在實際工作環境中啟用記錄功能的選項。預設為只在偵錯/預覽中啟用記錄功能。如果權限遭拒，logToConsole 不會擲回錯誤，但會抑制記錄訊息。

必填資料欄： logToConsole

查詢簽名： queryPermission('logging')

注意：控制是否允許自訂範本記錄到 Play 管理中心。

範例程式碼

const queryPermission = require('queryPermission');
const logToConsole = require('logToConsole');
// Note that it's fine to call log, since the log call will be ignored if
// logging isn't permitted in the current environment.
logToConsole('diagnostic info');

use_message

顯示名稱：使用訊息。

說明：使用 addMessageListener 或 sendMessage API 收發訊息。

設定：選擇指定訊息類型的選項，以及範本是否可監聽、傳送，或兩者皆有。

必填屬性： addMessageListener、sendMessage

查詢簽名： queryPermission('use_message', <usage>, <message type>)

注意：用量可以是 listen、send 或 listen_and_send 其中之一。

範例程式碼

const queryPermission = require('queryPermission');
const sendMessage = require('sendMessage');
if (queryPermission('use_message', 'send', 'set_cookie')) {
  sendMessage('set_cookie', {name: 'foo', value: 'bar'});
}

read_container_data

顯示名稱：讀取容器資料

說明：讀取容器相關資料。

設定：無。

必填屬性： getClientName、getContainerVersion

查詢簽名： queryPermission('read_container_data')

注意：控制是否允許自訂範本讀取容器資料。

範例程式碼

const getContainerVersion = require('getContainerVersion');
const queryPermission = require('queryPermission');
if (queryPermission('read_container_data')) {
  return getContainerVersion();
}

read_event_data

顯示名稱：讀取事件資料

說明：從事件讀取資料。

設定：允許任何存取，或由允許金鑰路徑清單控管的特定存取權 (支援萬用字元語法)。

必填屬性： getAllEventData、getEventData

查詢簽名： queryPermission('read_event_data'[, <optional key>])

注意：控制是否讓自訂範本讀取特定鍵路徑的事件資料 (如果未提供索引鍵路徑，則能讀取所有事件資料)。

範例程式碼

const getAllEventData = require('getAllEventData');
const queryPermission = require('queryPermission');
if (queryPermission('read_event_data')) {
  return getAllEventData();
}

const getEventData = require('getEventData');
const queryPermission = require('queryPermission');
const keyPath = 'parentField.childField';
if (queryPermission('read_event_data', keyPath)) {
  return getEventData(keyPath);
}

read_event_metadata

顯示名稱：讀取事件中繼資料

說明：讀取事件回呼中的事件中繼資料

設定：無

必填資料欄： addEventCallback

查詢簽名： queryPermission('read_event_metadata')

注意：控制自訂範本是否能讀取回呼中的事件中繼資料。

範例程式碼

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

read_request

顯示名稱：讀取 HTTP 要求

說明：讀取要求標頭、查詢參數、內文、路徑或遠端 IP 位址。

設定：允許任何或特定存取權的選項，並提供控制各種子元件存取權的子選項。

必填屬性： extractEventsFromMpv1、extractEventsFromMpv2、getRemoteAddress、getRequestBody、getRequestHeader、getRequestPath、getRequestQueryParameter、getRequestQueryParameters、getRequestQueryString

查詢簽名： queryPermission('read_request', <component>[, <optional component name>])

注意：管理是否可存取傳入的 HTTP 回應元件。

範例程式碼

const queryPermission = require('queryPermission');
const getRequestBody = require('getRequestBody');
const getRequestHeader = require('getRequestHeader');
let body, contentType;
if (queryPermission('read_request', 'body')) {
  body = getRequestBody();
}
if (queryPermission('read_request', 'header', 'content-type')) {
  contentType = getRequestHeader('content-type');
}
if (body && contentType == 'application/json') { ... }

return_response

顯示名稱：傳回回應

說明：將回覆傳回呼叫端。

設定：無

必填資料欄： returnResponse

查詢簽名： queryPermission('return_response')

注意：這項權限沒有可縮小的欄位範圍，因此通常不會查詢。

run_container

顯示名稱：執行容器

說明：執行含有事件的容器

設定：無

必填資料欄： runContainer

查詢簽名： queryPermission('run_container')

注意：這項權限沒有可縮小的欄位範圍，因此通常不會查詢。

send_http

顯示名稱：傳送 HTTP 要求

說明：將 HTTP 要求傳送至指定網址。

必填屬性： getGoogleScript、sendEventToGoogleAnalytics、sendHttpGet、sendHttpRequest

查詢簽名： queryPermission('send_http', <url>)

注意：根據網址，控管是否能提出 HTTP 要求。為確保連線安全，僅允許安全 (HTTPS) 網址。

範例程式碼

const queryPermission = require('queryPermission');
const sendHttpGet = require('sendHttpGet');
const url = 'https://example.com/search?query=foo&results=10';
if (queryPermission('send_http', url)) {
  sendHttpGet(url);
}

send_pixel_from_browser

顯示名稱：透過瀏覽器傳送像素

說明：透過瀏覽器將 GET 要求傳送至指定網址。

必填資料欄： sendPixelFromBrowser

查詢簽名： queryPermission('send_pixel_from_browser', <url>)

注意：根據網址，管理要求能否從瀏覽器傳送。

範例程式碼

const queryPermission = require('queryPermission');
const sendPixelFromBrowser = require('sendPixelFromBrowser');
const url = 'https://example.com/search?query=foo&results=10';
if (queryPermission('send_pixel_from_browser', url)) {
  sendPixelFromBrowser(url);
}

set_cookies

顯示名稱：設定 Cookie

說明：設定含指定名稱和參數的 Cookie。

設定：含有允許的 Cookie 名稱表格，每個名稱都有名稱、網域、路徑、secure 屬性和效期的選用限制。

必填資料欄： setCookie

查詢簽名： queryPermission('set_cookies', <name>, <options>)

注意：根據 Cookie 名稱、網域、路徑、secure 屬性和到期時間，控管是否能將特定的「Set-Cookie」標頭新增至回應。

範例程式碼

const queryPermission = require('queryPermission');
const setCookie = require('setCookie');
const options = {
  'domain': 'www.example.com',
  'path': '/',
  'max-age': 60*60*24*365,
  'secure': true
};
if (queryPermission('set_cookies', 'info', options)) {
  setCookie('info', 'xyz', options);
}

use_custom_private_keys

顯示名稱：使用自訂私密金鑰

說明：使用 JSON 金鑰檔案中的私密金鑰執行加密編譯作業。

設定：允許的金鑰 ID 清單。此 ID 必須與伺服器上 SGTM_CREDENTIALS 環境變數參照的 JSON 金鑰檔案中的金鑰相符。

必填資料欄： hmacSha256

查詢簽名： queryPermission('use_custom_private_keys', <key id>)

注意：管理允許的私密金鑰清單。

範例程式碼

const hmacSha256= require('hmacSha256');
const queryPermission = require('queryPermission');
const keyId = 'key1';

let result;
if (queryPermission('use_custom_private_keys', keyId)) {
  result = hmacSha256('my_data', keyId);
}

use_google_credentials

顯示名稱：使用 Google 應用程式預設憑證

說明：使用 Google 預設憑證呼叫 Google API。

設定：允許的 Google OAuth 2.0 範圍清單。

必填資料欄： getGoogleAuth

查詢簽名： queryPermission('use_google_credentials', <scopes>)

注意：會限制搭配 Google API 使用的允許的 Google OAuth 2.0 範圍。

範例程式碼

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);
}