मुख्य एपीआई
ये एपीआई, सैंडबॉक्स की गई JavaScript के साथ काम करते हैं, ताकि Google में कस्टम टेंप्लेट बनाए जा सकें
Tag Manager. हर एपीआई को require()
स्टेटमेंट के साथ जोड़ा जाता है, उदाहरण के लिए:
const myAPI = require('myAPI');
addConsentListener
दी गई सहमति की स्थिति को लागू करने के लिए, लिसनर फ़ंक्शन को रजिस्टर करता है टाइप में बदलाव.
दिए गए लिसनर का अनुरोध हर बार तब किया जाएगा, जब बताई गई स्थिति में सहमति टाइप को 'अनुमति नहीं दी गई' से 'अनुमति है' या 'अनुमति दी गई' से बदलकर 'अनुमति नहीं दी गई' में बदला जाता है. सहमति बिना स्थिति वाले टाइप को अनुमति नहीं दी जाती है. इसलिए, लिसनर को तब कॉल नहीं किया जाएगा, जब सेट नहीं किए गए सहमति टाइप को बदलकर 'अनुमति दी गई' कर दिया गया है. लिसनर फ़ंक्शन को चार्ज किया जाएगा ताकि यह पक्का किया जा सके कि उनका कोड सही बार काम करे.
उदाहरण:
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 |
बूलियन | यह एक बूलियन है, जो तब सही होता है, जब चुने गए सहमति टाइप को बदला जा रहा हो करने की अनुमति दी गई है. |
किसी डिवाइस से जुड़ी अनुमतियां
सहमति के टाइप के लिए, 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
एपीआई आपको एक उपनाम (जैसे कि window.foo =
window.bar
) बनाने देता है, जिससे कुछ टैग का इस्तेमाल करने में मदद मिलती है, जिनके लिए एलियासिंग की ज़रूरत होती है. असाइन करें
window
ऑब्जेक्ट की वैल्यू, fromPath
पर मिली वैल्यू
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 |
* | फ़ंक्शन को पास किए जाने वाले आर्ग्युमेंट. |
किसी डिवाइस से जुड़ी अनुमतियां
access_globals
, जिसमें execute
की अनुमति चालू है.
callLater
एसिंक्रोनस रूप से होने के लिए किसी फ़ंक्शन को कॉल शेड्यूल करता है. फ़ंक्शन होगा
मौजूदा कोड के रिटर्न के बाद कॉल किया जाता है. यह इसके बराबर है
setTimeout(<function>, 0)
.
सिंटैक्स
callLater(function)
पैरामीटर
पैरामीटर | टाइप | ब्यौरा |
---|---|---|
function |
फ़ंक्शन | कॉल करने के लिए फ़ंक्शन. |
copyFromDataLayer
डेटा लेयर में दी गई कुंजी को फ़िलहाल असाइन की गई वैल्यू दिखाता है:
दी गई कुंजी पर पाया जाने वाला मान, अगर वह कोई प्रिमिटिव टाइप, फ़ंक्शन या ऑब्जेक्ट है
लिटरल या undefined
से अलग.
सिंटैक्स
copyFromDataLayer(key[, dataLayerVersion])
पैरामीटर
पैरामीटर | टाइप | ब्यौरा |
---|---|---|
key |
स्ट्रिंग | "a.b.c" के फ़ॉर्मैट में कुंजी. |
dataLayerVersion |
नंबर | वैकल्पिक डेटा लेयर वर्शन. डिफ़ॉल्ट वैल्यू दो है. इसकी सलाह बिलकुल नहीं दी जाती है वैल्यू 1 का इस्तेमाल करें. |
किसी डिवाइस से जुड़ी अनुमतियां
copyFromWindow
window
ऑब्जेक्ट से वैरिएबल कॉपी करता है. अगर window
में मौजूद वैल्यू
सैंडबॉक्स की गई JavaScript में काम करने वाले टाइप में सीधे मैप किया गया है, तो undefined
वापस किया गया. सैंडबॉक्स की गई JavaScript में ये आठ तरह के काम करते हैं: null
,
undefined
, boolean
, number
, string
, Array
, Object
, और function
.
फ़ेच की गई (और कोड में बदली गई) वैल्यू दिखाता है.
सिंटैक्स
copyFromWindow(key)
पैरामीटर
पैरामीटर | टाइप | ब्यौरा |
---|---|---|
key |
स्ट्रिंग | वैल्यू को कॉपी करने के लिए, window में मौजूद कुंजी. |
किसी डिवाइस से जुड़ी अनुमतियां
createArgumentsQueue
टैग के साथ काम करने वाले आर्ग्युमेंट ऑब्जेक्ट से भरी जाने वाली सूची बनाता है की ज़रूरत होती है.
fnKey
आर्ग्युमेंट का इस्तेमाल करके, ग्लोबल स्कोप (जैसे, window
) में एक फ़ंक्शन बनाता है
(createQueue
की तरह ही सिमैंटिक). फ़ंक्शन बनाने के बाद, यह एपीआई
arrayKey
का इस्तेमाल करके window
में अरे (अगर यह पहले से मौजूद नहीं है) बनाता है
तर्क है.
fnKey
में बनाए गए फ़ंक्शन को कॉल करने पर, अपने आर्ग्युमेंट पुश किए जाते हैं
ऑब्जेक्ट को arrayKey
में बनाई गई अरे पर डालें. एपीआई से मिलने वाली रिटर्न वैल्यू
फ़ंक्शन को fnKey
के तहत बनाया गया.
इस फ़ंक्शन के लिए, fnKey
और arrayKey
के लिए, पढ़ने और लिखने की सेटिंग चालू होनी चाहिए
access_globals
की अनुमति.
उदाहरण:
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
में एक अरे बनाता है (अगर वह पहले से मौजूद नहीं है) और
फ़ंक्शन है, जो उस अरे पर वैल्यू पुश करेगा.
इस फ़ंक्शन कोarrayKey
access_globals
की अनुमति.
उदाहरण:
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
दिए गए यूआरआई कॉम्पोनेंट में, कोड में बदले गए किसी भी वर्ण को डिकोड करता है. यह वैल्यू दिखाता है
string, जो डिकोड किया गया यूआरआई कॉम्पोनेंट दिखाता है. जब 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
एपीआई की मदद से, बेस64 से स्ट्रिंग को डिकोड किया जा सकता है
प्रतिनिधित्व. गलत इनपुट देने पर undefined
दिखाता है.
सिंटैक्स
fromBase64(base64EncodedString)
पैरामीटर
पैरामीटर | टाइप | ब्यौरा |
---|---|---|
base64EncodedString |
स्ट्रिंग | Base64 से कोड में बदली गई स्ट्रिंग. |
उदाहरण
const fromBase64 = require('fromBase64');
const greeting = fromBase64('aGVsbG8=');
if (greeting === 'hello') {
// ...
}
किसी डिवाइस से जुड़ी अनुमतियां
कोई नहीं
generateRandom
दी गई रेंज में से किसी भी संख्या (पूर्णांक) की जानकारी देता है.
सिंटैक्स
generateRandom(min, max)
पैरामीटर
पैरामीटर | टाइप | ब्यौरा |
---|---|---|
min |
नंबर | लौटाए गए पूर्णांक का कम से कम संभावित मान. |
max |
नंबर | दिए गए पूर्णांक का ज़्यादा से ज़्यादा संभावित मान. |
किसी डिवाइस से जुड़ी अनुमतियां
कोई नहीं.
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 |
बूलियन | यह नीति कंट्रोल करती है कि कुकी की वैल्यू को डिकोड करना है या नहीं
JavaScript की
decodeURIComponent() . डिफ़ॉल्ट:
true . |
किसी डिवाइस से जुड़ी अनुमतियां
getQueryParameters
मौजूदा यूआरएल के queryKey
के लिए, पहले या सभी पैरामीटर दिखाता है.
queryKey
से पहला मान या
queryKey
.
सिंटैक्स
getQueryParameters(queryKey[, retrieveAll])
पैरामीटर
पैरामीटर | टाइप | ब्यौरा |
---|---|---|
queryKey |
स्ट्रिंग | क्वेरी पैरामीटर से पढ़ने के लिए कुंजी. |
retrieveAll |
बूलियन | क्या सभी वैल्यू को वापस लाना है. |
उदाहरण के लिए, अगर मौजूदा यूआरएल
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
API, getQueryParameters
की तरह ही काम करता है,
लेकिन वह वर्तमान URL के बजाय रेफ़रर पर काम करती है. यह नतीजे दिखाता है कि पहला या
दिए गए रेफ़रर के queryKey
के सभी पैरामीटर. पहला नतीजा दिखाता है
queryKey
से मिली वैल्यू या queryKey
से मिली वैल्यू की कलेक्शन.
सिंटैक्स
getReferrerQueryParameters(queryKey[, retrieveAll])
पैरामीटर
पैरामीटर | टाइप | ब्यौरा |
---|---|---|
queryKey |
स्ट्रिंग | क्वेरी पैरामीटर से पढ़ने के लिए कुंजी. |
retrieveAll |
बूलियन | क्या सभी वैल्यू को वापस लाना है. |
उदाहरण के लिए, यदि रेफ़रर URL
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 को प्राथमिकता दें.
ऐसा नंबर देता है जो यूनिक्स के बाद से मिलीसेकंड में मौजूदा समय दिखाता है
Epoch के लिए, Date.now()
से लौटाया गया है.
सिंटैक्स
getTimestamp();
किसी डिवाइस से जुड़ी अनुमतियां
कोई नहीं.
getTimestampMillis
ऐसा नंबर देता है जो यूनिक्स के बाद से मिलीसेकंड में मौजूदा समय दिखाता है
Epoch के लिए, Date.now()
से लौटाया गया है.
सिंटैक्स
getTimestampMillis();
किसी डिवाइस से जुड़ी अनुमतियां
कोई नहीं.
getType
दी गई वैल्यू के टाइप के बारे में बताने वाली string दिखाता है. typeof
को नापसंद करें,
getType
, array
और object
के बीच अंतर करता है.
सिंटैक्स
getType(data.someField)
ज़रूरी जानकारी
यहां दी गई टेबल में, हर इनपुट वैल्यू के लिए दिखाई गई स्ट्रिंग की सूची दी गई है.
इनपुट मान | नतीजा |
---|---|
undefined |
'तय नहीं है' |
null |
'शून्य' |
true |
'बूलियन' |
12 |
'नंबर' |
'string' |
'स्ट्रिंग' |
{ a: 3 } |
'ऑब्जेक्ट' |
[ 1, 3 ] |
'कलेक्शन' |
(x) => x + 1 |
'फ़ंक्शन' |
किसी डिवाइस से जुड़ी अनुमतियां
कोई नहीं.
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 |
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
चुने गए सहमति टाइप को अनुमति मिलने पर, 'सही' दिखाता है.
किसी खास तरह की सहमति के लिए सहमति तब ही मानी जाती है, जब प्रकार को 'granted' पर सेट किया गया या सेट नहीं किया गया हो. अगर सहमति टाइप को इस पर सेट किया गया है कोई और वैल्यू होगी, तो उसे 'अनुमति नहीं दी गई' माना जाएगा.
टैग सेटिंग के लिए 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 | कोई भी | वह वैल्यू जिसे बदलना है. अगर मान कोई स्ट्रिंग नहीं है, तो इनपुट एक स्ट्रिंग की तरह लग रहा है. |
JSON.stringify
पैरामीटर | टाइप | ब्यौरा |
---|---|---|
value | कोई भी | वह वैल्यू जिसे बदलना है. |
उदाहरण
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] |
कोई भी | तर्क |
किसी डिवाइस से जुड़ी अनुमतियां
makeInteger
दी गई वैल्यू को संख्या (पूर्णांक) में बदलता है.
सिंटैक्स
makeInteger(value)
पैरामीटर
पैरामीटर | टाइप | ब्यौरा |
---|---|---|
value |
कोई भी | वह वैल्यू जिसे बदलना है. |
किसी डिवाइस से जुड़ी अनुमतियां
कोई नहीं.
makeNumber
दी गई वैल्यू को संख्या में बदलता है.
सिंटैक्स
makeNumber(value)
पैरामीटर
पैरामीटर | टाइप | ब्यौरा |
---|---|---|
value |
कोई भी | वह वैल्यू जिसे बदलना है. |
किसी डिवाइस से जुड़ी अनुमतियां
कोई नहीं.
makeString
दी गई वैल्यू को स्ट्रिंग के तौर पर दिखाता है.
सिंटैक्स
makeString(value)
पैरामीटर
पैरामीटर | टाइप | ब्यौरा |
---|---|---|
value |
कोई भी | वह वैल्यू जिसे बदलना है. |
किसी डिवाइस से जुड़ी अनुमतियां
कोई नहीं.
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() उपलब्ध कराता है
व्यवहार. यह किसी दिए गए ऑब्जेक्ट की खुद की तय की जा सकने वाली प्रॉपर्टी वैल्यू का अरे दिखाता है
उसी क्रम में होना चाहिए जो for...in...
लूप करता है. अगर इनपुट वैल्यू
ऑब्जेक्ट है, तो उसे एक ऑब्जेक्ट के रूप में ढाला जाएगा.
entries()
वाला तरीका, स्टैंडर्ड लाइब्रेरी Object.entries() उपलब्ध कराता है
व्यवहार. यह किसी दिए गए ऑब्जेक्ट की गिनती वाली प्रॉपर्टी का अरे रिटर्न करता है
[key, value]
लूप की तरह उसी क्रम में जोड़ें जैसा for...in...
लूप करता है. अगर
इनपुट वैल्यू कोई ऑब्जेक्ट नहीं है. इसे ऑब्जेक्ट की तरह बनाया जाएगा.
freeze()
वाला तरीका, स्टैंडर्ड लाइब्रेरी Object.freeze() उपलब्ध कराता है
व्यवहार. फ़्रोज़न ऑब्जेक्ट को अब बदला नहीं जा सकता; किसी वस्तु को फ़्रीज़ होने से रोकना
उसमें कोई नई प्रॉपर्टी नहीं जोड़ी गई है, मौजूदा प्रॉपर्टी हटाई जा सकती हैं,
साथ ही, मौजूदा प्रॉपर्टी की वैल्यू में बदलाव नहीं होगा. freeze()
नतीजे के तौर पर
जो पहले पास किया गया था. प्रिमिटिव या शून्य आर्ग्युमेंट को
अगर यह एक फ़्रोज़न ऑब्जेक्ट था, तो उसे लौटा दिया जाएगा.
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 | कोई भी | वह ऑब्जेक्ट जिसकी कुंजियों की गिनती करना है. अगर इनपुट कोई ऑब्जेक्ट नहीं है, तो यह एक ऑब्जेक्ट के लिए बाध्य किया जाएगा. |
Object.values
पैरामीटर | टाइप | ब्यौरा |
---|---|---|
objectInput | कोई भी | वह ऑब्जेक्ट जिसकी वैल्यू की गिनती करनी है. अगर इनपुट कोई ऑब्जेक्ट नहीं है, उसे एक ऑब्जेक्ट के तौर पर जोड़ा जाएगा. |
Object.entries
पैरामीटर | टाइप | ब्यौरा |
---|---|---|
objectInput | कोई भी | वह ऑब्जेक्ट जिसकी गिनती करने के लिए, कुंजी/वैल्यू पेयर को जोड़ना होता है. अगर इनपुट ऑब्जेक्ट है, तो उसे एक ऑब्जेक्ट के रूप में ढाला जाएगा. |
Object.freeze
पैरामीटर | टाइप | ब्यौरा |
---|---|---|
objectInput | कोई भी | फ़्रीज़ किया जाने वाला ऑब्जेक्ट. अगर इनपुट कोई ऑब्जेक्ट नहीं है, उसे फ़्रोज़न ऑब्जेक्ट माना जाएगा. |
Object.delete
पैरामीटर | टाइप | ब्यौरा |
---|---|---|
objectInput | कोई भी | वह ऑब्जेक्ट जिसकी कुंजी को मिटाना है. |
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 |
कोई भी | फ़ंक्शन के तर्क, क्वेरी की गई अनुमति के आधार पर अलग-अलग होते हैं. यहां जाएं: फ़ंक्शन आर्ग्युमेंट नीचे दिए गए हैं. |
फ़ंक्शन आर्ग्युमेंट
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
किसी बताए गए यूआरएल एंडपॉइंट पर जीईटी अनुरोध करता है.
सिंटैक्स
sendPixel(url, onSuccess, onFailure)
पैरामीटर
पैरामीटर | टाइप | ब्यौरा |
---|---|---|
url |
स्ट्रिंग | Pixel कहां भेजें. |
onSuccess |
फ़ंक्शन | यह तब कॉल किया जाता है, जब पिक्सल सही से लोड हो जाता है. ध्यान दें: भले ही अनुरोध भेजा जाता है, तो हो सकता है कि ब्राउज़र को सफलता हासिल करने के लिए. |
onFailure |
फ़ंक्शन | यह तब कॉल किया जाता है, जब Pixel लोड नहीं हो पाता. ध्यान दें: भले ही अनुरोध सफलतापूर्वक भेजता है, तो onFailure तब चल सकता है जब सर्वर मान्य इमेज रिस्पॉन्स. |
किसी डिवाइस से जुड़ी अनुमतियां
setCookie
तय किए गए नाम, वैल्यू, और विकल्पों के साथ कुकी को सेट करता है या मिटाता है.
सिंटैक्स
setCookie(name, value[, options, encode])
पैरामीटर
पैरामीटर | टाइप | ब्यौरा |
---|---|---|
name |
स्ट्रिंग | कुकी का नाम. |
value |
स्ट्रिंग | कुकी की वैल्यू. |
options |
object | यह बताता है कि डोमेन, पाथ, समयसीमा, ज़्यादा से ज़्यादा उम्र, सुरक्षित, और SameSite एट्रिब्यूट. (नीचे विकल्प देखें.) |
encode |
बूलियन | यह नीति कंट्रोल करती है कि कुकी की वैल्यू को, इसके साथ एन्कोड करना है या नहीं
JavaScript की
encodeURIComponent() .
डिफ़ॉल्ट तौर पर, यह true पर सेट होती है. |
- डोमेन: अगर मौजूद हो, तो यह
options['domain']
प्रॉपर्टी से सेट किया जाता है. यह वैल्यू सेट करें'auto'
से, सबसे बड़े डोमेन का इस्तेमाल करके कुकी लिखने की कोशिश करें, दस्तावेज़ की जगह के हिसाब से. अगर ऐसा नहीं हो पाता है, तो एक के बाद एक कोशिश की जाएगी छोटे सबडोमेन. अगर वे सभी असफल हो जाते हैं, तो यह कुकी लिखने की कोशिश करेगा डोमेन के बिना. अगर कोई वैल्यू सेट नहीं है, तो यह कुकी लिखने की कोशिश करेगा बिना किसी डोमेन के. ध्यान दें: जब बिना डोमेन वाली कुकीdocument.cookie
को लिखा जाता है, तो उपयोगकर्ता एजेंट कुकी के डोमेन को डिफ़ॉल्ट रूप से सेट कर देगा दस्तावेज़ की मौजूदा जगह के होस्ट पर. - पाथ:
options['path']
मौजूद होने पर, उसका सेट किया जाता है. जब बिना पाथ वाली कुकीdocument.cookie
के लिए लिखा गया है, तो उपयोगकर्ता एजेंट डिफ़ॉल्ट तौर पर कुकी का पाथ, दस्तावेज़ की मौजूदा जगह के पाथ पर ले जाता है. - ज़्यादा से ज़्यादा उम्र:
options['max-age']
से सेट की जाती है, अगर यह मौजूद है, तो. - समयसीमा खत्म होने की तारीख: इसे
options['expires']
तय करता है. अगर यह मौजूद है, तो तारीख की स्ट्रिंग यूटीसी फ़ॉर्मैट में होनी चाहिए.Date.toUTCString()
का इस्तेमाल इस पैरामीटर के लिएDate
. - सुरक्षित: अगर मौजूद हो, तो इसे
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 |
object | ऐसा ऑब्जेक्ट जो किसी खास सहमति के लिए डिफ़ॉल्ट स्थिति के बारे में बताता है प्रकार. |
consentSettings
ऑब्जेक्ट, आर्बिट्रेरी सहमति टाइप स्ट्रिंग की मैपिंग है, ताकि
'granted'
या 'denied'
में से कोई एक. यह इन वैल्यू के साथ काम करता है:
कुंजी का नाम | टाइप | ब्यौरा |
---|---|---|
consentType |
स्ट्रिंग | सहमति के हर टाइप की वैल्यू को `'granted'` या `'denied'` पर सेट किया जा सकता है. `'granted'` के अलावा किसी भी वैल्यू को `'denied'` माना जाएगा. सेटिंग `undefined` की वैल्यू का पिछली वैल्यू पर कोई असर नहीं पड़ता. |
region |
कलेक्शन | क्षेत्र के कोड की वैकल्पिक कैटगरी, जो तय करती है कि सहमति की सेटिंग इन पर लागू होती हैं. क्षेत्र के कोड, देश के हिसाब से दिखाए जाते हैं और/या सबडिविज़न, ISO 3166-2 फ़ॉर्मैट में. |
wait_for_update |
नंबर | मिलीसेकंड में वैल्यू तय करता है, ताकि यह कंट्रोल किया जा सके कि डेटा के भेजा गया. इसका इस्तेमाल सहमति टूल के साथ किया जाता है, जो एसिंक्रोनस रूप से लोड होते हैं. |
किसी डिवाइस से जुड़ी अनुमतियां
इसमें access_consent
की सभी तरह की सहमति के लिए, लिखने का ऐक्सेस है:
ConsentSettings ऑब्जेक्ट का हिस्सा है.
setInWindow
दी गई कुंजी पर window
में दी गई वैल्यू सेट करता है. डिफ़ॉल्ट रूप से इस तरीके से
अगर पहले से कोई वैल्यू मौजूद है, तो window
में वैल्यू सेट करें. शुरू
window
में वैल्यू सेट करने के लिए overrideExisting
से true
पर सेट करें, भले ही
मौजूदा मान की मौजूदगी. बूलियन: true
दिखाता है, अगर वैल्यू
सेट नहीं होगा, और अगर नहीं है, तो false
.
सिंटैक्स
setInWindow(key, value, overrideExisting)
पैरामीटर
पैरामीटर | टाइप | ब्यौरा |
---|---|---|
key |
स्ट्रिंग | वैल्यू को तय करने के लिए, window में मौजूद कुंजी. |
value |
* | window में सेट की जाने वाली वैल्यू. |
overrideExisting |
बूलियन | वह फ़्लैग जो बताता है कि वैल्यू को 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 |
फ़ंक्शन | मिलने वाले डाइजेस्ट के साथ कॉल किया जाता है, जो base64 में एन्कोड किया गया होता है. हालांकि, ऐसा तब होता है, जब
options ऑब्जेक्ट, कोड में बदलने के अलग तरीके के बारे में बताता है. |
onFailure |
फ़ंक्शन | इसे तब कॉल किया जाता है, जब डाइजेस्ट की गणना करते समय कोई गड़बड़ी होती है या ब्राउज़र में sha256 की सुविधा स्थानीय तौर पर काम नहीं करती. कॉलबैक को कॉल किया जाता है एक ऐसा ऑब्जेक्ट होना चाहिए जिसमें गड़बड़ी का नाम और मैसेज हो. |
options |
object | आउटपुट एन्कोडिंग तय करने के लिए, ज़रूरी नहीं विकल्प ऑब्जेक्ट. अगर आपने
बताया गया है, ऑब्जेक्ट में 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 |
object | ऐसा ऑब्जेक्ट जो तय किए गए सहमति टाइप की स्थिति अपडेट करता है. |
consentSettings
ऑब्जेक्ट, आर्बिट्रेरी सहमति टाइप स्ट्रिंग की मैपिंग है, ताकि
'granted'
या 'denied'
में से कोई एक. यह इन वैल्यू के साथ काम करता है:
कुंजी का नाम | टाइप | ब्यौरा |
---|---|---|
consentType |
स्ट्रिंग | हर सहमति टाइप के लिए वैल्यू, 'granted' पर सेट की जा सकती है या 'अस्वीकार किया गया' होना चाहिए. 'मंज़ूरी दी गई' के अलावा कोई भी अन्य वैल्यू उसे 'अस्वीकार किया गया' माना जाएगा. सेटिंग 'undefined' के लिए मान पुरानी वैल्यू पर कोई असर नहीं पड़ेगा. |
किसी डिवाइस से जुड़ी अनुमतियां
इसमें access_consent
की सभी तरह की सहमति के लिए, लिखने का ऐक्सेस है:
ConsentSettings ऑब्जेक्ट का हिस्सा है.
टेस्ट एपीआई
ये एपीआई, सैंडबॉक्स किए गए JavaScript टेस्ट के साथ काम करते हैं, ताकि ज़रूरत के मुताबिक
टेम्प्लेट पर जाकर. इन टेस्ट एपीआई के लिए, 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 |
कोई भी | आसानी से जांच करने के लिए इस्तेमाल की जाने वाली वैल्यू. |
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() |
दावा करता है कि विषय एक ऐसी सरणी या स्ट्रिंग है जो खाली है (length = 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
एपीआई की मदद से, सैंडबॉक्स एपीआई के काम करने के तरीके को बदला जा सकता है. द मॉक
टेंप्लेट कोड में एपीआई का इस्तेमाल सुरक्षित है, लेकिन यह सिर्फ़ टेस्ट मोड में काम करता है.
हर टेस्ट पूरा होने से पहले, मॉक रीसेट हो जाते हैं.
सिंटैक्स
mock(apiName, returnValue);
पैरामीटर
पैरामीटर | टाइप | ब्यौरा |
---|---|---|
apiName |
स्ट्रिंग | मॉक करने के लिए एपीआई का नाम; वही स्ट्रिंग जो
require() |
returnValue |
कोई भी | एपीआई या फ़ंक्शन के लिए दी जाने वाली वैल्यू
एपीआई. अगर 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 |
object | एपीआई या फ़ंक्शन के लिए दी जाने वाली वैल्यू एपीआई. कोई ऑब्जेक्ट होना चाहिए. |
उदाहरण
const storage = {};
mockObject('localStorage', {
setItem: (key, value) => {storage[key] = value;},
getItem: (key) => storage[key],
});
runCode
टेंप्लेट के लिए कोड चलाता है, जैसे कि कोड टैब का कॉन्टेंट दिए गए इनपुट डेटा ऑब्जेक्ट के साथ मौजूदा टेस्ट एनवायरमेंट.
सिंटैक्स
runCode(data)
पैरामीटर
पैरामीटर | टाइप | ब्यौरा |
---|---|---|
data |
object | जांच में इस्तेमाल किया जाने वाला डेटा ऑब्जेक्ट. |
रिटर्न वैल्यू
वैरिएबल टेंप्लेट के लिए वैरिएबल की वैल्यू दिखाता है; इसके लिए undefined
लौटाता है
अन्य सभी प्रकार के टेम्प्लेट के साथ काम करता है.
उदाहरण
runCode({field1: 123, field2: 'value'});