मुख्य एपीआई
ये एपीआई, Google Tag Manager में कस्टम टेंप्लेट बनाने के लिए, सैंडबॉक्स किए गए JavaScript के साथ काम करते हैं. हर एपीआई को require() स्टेटमेंट के साथ जोड़ा जाता है. उदाहरण के लिए:
const myAPI = require('myAPI');
addConsentListener
सहमति के किसी खास टाइप की स्थिति बदलने पर, उसे लागू करने के लिए लिसनर फ़ंक्शन रजिस्टर करता है.
दिए गए लिसनर को हर बार तब ट्रिगर किया जाएगा, जब सहमति के तय किए गए टाइप की स्थिति, 'अस्वीकार किया गया' से 'स्वीकार किया गया' या 'स्वीकार किया गया' से 'अस्वीकार किया गया' में बदलेगी. जिस सहमति टाइप की कोई स्थिति नहीं है उसे 'मंज़ूरी मिल चुकी है' माना जाता है. इसलिए, अगर किसी सहमति टाइप की स्थिति को 'अनसेट' से 'मंज़ूरी मिल चुकी है' पर अपडेट किया जाता है, तो ऑडियंस को कॉल नहीं किया जाएगा. यह पक्का करना, Listener फ़ंक्शन का काम होगा कि उनका कोड सही संख्या में चल रहा है या नहीं.
उदाहरण:
const isConsentGranted = require('isConsentGranted');
const addConsentListener = require('addConsentListener');
if (!isConsentGranted('ad_storage')) {
let wasCalled = false;
addConsentListener('ad_storage', (consentType, granted) => {
if (wasCalled) return;
wasCalled = true;
const cookies = getMyCookies();
sendFullPixel(cookies);
});
}
सिंटैक्स
addConsentListener(consentType, listener)
पैरामीटर
| पैरामीटर | टाइप | ब्यौरा |
|---|---|---|
consentType |
स्ट्रिंग | स्थिति में होने वाले बदलावों को सुनने के लिए, सहमति का टाइप. |
listener |
फ़ंक्शन | यह फ़ंक्शन तब चलता है, जब सहमति के किसी खास टाइप की स्थिति बदलती है. |
जब किसी लिसनर को ट्रिगर किया जाता है, तो उसमें सहमति का वह टाइप और उसकी नई वैल्यू पास की जाएगी जिसे बदला जा रहा है:
| पैरामीटर | टाइप | ब्यौरा |
|---|---|---|
consentType |
स्ट्रिंग | सहमति का वह टाइप जिसे बदला जा रहा है. |
granted |
boolean | यह एक बूलियन वैल्यू है, जो सहमति के तय किए गए टाइप को 'मंज़ूरी मिल चुकी है' में बदलने पर 'सही' होती है. |
इससे जुड़ी अनुमतियां
सहमति के टाइप के लिए, पढ़ने का ऐक्सेस वाली access_consent अनुमति.
addEventCallback
addEventCallback एपीआई की मदद से, कॉलबैक फ़ंक्शन को रजिस्टर किया जा सकता है. इसे किसी इवेंट के आखिर में ट्रिगर किया जाएगा. इवेंट के सभी टैग लागू होने या पेज पर होने वाले इवेंट का टाइम आउट पूरा होने पर, कॉलबैक लागू होगा.
कॉलबैक में दो वैल्यू भेजी जाती हैं. फ़ंक्शन को कॉल करने वाले कंटेनर का आईडी और इवेंट के बारे में जानकारी देने वाला ऑब्जेक्ट.
सिंटैक्स
addEventCallback(callback)
पैरामीटर
| पैरामीटर | टाइप | ब्यौरा |
|---|---|---|
callback |
फ़ंक्शन | इवेंट के खत्म होने पर, ट्रिगर होने वाला फ़ंक्शन. |
eventData ऑब्जेक्ट में यह डेटा शामिल होता है:
| कुंजी का नाम | टाइप | ब्यौरा |
|---|---|---|
tags |
कलेक्शन | टैग डेटा ऑब्जेक्ट का कलेक्शन. इवेंट के दौरान ट्रिगर हुए हर टैग के लिए, इस कलेक्शन में एक एंट्री होगी. टैग डेटा ऑब्जेक्ट में,
टैग का आईडी (id), उसे ट्रिगर करने की स्थिति (status), और उसे ट्रिगर करने का समय (executionTime) शामिल होता है. टैग डेटा में, टैग पर कॉन्फ़िगर किया गया अतिरिक्त
टैग मेटाडेटा भी शामिल होगा. |
उदाहरण
addEventCallback(function(ctid, eventData) {
logToConsole('Tag count for container ' + ctid + ': ' + eventData['tags'].length);
});
इससे जुड़ी अनुमतियां
aliasInWindow
aliasInWindow API की मदद से, कोई उपनाम (उदाहरण के लिए, window.foo =
window.bar) बनाया जा सकता है. इससे उन कुछ टैग के साथ काम करने में मदद मिलती है जिनके लिए उपनाम की ज़रूरत होती है. fromPath में मिले window ऑब्जेक्ट की वैल्यू को, toPath में मौजूद window ऑब्जेक्ट की कुंजी को असाइन करता है. अगर लेन-देन पूरा हो जाता है, तो true दिखाता है. अगर लेन-देन पूरा नहीं होता है, तो false दिखाता है.
सिंटैक्स
aliasInWindow(toPath, fromPath)
पैरामीटर
| पैरामीटर | टाइप | ब्यौरा |
|---|---|---|
toPath |
स्ट्रिंग | window ऑब्जेक्ट में बिंदु से अलग किया गया पाथ, जहां वैल्यू को कॉपी किया जाना चाहिए. आखिरी कॉम्पोनेंट तक के पाथ में मौजूद सभी कॉम्पोनेंट,
window ऑब्जेक्ट में पहले से मौजूद होने चाहिए. |
fromPath |
स्ट्रिंग | window में मौजूद, बिंदु से अलग की गई वैल्यू को कॉपी करने का पाथ. अगर वैल्यू मौजूद नहीं है, तो ऑपरेशन पूरा नहीं होगा. |
उदाहरण
aliasInWindow('foo.bar', 'baz.qux')
इससे जुड़ी अनुमतियां
toPath और fromPath, दोनों के लिए access_globals ज़रूरी है; toPath के लिए लिखने का ऐक्सेस और fromPath के लिए पढ़ने का ऐक्सेस ज़रूरी है.
callInWindow
इसकी मदद से, window ऑब्जेक्ट के बाहर के पाथ से फ़ंक्शन को नीति के हिसाब से कंट्रोल किया जा सकता है. दिए गए आर्ग्युमेंट के साथ, window में दिए गए पाथ पर फ़ंक्शन को कॉल करता है और वैल्यू दिखाता है. अगर रिटर्न टाइप को सीधे तौर पर, सैंडबॉक्स किए गए JavaScript में काम करने वाले टाइप पर मैप नहीं किया जा सकता, तो undefined दिखाया जाएगा. सैंडबॉक्स किए गए JavaScript में, null, undefined,
boolean, number, string, Array, Object, और function जैसे आठ टाइप का इस्तेमाल किया जा सकता है. अगर दिया गया पाथ मौजूद नहीं है या किसी फ़ंक्शन का रेफ़रंस नहीं देता है, तो undefined दिखाया जाएगा.
सिंटैक्स
callInWindow(pathToFunction, argument [, argument2,... argumentN])
पैरामीटर
| पैरामीटर | टाइप | ब्यौरा |
|---|---|---|
pathToFunction |
स्ट्रिंग | window में मौजूद फ़ंक्शन का पाथ, जिसे बिंदु से अलग किया गया है. |
args |
* | फ़ंक्शन में इस्तेमाल किए जाने वाले आर्ग्युमेंट. |
इससे जुड़ी अनुमतियां
execute की अनुमति चालू होने पर access_globals.
callLater
किसी फ़ंक्शन को असिंक्रोनस तरीके से कॉल करने के लिए शेड्यूल करता है. मौजूदा कोड मिलने के बाद, फ़ंक्शन को कॉल किया जाएगा. यह setTimeout(<function>, 0) के बराबर है.
सिंटैक्स
callLater(function)
पैरामीटर
| पैरामीटर | टाइप | ब्यौरा |
|---|---|---|
function |
फ़ंक्शन | कॉल किया जाने वाला फ़ंक्शन. |
copyFromDataLayer
डेटा लेयर में दिए गए पासकोड को असाइन की गई मौजूदा वैल्यू दिखाता है: अगर पासकोड प्राइमटिव टाइप, फ़ंक्शन या ऑब्जेक्ट लिटरल है, तो उसमें मौजूद वैल्यू दिखाता है. अगर ऐसा नहीं है, तो undefined दिखाता है.
सिंटैक्स
copyFromDataLayer(key[, dataLayerVersion])
पैरामीटर
| पैरामीटर | टाइप | ब्यौरा |
|---|---|---|
key |
स्ट्रिंग | "a.b.c" फ़ॉर्मैट में मौजूद कुंजी. |
dataLayerVersion |
number | डेटा लेयर का वर्शन, जो ज़रूरी नहीं है. डिफ़ॉल्ट वैल्यू 2 है. वैल्यू के तौर पर 1 का इस्तेमाल करने का सुझाव नहीं दिया जाता. |
इससे जुड़ी अनुमतियां
copyFromWindow
window ऑब्जेक्ट से वैरिएबल कॉपी करता है. अगर window की वैल्यू को सैंडबॉक्स किए गए JavaScript में काम करने वाले टाइप पर सीधे तौर पर मैप नहीं किया जा सकता, तो undefined दिखाया जाएगा. सैंडबॉक्स किए गए JavaScript में आठ तरह के फ़ाइल टाइप इस्तेमाल किए जा सकते हैं: null,
undefined, boolean, number, string, Array, Object, और function.
फ़ेच की गई (और बदली गई) वैल्यू दिखाता है.
सिंटैक्स
copyFromWindow(key)
पैरामीटर
| पैरामीटर | टाइप | ब्यौरा |
|---|---|---|
key |
स्ट्रिंग | window में मौजूद वह कुंजी जिसकी वैल्यू कॉपी करनी है. |
इससे जुड़ी अनुमतियां
createArgumentsQueue
आर्ग्युमेंट ऑब्जेक्ट से भरी एक कतार बनाता है, ताकि ज़रूरत पड़ने पर टैग के समाधानों का इस्तेमाल किया जा सके.
fnKey आर्ग्युमेंट (createQueue के जैसे ही सेमेंटेक्स) का इस्तेमाल करके, ग्लोबल स्कोप (यानी window) में फ़ंक्शन बनाता है. फ़ंक्शन बनने के बाद, यह एपीआई arrayKey आर्ग्युमेंट का इस्तेमाल करके, window में एक ऐरे बनाता है (अगर वह पहले से मौजूद नहीं है).
जब fnKey में बनाए गए फ़ंक्शन को कॉल किया जाता है, तो वह अपने आर्ग्युमेंट ऑब्जेक्ट को arrayKey में बनाए गए कलेक्शन में डाल देता है. एपीआई की रिटर्न वैल्यू, fnKey के तहत बनाया गया फ़ंक्शन है.
इस फ़ंक्शन के लिए, access_globals की अनुमति पर fnKey और arrayKey के लिए, पढ़ने और लिखने की सेटिंग की ज़रूरत होती है.
उदाहरण:
const gtag = createArgumentsQueue('gtag', 'dataLayer');
gtag('set', {'currency': 'USD'});
सिंटैक्स
createArgumentsQueue(fnKey, arrayKey)
पैरामीटर
| पैरामीटर | टाइप | ब्यौरा |
|---|---|---|
fnKey |
स्ट्रिंग | window में वह पाथ जहां फ़ंक्शन सेट किया गया है, अगर वह पहले से मौजूद नहीं है. यह आर्ग्युमेंट, स्टैंडर्ड बिंदु वाले नोटेशन के साथ काम करता है. अगर की के पाथ का कोई अस्तित्व नहीं है, तो अपवाद का मैसेज दिखता है. इसका मतलब है कि अगर fnKey 'one.two' है, तो यह अपवाद दिखाएगा. |
arrayKey |
स्ट्रिंग | window में मौजूद वह पाथ जहां ऐरे सेट किया गया है, अगर वह पहले से मौजूद नहीं है. यह आर्ग्युमेंट, स्टैंडर्ड बिंदु वाले नोटेशन के साथ काम करता है. अगर की के पाथ का कोई अस्तित्व नहीं है, तो अपवाद का मैसेज दिखता है. इसका मतलब है कि अगर
arrayKey, 'one.two' है और 'one' नाम का कोई ग्लोबल ऑब्जेक्ट नहीं है, तो यह एक अपवाद दिखाएगा. |
इससे जुड़ी अनुमतियां
createQueue
अगर window में पहले से कोई ऐरे मौजूद नहीं है, तो यह एक ऐरे बनाता है. साथ ही, एक ऐसा फ़ंक्शन दिखाता है जो उस ऐरे में वैल्यू डालेगा.
इस फ़ंक्शन के लिए, access_globals अनुमति पर arrayKey के लिए, पढ़ने और लिखने की सेटिंग की ज़रूरत होती है.
उदाहरण:
const dataLayerPush = createQueue('dataLayer');
dataLayerPush({'currency': 'USD'}, {'event': 'myConversion'});
सिंटैक्स
createQueue(arrayKey)
पैरामीटर
| पैरामीटर | टाइप | ब्यौरा |
|---|---|---|
arrayKey |
स्ट्रिंग | window में मौजूद वह कुंजी जहां ऐरे सेट किया गया है, अगर वह पहले से मौजूद नहीं है. यह आर्ग्युमेंट, स्टैंडर्ड बिंदु वाले नोटेशन के साथ काम करता है. अगर की के पाथ का कोई अस्तित्व नहीं है, तो अपवाद का मैसेज दिखता है. उदाहरण के लिए, अगर
arrayKey 'one.two' है और 'one' नाम का कोई ग्लोबल ऑब्जेक्ट नहीं है, तो यह एक अपवाद दिखाएगा. |
इससे जुड़ी अनुमतियां
decodeUri
दिए गए यूआरआई में, कोड में बदले गए किसी भी वर्ण को डिकोड करता है. डिकोड किए गए यूआरआई को दिखाने वाली स्ट्रिंग दिखाता है. अमान्य इनपुट मिलने पर, undefined दिखाता है.
उदाहरण:
const decode = require('decodeUri');
const decodedUrl = decode(data.encodedUrl);
if (decodedUrl) {
// ...
}
सिंटैक्स
decodeUri(encoded_uri)
पैरामीटर
| पैरामीटर | टाइप | ब्यौरा |
|---|---|---|
encoded_uri |
स्ट्रिंग | ऐसा यूआरआई जिसे encodeUri() या किसी अन्य तरीके से एन्कोड किया गया हो. |
इससे जुड़ी अनुमतियां
कोई नहीं.
decodeUriComponent
दिए गए यूआरआई कॉम्पोनेंट में, कोड में बदले गए किसी भी वर्ण को डिकोड करता है. डिकोड किए गए यूआरआई कॉम्पोनेंट को दिखाने वाली स्ट्रिंग दिखाता है. अमान्य इनपुट मिलने पर, undefined दिखाता है.
उदाहरण:
const decode = require('decodeUriComponent');
const decodedUrl = decode(data.encodedUrl);
if (decodedUrl) {
// ...
}
सिंटैक्स
decodeUriComponent(encoded_uri_component)
पैरामीटर
| पैरामीटर | टाइप | ब्यौरा |
|---|---|---|
encoded_uri_component |
स्ट्रिंग | यूआरआई का ऐसा कॉम्पोनेंट जिसे encodeUriComponent() या किसी अन्य तरीके से कोड में बदला गया हो. |
इससे जुड़ी अनुमतियां
कोई नहीं.
encodeUri
खास वर्णों को एस्केप करके, कोड में बदला गया यूनिफ़ॉर्म रिसॉर्स आइडेंटिफ़ायर (यूआरआई) दिखाता है. एक स्ट्रिंग दिखाता है, जो यूआरआई के तौर पर कोड में बदली गई दी गई स्ट्रिंग को दिखाती है. अमान्य इनपुट (सिर्फ़ एक सरोगेट) मिलने पर, undefined दिखाता है.
उदाहरण:
sendPixel('https://www.example.com/' + encodeUri(pathInput));
सिंटैक्स
encodeUri(uri)
पैरामीटर
| पैरामीटर | टाइप | ब्यौरा |
|---|---|---|
uri |
स्ट्रिंग | पूरा यूआरआई. |
इससे जुड़ी अनुमतियां
कोई नहीं.
encodeUriComponent
खास वर्णों को एस्केप करके, कोड में बदला गया यूनिफ़ॉर्म रिसॉर्स आइडेंटिफ़ायर (यूआरआई) दिखाता है. एक स्ट्रिंग दिखाता है, जो यूआरआई के तौर पर कोड में बदली गई दी गई स्ट्रिंग को दिखाती है. अमान्य इनपुट (सिर्फ़ एक सरोगेट) मिलने पर, undefined दिखाता है.
उदाहरण:
sendPixel('https://www.example.com/?' + encodeUriComponent(queryInput));
सिंटैक्स
encodeUriComponent(str)
पैरामीटर
| पैरामीटर | टाइप | ब्यौरा |
|---|---|---|
str |
स्ट्रिंग | यूआरआई का कॉम्पोनेंट. |
इससे जुड़ी अनुमतियां
कोई नहीं.
fromBase64
fromBase64 API की मदद से, स्ट्रिंग को base64 कोड में बदला जा सकता है. अमान्य इनपुट मिलने पर, undefined दिखाता है.
सिंटैक्स
fromBase64(base64EncodedString)
पैरामीटर
| पैरामीटर | टाइप | ब्यौरा |
|---|---|---|
base64EncodedString |
स्ट्रिंग | Base64 में एन्कोड की गई स्ट्रिंग. |
उदाहरण
const fromBase64 = require('fromBase64');
const greeting = fromBase64('aGVsbG8=');
if (greeting === 'hello') {
// ...
}
इससे जुड़ी अनुमतियां
कोई नहीं
generateRandom
यह फ़ंक्शन, दी गई रेंज में कोई भी संख्या (पूर्णांक) दिखाता है.
सिंटैक्स
generateRandom(min, max)
पैरामीटर
| पैरामीटर | टाइप | ब्यौरा |
|---|---|---|
min |
number | दिखाए गए पूर्णांक की कम से कम संभावित वैल्यू. |
max |
number | दिखाए गए पूर्णांक की ज़्यादा से ज़्यादा संभावित वैल्यू. |
इससे जुड़ी अनुमतियां
कोई नहीं.
getContainerVersion
मौजूदा कंटेनर के डेटा वाला ऑब्जेक्ट दिखाता है. दिखाए गए ऑब्जेक्ट में ये फ़ील्ड होते हैं:
{
containerId: string,
debugMode: boolean,
environmentName: string,
environmentMode: boolean,
previewMode: boolean,
version: string,
}
उदाहरण
const getContainerVersion = require('getContainerVersion');
const sendPixel = require('sendPixel');
if (query('read_container_data')) {
const cv = getContainerVersion();
const pixelUrl = 'https://pixel.com/' +
'?version=' + cv.version +
'&envName=' + cv.environmentName +
'&ctid=' + cv.containerId +
'&debugMode=' + cv.debugMode +
'&previewMode=' + cv.previewMode;
if (query('send_pixel', pixelUrl)) {
sendPixel(pixelUrl);
}
}
सिंटैक्स
getContainerVersion();
इससे जुड़ी अनुमतियां
getCookieValues
दिए गए नाम वाली सभी कुकी की वैल्यू दिखाता है.
सिंटैक्स
getCookieValues(name[, decode])
पैरामीटर
| पैरामीटर | टाइप | ब्यौरा |
|---|---|---|
name |
स्ट्रिंग | कुकी का नाम. |
decode |
boolean | यह कंट्रोल करता है कि कुकी वैल्यू को JavaScript के
decodeURIComponent() के साथ डिकोड किया जाए या नहीं. डिफ़ॉल्ट रूप से, यह वैल्यू
true पर सेट होती है. |
इससे जुड़ी अनुमतियां
getQueryParameters
मौजूदा यूआरएल के queryKey के लिए, पहला या सभी पैरामीटर दिखाता है.
queryKey से पहली वैल्यू या queryKey से वैल्यू का ऐरे दिखाता है.
सिंटैक्स
getQueryParameters(queryKey[, retrieveAll])
पैरामीटर
| पैरामीटर | टाइप | ब्यौरा |
|---|---|---|
queryKey |
स्ट्रिंग | क्वेरी पैरामीटर से पढ़ने के लिए कुंजी. |
retrieveAll |
boolean | सभी वैल्यू वापस लानी हैं या नहीं. |
उदाहरण के लिए, अगर मौजूदा यूआरएल https://example.com/path?var=foo&var1=foo1&var=foo2&var=foo है, तो:
getQueryParameters('var') == 'foo'getQueryParameters('var', false) == 'foo'getQueryParameters('var', null) == 'foo'getQueryParameters('var', true) == ['foo', 'foo2', 'foo']
इससे जुड़ी अनुमतियां
get_url को query कॉम्पोनेंट को अनुमति देनी होगी. साथ ही, अनुमति वाली क्वेरी कुंजियों में queryKey को बताना होगा या किसी भी क्वेरी कुंजी को अनुमति देनी होगी.
getReferrerQueryParameters
getReferrerQueryParameters एपीआई, getQueryParameters की तरह ही काम करता है. हालांकि, यह मौजूदा यूआरएल के बजाय रेफ़रर पर काम करता है. दिए गए रेफ़रर के queryKey के लिए, पहला या सभी पैरामीटर दिखाता है. queryKey से पहली वैल्यू या queryKey से वैल्यू का ऐरे दिखाता है.
सिंटैक्स
getReferrerQueryParameters(queryKey[, retrieveAll])
पैरामीटर
| पैरामीटर | टाइप | ब्यौरा |
|---|---|---|
queryKey |
स्ट्रिंग | क्वेरी पैरामीटर से पढ़ने के लिए कुंजी. |
retrieveAll |
boolean | सभी वैल्यू वापस लानी हैं या नहीं. |
उदाहरण के लिए, अगर रेफ़रल यूआरएल https://example.com/path?var=foo&var1=foo1&var=foo2&var=foo है, तो:
getReferrerQueryParameters('var') == 'foo'getReferrerQueryParameters('var', false) == 'foo'getReferrerQueryParameters('var', null) == 'foo'getReferrerQueryParameters('var', true) == ['foo', 'foo2', 'foo']
इससे जुड़ी अनुमतियां
get_referrer को query कॉम्पोनेंट को अनुमति देनी होगी. साथ ही, अनुमति वाली क्वेरी कुंजियों में queryKey को बताना होगा या किसी भी क्वेरी कुंजी को अनुमति देनी होगी.
getReferrerUrl
किसी कॉम्पोनेंट टाइप के लिए, एपीआई रेफ़रर के लिए दस्तावेज़ ऑब्जेक्ट को पढ़ता है और रेफ़रर के किसी हिस्से को दिखाने वाली स्ट्रिंग दिखाता है. अगर कोई कॉम्पोनेंट नहीं दिया गया है, तो रेफ़रल देने वाले का पूरा यूआरएल दिखता है.
सिंटैक्स
getReferrerUrl([component])
पैरामीटर
| पैरामीटर | टाइप | ब्यौरा |
|---|---|---|
component |
स्ट्रिंग | यूआरएल से वापस लाने के लिए कॉम्पोनेंट. इनमें से कोई एक हो सकता है:
protocol, host, port,
path, query, extension. अगर
component, undefined या null है या
इनमें से किसी एक कॉम्पोनेंट से मेल नहीं खाता है, तो पूरा यूआरएल दिखाया जाएगा. |
इससे जुड़ी अनुमतियां
get_referrer को query कॉम्पोनेंट को अनुमति देनी होगी. साथ ही, अनुमति वाली क्वेरी कुंजियों में queryKey को बताना होगा या किसी भी क्वेरी कुंजी को अनुमति देनी होगी.
getTimestamp
अब काम नहीं करता. getTimestampMillis का इस्तेमाल करें.
यह एक संख्या दिखाता है, जो Date.now() से मिली यूनिक्स इकोपॉइंट के बाद से, मिलीसेकंड में मौजूदा समय दिखाता है.
सिंटैक्स
getTimestamp();
इससे जुड़ी अनुमतियां
कोई नहीं.
getTimestampMillis
यह एक संख्या दिखाता है, जो Date.now() से मिली यूनिक्स इकोपॉइंट के बाद से, मिलीसेकंड में मौजूदा समय दिखाता है.
सिंटैक्स
getTimestampMillis();
इससे जुड़ी अनुमतियां
कोई नहीं.
getType
यह फ़ंक्शन, दी गई वैल्यू के टाइप की जानकारी देने वाली स्ट्रिंग दिखाता है. typeof के उलट,
getType में array और object के बीच अंतर किया जाता है.
सिंटैक्स
getType(data.someField)
ज़रूरी जानकारी
नीचे दी गई टेबल में, हर इनपुट वैल्यू के लिए दिखाई गई स्ट्रिंग की सूची दी गई है.
| इनपुट मान | नतीजा |
|---|---|
undefined |
'undefined' |
null |
'null' |
true |
'boolean' |
12 |
'number' |
'string' |
'string' |
{ a: 3 } |
'object' |
[ 1, 3 ] |
'array' |
(x) => x + 1 |
'function' |
इससे जुड़ी अनुमतियां
कोई नहीं.
getUrl
यह एक स्ट्रिंग दिखाता है, जो कॉम्पोनेंट टाइप और कुछ कॉन्फ़िगरेशन पैरामीटर के हिसाब से, मौजूदा यूआरएल का पूरा या कुछ हिस्सा दिखाता है.
सिंटैक्स
getUrl(component)
पैरामीटर
| पैरामीटर | टाइप | ब्यौरा |
|---|---|---|
component |
स्ट्रिंग | यूआरएल से वापस लाने के लिए कॉम्पोनेंट. इनमें से कोई एक होना चाहिए:
protocol, host, port,
path, query, extension,
fragment. अगर कॉम्पोनेंट undefined,
null है या इनमें से किसी एक से मेल नहीं खाता है, तो
पूरी href वैल्यू दिखा दी जाएगी. |
इससे जुड़ी अनुमतियां
gtagSet
डेटा लेयर में gtag सेट कमांड को पुश करता है, ताकि मौजूदा इवेंट और उससे ट्रिगर हुए सभी टैग के प्रोसेस होने के बाद (या टैग प्रोसेसिंग टाइम आउट होने के बाद) इसे जल्द से जल्द प्रोसेस किया जा सके. यह पक्का है कि डेटा लेयर की सूची में मौजूद किसी भी आइटम से पहले, अपडेट को इस कंटेनर में प्रोसेस किया जाएगा.
उदाहरण के लिए, अगर सहमति की प्रोसेस शुरू करने पर ट्रिगर किए गए टैग से कॉल किया जाता है, तो अपडेट, इनिशियलाइज़ेशन इवेंट के प्रोसेस होने से पहले लागू हो जाएगा. उदाहरण के लिए, ads_data_redaction को true या false पर सेट करना या url_passthrough को true या false पर सेट करना.
उदाहरण:
const gtagSet = require('gtagSet');
gtagSet({
'ads_data_redaction': true,
'url_passthrough': true,
});
सिंटैक्स
gtagSet(object)
पैरामीटर
| पैरामीटर | टाइप | ब्यौरा |
|---|---|---|
Object |
ऑब्जेक्ट | ऐसा ऑब्जेक्ट जो अपनी प्रॉपर्टी के लिए ग्लोबल स्टेटस को अपडेट करता है. |
इससे जुड़ी अनुमतियां
write_data_layer, बताई गई सभी कुंजियों के लिए dataLayer को लिखने की अनुमति की जांच करता है. अगर gtagSet में कोई सादा ऑब्जेक्ट डाला जाता है, तो एपीआई उस ऑब्जेक्ट में मौजूद सभी फ़्लैट की गई कुंजियों के लिए, लिखने की अनुमति की जांच करेगा. उदाहरण के लिए, gtagSet({foo: {bar: 'baz'}}) के लिए, एपीआई foo.bar के लिए लिखने की अनुमति की जांच करेगा.
अगर gtagSet में दिया गया इनपुट कोई कुंजी और कोई ऐसी ऑब्जेक्ट वैल्यू है जो साधारण नहीं है, तो एपीआई उस कुंजी में बदलाव करने की अनुमति देखेगा. उदाहरण के लिए, gtagSet('abc', true) के लिए, एपीआई 'abc' में बदलाव करने की अनुमति देखेगा.
ध्यान दें कि अगर इनपुट ऑब्जेक्ट में कोई साइकल है, तो उसी ऑब्जेक्ट तक पहुंचने से पहले सिर्फ़ कुंजियों की जांच की जाएगी.
injectHiddenIframe
पेज पर एक न दिखने वाला iframe जोड़ता है.
कॉलबैक, फ़ंक्शन इंस्टेंस के तौर पर दिए जाते हैं और उन्हें JavaScript फ़ंक्शन में रैप किया जाता है, जो उन्हें कॉल करते हैं.
सिंटैक्स
injectHiddenIframe(url, onSuccess)
पैरामीटर
| पैरामीटर | टाइप | ब्यौरा |
|---|---|---|
url |
स्ट्रिंग | iframe के src
एट्रिब्यूट की वैल्यू के तौर पर इस्तेमाल किया जाने वाला यूआरएल. |
onSuccess |
फ़ंक्शन | फ़्रेम लोड होने पर कॉल किया जाता है. |
इससे जुड़ी अनुमतियां
injectScript
दिए गए यूआरएल को एसिंक्रोनस तरीके से लोड करने के लिए, पेज में स्क्रिप्ट टैग जोड़ता है. कॉलबैक को फ़ंक्शन इंस्टेंस के तौर पर दिया जाता है और उन्हें JavaScript फ़ंक्शन में रैप किया जाता है, जो उन्हें कॉल करते हैं.
सिंटैक्स
injectScript(url, onSuccess, onFailure[, cacheToken])
पैरामीटर
| पैरामीटर | टाइप | ब्यौरा |
|---|---|---|
url |
स्ट्रिंग | इंजेक्ट की जाने वाली स्क्रिप्ट का पता. |
onSuccess |
फ़ंक्शन | स्क्रिप्ट लोड होने पर इसे कॉल किया जाता है. |
onFailure |
फ़ंक्शन | स्क्रिप्ट लोड न होने पर कॉल किया जाता है. |
cacheToken |
स्ट्रिंग | यह वैकल्पिक स्ट्रिंग है. इसका इस्तेमाल यह बताने के लिए किया जाता है कि दिए गए यूआरएल को कैश मेमोरी में सेव किया जाना चाहिए. अगर
इस वैल्यू को तय किया जाता है, तो JavaScript का अनुरोध करने के लिए सिर्फ़ एक स्क्रिप्ट एलिमेंट बनाया जाएगा. लोड करने की किसी भी और कोशिश के नतीजे में, स्क्रिप्ट लोड होने तक, दिए गए onSuccess और onFailure तरीके, सूची में शामिल कर दिए जाएंगे. |
इससे जुड़ी अनुमतियां
isConsentGranted
अगर सहमति का कोई टाइप दिया गया है और उसे मंज़ूरी मिल गई है, तो यह फ़ंक्शन 'सही' दिखाता है.
किसी खास तरह की सहमति के लिए सहमति तब दी गई मानी जाती है, जब सहमति का टाइप 'दी गई है' पर सेट हो या सेट न किया गया हो. अगर सहमति के टाइप को किसी दूसरी वैल्यू पर सेट किया गया है, तो इसे सहमति नहीं दी गई माना जाएगा.
टैग सेटिंग के लिए Tag Manager के यूज़र इंटरफ़ेस में, हमेशा ट्रिगर होने का विकल्प मिलेगा. अगर हमेशा ट्रिगर होने की सुविधा चालू होने पर, कोई टैग इस एपीआई का इस्तेमाल करता है, तो सहमति को स्वीकार माना जाएगा और true दिखाया जाएगा. भले ही, सहमति की असली स्थिति कुछ भी हो.
उदाहरण:
const isConsentGranted = require('isConsentGranted');
if (isConsentGranted('ad_storage')) {
sendFullPixel();
} else {
sendPixelWithoutCookies();
}
सिंटैक्स
isConsentGranted(consentType)
पैरामीटर
| पैरामीटर | टाइप | ब्यौरा |
|---|---|---|
consentType |
स्ट्रिंग | सहमति का टाइप, जिसकी स्थिति देखनी है. |
इससे जुड़ी अनुमतियां
सहमति के टाइप के लिए, पढ़ने का ऐक्सेस वाली access_consent अनुमति.
JSON
JSON फ़ंक्शन देने वाला ऑब्जेक्ट दिखाता है.
parse() फ़ंक्शन, किसी JSON स्ट्रिंग को पार्स करके, उसमें बताई गई वैल्यू या ऑब्जेक्ट बनाता है. अगर वैल्यू को पार्स नहीं किया जा सकता (जैसे, गलत फ़ॉर्मैट वाला JSON), तो फ़ंक्शन undefined दिखाएगा. अगर इनपुट वैल्यू कोई स्ट्रिंग नहीं है, तो इनपुट को स्ट्रिंग में बदल दिया जाएगा.
stringify() फ़ंक्शन, इनपुट को JSON स्ट्रिंग में बदल देता है. अगर वैल्यू को पार्स नहीं किया जा सकता (उदाहरण के लिए, ऑब्जेक्ट में साइकल है), तो यह तरीका undefined दिखाएगा.
सिंटैक्स
JSON.parse(stringInput)
JSON.stringify(value);
पैरामीटर
JSON.parse
| पैरामीटर | टाइप | ब्यौरा |
|---|---|---|
| stringInput | any | वह वैल्यू जिसे बदलना है. अगर वैल्यू कोई स्ट्रिंग नहीं है, तो इनपुट को स्ट्रिंग में बदल दिया जाएगा. |
JSON.stringify
| पैरामीटर | टाइप | ब्यौरा |
|---|---|---|
| value | any | वह वैल्यू जिसे बदलना है. |
उदाहरण
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'});
localStorage
यह लोकल स्टोरेज को ऐक्सेस करने के तरीकों के साथ एक ऑब्जेक्ट दिखाता है.
सिंटैक्स
const localStorage = require('localStorage');
// Requires read access for the key. Returns null if the key does not exist.
localStorage.getItem(key);
// Requires write access for the key. Returns true if successful.
localStorage.setItem(key, value);
// Requires write access for the key.
localStorage.removeItem(key);
इससे जुड़ी अनुमतियां
उदाहरण
const localStorage = require('localStorage');
if (localStorage) {
const value = localStorage.getItem('my_key');
if (value) {
const success = localStorage.setItem('my_key', 'new_value');
if (success) {
localStorage.removeItem('my_key');
}
}
}
logToConsole
ब्राउज़र कंसोल में आर्ग्युमेंट लॉग करता है.
सिंटैक्स
logToConsole(obj1 [, obj2,... objN])
पैरामीटर
| पैरामीटर | टाइप | ब्यौरा |
|---|---|---|
obj1 [, obj2,... objN] |
any | तर्क |
इससे जुड़ी अनुमतियां
makeInteger
दी गई वैल्यू को संख्या (पूर्णांक) में बदलता है.
सिंटैक्स
makeInteger(value)
पैरामीटर
| पैरामीटर | टाइप | ब्यौरा |
|---|---|---|
value |
any | वह वैल्यू जिसे बदलना है. |
इससे जुड़ी अनुमतियां
कोई नहीं.
makeNumber
दी गई वैल्यू को संख्या में बदलता है.
सिंटैक्स
makeNumber(value)
पैरामीटर
| पैरामीटर | टाइप | ब्यौरा |
|---|---|---|
value |
any | वह वैल्यू जिसे बदलना है. |
इससे जुड़ी अनुमतियां
कोई नहीं.
makeString
दी गई वैल्यू को स्ट्रिंग के तौर पर दिखाता है.
सिंटैक्स
makeString(value)
पैरामीटर
| पैरामीटर | टाइप | ब्यौरा |
|---|---|---|
value |
any | वह वैल्यू जिसे बदलना है. |
इससे जुड़ी अनुमतियां
कोई नहीं.
makeTableMap
दो कॉलम वाले टेबल ऑब्जेक्ट को Map में बदलता है. इसका इस्तेमाल, दो कॉलम वाले SIMPLE_TABLE टेंप्लेट फ़ील्ड को मैनेज करने में आसान फ़ॉर्मैट में बदलने के लिए किया जाता है.
उदाहरण के लिए, यह फ़ंक्शन किसी टेबल ऑब्जेक्ट को बदल सकता है:
[
{'key': 'k1', 'value': 'v1'},
{'key': 'k2', 'value': 'v2'}
]
को मैप में जोड़ने के लिए:
{
'k1': 'v1',
'k2': 'v2'
}
यह एक ऑब्जेक्ट दिखाता है: अगर इसमें की-वैल्यू पेयर जोड़े गए हैं, तो बदला गया Map या नहीं तो null.
सिंटैक्स
makeTableMap(tableObj, keyColumnName, valueColumnName)
पैरामीटर
| पैरामीटर | टाइप | ब्यौरा |
|---|---|---|
tableObj |
सूची | वह टेबल ऑब्जेक्ट जिसे बदलना है. यह मैप की एक सूची है, जिसमें हर
Map टेबल में एक पंक्ति को दिखाता है. किसी पंक्ति ऑब्जेक्ट में मौजूद हर प्रॉपर्टी का नाम, कॉलम का नाम होता है और प्रॉपर्टी वैल्यू, पंक्ति में मौजूद कॉलम की वैल्यू होती है. |
keyColumnName |
स्ट्रिंग | उस कॉलम का नाम जिसकी वैल्यू, बदले गए
Map में कुंजियां बन जाएंगी. |
valueColumnName |
स्ट्रिंग | उस कॉलम का नाम जिसकी वैल्यू, बदले गए
Map में वैल्यू बन जाएंगी. |
इससे जुड़ी अनुमतियां
कोई नहीं.
Math
Math फ़ंक्शन देने वाला ऑब्जेक्ट.
सिंटैक्स
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);
पैरामीटर
मैथ फ़ंक्शन के पैरामीटर को संख्याओं में बदल दिया जाता है.
इससे जुड़ी अनुमतियां
कोई नहीं.
Object
ऐसा ऑब्जेक्ट दिखाता है जो Object तरीके उपलब्ध कराता है.
keys() तरीका, स्टैंडर्ड लाइब्रेरी Object.keys() के व्यवहार की जानकारी देता है. यह किसी ऑब्जेक्ट की एन्यूमेरेबल प्रॉपर्टी के नामों का एक कलेक्शन दिखाता है. यह कलेक्शन उसी क्रम में दिखता है जिस क्रम में for...in... लूप दिखता है. अगर इनपुट वैल्यू कोई ऑब्जेक्ट नहीं है, तो उसे ऑब्जेक्ट में बदल दिया जाएगा.
values() तरीका, स्टैंडर्ड लाइब्रेरी Object.values() के व्यवहार की जानकारी देता है. यह किसी ऑब्जेक्ट की enumerable प्रॉपर्टी की वैल्यू का ऐरे दिखाता है. यह वैल्यू उसी क्रम में दिखती है जिस क्रम में for...in... लूप दिखाता है. अगर इनपुट वैल्यू कोई ऑब्जेक्ट नहीं है, तो उसे ऑब्जेक्ट में बदल दिया जाएगा.
entries() तरीका, स्टैंडर्ड लाइब्रेरी Object.entries() के व्यवहार की जानकारी देता है. यह किसी ऑब्जेक्ट की enumerable प्रॉपर्टी के [key, value] पेयर का एक कलेक्शन दिखाता है. यह कलेक्शन उसी क्रम में दिखता है जिस क्रम में for...in... लूप दिखता है. अगर इनपुट वैल्यू कोई ऑब्जेक्ट नहीं है, तो उसे ऑब्जेक्ट में बदल दिया जाएगा.
freeze() तरीका, स्टैंडर्ड लाइब्रेरी Object.freeze() के व्यवहार को दिखाता है. फ़्रीज़ किए गए ऑब्जेक्ट में अब बदलाव नहीं किया जा सकता. किसी ऑब्जेक्ट को फ़्रीज़ करने पर, उसमें नई प्रॉपर्टी नहीं जोड़ी जा सकतीं, मौजूदा प्रॉपर्टी नहीं हटाई जा सकतीं, और मौजूदा प्रॉपर्टी की वैल्यू नहीं बदली जा सकतीं. freeze() वही ऑब्जेक्ट दिखाता है जो इसमें पास किया गया था. प्राइमिटिव या शून्य आर्ग्युमेंट को वैसे ही माना जाएगा जैसे कि वह फ़्रीज़ किया गया ऑब्जेक्ट हो. साथ ही, उसे दिखाया भी जाएगा.
delete() तरीका, स्टैंडर्ड लाइब्रेरी के delete ऑपरेटर के व्यवहार को दिखाता है. यह ऑब्जेक्ट से दी गई कुंजी को तब तक हटा देता है, जब तक ऑब्जेक्ट को फ़्रीज़ नहीं किया जाता.
स्टैंडर्ड लाइब्रेरी के delete ऑपरेटर की तरह ही, यह true दिखाता है. ऐसा तब होता है, जब पहली इनपुट वैल्यू (objectInput) ऐसा ऑब्जेक्ट हो जो फ़्रीज़ नहीं किया गया है. भले ही, दूसरी इनपुट वैल्यू (keyToDelete) में ऐसी कुंजी दी गई हो जो मौजूद नहीं है. यह अन्य सभी मामलों में false दिखाता है. हालांकि, यह स्टैंडर्ड लाइब्रेरी के मिटाने वाले ऑपरेटर से इन तरीकों से अलग है:
keyToDelete, बिंदु से अलग की गई ऐसी स्ट्रिंग नहीं हो सकती जो नेस्ट की गई कुंजी की जानकारी देती हो.- किसी ऐरे से एलिमेंट हटाने के लिए,
delete()का इस्तेमाल नहीं किया जा सकता. delete()का इस्तेमाल, ग्लोबल स्कोप से किसी भी प्रॉपर्टी को हटाने के लिए नहीं किया जा सकता.
सिंटैक्स
Object.keys(objectInput)
Object.values(objectInput)
Object.entries(objectInput)
Object.freeze(objectInput)
Object.delete(objectInput, keyToDelete)
पैरामीटर
Object.keys
| पैरामीटर | टाइप | ब्यौरा |
|---|---|---|
| objectInput | any | वह ऑब्जेक्ट जिसकी कुंजियों की गिनती करनी है. अगर इनपुट कोई ऑब्जेक्ट नहीं है, तो उसे ऑब्जेक्ट में बदल दिया जाएगा. |
Object.values
| पैरामीटर | टाइप | ब्यौरा |
|---|---|---|
| objectInput | any | वह ऑब्जेक्ट जिसकी वैल्यू की गिनती करनी है. अगर इनपुट कोई ऑब्जेक्ट नहीं है, तो उसे ऑब्जेक्ट में बदल दिया जाएगा. |
Object.entries
| पैरामीटर | टाइप | ब्यौरा |
|---|---|---|
| objectInput | any | वह ऑब्जेक्ट जिसका की/वैल्यू पेयर एनोटेट करना है. अगर इनपुट कोई ऑब्जेक्ट नहीं है, तो उसे ऑब्जेक्ट में बदल दिया जाएगा. |
Object.freeze
| पैरामीटर | टाइप | ब्यौरा |
|---|---|---|
| objectInput | any | वह ऑब्जेक्ट जिसे फ़्रीज़ करना है. अगर इनपुट कोई ऑब्जेक्ट नहीं है, तो उसे फ़्रीज़ किए गए ऑब्जेक्ट के तौर पर माना जाएगा. |
Object.delete
| पैरामीटर | टाइप | ब्यौरा |
|---|---|---|
| objectInput | any | वह ऑब्जेक्ट जिसकी कुंजी मिटानी है. |
| keyToDelete | स्ट्रिंग | मिटाने के लिए, सबसे ऊपर मौजूद बटन दबाएं. |
उदाहरण
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.
parseUrl
यह एक ऐसा ऑब्जेक्ट दिखाता है जिसमें किसी यूआरएल के सभी कॉम्पोनेंट शामिल होते हैं. यह ऑब्जेक्ट, URL ऑब्जेक्ट से मिलता-जुलता होता है.
गलत तरीके से लिखे गए किसी भी यूआरएल के लिए, यह एपीआई undefined दिखाएगा. सही फ़ॉर्मैट वाले यूआरएल के लिए, यूआरएल स्ट्रिंग में मौजूद फ़ील्ड की वैल्यू खाली स्ट्रिंग होगी. इसके अलावा, searchParams के मामले में, खाली ऑब्जेक्ट होगा.
दिखाए गए ऑब्जेक्ट में ये फ़ील्ड होंगे:
{
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,
}
उदाहरण
const parseUrl = require('parseUrl');
const urlObject = parseUrl('https://abc:xyz@example.com:8080/foo?param=val%2Cue#bar');
सिंटैक्स
parseUrl(url);
पैरामीटर
| पैरामीटर | टाइप | ब्यौरा |
|---|---|---|
url |
स्ट्रिंग | वह पूरा यूआरएल जिसे पार्स किया जाएगा. |
इससे जुड़ी अनुमतियां
कोई नहीं.
queryPermission
अनुमति वाली और सीमित अनुमतियों के बारे में क्वेरी करें. बोलियन वैल्यू दिखाता है: अनुमति मिलने पर true और न मिलने पर false.
सिंटैक्स
queryPermission(permission, functionArgs*)
पैरामीटर
| पैरामीटर | टाइप | ब्यौरा |
|---|---|---|
permission |
स्ट्रिंग | अनुमति का नाम. |
functionArgs |
any | फ़ंक्शन के आर्ग्युमेंट, क्वेरी की जा रही अनुमति के हिसाब से अलग-अलग होते हैं. यहां फ़ंक्शन के आर्ग्युमेंट देखें. |
फ़ंक्शन के आर्ग्युमेंट
sendPixel, injectScript, injectHiddenIframe: दूसरा पैरामीटर, यूआरएल स्ट्रिंग होना चाहिए.
writeGlobals, readGlobals: दूसरा पैरामीटर वह कुंजी होनी चाहिए जिसे लिखा या पढ़ा जा रहा है.
readUrl: पूरे यूआरएल को पढ़ा जा सकता है या नहीं, यह पता करने के लिए किसी और आर्ग्युमेंट की ज़रूरत नहीं है. किसी कॉम्पोनेंट को पढ़ा जा सकता है या नहीं, यह जानने के लिए कॉम्पोनेंट का नाम दूसरे आर्ग्युमेंट के तौर पर पास करें:
if (queryPermission('readUrl','port')) {
// read the port
}
यह देखने के लिए कि कोई खास क्वेरी कुंजी पढ़ी जा सकती है या नहीं, क्वेरी कुंजी को तीसरे पैरामीटर के तौर पर पास करें:
if (queryPermission('readUrl','query','key')) {
getUrlComponent(...);
}
इससे जुड़ी अनुमतियां
कोई नहीं.
readCharacterSet
document.characterSet की वैल्यू दिखाता है.
सिंटैक्स
readCharacterSet()
पैरामीटर
कोई नहीं.
इससे जुड़ी अनुमतियां
readTitle
document.title की वैल्यू दिखाता है.
सिंटैक्स
readTitle()
पैरामीटर
कोई नहीं.
इससे जुड़ी अनुमतियां
require
नाम के हिसाब से, पहले से मौजूद फ़ंक्शन इंपोर्ट करता है. ऐसा फ़ंक्शन या ऑब्जेक्ट दिखाता है जिसे आपके प्रोग्राम से कॉल किया जा सकता है. जब ब्राउज़र में पहले से मौजूद फ़ंक्शन काम नहीं करता, तो यह undefined दिखाता है.
सिंटैक्स
require(name)
पैरामीटर
| पैरामीटर | टाइप | ब्यौरा |
|---|---|---|
name |
स्ट्रिंग | इंपोर्ट किए जाने वाले फ़ंक्शन का नाम. |
उदाहरण
const getUrl = require('getUrl');
const url = getUrl();
इससे जुड़ी अनुमतियां
कोई नहीं.
sendPixel
किसी खास यूआरएल एंडपॉइंट पर GET अनुरोध भेजता है.
सिंटैक्स
sendPixel(url, onSuccess, onFailure)
पैरामीटर
| पैरामीटर | टाइप | ब्यौरा |
|---|---|---|
url |
स्ट्रिंग | पिक्सल कहां भेजना है. |
onSuccess |
फ़ंक्शन | पिक्सल के लोड होने पर कॉल किया जाता है. ध्यान दें: भले ही अनुरोध भेजने में कोई समस्या न आए, फिर भी ब्राउज़र को onSuccess को चलाने के लिए, मान्य इमेज रिस्पॉन्स की ज़रूरत पड़ सकती है. |
onFailure |
फ़ंक्शन | यह तब कॉल किया जाता है, जब पिक्सल लोड नहीं हो पाता. ध्यान दें: अगर अनुरोध ठीक से भेजा जाता है, तो भी अगर सर्वर से इमेज का मान्य रिस्पॉन्स नहीं मिलता है, तो onFailure फ़ंक्शन चल सकता है. |
इससे जुड़ी अनुमतियां
setCookie
बताए गए नाम, वैल्यू, और विकल्पों के साथ कुकी सेट या मिटाता है.
सिंटैक्स
setCookie(name, value[, options, encode])
पैरामीटर
| पैरामीटर | टाइप | ब्यौरा |
|---|---|---|
name |
स्ट्रिंग | कुकी का नाम. |
value |
स्ट्रिंग | कुकी की वैल्यू. |
options |
ऑब्जेक्ट | इसमें डोमेन, पाथ, खत्म होने की तारीख, ज़्यादा से ज़्यादा उम्र, सुरक्षित, और SameSite एट्रिब्यूट की जानकारी होती है. (नीचे दिए गए विकल्प देखें.) |
encode |
boolean | यह कंट्रोल करता है कि कुकी वैल्यू को JavaScript के encodeURIComponent() के साथ एन्कोड किया जाए या नहीं.
डिफ़ॉल्ट रूप से, यह true पर सेट होती है. |
- डोमेन: अगर
options['domain']प्रॉपर्टी मौजूद है, तो उससे सेट किया जाता है. दस्तावेज़ की जगह के आधार पर, सबसे बड़े डोमेन का इस्तेमाल करके कुकी लिखने की कोशिश करने के लिए, इस वैल्यू को'auto'पर सेट करें. अगर ऐसा नहीं होता है, तो यह छोटे सबडोमेन को क्रम से आज़माएगा. अगर ये सभी विकल्प काम नहीं करते हैं, तो यह डोमेन के बिना कुकी लिखने की कोशिश करेगा. अगर कोई वैल्यू सेट नहीं की गई है, तो यह डोमेन तय किए बिना कुकी को लिखने की कोशिश करेगी. ध्यान दें: जब डोमेन के बारे में जानकारी दिए बिना कुकी कोdocument.cookieमें लिखा जाता है, तो उपयोगकर्ता एजेंट डिफ़ॉल्ट रूप से कुकी के डोमेन को मौजूदा दस्तावेज़ की जगह के होस्ट पर सेट कर देगा. - पाथ: अगर मौजूद है, तो
options['path']से सेट किया गया. जबdocument.cookieमें पाथ के बिना कुकी लिखी जाती है, तो उपयोगकर्ता एजेंट डिफ़ॉल्ट रूप से कुकी के पाथ को मौजूदा दस्तावेज़ की जगह के पाथ पर सेट कर देगा. - Max-Age: अगर मौजूद है, तो
options['max-age']से सेट किया गया. - समयसीमा खत्म होने की तारीख: अगर मौजूद हो, तो
options['expires']से सेट करें. अगर यह मौजूद है, तो यह यूटीसी फ़ॉर्मैट में तारीख की स्ट्रिंग होनी चाहिए. इस पैरामीटर के लिएDateको फ़ॉर्मैट करने के लिए,Date.toUTCString()का इस्तेमाल किया जा सकता है. - सुरक्षित: अगर
options['secure']मौजूद है, तो उसे सेट करें. - SameSite: अगर मौजूद है, तो
options['samesite']से सेट किया गया.
इससे जुड़ी अनुमतियां
setDefaultConsentState
डेटा लेयर में सहमति का डिफ़ॉल्ट अपडेट पुश करता है, ताकि मौजूदा इवेंट और उससे ट्रिगर हुए सभी टैग के प्रोसेस होने के बाद (या टैग प्रोसेस करने का टाइम आउट पूरा होने के बाद), उसे जल्द से जल्द प्रोसेस किया जा सके. यह पक्का किया जाता है कि डेटा लेयर में लाइन में लगे किसी भी आइटम से पहले, अपडेट को इस कंटेनर में प्रोसेस किया जाए. सहमति के बारे में ज़्यादा जानें.
उदाहरण:
const setDefaultConsentState = require('setDefaultConsentState');
setDefaultConsentState({
'ad_storage': 'denied',
'analytics_storage': 'granted',
'third_party_storage': 'denied',
'region': ['US-CA'],
'wait_for_update': 500
});
सिंटैक्स
setDefaultConsentState(consentSettings)
पैरामीटर
| पैरामीटर | टाइप | ब्यौरा |
|---|---|---|
consentSettings |
ऑब्जेक्ट | यह एक ऑब्जेक्ट है, जो सहमति के बताए गए टाइप के लिए डिफ़ॉल्ट स्थिति तय करता है. |
consentSettings ऑब्जेक्ट, सहमति के अलग-अलग टाइप की स्ट्रिंग को 'granted' या 'denied' में से किसी एक पर मैप करता है. इसमें ये वैल्यू इस्तेमाल की जा सकती हैं:
| कुंजी का नाम | टाइप | ब्यौरा |
|---|---|---|
consentType |
स्ट्रिंग | सहमति के हर टाइप के लिए वैल्यू को `'granted'` या `'denied'` पर सेट किया जा सकता है. `'granted'` के अलावा किसी भी वैल्यू को `'denied'` माना जाएगा. वैल्यू को `undefined` पर सेट करने से, उसकी पिछली वैल्यू पर कोई असर नहीं पड़ेगा. |
region |
कलेक्शन | क्षेत्र के कोड का वैकल्पिक कलेक्शन, जिसमें यह बताया गया हो कि सहमति की सेटिंग किस क्षेत्र पर लागू होती हैं. क्षेत्र के कोड, ISO 3166-2 फ़ॉर्मैट में देश और/या उप-विभागों का इस्तेमाल करके दिखाए जाते हैं. |
wait_for_update |
number | डेटा भेजने से पहले कितनी देर इंतज़ार करना है, यह कंट्रोल करने के लिए मिलीसेकंड की वैल्यू तय करता है. इसका इस्तेमाल, ऐसे सहमति टूल के साथ किया जाता है जो एसिंक्रोनस तरीके से लोड होते हैं. |
इससे जुड़ी अनुमतियां
access_consent consentSettings ऑब्जेक्ट में, सहमति के सभी टाइप के लिए, लिखने का ऐक्सेस वाली अनुमति.
setInWindow
यह फ़ंक्शन, दी गई वैल्यू को window में दी गई कुंजी पर सेट करता है. अगर window में पहले से कोई वैल्यू मौजूद है, तो डिफ़ॉल्ट रूप से यह तरीका वैल्यू सेट नहीं करेगा. window में वैल्यू सेट करने के लिए, overrideExisting को true पर सेट करें. भले ही, कोई मौजूदा वैल्यू मौजूद हो. बुलियन दिखाता है: अगर वैल्यू सेट हो गई है, तो true और अगर नहीं हुई है, तो false.
सिंटैक्स
setInWindow(key, value, overrideExisting)
पैरामीटर
| पैरामीटर | टाइप | ब्यौरा |
|---|---|---|
key |
स्ट्रिंग | वैल्यू डालने के लिए, window में मौजूद बटन. |
value |
* | window में सेट की जाने वाली वैल्यू. |
overrideExisting |
boolean | यह फ़्लैग बताता है कि वैल्यू को window में सेट किया जाना चाहिए,
भले ही वहां कोई वैल्यू मौजूद हो या नहीं. |
इससे जुड़ी अनुमतियां
sha256
यह फ़ंक्शन, इनपुट के SHA-256 डाइजेस्ट का हिसाब लगाता है और base64 में एन्कोड किए गए डाइजेस्ट के साथ कॉलबैक को शुरू करता है. ऐसा तब तक होता है, जब तक options ऑब्जेक्ट कोई दूसरा आउटपुट कोडिंग तय न कर दे.
उदाहरण:
sha256('inputString', (digest) => {
sendPixel('https://example.com/collect?id=' + digest);
data.gtmOnSuccess();
}, data.gtmOnFailure);
sha256('inputString', (digest) => {
sendPixel('https://example.com/collect?id=' + digest);
data.gtmOnSuccess();
}, data.gtmOnFailure, {outputEncoding: 'hex'});
सिंटैक्स
sha256(input, onSuccess, onFailure = undefined, options = undefined)
पैरामीटर
| पैरामीटर | टाइप | ब्यौरा |
|---|---|---|
input |
स्ट्रिंग | वह स्ट्रिंग जिसके लिए हैश का हिसाब लगाना है. |
onSuccess |
फ़ंक्शन | जब तक options ऑब्जेक्ट किसी दूसरी आउटपुट कोडिंग के बारे में नहीं बताता, तब तक इसे base64 में एन्कोड किए गए डाइजेस्ट के साथ कॉल किया जाता है. |
onFailure |
फ़ंक्शन | अगर डाइजेस्ट का हिसाब लगाते समय कोई गड़बड़ी होती है या ब्राउज़र में sha256 के लिए नेटिव सपोर्ट नहीं है, तो इसे कॉल किया जाता है. कॉलबैक को ऐसे ऑब्जेक्ट के साथ कॉल किया जाता है जिसमें गड़बड़ी का नाम और मैसेज होता है. |
options |
ऑब्जेक्ट | आउटपुट एन्कोडिंग की जानकारी देने के लिए, ज़रूरी नहीं विकल्प ऑब्जेक्ट. अगर
यह जानकारी दी गई है, तो ऑब्जेक्ट में outputEncoding कीवर्ड होना चाहिए. साथ ही, इसकी वैल्यू base64 या hex में से कोई एक होनी चाहिए. |
इससे जुड़ी अनुमतियां
कोई नहीं.
templateStorage
टेंप्लेट स्टोरेज को ऐक्सेस करने के तरीकों के साथ एक ऑब्जेक्ट दिखाता है. टेंप्लेट स्टोरेज की मदद से, एक ही टेंप्लेट के सभी रन के बीच डेटा शेयर किया जा सकता है. टेंप्लेट स्टोरेज में सेव किया गया डेटा, पेज के लाइफ़टाइम तक बना रहता है.
सिंटैक्स
const templateStorage = require('templateStorage');
templateStorage.getItem(key);
templateStorage.setItem(key, value);
templateStorage.removeItem(key);
// Deletes all stored values for the template.
templateStorage.clear();
इससे जुड़ी अनुमतियां
उदाहरण
const templateStorage = require('templateStorage');
const sendPixel = require('sendPixel');
// Ensure sendPixel is called only once per page.
if (templateStorage.getItem('alreadyRan')) {
data.gtmOnSuccess();
return;
}
templateStorage.setItem('alreadyRan', true);
sendPixel(
data.oncePerPagePixelUrl,
data.gtmOnSuccess,
() => {
templateStorage.setItem('alreadyRan', false);
data.gtmOnFailure();
});
toBase64
toBase64 एपीआई की मदद से, किसी स्ट्रिंग को base64 कोड में बदला जा सकता है.
सिंटैक्स
toBase64(input)
पैरामीटर
| पैरामीटर | टाइप | ब्यौरा |
|---|---|---|
input |
स्ट्रिंग | कोड में बदली जाने वाली स्ट्रिंग. |
उदाहरण
const toBase64 = require('toBase64');
const base64Hello = toBase64('hello');
इससे जुड़ी अनुमतियां
कोई नहीं
updateConsentState
डेटा लेयर में सहमति का अपडेट भेजता है, ताकि मौजूदा इवेंट और उससे ट्रिगर हुए सभी टैग की प्रोसेसिंग पूरी होने के बाद (या टैग की प्रोसेसिंग के टाइम आउट तक पहुंचने के बाद) उसे जल्द से जल्द प्रोसेस किया जा सके. डेटा लेयर में लाइन में लगे किसी भी आइटम से पहले, इस कंटेनर में अपडेट को प्रोसेस किया जाएगा. सहमति के बारे में ज़्यादा जानें.
उदाहरण:
const updateConsentState = require('updateConsentState');
updateConsentState({
'ad_storage': 'granted',
'analytics_storage': 'denied',
'third_party_storage': 'granted',
});
सिंटैक्स
updateConsentState(consentSettings)
पैरामीटर
| पैरामीटर | टाइप | ब्यौरा |
|---|---|---|
consentSettings |
ऑब्जेक्ट | ऐसा ऑब्जेक्ट जो सहमति के तय किए गए टाइप के लिए स्टेटस अपडेट करता है. |
consentSettings ऑब्जेक्ट, सहमति के अलग-अलग टाइप की स्ट्रिंग को 'granted' या 'denied' में से किसी एक पर मैप करता है. इसमें ये वैल्यू इस्तेमाल की जा सकती हैं:
| कुंजी का नाम | टाइप | ब्यौरा |
|---|---|---|
consentType |
स्ट्रिंग | सहमति के हर टाइप की वैल्यू को 'दी गई' या 'अस्वीकार की गई' पर सेट किया जा सकता है. 'granted' के अलावा किसी भी वैल्यू को 'denied' माना जाएगा. वैल्यू को 'undefined' पर सेट करने से, उसकी पिछली वैल्यू पर कोई असर नहीं पड़ेगा. |
इससे जुड़ी अनुमतियां
access_consent consentSettings ऑब्जेक्ट में, सहमति के सभी टाइप के लिए लिखने का ऐक्सेस वाली अनुमति.
एपीआई की जांच करना
ये एपीआई, सैंडबॉक्स किए गए JavaScript टेस्ट के साथ काम करते हैं, ताकि Google Tag Manager में कस्टम टेंप्लेट के लिए टेस्ट बनाए जा सकें. इन टेस्ट एपीआई के लिए, require()
स्टेटमेंट की ज़रूरत नहीं होती. कस्टम टेंप्लेट टेस्ट के बारे में ज़्यादा जानें.
assertApi
यह एक मैचर ऑब्जेक्ट दिखाता है. इसका इस्तेमाल, दिए गए एपीआई के बारे में आसानी से बताने के लिए किया जा सकता है.
सिंटैक्स
assertApi(apiName)
पैरामीटर
| पैरामीटर | टाइप | ब्यौरा |
|---|---|---|
apiName |
स्ट्रिंग | जिस एपीआई की जांच करनी है उसका नाम. यह वही स्ट्रिंग है जो
require() को पास की गई है.
|
मैच करने वाले टूल
Subject.wasCalled()Subject.wasNotCalled()Subject.wasCalledWith(...expected)Subject.wasNotCalledWith(...expected)
उदाहरण
assertApi('sendPixel').wasCalled();
assertApi('getUrl').wasNotCalled();
assertApi('makeNumber').wasCalledWith('8');
assertApi('setInWindow').wasNotCalledWith('myVar', 'theWrongValue');
assertThat
assertThat एपीआई को Google की [Truth] लाइब्रेरी के हिसाब से बनाया गया है. यह एक ऑब्जेक्ट दिखाता है, जिसका इस्तेमाल किसी विषय की वैल्यू के बारे में आसानी से बताने के लिए किया जा सकता है. अगर किसी एग्ज़रेशन की पुष्टि नहीं हो पाती है, तो टेस्ट तुरंत रुक जाएगा और उसे 'असफल' के तौर पर मार्क कर दिया जाएगा. हालांकि, किसी एक टेस्ट में फ़ेल होने का असर दूसरे टेस्ट केस पर नहीं पड़ेगा.
सिंटैक्स
assertThat(actual, opt_message)
पैरामीटर
| पैरामीटर | टाइप | ब्यौरा |
|---|---|---|
actual |
any | फ़्लूइंट जांच में इस्तेमाल की जाने वाली वैल्यू. |
opt_message |
स्ट्रिंग | अगर दावा पूरा नहीं होता है, तो प्रिंट करने के लिए वैकल्पिक मैसेज. |
मैच करने वाले टूल
| मैच करने वाला | ब्यौरा |
|---|---|
isUndefined() |
यह बताता है कि विषय undefined है. |
isDefined() |
यह बताता है कि विषय undefined नहीं है. |
isNull() |
यह बताता है कि विषय null है. |
isNotNull() |
यह बताता है कि विषय null नहीं है. |
isFalse() |
यह बताता है कि विषय false है. |
isTrue() |
यह बताता है कि विषय true है. |
isFalsy() |
यह बताता है कि सबजेक्ट गलत है. गलत वैल्यू ये हैं:
undefined, null, false,
NaN, 0, और '' (खाली स्ट्रिंग). |
isTruthy() |
यह बताता है कि सबजेक्ट सही है. गलत वैल्यू ये हैं:
undefined, null, false,
NaN, 0, और '' (खाली स्ट्रिंग). |
isNaN() |
यह बताता है कि विषय की वैल्यू NaN है. |
isNotNaN() |
यह बताता है कि सबजेक्ट, NaN के अलावा कोई भी वैल्यू है. |
isInfinity() |
यह बताता है कि विषय पॉज़िटिव या नेगेटिव अनंत है. |
isNotInfinity() |
यह बताता है कि विषय, अनंत की सकारात्मक या नेगेटिव वैल्यू के अलावा कोई भी वैल्यू हो सकती है. |
isEqualTo(expected) |
यह बताता है कि सबजेक्ट, दी गई वैल्यू के बराबर है. यह वैल्यू की तुलना है, रेफ़रंस की तुलना नहीं. ऑब्जेक्ट और ऐरे के कॉन्टेंट की तुलना, बार-बार की जाती है. |
isNotEqualTo(expected) |
यह बताता है कि विषय, दी गई वैल्यू से मेल नहीं खाता. यह रेफ़रंस की तुलना के बजाय, वैल्यू की तुलना है. ऑब्जेक्ट और ऐरे के कॉन्टेंट की तुलना बार-बार की जाती है. |
isAnyOf(...expected) |
यह बताता है कि सबजेक्ट, दी गई वैल्यू में से किसी एक के बराबर है. यह रेफ़रंस की तुलना के बजाय, वैल्यू की तुलना है. ऑब्जेक्ट और ऐरे के कॉन्टेंट की तुलना बार-बार की जाती है. |
isNoneOf(...expected) |
यह बताता है कि सबजेक्ट, दी गई किसी भी वैल्यू से मेल नहीं खाता. यह रेफ़रंस की तुलना नहीं, बल्कि वैल्यू की तुलना है. ऑब्जेक्ट और ऐरे के कॉन्टेंट की तुलना बार-बार की जाती है. |
isStrictlyEqualTo(expected) |
यह बताता है कि ऑब्जेक्ट, दी गई वैल्यू (===) से पूरी तरह से मेल खाता है. |
isNotStrictlyEqualTo(expected) |
यह बताता है कि विषय, दी गई वैल्यू (!==) से पूरी तरह से मेल नहीं खाता. |
isGreaterThan(expected) |
यह बताता है कि ऑर्डर की गई तुलना में, विषय (>) दी गई वैल्यू से ज़्यादा है. |
isGreaterThanOrEqualTo(expected) |
यह बताता है कि ऑर्डर की गई तुलना में, विषय, दी गई वैल्यू (>=) से ज़्यादा या उसके बराबर है. |
isLessThan(expected) |
यह बताता है कि ऑर्डर की गई तुलना में, विषय (<) दी गई वैल्यू से कम है. |
isLessThanOrEqualTo(expected) |
यह बताता है कि ऑर्डर की गई तुलना में, विषय (<=)
दी गई वैल्यू से कम या उसके बराबर है. |
contains(...expected) |
यह बताता है कि सबजेक्ट एक ऐरे या स्ट्रिंग है, जिसमें दी गई सभी वैल्यू किसी भी क्रम में मौजूद हैं. यह वैल्यू की तुलना है, न कि रेफ़रंस की तुलना. ऑब्जेक्ट और ऐरे के कॉन्टेंट की तुलना, बार-बार की जाती है. |
doesNotContain(...expected) |
यह बताता है कि सबजेक्ट एक ऐरे या स्ट्रिंग है, जिसमें दी गई कोई भी वैल्यू मौजूद नहीं है. यह वैल्यू की तुलना है, न कि रेफ़रंस की तुलना. ऑब्जेक्ट और ऐरे के कॉन्टेंट की तुलना बार-बार की जाती है. |
containsExactly(...expected) |
यह बताता है कि सबजेक्ट एक ऐरे है, जिसमें दी गई सभी वैल्यू किसी भी क्रम में मौजूद हैं और कोई दूसरी वैल्यू नहीं है. यह वैल्यू की तुलना है, रेफ़रंस की तुलना नहीं. ऑब्जेक्ट और ऐरे के कॉन्टेंट की तुलना, बार-बार की जाती है. |
doesNotContainExactly(...expected) |
यह बताता है कि सबजेक्ट एक ऐरे है, जिसमें किसी भी क्रम में दी गई वैल्यू से अलग वैल्यू का सेट होता है. यह वैल्यू की तुलना है, रेफ़रंस की तुलना नहीं. ऑब्जेक्ट और ऐरे के कॉन्टेंट की तुलना, बार-बार की जाती है. |
hasLength(expected) |
यह बताता है कि सबजेक्ट, दी गई लंबाई वाला ऐरे या स्ट्रिंग है. अगर वैल्यू ऐरे या स्ट्रिंग नहीं है, तो यह दावा हमेशा गलत होता है. |
isEmpty() |
यह बताता है कि सबजेक्ट एक खाली ऐरे या स्ट्रिंग है (लंबाई = 0). अगर वैल्यू ऐरे या स्ट्रिंग नहीं है, तो यह दावा हमेशा गलत होता है. |
isNotEmpty() |
यह बताता है कि सबजेक्ट एक ऐरे या स्ट्रिंग है, जो खाली नहीं है (लंबाई > 0). अगर वैल्यू कोई ऐरे या स्ट्रिंग नहीं है, तो यह दावा हमेशा गलत होता है. |
isArray() |
यह बताता है कि विषय का टाइप ऐरे है. |
isBoolean() |
यह बताता है कि विषय का टाइप बूलियन है. |
isFunction() |
यह बताता है कि विषय का टाइप फ़ंक्शन है. |
isNumber() |
यह बताता है कि विषय का टाइप संख्या है. |
isObject() |
यह बताता है कि विषय का टाइप ऑब्जेक्ट है. |
isString() |
यह बताता है कि विषय का टाइप स्ट्रिंग है. |
उदाहरण
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
मौजूदा टेस्ट को तुरंत फ़ेल कर देता है और दिए गए मैसेज को प्रिंट करता है.
सिंटैक्स
fail(opt_message);
पैरामीटर
| पैरामीटर | टाइप | ब्यौरा |
|---|---|---|
opt_message |
स्ट्रिंग | गड़बड़ी का मैसेज लिखना ज़रूरी नहीं है. |
उदाहरण
fail('This test has failed.');
mock
mock API की मदद से, सैंडबॉक्स किए गए एपीआई के काम करने के तरीके को बदला जा सकता है. टेंप्लेट कोड में मॉक एपीआई का इस्तेमाल करना सुरक्षित है. हालांकि, यह सिर्फ़ टेस्ट मोड में काम करता है.
हर टेस्ट शुरू होने से पहले, मॉक रीसेट हो जाते हैं.
सिंटैक्स
mock(apiName, returnValue);
पैरामीटर
| पैरामीटर | टाइप | ब्यौरा |
|---|---|---|
apiName |
स्ट्रिंग | उस एपीआई का नाम जिसे मॉक करना है. यह वही स्ट्रिंग है जो
require() को पास की गई है |
returnValue |
any | एपीआई के लिए रिटर्न की जाने वाली वैल्यू या एपीआई के बजाय कॉल किए गए फ़ंक्शन की वैल्यू. अगर returnValue कोई फ़ंक्शन है, तो सैंडबॉक्स किए गए एपीआई के बजाय उस फ़ंक्शन को कॉल किया जाता है. अगर returnValue कोई फ़ंक्शन नहीं है, तो सैंडबॉक्स किए गए एपीआई के बजाय वह वैल्यू दी जाती है. |
उदाहरण
mock('encodeUri', "https://endpoint.example.com/?account=12345");
mock('sendPixel', function(url, onSuccess, onFailure) {
onSuccess();
});
mockObject
mockObject एपीआई की मदद से, सैंडबॉक्स किए गए उन एपीआई के व्यवहार को बदला जा सकता है जो ऑब्जेक्ट दिखाते हैं. टेंप्लेट कोड में एपीआई का इस्तेमाल करना सुरक्षित है. हालांकि, यह सिर्फ़ टेस्ट मोड में काम करता है. हर टेस्ट शुरू होने से पहले, मॉक रीसेट हो जाते हैं.
सिंटैक्स
mockObject(apiName, objectMock);
पैरामीटर
| पैरामीटर | टाइप | ब्यौरा |
|---|---|---|
apiName |
स्ट्रिंग | उस एपीआई का नाम जिसे मॉक करना है. यह वही स्ट्रिंग है जो
require() को पास की गई है |
objectMock |
ऑब्जेक्ट | एपीआई के लिए रिटर्न की जाने वाली वैल्यू या एपीआई के बजाय कॉल किए गए फ़ंक्शन की वैल्यू. यह एक ऑब्जेक्ट होना चाहिए. |
उदाहरण
const storage = {};
mockObject('localStorage', {
setItem: (key, value) => {storage[key] = value;},
getItem: (key) => storage[key],
});
runCode
यह टेंप्लेट के कोड को चलाता है. इसका मतलब है कि यह दिए गए इनपुट डेटा ऑब्जेक्ट के साथ, मौजूदा टेस्ट एनवायरमेंट में कोड टैब का कॉन्टेंट चलाता है.
सिंटैक्स
runCode(data)
पैरामीटर
| पैरामीटर | टाइप | ब्यौरा |
|---|---|---|
data |
ऑब्जेक्ट | टेस्ट में इस्तेमाल किया जाने वाला डेटा ऑब्जेक्ट. |
रिटर्न वैल्यू
वैरिएबल टेंप्लेट के लिए, किसी वैरिएबल की वैल्यू दिखाता है. साथ ही, अन्य सभी तरह के टेंप्लेट के लिए undefined दिखाता है.
उदाहरण
runCode({field1: 123, field2: 'value'});