Offerwall Custom Choice API

Einführung

Mit der Offerwall Custom Choice API können Sie Ihre eigene benutzerdefinierte Monetarisierungslösung in die Offerwall in Google Ad Manager einbinden.

Wenn Sie Ihre eigene Monetarisierungslösung in die Offerwall einbinden möchten, folgen Sie dieser Anleitung zur Einrichtung der benutzerdefinierten Auswahl. Zusammenfassung:

  1. Aktivieren Sie die Option „Benutzerdefinierte Auswahl“ für Ihre Offerwall auf dem Tab Datenschutz und Mitteilungen in Ad Manager.

  2. Fügen Sie benutzerdefiniertes JavaScript zwischen den <head>- und </head>-Tags der Website ein, auf der Sie Ihre Offerwall veröffentlicht haben.

  3. Erstellen Sie ein CustomOfferwallChoice-Objekt wie in den folgenden Abschnitten definiert und registrieren Sie es in Ihrem Offerwall-Fenster.

API-Verwendung

CustomOfferwallChoice ist ein JavaScript-Objekt, das Sie in Ihre Offerwall einbinden, um Ihre benutzerdefinierte Monetarisierungsimplementierung zu integrieren.

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

Methodendefinitionen

In diesem Abschnitt werden die einzelnen Methoden beschrieben, die eine CustomOfferwallChoice implementieren muss.

initialize

initialize(params: InitializeParams): Promise<InitializeResponseEnum>

Ihre benutzerdefinierte Monetarisierungslösung initialisieren Diese Funktion wird vor allen anderen Funktionen aufgerufen und wird bei einem bestimmten Seitenladevorgang voraussichtlich höchstens einmal aufgerufen.

Beispiel

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

Einblenden

show(): Promise<boolean>

Rendere deine benutzerdefinierte Monetarisierungslösung und handel mit den Monetarisierungsaktionen des Nutzers. Diese Methode wird von Ihrer Offerwall aufgerufen, wenn der Nutzer auf die Option „Benutzerdefinierte Auswahl“ klickt. Die Monetarisierung kann verschiedene Formen haben, z. B. Abodienste, Mikrozahlungsdienste oder Anzeigen mit Prämie. Wenn die Warnung angezeigt wird, wird Ihre Offerwall ausgeblendet, bis das Problem behoben ist. In der Zwischenzeit ist es Sache Ihres CustomOfferwallChoice, die Seite zu sperren. Sobald dieses Versprechen erfüllt ist, darf Ihre CustomOfferwallChoice nicht mehr auf der Webseite sichtbar sein.

Nach der Auflösung des Versprechens der show()-Funktion müssen Sie Folgendes tun:

  • Renderte Monetarisierungslösung ausblenden

  • Gibt einen booleschen Wert zurück, der angibt, ob der Nutzer Zugriff auf den Seiteninhalt erhalten hat:

    • true: Der Nutzer hat Zugriff auf den Seiteninhalt erhalten. In diesem Fall wird Ihre Offerwall nach der Erfüllung des Versprechens nicht noch einmal gerendert.
    • false: Der Nutzer konnte nicht auf den Seiteninhalt zugreifen. In diesem Fall wird Ihre Offerwall nach der Erfüllung des Versprechens noch einmal gerendert.

Beispiel

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

Registrierung für die benutzerdefinierte Auswahl

Die Registrierung umfasst das Übergeben des instanziierten CustomOfferwallChoice-Objekts an die folgende Fensterregistrierung: window.googlefc.offerwall.customchoice.registry

Beispiel

    // 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-Typdefinitionen

In diesem Abschnitt werden die einzelnen Datentypen in der API beschrieben.

Objektdefinitionen

In diesem Abschnitt werden alle Objektdefinitionen in der API beschrieben.

InitializeParams

Der Parameterobjekttyp für die Funktion initialize.

Attribut Typ Beschreibung
offerwallLanguageCode string | undefined Der Sprachcode Ihrer Offerwall, der gemäß BCP 47 ausgeliefert wird.

Enumerationsdefinitionen

In diesem Abschnitt werden alle Enum-Definitionen in der API beschrieben.

googlefc.offerwall.customchoice.InitializeResponseEnum

Der Enumerationstyp der Antwort für die Funktion initialize.

Aufzählungselement Beschreibung
CUSTOM_CHOICE_DISABLED Deaktivieren Sie die Option „Benutzerdefinierte Auswahl“ in Ihrer Offerwall. Wenn die benutzerdefinierte Auswahl deaktiviert ist, kann Ihre Offerwall nur
mit anderen infrage kommenden Optionen gerendert werden. Wenn keine anderen Optionen infrage kommen, wird Ihre Offerwall auf der Seite nicht gerendert.
ACCESS_GRANTED Gewähren Sie der Nutzerseite beim Laden der Seite Zugriff. Wenn diese Antwort zurückgegeben wird, wird Ihre Offerwall nicht auf der Seite gerendert.
ACCESS_NOT_GRANTED Gewähren Sie der Nutzerseite beim Laden der Seite keinen Zugriff. Ihre Offerwall kann auf der Seite gerendert werden, wenn diese Antwort zurückgegeben wird.