---
title: "AdsGram SDK API रेफरेंस"
description: "AdsGram JavaScript SDK का पूरा रेफरेंस: init मेथड, AdController मेथड्स (show, destroy, addEventListener), पैरामीटर और इवेंट टाइप्स।"
outline: [2,3]
---
# API संदर्भ

## Adsgram विधियाँ

### init
`AdController` बनाएं जो ad दिखाने, लोड करने और नष्ट करने के लिए उपयोग होता है।\
एक ही `blockId` के लिए केवल एक बार initialization करना पर्याप्त है।\
यदि आप एक ही `blockId` के साथ `init` फ़ंक्शन को एक से अधिक बार कॉल करते हैं, तो आपको उसी `blockId` के लिए एक ही `AdController` मिलेगा।
#### सिंटैक्स
```js
const AdController = window.Adsgram.init({
  blockId: "your-block-id",
  debug: true,
  debugConsole: true,
  debugBannerType: "FullscreenMedia"
});
```

#### पैरामीटर्स
`blockId`
> String with digits, for example `"123"`.\
> यह वह अनूठा पहचानकर्ता है जो आप [publisher के खाते](https://partner.adsgram.ai/) में प्राप्त करते हैं।\
> BlockId प्राप्त करने के लिए विस्तृत निर्देश [Get block-id section](./get-block-id) में देखें

`debug` <Badge type="info" text="Optional" />
> Boolean मान है। यदि इसे `true` पर सेट करते हैं तो आपको सर्वर से टेस्ट विज्ञापन के साथ प्रतिक्रिया मिलेगी और `ADSGRAM DEBUG LOG` प्रीफ़िक्स के साथ विस्तृत लॉग ब्राउज़र कंसोल में आउटपुट होंगे।
> ::: danger खतरा
> प्रोडक्शन में रिलीज़ करने से पहले इसे हटाना या `false` पर सेट करना न भूलें।\
> हम **test ad** इंप्रेशन को आँकड़ों में नहीं जोड़ते, इसलिए आप इसके इंप्रेशन, शो, क्लिक आदि की आँकड़े प्लेटफ़ॉर्म और ब्लॉक पेज पर नहीं देखेंगे।\
> Reward Url के लिए अनुरोध नहीं भेजा जाएगा।
> :::

`debugConsole` <Badge type="info" text="Optional" />
> Boolean मान। डिफ़ॉल्ट `true` है। यह केवल तभी काम करता है जब debug पैरामीटर `true` हो।\
> यदि `true` है, तो ब्राउज़र कंसोल में `ADSGRAM DEBUG LOG` प्रीफ़िक्स के साथ विस्तृत लॉग आउटपुट होंगे।\
> यदि `false` है, तो debug मोड में भी लॉग कंसोल में आउटपुट नहीं होंगे।

`debugBannerType` <Badge type="info" text="Optional" />
> संभावित मान हैं `"FullscreenMedia"` और `"RewardedVideo"`.\
> यह मान तब उपयोग करें जब आप विशेष टेस्ट बैनर प्रकार प्राप्त करना चाहते हैं। यह केवल तभी काम करता है जब debug पैरामीटर `true` हो।

#### रिटर्न वैल्यू
`AdController`

## AdController methods
### show
Ad लोड और दिखाता है।
#### सिंटैक्स
::: code-group
```js [javascript]
AdController.show();
```
```ts [typescript]
const showPromise: Promise<ShowPromiseResult> = AdController.show();
```
:::
#### रिटर्न वैल्यू
> `Promise` जो तब resolve होता है जब उपयोगकर्ता विज्ञापन अंत तक देखता है या Interstitial फ़ॉर्मैट में उसे बंद कर देता है, अन्यथा reject होता है।\
> प्रॉमिस के परिणाम के प्रकार निम्नलिखित हैं:
> ```ts
> interface ShowPromiseResult {
>   done: boolean; // true यदि उपयोगकर्ता अंत तक देखता है या interstitial फ़ॉर्मैट में बंद करता है, अन्यथा false
>   description: string; // इवेंट का विवरण
>   state: 'load' | 'render' | 'playing' | 'destroy'; // बैनर की स्थिति
>   error: boolean; // true यदि इवेंट त्रुटि के कारण हुआ, अन्यथा false
> }
> ```

#### उदाहरण
[promises API](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise/then) का उपयोग करते हुए:
::: code-group
```js [javascript]
AdController.show().then((result) => {
  // उपयोगकर्ता ने विज्ञापन अंत तक देखा या interstitial फ़ॉर्मैट में बंद किया
  // उपयोगकर्ता को इनाम देने के लिए आपका कोड
}).catch((result) => {
  // विज्ञापन चलाते समय त्रुटि हुई या उपयोगकर्ता ने विज्ञापन छोड़ दिया
  // कुछ न करें या अपनी ज़रूरत के अनुसार कार्रवाई करें
})
```
```ts [typescript]
AdController.show().then((result: ShowPromiseResult) => {
  // उपयोगकर्ता ने विज्ञापन अंत तक देखा या interstitial फ़ॉर्मैट में बंद किया
  // उपयोगकर्ता को इनाम देने के लिए आपका कोड
}).catch((result: ShowPromiseResult) => {
  // विज्ञापन चलाते समय त्रुटि हुई या उपयोगकर्ता ने विज्ञापन छोड़ दिया
  // कुछ न करें या अपनी ज़रूरत के अनुसार कार्रवाई करें
})
```
:::
आप उसी व्यवहार को [await](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await) का उपयोग करके भी प्राप्त कर सकते हैं:
::: code-group
```js [javascript]
try {
  const showPromiseResult = await AdController.show();
  // उपयोगकर्ता ने विज्ञापन अंत तक देखा या interstitial फ़ॉर्मैट में बंद किया
  // उपयोगकर्ता को इनाम देने के लिए आपका कोड
} catch (showPromiseResult) {
  // विज्ञापन चलाते समय त्रुटि हुई या उपयोगकर्ता ने विज्ञापन छोड़ दिया
  // कुछ न करें या अपनी ज़रूरत के अनुसार कार्रवाई करें
}
```
```ts [typescript]
try {
  const showPromiseResult: ShowPromiseResult = await AdController.show();
  // उपयोगकर्ता ने विज्ञापन अंत तक देखा या interstitial फ़ॉर्मैट में बंद किया
  // उपयोगकर्ता को इनाम देने के लिए आपका कोड
} catch (error) {
  const showPromiseResult = error as ShowPromiseResult;
  // विज्ञापन चलाते समय त्रुटि हुई या उपयोगकर्ता ने विज्ञापन छोड़ दिया
  // कुछ न करें या अपनी ज़रूरत के अनुसार कार्रवाई करें
}
```
:::
::: tip सुझाव
यदि आप चाहते हैं कि ad समाप्त होने के बाद, उसे छोड़ने पर या त्रुटि आने पर कोई अतिरिक्त कार्रवाई हो, तो `finally` के साथ प्रॉमिस chain करें।
:::
### destroy
Ad दिखाना बंद करने और लोड किए गए बैनर डेटा को हटाने के लिए।
#### सिंटैक्स
```js
AdController.destroy();
```
#### रिटर्न वैल्यू
> None(`undefined`)
::: info जानकारी
आमतौर पर आपको इसे मैन्युअल रूप से कॉल करने की आवश्यकता नहीं होती है, यदि कोई त्रुटि है, स्किप किया गया है या विज्ञापन पूरी तरह से देखा गया है, तो यह स्वचालित रूप से नष्ट कर दिया जाएगा।
:::
### addEventListener
`event` की सदस्यता लेता है और यदि `event` fired होता है तो `callback` फ़ंक्शन को कॉल करता है।\
यदि आप प्रदर्शन पर अधिक नियंत्रण चाहते हैं तो यह उपयोग किया जाता है।
#### सिंटैक्स
```js
AdController.addEventListener('onReward', () => {
    // उपयोगकर्ता को इनाम देने के लिए आपका कोड
});
```
#### पैरामीटर्स {#add-event-listener-parameters}
`event`
> ##### Events के प्रकार:
> | Event              | Occurs                                                             |
> |--------------------|--------------------------------------------------------------------|
> | `onStart`          | जब पहला बैनर फ़्रेम दिखाया जाता है                               |
> | `onSkip`           | जब उपयोगकर्ता विज्ञापन बंद करता है                              |
> | `onReward`         | जब उपयोगकर्ता reward प्राप्त करने के लिए rewarded banner को अंत तक देखता है                     |
> | `onComplete`       | जब उपयोगकर्ता interstitial banner को अंत तक देखता है या बंद कर देता है     |
> | `onError`          | जब उपयोगकर्ता को render या play करते समय त्रुटि होती है        |
> | `onBannerNotFound` | जब दिखाने के लिए कोई बैनर नहीं है                                 |
> | `onNonStopShow`    | जब उपयोगकर्ता लगातार कई विज्ञापन देखने की कोशिश कर रहा है                  |
> | `onTooLongSession` | जब सत्र बहुत लंबा है, उपयोगकर्ता को फिर से शुरू करना चाहिए | 
>
> ::: tip सुझाव
> यदि आप अपनी कस्टम अलर्ट दिखाना चाहते हैं, तो आप `onBannerNotFound`, `onNonStopShow` या `onTooLongSession` की सदस्यता ले सकते हैं।\
> अन्यथा हम डिफ़ॉल्ट अलर्ट दिखाएँगे।\
> अलर्ट उपयोगकर्ता की भाषा या अंग्रेजी में दिखाया जाता है और इस तरह होता है 👇
> <img src="../../publisher/images/default_alert_banner.webp" alt="alert" width="300" />
> :::

`callback`
> फ़ंक्शन जो निर्दिष्ट प्रकार के event के होने पर कॉल किया जाएगा।

#### रिटर्न वैल्यू
> None(`undefined`)
### removeEventListener
`event` की सदस्यता रद्द करता है जिसमे `callback` निर्धारित किया गया हो।
#### सिंटैक्स
```ts
AdController.removeEventListener('onReward', rewardFunction);
```
#### पैरामीटर्स
[addEventListener](#add-event-listener-parameters) के समान

#### रिटर्न वैल्यू
> None(`undefined`)
