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 der Anleitung zum Einrichten 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. Instanziieren Sie ein CustomOfferwallChoice-Objekt, wie in den folgenden Abschnitten beschrieben, und registrieren Sie es mit Ihrer Offerwall im Fenster.

Beispielcode

Hier finden Sie ein funktionierendes Beispiel für die Implementierung der Offerwall Custom Choice API.

API-Verwendung

Ein CustomOfferwallChoice ist ein JavaScript-Objekt, das Sie in Ihre Offerwall einfügen, 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 ein CustomOfferwallChoice implementieren muss.

initialize

initialize(params: InitializeParams): Promise<InitializeResponseEnum>

Initialisieren Sie Ihre benutzerdefinierte Monetarisierungslösung. Diese Funktion wird vor allen anderen Funktionen aufgerufen und kann höchstens einmal pro Seitenaufruf aufgerufen werden.

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>

Rendern Sie Ihre benutzerdefinierte Monetarisierungslösung und verarbeiten Sie die Monetarisierungsaktionen des Nutzers. Diese Methode wird von Ihrer Offerwall aufgerufen, wenn der Nutzer auf die Option für die benutzerdefinierte Auswahl klickt. Die Monetarisierung kann verschiedene Formen annehmen, z. B. ein Aboservice, ein Mikrozahlungsservice oder Anzeigen mit Prämie. Wenn die Offerwall aufgerufen wird, wird sie ausgeblendet, bis dieses Versprechen eingelöst wurde. Es liegt in der Verantwortung von CustomOfferwallChoice, die Seiteninhalte in der Zwischenzeit zu sperren. Sobald dieses Promise aufgelöst wurde, darf CustomOfferwallChoice nicht mehr auf der Webseite sichtbar sein.

Nachdem das Versprechen der show()-Funktion aufgelöst wurde, müssen Sie Folgendes tun:

  • Blenden Sie Ihre gerenderte Monetarisierungslösung aus.

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

    • true: Der Nutzer hat Zugriff auf Seiteninhalte erhalten. In diesem Fall wird die Offerwall nach der Einlösung des Versprechens nicht noch einmal gerendert.
    • false: Der Nutzer hat keinen Zugriff auf Seiteninhalte erhalten. In diesem Fall wird Ihre Offerwall nach der Auflösung des Promise 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

Bei der Registrierung müssen Sie Ihr instanziiertes CustomOfferwallChoice-Objekt an die folgende Fensterregistrierung übergeben: 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 die einzelnen Objektdefinitionen in der API beschrieben.

InitializeParams

Der Parametertyp für die Funktion initialize.

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

Enum-Definitionen

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

googlefc.offerwall.customchoice.InitializeResponseEnum

Der Antwort-Enum-Typ 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 Auswahlmöglichkeiten gerendert werden. Wenn keine anderen Auswahlmöglichkeiten infrage kommen, wird Ihre Offerwall nie auf der Seite gerendert.
ACCESS_GRANTED Gewähren Sie dem Nutzer beim Laden der Seite Zugriff auf die Seite. Ihre Offerwall wird auf der Seite nie gerendert, wenn diese Antwort zurückgegeben wird.
ACCESS_NOT_GRANTED Gewähren Sie dem Nutzer beim Laden der Seite keinen Seitenzugriff. Ihre Offerwall kann auf der Seite gerendert werden, wenn diese Antwort zurückgegeben wird.