विज्ञापन का कॉन्फ़िगरेशन

adConfig() कॉल, गेम के मौजूदा कॉन्फ़िगरेशन को विज्ञापन प्लेसमेंट एपीआई के बारे में बताता है. Ad Placement API इसका इस्तेमाल विज्ञापनों को पहले से लोड करने के तरीके और अनुरोध के हिसाब से विज्ञापन फ़िल्टर करने के लिए कर सकता है, ताकि वे सही हों (जैसे कि वे वीडियो विज्ञापन जिनमें आवाज़ की ज़रूरत होती है).

फ़ंक्शन हस्ताक्षर:

adConfig({
   preloadAdBreaks: 'on|auto',  // Ad preloading strategy
   sound: 'on|off'              // This game has sound
   onReady: () => {},           // Called when API has initialised and adBreak() is ready
});

adConfig पैरामीटर

नाम टाइप जानकारी
sound स्ट्रिंग (ज़रूरी नहीं) गेम में आवाज़ चल रही है या नहीं. वैल्यू:
- on (डिफ़ॉल्ट)
- off
इस कॉल से पता चलता है कि आपके गेम में, आवाज़ सुनने की सुविधा है या नहीं. साथ ही, यह भी पता चलता है कि adBreak() के कॉल से पहले, साउंड चालू की गई थी या नहीं (यानी अनम्यूट किया गया). इससे, विज्ञापन प्लेसमेंट एपीआई को आपके गेम के लिए सही विज्ञापन चुनने में मदद मिलती है.
गेम की आवाज़ बदलने पर, इस फ़ंक्शन को कॉल करें. ऐसा इसलिए, क्योंकि विज्ञापन प्लेसमेंट एपीआई को नए क्रिएटिव के लिए अनुरोध करना पड़ सकता है. साथ ही, ऐसा करने के लिए ज़्यादा से ज़्यादा समय भी मिलता है.

डिफ़ॉल्ट वैल्यू चालू है. इसलिए, जब ज़्यादातर गेम adConfig() के लिए आवाज़ की सुविधा चालू होने की जानकारी देते हैं, तो उन्हें कॉल करना होता है.
preloadAdBreaks स्ट्रिंग (ज़रूरी नहीं) adBreak() पर पहली बार कॉल करने से पहले विज्ञापन हमेशा पहले से लोड किए जाने चाहिए या नहीं. वैल्यू:
- on
- auto (डिफ़ॉल्ट)

auto की डिफ़ॉल्ट वैल्यू, विज्ञापन प्लेसमेंट एपीआई के फ़ैसले पर निर्भर करती है. preloadAdBreaks को adConfig() के साथ सिर्फ़ एक बार सेट किया जा सकता है. साथ ही, preloadAdBreaks को आगे की वैल्यू पर कोई असर नहीं पड़ेगा.
adBreak() पर पहले कॉल के बाद preloadAdBreaks सेट करने से कोई असर नहीं पड़ेगा.
onReady स्ट्रिंग (ज़रूरी नहीं) तब कॉल किया जाता है, जब एपीआई शुरू होता है और विज्ञापन पहले से लोड हो जाते हैं. ऐसा तब होता है, जब आपने ऊपर दिए गए preloadAdBreaks का इस्तेमाल करके, पहले से लोड करने का अनुरोध किया हो.