API संदर्भ
Adsgram विधियाँ
init
AdController बनाएं जो ad दिखाने, लोड करने और नष्ट करने के लिए उपयोग होता है।
एक ही blockId के लिए केवल एक बार initialization करना पर्याप्त है।
यदि आप एक ही blockId के साथ init फ़ंक्शन को एक से अधिक बार कॉल करते हैं, तो आपको उसी blockId के लिए एक ही AdController मिलेगा।
सिंटैक्स
const AdController = window.Adsgram.init({
blockId: "your-block-id",
debug: true,
debugConsole: true,
debugBannerType: "FullscreenMedia"
});पैरामीटर्स
blockId
String with digits, for example
"123".
यह वह अनूठा पहचानकर्ता है जो आप publisher के खाते में प्राप्त करते हैं।
BlockId प्राप्त करने के लिए विस्तृत निर्देश Get block-id section में देखें
debug Optional
Boolean मान है। यदि इसे
trueपर सेट करते हैं तो आपको सर्वर से टेस्ट विज्ञापन के साथ प्रतिक्रिया मिलेगी औरADSGRAM DEBUG LOGप्रीफ़िक्स के साथ विस्तृत लॉग ब्राउज़र कंसोल में आउटपुट होंगे।खतरा
प्रोडक्शन में रिलीज़ करने से पहले इसे हटाना या
falseपर सेट करना न भूलें।
हम test ad इंप्रेशन को आँकड़ों में नहीं जोड़ते, इसलिए आप इसके इंप्रेशन, शो, क्लिक आदि की आँकड़े प्लेटफ़ॉर्म और ब्लॉक पेज पर नहीं देखेंगे।
Reward Url के लिए अनुरोध नहीं भेजा जाएगा।
debugConsole Optional
Boolean मान। डिफ़ॉल्ट
trueहै। यह केवल तभी काम करता है जब debug पैरामीटरtrueहो।
यदिtrueहै, तो ब्राउज़र कंसोल मेंADSGRAM DEBUG LOGप्रीफ़िक्स के साथ विस्तृत लॉग आउटपुट होंगे।
यदिfalseहै, तो debug मोड में भी लॉग कंसोल में आउटपुट नहीं होंगे।
debugBannerType Optional
संभावित मान हैं
"FullscreenMedia"और"RewardedVideo".
यह मान तब उपयोग करें जब आप विशेष टेस्ट बैनर प्रकार प्राप्त करना चाहते हैं। यह केवल तभी काम करता है जब debug पैरामीटरtrueहो।
रिटर्न वैल्यू
AdController
AdController methods
show
Ad लोड और दिखाता है।
सिंटैक्स
AdController.show();const showPromise: Promise<ShowPromiseResult> = AdController.show();रिटर्न वैल्यू
Promiseजो तब resolve होता है जब उपयोगकर्ता विज्ञापन अंत तक देखता है या Interstitial फ़ॉर्मैट में उसे बंद कर देता है, अन्यथा reject होता है।
प्रॉमिस के परिणाम के प्रकार निम्नलिखित हैं:tsinterface ShowPromiseResult { done: boolean; // true यदि उपयोगकर्ता अंत तक देखता है या interstitial फ़ॉर्मैट में बंद करता है, अन्यथा false description: string; // इवेंट का विवरण state: 'load' | 'render' | 'playing' | 'destroy'; // बैनर की स्थिति error: boolean; // true यदि इवेंट त्रुटि के कारण हुआ, अन्यथा false }
उदाहरण
promises API का उपयोग करते हुए:
AdController.show().then((result) => {
// उपयोगकर्ता ने विज्ञापन अंत तक देखा या interstitial फ़ॉर्मैट में बंद किया
// उपयोगकर्ता को इनाम देने के लिए आपका कोड
}).catch((result) => {
// विज्ञापन चलाते समय त्रुटि हुई या उपयोगकर्ता ने विज्ञापन छोड़ दिया
// कुछ न करें या अपनी ज़रूरत के अनुसार कार्रवाई करें
})AdController.show().then((result: ShowPromiseResult) => {
// उपयोगकर्ता ने विज्ञापन अंत तक देखा या interstitial फ़ॉर्मैट में बंद किया
// उपयोगकर्ता को इनाम देने के लिए आपका कोड
}).catch((result: ShowPromiseResult) => {
// विज्ञापन चलाते समय त्रुटि हुई या उपयोगकर्ता ने विज्ञापन छोड़ दिया
// कुछ न करें या अपनी ज़रूरत के अनुसार कार्रवाई करें
})आप उसी व्यवहार को await का उपयोग करके भी प्राप्त कर सकते हैं:
try {
const showPromiseResult = await AdController.show();
// उपयोगकर्ता ने विज्ञापन अंत तक देखा या interstitial फ़ॉर्मैट में बंद किया
// उपयोगकर्ता को इनाम देने के लिए आपका कोड
} catch (showPromiseResult) {
// विज्ञापन चलाते समय त्रुटि हुई या उपयोगकर्ता ने विज्ञापन छोड़ दिया
// कुछ न करें या अपनी ज़रूरत के अनुसार कार्रवाई करें
}try {
const showPromiseResult: ShowPromiseResult = await AdController.show();
// उपयोगकर्ता ने विज्ञापन अंत तक देखा या interstitial फ़ॉर्मैट में बंद किया
// उपयोगकर्ता को इनाम देने के लिए आपका कोड
} catch (error) {
const showPromiseResult = error as ShowPromiseResult;
// विज्ञापन चलाते समय त्रुटि हुई या उपयोगकर्ता ने विज्ञापन छोड़ दिया
// कुछ न करें या अपनी ज़रूरत के अनुसार कार्रवाई करें
}सुझाव
यदि आप चाहते हैं कि ad समाप्त होने के बाद, उसे छोड़ने पर या त्रुटि आने पर कोई अतिरिक्त कार्रवाई हो, तो finally के साथ प्रॉमिस chain करें।
destroy
Ad दिखाना बंद करने और लोड किए गए बैनर डेटा को हटाने के लिए।
सिंटैक्स
AdController.destroy();रिटर्न वैल्यू
None(
undefined)
जानकारी
आमतौर पर आपको इसे मैन्युअल रूप से कॉल करने की आवश्यकता नहीं होती है, यदि कोई त्रुटि है, स्किप किया गया है या विज्ञापन पूरी तरह से देखा गया है, तो यह स्वचालित रूप से नष्ट कर दिया जाएगा।
addEventListener
event की सदस्यता लेता है और यदि event fired होता है तो callback फ़ंक्शन को कॉल करता है।
यदि आप प्रदर्शन पर अधिक नियंत्रण चाहते हैं तो यह उपयोग किया जाता है।
सिंटैक्स
AdController.addEventListener('onReward', () => {
// उपयोगकर्ता को इनाम देने के लिए आपका कोड
});पैरामीटर्स
event
Events के प्रकार:
Event Occurs onStartजब पहला बैनर फ़्रेम दिखाया जाता है onSkipजब उपयोगकर्ता विज्ञापन बंद करता है onRewardजब उपयोगकर्ता reward प्राप्त करने के लिए rewarded banner को अंत तक देखता है onCompleteजब उपयोगकर्ता interstitial banner को अंत तक देखता है या बंद कर देता है onErrorजब उपयोगकर्ता को render या play करते समय त्रुटि होती है onBannerNotFoundजब दिखाने के लिए कोई बैनर नहीं है onNonStopShowजब उपयोगकर्ता लगातार कई विज्ञापन देखने की कोशिश कर रहा है onTooLongSessionजब सत्र बहुत लंबा है, उपयोगकर्ता को फिर से शुरू करना चाहिए सुझाव
यदि आप अपनी कस्टम अलर्ट दिखाना चाहते हैं, तो आप
onBannerNotFound,onNonStopShowयाonTooLongSessionकी सदस्यता ले सकते हैं।
अन्यथा हम डिफ़ॉल्ट अलर्ट दिखाएँगे।
अलर्ट उपयोगकर्ता की भाषा या अंग्रेजी में दिखाया जाता है और इस तरह होता है 👇
callback
फ़ंक्शन जो निर्दिष्ट प्रकार के event के होने पर कॉल किया जाएगा।
रिटर्न वैल्यू
None(
undefined)
removeEventListener
event की सदस्यता रद्द करता है जिसमे callback निर्धारित किया गया हो।
सिंटैक्स
AdController.removeEventListener('onReward', rewardFunction);पैरामीटर्स
addEventListener के समान
रिटर्न वैल्यू
None(
undefined)
