Interfejs API do obsługi niestandardowych opcji w wiadomości typu Offerwall

Wprowadzenie

Interfejs Offerwall Custom Choice API umożliwia zintegrowanie własnego rozwiązania do generowania przychodu z Offerwall w usłudze Google Ad Manager.

Aby zintegrować własne rozwiązanie do generowania przychodu z wiadomością typu Offerwall, wykonaj te czynności konfigurowania opcji niestandardowej. Podsumowanie:

  1. Włącz opcję „Opcja niestandardowa” dla funkcji Offerwall na karcie Prywatność i wyświetlanie wiadomości w usłudze Ad Manager.

  2. Dodaj niestandardowy kod JavaScript między tagami <head> i </head> w witrynie, w której opublikowano wiadomość typu Offerwall.

  3. Utwórz instancję obiektu CustomOfferwallChoice zgodnie z opisem w kolejnych sekcjach i zarejestruj ją w wiadomości typu Offerwall w oknie.

Przykładowy kod

Aby szybko rozpocząć, zapoznaj się z tym działającym przykładem implementacji interfejsu Offerwall Custom Choice API.

Używanie API

CustomOfferwallChoice to obiekt JavaScript, który możesz podłączyć do wiadomości typu Offerwall, aby zintegrować niestandardową implementację generowania przychodu.

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

Definicje metod

W tej sekcji opisujemy każdą metodę, którą CustomOfferwallChoice musi wdrożyć.

inicjować,

initialize(params: InitializeParams): Promise<InitializeResponseEnum>

Zainicjuj niestandardowe rozwiązanie do generowania przychodu. Ta funkcja jest wywoływana przed każdą inną funkcją i może być wywoływana co najwyżej raz podczas wczytywania danej strony.

Przykład

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

pokaż

show(): Promise<boolean>

Wyświetlaj niestandardowe rozwiązanie do generowania przychodu i obsługuj działania użytkownika związane z generowaniem przychodu. Ta metoda jest wywoływana przez wiadomość typu Offerwall, gdy użytkownik kliknie opcję niestandardową. Monetyzacja może przybierać różne formy, w tym subskrypcję, mikropłatności, reklamy z nagrodą i inne. Po wywołaniu ściana ofert jest ukryta do czasu rozstrzygnięcia tej obietnicy. W tym czasie za blokowanie treści na stronie odpowiada CustomOfferwallChoice. Gdy ta obietnica zostanie spełniona, CustomOfferwallChoice nie może już być widoczny na stronie.

Po spełnieniu obietnicy funkcji show() musisz:

  • Ukryj wyrenderowane rozwiązanie do zarabiania.

  • Zwróć wartość logiczną wskazującą, czy użytkownik uzyskał dostęp do treści strony:

    • true: użytkownik uzyskał dostęp do treści strony. W takim przypadku wiadomość typu Offerwall nie będzie ponownie renderowana po rozwiązaniu obietnicy.
    • false: użytkownik nie uzyskał dostępu do treści strony. W takim przypadku wiadomość typu Offerwall zostanie ponownie wyrenderowana po rozwiązaniu obietnicy.

Przykład

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

Rejestracja opcji niestandardowej

Rejestracja obejmuje przekazanie utworzonego obiektu CustomOfferwallChoice do tego rejestru okien:window.googlefc.offerwall.customchoice.registry

Przykład

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

Definicje typów interfejsów API

W tej sekcji opisujemy każdy typ danych w interfejsie API.

Definicje obiektów

W tej sekcji opisano definicje poszczególnych obiektów w interfejsie API.

InitializeParams

Typ obiektu parametru dla funkcji initialize.

Właściwość Typ Opis
offerwallLanguageCode string | undefined Kod języka wyświetlanej wiadomości typu Offerwall zdefiniowany zgodnie ze standardem BCP 47.

Definicje typu wyliczeniowego

W tej sekcji opisano każdą definicję wyliczenia w interfejsie API.

googlefc.offerwall.customchoice.InitializeResponseEnum

Typ wyliczeniowy odpowiedzi dla funkcji initialize.

Element wyliczenia Opis
CUSTOM_CHOICE_DISABLED Wyłącz opcję niestandardową w wiadomości typu Offerwall. Jeśli opcja wyboru niestandardowego jest wyłączona, wiadomość typu Offerwall może być wyświetlana tylko z innymi kwalifikującymi się opcjami. Jeśli żadne inne opcje nie kwalifikują się, wiadomość typu Offerwall nigdy nie będzie wyświetlana na stronie.
ACCESS_GRANTED Przyznaj użytkownikowi dostęp do strony podczas jej wczytywania. Jeśli ta odpowiedź zostanie zwrócona, wiadomość typu Offerwall nigdy nie pojawi się na stronie.
ACCESS_NOT_GRANTED Nie przyznawaj użytkownikowi dostępu do strony podczas jej wczytywania. Jeśli zostanie zwrócona ta odpowiedź, wiadomość typu Offerwall może się wyświetlać na stronie.