Offerwall Custom Choice API

Pengantar

Offerwall Custom Choice API memungkinkan Anda mengintegrasikan solusi monetisasi kustom Anda sendiri dengan Offerwall di Google Ad Manager.

Untuk mengintegrasikan solusi monetisasi Anda sendiri dengan Offerwall, ikuti langkah-langkah penyiapan Pilihan Kustom ini. Rangkuman:

  1. Aktifkan opsi "Pilihan Kustom" untuk Offerwall Anda dari dalam tab Privasi & pesan di Ad Manager.

  2. Tambahkan JavaScript kustom di antara tag <head> dan </head> di situs tempat Anda memublikasikan Offerwall.

  3. Buat instance objek CustomOfferwallChoice seperti yang ditentukan di bagian berikutnya, dan daftarkan dengan Offerwall Anda di jendela.

Kode Contoh

Untuk memulai dengan cepat, lihat contoh penerapan Offerwall Custom Choice API yang berfungsi ini.

Penggunaan API

CustomOfferwallChoice adalah objek JavaScript yang Anda masukkan ke Offerwall untuk mengintegrasikan penerapan monetisasi kustom Anda.

// 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();

Definisi Metode

Bagian ini menjelaskan setiap metode yang harus diterapkan oleh CustomOfferwallChoice.

initialize

initialize(params: InitializeParams): Promise<InitializeResponseEnum>

Lakukan inisialisasi solusi monetisasi kustom Anda. Fungsi ini dipanggil sebelum fungsi lainnya, dan dapat diharapkan dipanggil paling banyak satu kali pada pemuatan halaman tertentu.

Contoh

  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);
  }

tunjukkan

show(): Promise<boolean>

Tampilkan solusi monetisasi kustom Anda dan tangani tindakan monetisasi pengguna. Metode ini dipanggil oleh Offerwall Anda saat pengguna mengklik opsi pilihan kustom. Monetisasi dapat berbentuk apa pun, termasuk layanan langganan, layanan pembayaran mikro, iklan reward, dan lainnya. Saat dipanggil, Offerwall Anda disembunyikan hingga janji ini diselesaikan dan CustomOfferwallChoice Anda bertanggung jawab untuk membatasi konten halaman untuk sementara. Setelah janji ini dipenuhi, CustomOfferwallChoice Anda tidak boleh lagi terlihat di halaman web.

Setelah penyelesaian promise fungsi show(), Anda harus:

  • Menyembunyikan solusi monetisasi yang dirender.

  • Menampilkan nilai boolean yang menunjukkan apakah pengguna mendapatkan akses ke konten halaman:

    • true: Pengguna mendapatkan akses ke konten halaman. Dalam hal ini, Offerwall Anda tidak akan dirender lagi setelah penyelesaian promise.
    • false: Pengguna tidak mendapatkan akses ke konten halaman. Dalam hal ini, Offerwall Anda akan dirender lagi setelah penyelesaian promise.

Contoh

  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);
  }

Pendaftaran Pilihan Kustom

Pendaftaran mencakup meneruskan objek CustomOfferwallChoice yang di-instance ke registry jendela berikut: window.googlefc.offerwall.customchoice.registry

Contoh

    // 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();

Definisi Jenis API

Bagian ini menjelaskan setiap jenis data di API.

Definisi Objek

Bagian ini menjelaskan setiap definisi objek dalam API.

InitializeParams

Jenis objek parameter untuk fungsi initialize.

Properti Jenis Deskripsi
offerwallLanguageCode string | undefined Kode bahasa Offerwall yang ditayangkan, sebagaimana ditentukan oleh BCP 47.

Definisi Enum

Bagian ini menjelaskan setiap definisi enum dalam API.

googlefc.offerwall.customchoice.InitializeResponseEnum

Jenis enum respons untuk fungsi initialize.

Anggota enumerasi Deskripsi
CUSTOM_CHOICE_DISABLED Nonaktifkan opsi pilihan kustom di Offerwall Anda. Jika pilihan kustom dinonaktifkan, Offerwall Anda hanya dapat
dirender dengan pilihan lain yang memenuhi syarat; jika tidak ada pilihan lain yang memenuhi syarat, Offerwall Anda tidak akan pernah dirender di halaman.
ACCESS_GRANTED Memberi pengguna akses halaman saat halaman dimuat. Offerwall Anda tidak akan pernah dirender di halaman jika respons ini ditampilkan.
ACCESS_NOT_GRANTED Jangan berikan akses halaman pengguna saat halaman dimuat. Offerwall Anda memenuhi syarat untuk dirender di halaman jika respons ini ditampilkan.