परिचय
Offerwall Custom Choice API की मदद से, कमाई करने के अपने तरीके को Google Ad Manager में Offerwall के साथ इंटिग्रेट किया जा सकता है.
कमाई करने के अपने तरीके को Offerwall के साथ इंटिग्रेट करने के लिए, पसंद के मुताबिक बनाए गए विकल्प को सेट अप करने के ये चरण पूरे करें. सारांश में:
Ad Manager में निजता और मैसेज सेवा टैब में जाकर, अपने Offerwall के लिए "कस्टम विकल्प" को चालू करें.
उस साइट के
<head>और</head>टैग के बीच कस्टम JavaScript जोड़ें जहां आपने Offerwall पब्लिश किया है.यहां दिए गए सेक्शन में बताए गए तरीके से,
CustomOfferwallChoiceऑब्जेक्ट को इंस्टैंटिएट करें. इसके बाद, इसे विंडो पर अपने Offerwall के साथ रजिस्टर करें.
नमूना कोड
जल्दी से शुरू करने के लिए, Offerwall Custom Choice API को लागू करने का यह काम करने वाला सैंपल देखें.
एपीआई प्रयोग
CustomOfferwallChoice एक JavaScript ऑब्जेक्ट है. इसे Offerwall में प्लग इन किया जाता है, ताकि कमाई करने के अपने तरीके को इंटिग्रेट किया जा सके.
// Define your custom choice.
class CustomOfferwallChoice {
// Initialize your custom choice, which may include loading or preparing any
// resources required to function.
async initialize(params: InitializeParams): Promise<InitializeResponseEnum> {...}
// Show your custom choice on the web page, which may be a subscription
// service, micropayments service, rewarded ad, etc.
async show(): Promise<boolean> {...}
}
// Register your custom choice with your Offerwall.
window.googlefc = window.googlefc || {};
window.googlefc.offerwall = window.googlefc.offerwall || {};
window.googlefc.offerwall.customchoice = window.googlefc.offerwall.customchoice || {};
window.googlefc.offerwall.customchoice.registry = new CustomOfferwallChoice();
तरीकों की परिभाषाएं
इस सेक्शन में, हर उस तरीके के बारे में बताया गया है जिसे CustomOfferwallChoice को लागू करना ज़रूरी है.
शुरू करें
initialize(params: InitializeParams): Promise<InitializeResponseEnum>
अपने हिसाब से कमाई करने के तरीके को शुरू करें. इस फ़ंक्शन को किसी भी दूसरे फ़ंक्शन से पहले लागू किया जाता है. साथ ही, पेज लोड होने पर इसे ज़्यादा से ज़्यादा एक बार लागू किया जा सकता है.
उदाहरण
async initialize(params: InitializeParams): Promise<InitializeResponseEnum> {
// If your custom choice is inoperable on this page, return CUSTOM_CHOICE_DISABLED,
// causing your Offerwall to exclude the custom choice option when rendering.
const isCustomChoiceEnabled: boolean = await this.initializeCustomOfferwallChoice(params);
if (!isCustomChoiceEnabled) {
resolve(googlefc.offerwall.customchoice.InitializeResponseEnum.CUSTOM_CHOICE_DISABLED);
}
// If the user should automatically be granted page access on page load, return
// ACCESS_GRANTED, causing your Offerwall to be ineligible to render on this page.
const isAccessGranted: boolean = await this.shouldUserBeGrantedPageAccess();
if (isAccessGranted) {
resolve(googlefc.offerwall.customchoice.InitializeResponseEnum.ACCESS_GRANTED);
}
// If the user shouldn't automatically be granted page access on page load, return
// ACCESS_NOT_GRANTED, causing your Offerwall to be eligible to render on this page.
resolve(googlefc.offerwall.customchoice.InitializeResponseEnum.ACCESS_NOT_GRANTED);
}
दिखाएं
show(): Promise<boolean>
कमाई करने के अपने तरीके को रेंडर करें और उपयोगकर्ता की कमाई करने से जुड़ी कार्रवाइयों को मैनेज करें. जब उपयोगकर्ता, कस्टम चॉइस विकल्प पर क्लिक करता है, तब आपका Offerwall इस तरीके को लागू करता है. कमाई करने के कई तरीके हो सकते हैं. जैसे, सदस्यता सेवा, माइक्रोपेमेंट सेवा, इनाम वाला विज्ञापन वगैरह. इस फ़ंक्शन को शुरू करने पर, आपका Offerwall तब तक नहीं दिखता, जब तक यह प्रॉमिस पूरा नहीं हो जाता. इस दौरान, पेज के कॉन्टेंट को गेट करने की ज़िम्मेदारी आपके CustomOfferwallChoice की होती है. इस समस्या के ठीक हो जाने के बाद, यह ज़रूरी है कि आपका CustomOfferwallChoice वेब पेज पर न दिखे.
show() फ़ंक्शन के प्रॉमिस के पूरा होने पर, आपको यह करना होगा:
रेंडर किए गए कमाई करने के समाधान को छिपाएं.
बूलियन वैल्यू दिखाएं, जिससे यह पता चले कि उपयोगकर्ता को पेज के कॉन्टेंट का ऐक्सेस मिला है या नहीं:
true: उपयोगकर्ता को पेज के कॉन्टेंट का ऐक्सेस मिल गया है. इस मामले में, वादा पूरा होने पर आपका Offerwall फिर से रेंडर नहीं किया जाएगा.false: उपयोगकर्ता को पेज का कॉन्टेंट ऐक्सेस करने की अनुमति नहीं मिली. इस मामले में, वादा पूरा होने के बाद आपकी Offerwall फिर से रेंडर हो जाएगी.
उदाहरण
async show(): Promise<boolean> {
// Show your custom choice dialog and hide it once the user completes an action.
const didUserGainAccessToPage: boolean = await this.showCustomChoiceDialogUntilUserAction();
resolve(didUserGainAccessToPage);
}
पसंद के मुताबिक विकल्प चुनने की सुविधा के लिए रजिस्ट्रेशन
रजिस्ट्रेशन में, इंस्टैंटिएट किए गए CustomOfferwallChoice ऑब्जेक्ट को विंडो रजिस्ट्री में पास करना शामिल है:
window.googlefc.offerwall.customchoice.registry
उदाहरण
// Register your custom choice with your Offerwall.
window.googlefc = window.googlefc || {};
window.googlefc.offerwall = window.googlefc.offerwall || {};
window.googlefc.offerwall.customchoice = window.googlefc.offerwall.customchoice || {};
window.googlefc.offerwall.customchoice.registry = new CustomOfferwallChoice();
एपीआई टाइप डेफ़िनिशन
इस सेक्शन में, एपीआई में मौजूद हर डेटा टाइप के बारे में बताया गया है.
ऑब्जेक्ट की परिभाषाएं
इस सेक्शन में, एपीआई में मौजूद हर ऑब्जेक्ट की परिभाषा के बारे में बताया गया है.
InitializeParams
initialize फ़ंक्शन के लिए पैरामीटर ऑब्जेक्ट टाइप.
| प्रॉपर्टी | टाइप | ब्यौरा |
|---|---|---|
offerwallLanguageCode |
string | undefined |
BCP 47 के मुताबिक, दिखाए जा रहे Offerwall का भाषा कोड. |
Enum की परिभाषाएं
इस सेक्शन में, एपीआई में मौजूद हर enum की परिभाषा के बारे में बताया गया है.
googlefc.offerwall.customchoice.InitializeResponseEnum
initialize फ़ंक्शन के लिए, जवाब के एनम टाइप की सूची.
| एन्यूमरेशन का सदस्य | ब्यौरा |
|---|---|
CUSTOM_CHOICE_DISABLED
|
अपने Offerwall में, पसंद के मुताबिक विकल्प बनाने की सुविधा बंद करें. कस्टम विकल्प बंद होने पर, आपका Offerwall सिर्फ़ ज़रूरी शर्तें पूरी करने वाले अन्य विकल्पों के साथ रेंडर हो सकता है. अगर कोई भी विकल्प ज़रूरी शर्तें पूरी नहीं करता है, तो आपका Offerwall पेज पर कभी रेंडर नहीं होगा. |
ACCESS_GRANTED |
पेज लोड होने पर, उपयोगकर्ता को पेज का ऐक्सेस दें. अगर यह जवाब मिलता है, तो आपका Offerwall कभी भी पेज पर रेंडर नहीं होगा. |
ACCESS_NOT_GRANTED |
पेज लोड होने पर, उपयोगकर्ता को पेज का ऐक्सेस न दें. अगर यह जवाब मिलता है, तो इसका मतलब है कि आपका Offerwall पेज पर रेंडर किया जा सकता है. |