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 लोड और दिखाता है।

सिंटैक्स

javascript

AdController.show();

typescript

const showPromise: Promise<ShowPromiseResult> = AdController.show();

रिटर्न वैल्यू

Promise जो तब resolve होता है जब उपयोगकर्ता विज्ञापन अंत तक देखता है, अन्यथा reject होता है।
प्रॉमिस के परिणाम के प्रकार निम्नलिखित हैं:

interface ShowPromiseResult {
  done: boolean; // true if user watch till the end, otherwise false
  description: string; // event description
  state: 'load' | 'render' | 'playing' | 'destroy'; // banner state
  error: boolean; // true if event was emitted due to error, otherwise false
}

उदाहरण

promises API का उपयोग करते हुए:

javascript

AdController.show().then((result) => {
  // user watch ad till the end
  // your code to reward user
}).catch((result) => {
  // user get error during playing ad or skip ad
  // do nothing or whatever you want
})

typescript

AdController.show().then((result: ShowPromiseResult) => {
  // user watch ad till the end
  // your code to reward user
}).catch((result: ShowPromiseResult) => {
  // user get error during playing ad or skip ad
  // do nothing or whatever you want
})

आप उसी व्यवहार को await का उपयोग करके भी प्राप्त कर सकते हैं:

javascript

try {
  const showPromiseResult = await AdController.show();
  // user watch ad till the end
  // your code to reward user
} catch (showPromiseResult) {
  // user get error during playing ad or skip ad
  // do nothing or whatever you want
}

typescript

try {
  const showPromiseResult: ShowPromiseResult = await AdController.show();
  // user watch ad till the end
  // your code to reward user
} catch (showPromiseResult: ShowPromiseResult) {
  // user get error during playing ad or skip ad
  // do nothing or whatever you want
}

सुझाव

यदि आप चाहते हैं कि ad समाप्त होने के बाद, उसे छोड़ने पर या त्रुटि आने पर कोई अतिरिक्त कार्रवाई हो, तो finally के साथ प्रॉमिस chain करें।

destroy

Ad दिखाना बंद करने और लोड किए गए बैनर डेटा को हटाने के लिए।

सिंटैक्स

AdController.destroy();

रिटर्न वैल्यू

None(undefined)

जानकारी

आमतौर पर आपको इसे मैन्युअल रूप से कॉल करने की आवश्यकता नहीं होती है, यदि कोई त्रुटि है, स्किप किया गया है या विज्ञापन पूरी तरह से देखा गया है, तो यह स्वचालित रूप से नष्ट कर दिया जाएगा।

addEventListener

event की सदस्यता लेता है और यदि event fired होता है तो callback फ़ंक्शन को कॉल करता है।
यदि आप प्रदर्शन पर अधिक नियंत्रण चाहते हैं तो यह उपयोग किया जाता है।

सिंटैक्स

AdController.addEventListener('onReward', () => {
    // your code to reward user
});

पैरामीटर्स

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)