Offerwall Custom Choice API

Introduzione

L'API Offerwall Custom Choice ti consente di integrare la tua soluzione di monetizzazione personalizzata con Offerwall in Google Ad Manager.

Per integrare la tua soluzione di monetizzazione con Offerwall, segui questi passaggi per la configurazione della scelta personalizzata. In sintesi:

  1. Attiva l'opzione"Scelta personalizzata " per il tuo Offerwall dalla scheda Privacy e messaggi in Ad Manager.

  2. Aggiungi il codice JavaScript personalizzato tra i tag <head> e </head> del sito in cui hai pubblicato la tua Offerwall.

  3. Crea un'istanza di un oggetto CustomOfferwallChoice come definito nelle sezioni seguenti e registralo con la tua Offerwall nella finestra.

Codice di esempio

Per iniziare rapidamente, consulta questo esempio di implementazione dell'API Offerwall Custom Choice.

Uso dell'API

CustomOfferwallChoice è un oggetto JavaScript che colleghi alla tua Offerwall per integrare l'implementazione di monetizzazione personalizzata.

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

Definizioni dei metodi

Questa sezione descrive ciascun metodo che un CustomOfferwallChoice è tenuto a implementare.

initialize

initialize(params: InitializeParams): Promise<InitializeResponseEnum>

Inizializza la soluzione di monetizzazione personalizzata. Questa funzione viene richiamata prima di qualsiasi altra funzione e può essere richiamata al massimo una volta durante un determinato caricamento della pagina.

Esempio

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

mostra

show(): Promise<boolean>

Esegui il rendering della soluzione di monetizzazione personalizzata e gestisci le azioni di monetizzazione dell'utente. Questo metodo viene richiamato dalla Offerwall quando l'utente fa clic sull'opzione di scelta personalizzata. La monetizzazione può assumere qualsiasi forma, inclusi un servizio di abbonamento, un servizio di micropagamenti, un annuncio con premio e altro ancora. Quando viene richiamata, la tua Offerwall viene nascosta finché questa promessa non viene risolta ed è responsabilità del tuo CustomOfferwallChoice controllare i contenuti della pagina nel frattempo. Una volta risolta questa promessa, il tuo CustomOfferwallChoice non deve più essere visibile sulla pagina web.

Una volta risolta la promessa della funzione show(), devi:

  • Nascondi la soluzione di monetizzazione di cui è stato eseguito il rendering.

  • Restituisce un valore booleano che indica se l'utente ha ottenuto l'accesso ai contenuti della pagina:

    • true: L'utente ha ottenuto l'accesso ai contenuti della pagina. In questo caso, la Offerwall non verrà visualizzata di nuovo al momento della risoluzione della promessa.
    • false: l'utente non ha ottenuto l'accesso ai contenuti della pagina. In questo caso, l'Offerwall verrà visualizzato di nuovo una volta risolta la promessa.

Esempio

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

Registrazione di Scelta personalizzata

La registrazione include il passaggio dell'oggetto CustomOfferwallChoice di cui è stata creata un'istanza al seguente registro di Windows: window.googlefc.offerwall.customchoice.registry

Esempio

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

Definizioni dei tipi di API

Questa sezione descrive ogni tipo di dati nell'API.

Definizioni dell'oggetto

Questa sezione descrive ogni definizione di oggetto nell'API.

InitializeParams

Il tipo di oggetto parametro per la funzione initialize.

Proprietà Tipo Descrizione
offerwallLanguageCode string | undefined Il codice lingua della Offerwall pubblicata, come definito da BCP 47.

Definizioni enum

Questa sezione descrive ogni definizione di enumerazione nell'API.

googlefc.offerwall.customchoice.InitializeResponseEnum

Il tipo di enumerazione della risposta per la funzione initialize.

Membro dell'enumerazione Descrizione
CUSTOM_CHOICE_DISABLED Disattiva l'opzione di scelta personalizzata nella tua Offerwall. Se la scelta personalizzata è disattivata, la Offerwall può essere visualizzata solo con altre scelte idonee. Se non sono presenti altre scelte idonee, la Offerwall non verrà mai visualizzata sulla pagina.
ACCESS_GRANTED Concedi l'accesso alla pagina utente durante il caricamento della pagina. La Offerwall non verrà mai visualizzata sulla pagina se viene restituita questa risposta.
ACCESS_NOT_GRANTED Non concedere l'accesso alla pagina utente al caricamento della pagina. La tua Offerwall è idonea per il rendering sulla pagina se viene restituita questa risposta.