সার্ভার-সাইড কাস্টম টেমপ্লেট অনুমতি

এই নথিটি সার্ভার-সাইড কাস্টম টেমপ্লেটগুলির জন্য অনুমতিগুলির রূপরেখা দেয়৷


প্রতিটি অনুমতি হল:

  • এপিআই দ্বারা চেক করা হয়েছে যার জন্য তাদের প্রয়োজন।
  • কি API ব্যবহার করা হয় তার উপর ভিত্তি করে স্যান্ডবক্সযুক্ত জাভাস্ক্রিপ্টে স্বয়ংক্রিয়ভাবে সনাক্ত করা হয়। কাস্টম টেমপ্লেট এডিটর (দ্রুত ফিডব্যাক লুপের জন্য) এবং যখন কোড কম্পাইল করা হয় (সঠিক অনুমতি প্রয়োগ করা হয়েছে তা যাচাই করার জন্য) সম্পাদনা করা হলে এটি ঘটে।
  • কাস্টম টেমপ্লেট এডিটরে সম্পাদনাযোগ্য, অনুমতি আরও নির্দিষ্ট করতে।
  • queryPermission API-এর মাধ্যমে স্যান্ডবক্সযুক্ত জাভাস্ক্রিপ্টে অনুসন্ধানযোগ্য।

অ্যাক্সেস_বিগকুয়েরি

প্রদর্শনের নাম: BigQuery অ্যাক্সেস করে

বর্ণনা: Google ক্লাউড প্ল্যাটফর্মে BigQuery-এ অ্যাক্সেসের অনুমতি দেয়।

কনফিগারেশন: BigQuery-এর সাথে নির্দিষ্ট প্রজেক্ট, ডেটাসেট এবং টেবিল কম্বিনেশন ব্যবহার করার অনুমতি দেওয়ার বিকল্প। GOOGLE_CLOUD_PROJECT এর একটি প্রজেক্ট আইডি কনফিগারেশন সেট করা হলে GOOGLE_CLOUD_PROJECT এনভায়রনমেন্ট ভেরিয়েবলকে প্রজেক্ট আইডি হিসেবে ব্যবহার করার অনুমতি দেবে যখন projectId BigQuery API parameter থেকে বাদ দেওয়া হয়।

এর দ্বারা প্রয়োজনীয়: BigQuery

প্রশ্ন স্বাক্ষর: queryPermission('access_bigquery', <operation>, <options>)

নোট: <operation> একটি স্ট্রিং এবং নিম্নলিখিত মান থাকতে পারে:

  • লিখুন

<options> নিম্নলিখিত আইটেম ধারণকারী একটি বস্তু:

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

উদাহরণ কোড

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

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

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

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

অ্যাক্সেস_ফায়ারস্টোর

প্রদর্শনের নাম: Google Firestore অ্যাক্সেস করে

বর্ণনা: গুগল ফায়ারস্টোরে অ্যাক্সেসের অনুমতি দেয়।

কনফিগারেশন: নির্দিষ্ট প্রজেক্ট এবং পাথ (ওয়াইল্ডকার্ড সিনট্যাক্স সমর্থিত) সমন্বয়গুলি Firestore-এর সাথে ব্যবহার করার অনুমতি দেওয়ার বিকল্প। GOOGLE_CLOUD_PROJECT এর একটি প্রজেক্ট আইডি কনফিগারেশন সেট করা GOOGLE_CLOUD_PROJECT এনভায়রনমেন্ট ভেরিয়েবলকে প্রজেক্ট আইডি হিসাবে ব্যবহার করার অনুমতি দেবে যখন projectId Firestore API parameter থেকে বাদ দেওয়া হয়।

এর দ্বারা প্রয়োজনীয়: Firestore

প্রশ্ন স্বাক্ষর: queryPermission('access_firestore', <operation>, <options>)

নোট: <operation> একটি স্ট্রিং এবং নিম্নলিখিত মান থাকতে পারে:

  • পঠন - এপিআইগুলিকে পঠন এবং জিজ্ঞাসা করার অ্যাক্সেস মঞ্জুর করে৷
  • লিখুন - 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);
}

অ্যাক্সেস_প্রতিক্রিয়া

প্রদর্শনের নাম: প্রতিক্রিয়া অ্যাক্সেস করে

বর্ণনা: প্রতিক্রিয়া প্রধান অংশ, শিরোনাম, বা স্থিতি অ্যাক্সেস করে।

কনফিগারেশন: বিভিন্ন সাব-কম্পোনেন্টে অ্যাক্সেস নিয়ন্ত্রণের জন্য সাব-বিকল্প সহ যেকোনো বা নির্দিষ্ট অ্যাক্সেসের অনুমতি দেওয়ার বিকল্প।

এর দ্বারা প্রয়োজনীয়: 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);
}

অ্যাক্সেস_টেমপ্লেট_স্টোরেজ

প্রদর্শনের নাম: টেমপ্লেট স্টোরেজ অ্যাক্সেস করে

বর্ণনা: টেমপ্লেটগুলির জন্য অস্থায়ী সঞ্চয়স্থানে অ্যাক্সেসের অনুমতি দেয় যা সার্ভার-সাইড প্রক্রিয়ার জীবনকাল ধরে চলতে পারে।

কনফিগারেশন: কোনোটিই নয়

এর দ্বারা প্রয়োজনীয়: templateDataStorage

প্রশ্ন স্বাক্ষর: queryPermission('access_template_storage')

উদাহরণ কোড

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

get_cookies

প্রদর্শনের নাম: কুকি মান(গুলি) পড়ে

বর্ণনা: নির্দিষ্ট নামের সাথে কুকিজের মান পড়ে।

কনফিগারেশন: পড়ার জন্য অনুমোদিত কুকিজের নামের তালিকা।

এর দ্বারা প্রয়োজনীয়: getCookieValues

প্রশ্ন স্বাক্ষর: queryPermission('get_cookies', <name>)

দ্রষ্টব্য: একটি কুকির নামের উপর নির্ভর করে পড়া যাবে কিনা তা নিয়ন্ত্রণ করে।

উদাহরণ কোড

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

লগিং

প্রদর্শনের নাম: কনসোলে লগ

বর্ণনা: বিকাশকারী কনসোল এবং ট্যাগ ম্যানেজারের পূর্বরূপ মোডে লগ করে।

কনফিগারেশন: লগ ইন উৎপাদন সক্ষম করার বিকল্প। শুধুমাত্র ডিবাগ/প্রিভিউতে লগিং সক্ষম করতে ডিফল্ট। অনুমতি অস্বীকৃত হলে, logToConsole একটি ত্রুটি নিক্ষেপ করবে না, কিন্তু লগ বার্তাটি দমন করবে।

এর দ্বারা প্রয়োজনীয়: logToConsole

প্রশ্ন স্বাক্ষর: queryPermission('logging')

দ্রষ্টব্য: একটি কাস্টম টেমপ্লেট বিকাশকারী কনসোলে লগ করতে পারে কিনা তা নিয়ন্ত্রণ করে।

উদাহরণ কোড

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

use_message

প্রদর্শনের নাম: বার্তা ব্যবহার করে

বর্ণনা: addMessageListener বা sendMessage API ব্যবহার করে বার্তা পাঠায় বা গ্রহণ করে।

কনফিগারেশন: বার্তার ধরন এবং টেমপ্লেট শুনতে, পাঠাতে বা উভয়ই করতে পারে কিনা তা নির্দিষ্ট করার বিকল্প।

এর দ্বারা প্রয়োজনীয়: addMessageListener , sendMessage

প্রশ্ন স্বাক্ষর: queryPermission('use_message', <usage>, <message type>)

দ্রষ্টব্য: listen , send , বা listen_and_send এর মধ্যে একটি ব্যবহার হতে পারে।

উদাহরণ কোড

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

Read_container_data

প্রদর্শনের নাম: কন্টেইনার ডেটা পড়ে

বর্ণনা: ধারক সম্পর্কে ডেটা পড়ে।

কনফিগারেশন: কোনোটিই নয়।

এর দ্বারা প্রয়োজনীয়: getClientName , getContainerVersion

প্রশ্ন স্বাক্ষর: queryPermission('read_container_data')

নোট: একটি কাস্টম টেমপ্লেট কন্টেইনার ডেটা পড়তে পারে কিনা তা নিয়ন্ত্রণ করে।

উদাহরণ কোড

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

পড়ুন_ইভেন্ট_ডেটা

প্রদর্শনের নাম: ইভেন্ট ডেটা পড়ে

বর্ণনা: ইভেন্ট থেকে ডেটা পড়ে।

কনফিগারেশন: অনুমোদিত কী পাথগুলির একটি তালিকা দ্বারা নিয়ন্ত্রিত যে কোনও অ্যাক্সেস বা নির্দিষ্ট অ্যাক্সেসের অনুমতি দেওয়ার বিকল্প (ওয়াইল্ডকার্ড সিনট্যাক্স সমর্থিত)।

এর দ্বারা প্রয়োজনীয়: 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);
}

পড়ুন_ইভেন্ট_মেটাডেটা

প্রদর্শনের নাম: ইভেন্ট মেটাডেটা পড়ে

বর্ণনা: ইভেন্ট কলব্যাকে ইভেন্ট মেটাডেটা পড়ে

কনফিগারেশন: কোনোটিই নয়

এর দ্বারা প্রয়োজনীয়: addEventCallback

প্রশ্ন স্বাক্ষর: queryPermission('read_event_metadata')

দ্রষ্টব্য: একটি কাস্টম টেমপ্লেট কলব্যাকে ইভেন্ট মেটাডেটা পড়তে পারে কিনা তা নিয়ন্ত্রণ করে।

উদাহরণ কোড

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

পড়ুন_অনুরোধ করুন

প্রদর্শনের নাম: HTTP অনুরোধ পড়ে

বর্ণনা: রিকোয়েস্ট হেডার, ক্যোয়ারী প্যারামিটার, বডি, পাথ বা রিমোট আইপি অ্যাড্রেস পড়ে।

কনফিগারেশন: বিভিন্ন সাব-কম্পোনেন্টে অ্যাক্সেস নিয়ন্ত্রণের জন্য সাব-বিকল্প সহ যেকোনো বা নির্দিষ্ট অ্যাক্সেসের অনুমতি দেওয়ার বিকল্প।

এর দ্বারা প্রয়োজনীয়: 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') { ... }

প্রত্যাবর্তন_প্রতিক্রিয়া

প্রদর্শনের নাম: প্রতিক্রিয়া প্রদান করে

বর্ণনা: কলকারীর প্রতিক্রিয়া প্রদান করে।

কনফিগারেশন: কোনোটিই নয়

এর দ্বারা প্রয়োজনীয়: returnResponse

প্রশ্ন স্বাক্ষর: queryPermission('return_response')

দ্রষ্টব্য: এই অনুমতির সংকীর্ণ করার জন্য কোন ক্ষেত্র নেই, এবং সাধারণত এর জন্য জিজ্ঞাসা করা হয় না।

রান_কন্টেইনার

প্রদর্শনের নাম: ধারক চালায়

বর্ণনা: একটি ইভেন্ট সহ ধারক চালায়

কনফিগারেশন: কোনোটিই নয়

এর দ্বারা প্রয়োজনীয়: runContainer

প্রশ্ন স্বাক্ষর: queryPermission('run_container')

দ্রষ্টব্য: এই অনুমতির সংকীর্ণ করার জন্য কোন ক্ষেত্র নেই, এবং সাধারণত এর জন্য জিজ্ঞাসা করা হয় না।

send_http

প্রদর্শনের নাম: HTTP অনুরোধ পাঠায়

বর্ণনা: একটি নির্দিষ্ট URL-এ একটি HTTP অনুরোধ পাঠায়।

এর দ্বারা প্রয়োজনীয়: getGoogleScript , sendEventToGoogleAnalytics , sendHttpGet , sendHttpRequest

প্রশ্ন স্বাক্ষর: queryPermission('send_http', <url>)

দ্রষ্টব্য: URL এর উপর নির্ভর করে একটি HTTP অনুরোধ করা যেতে পারে কিনা তা নিয়ন্ত্রণ করে। একটি নিরাপদ সংযোগ নিশ্চিত করতে, শুধুমাত্র নিরাপদ (HTTPS) URL গুলি অনুমোদিত৷

উদাহরণ কোড

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

ব্রাউজার থেকে_পিক্সেল_সেন্ড করুন

প্রদর্শনের নাম: ব্রাউজার থেকে পিক্সেল পাঠায়

বর্ণনা: ব্রাউজার থেকে একটি নির্দিষ্ট URL-এ একটি GET অনুরোধ পাঠায়।

এর দ্বারা প্রয়োজনীয়: sendPixelFromBrowser

প্রশ্ন স্বাক্ষর: queryPermission('send_pixel_from_browser', <url>)

দ্রষ্টব্য: URL-এর উপর নির্ভর করে ব্রাউজার থেকে অনুরোধ পাঠানো যাবে কিনা তা নিয়ন্ত্রণ করে।

উদাহরণ কোড

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

সেট_কুকিজ

প্রদর্শনের নাম: একটি কুকি সেট করে

বর্ণনা: নির্দিষ্ট নাম এবং পরামিতি সহ একটি কুকি সেট করে।

কনফিগারেশন: অনুমোদিত কুকি নামের একটি টেবিল, প্রতিটিতে নাম, ডোমেন, পাথ, secure বৈশিষ্ট্য এবং মেয়াদ শেষ হওয়ার উপর ঐচ্ছিক সীমাবদ্ধতা রয়েছে।

দ্বারা প্রয়োজনীয়: setCookie

প্রশ্ন স্বাক্ষর: queryPermission('set_cookies', <name>, <options>)

দ্রষ্টব্য: কুকির নাম, ডোমেন, পাথ, secure বৈশিষ্ট্য এবং মেয়াদ শেষ হওয়ার উপর নির্ভর করে প্রতিক্রিয়াতে একটি প্রদত্ত 'সেট-কুকি' শিরোনাম যোগ করা যেতে পারে কিনা তা নিয়ন্ত্রণ করে।

উদাহরণ কোড

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

ব্যবহার_কাস্টম_প্রাইভেট_কী

প্রদর্শনের নাম: কাস্টম ব্যক্তিগত কী ব্যবহার করে

বর্ণনা: ক্রিপ্টোগ্রাফিক অপারেশনের জন্য একটি JSON কী ফাইল থেকে ব্যক্তিগত কী ব্যবহার করে।

কনফিগারেশন: অনুমোদিত কী আইডিগুলির একটি তালিকা। আইডিগুলি অবশ্যই সার্ভারে 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 API-এ কল করতে Google ডিফল্ট শংসাপত্র ব্যবহার করে।

কনফিগারেশন: অনুমোদিত 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);
}