API انتخاب سفارشی Offerwall

مقدمه

API انتخاب سفارشی Offerwall به شما امکان می دهد راه حل کسب درآمد سفارشی خود را با Offerwall در Google Ad Manager ادغام کنید.

برای ادغام راه حل کسب درآمد خود با Offerwall، این مراحل تنظیم انتخاب سفارشی را دنبال کنید. به طور خلاصه:

  1. گزینه «انتخاب سفارشی» را برای Offerwall خود از داخل برگه حریم خصوصی و پیام در Ad Manager فعال کنید.

  2. جاوا اسکریپت سفارشی را بین تگ های <head> و </head> سایتی که Offerwall خود را در آن منتشر کرده اید، اضافه کنید.

  3. یک شی CustomOfferwallChoice را همانطور که در بخش های بعدی تعریف شده است، نمونه سازی کنید و آن را با Offerwall خود در پنجره ثبت کنید .

کد نمونه

برای شروع سریع، این نمونه کاری از اجرای Offerwall Custom Choice API را ببینید.

استفاده از API

CustomOfferwallChoice یک شی جاوا اسکریپت است که به 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();

تعاریف نوع API

این بخش هر نوع داده در API را توضیح می دهد.

تعاریف شی

این بخش هر تعریف شی در API را توضیح می دهد.

Params را راه اندازی کنید

نوع شی پارامتر برای تابع مقداردهی اولیه .

اموال تایپ کنید توضیحات
offerwallLanguageCode string | undefined کد زبان Offerwall شما که در حال ارائه است، همانطور که توسط BCP 47 تعریف شده است.

تعاریف Enum

این بخش هر تعریف enum در API را توضیح می دهد.

googlefc.offerwall.customchoice.InitializeResponseEnum

نوع enum پاسخ برای تابع مقداردهی اولیه .

عضو شمارش توضیحات
CUSTOM_CHOICE_DISABLED گزینه انتخاب سفارشی را در Offerwall خود غیرفعال کنید. اگر انتخاب سفارشی غیرفعال باشد، Offerwall شما فقط می‌تواند
ارائه با سایر گزینه های واجد شرایط؛ اگر هیچ گزینه دیگری واجد شرایط نباشد، Offerwall شما هرگز در صفحه نمایش داده نخواهد شد.
ACCESS_GRANTED اجازه دسترسی به صفحه کاربر در بارگذاری صفحه. اگر این پاسخ بازگردانده شود، Offerwall شما هرگز در صفحه نمایش داده نمی شود.
ACCESS_NOT_GRANTED هنگام بارگذاری صفحه به صفحه کاربر اجازه دسترسی ندهید. اگر این پاسخ بازگردانده شود، Offerwall شما واجد شرایط ارائه در صفحه است.