Offerwall Custom Choice API

Giriş

Offerwall Custom Choice API, kendi özel para kazanma çözümünüzü Google Ad Manager'daki Offerwall ile entegre etmenize olanak tanır.

Kendi para kazanma çözümünüzü Offerwall ile entegre etmek için Özel Seçim kurulumu adımlarını uygulayın. Özet olarak:

  1. Ad Manager'daki Gizlilik ve Mesajlaşma sekmesinden Offerwall'unuz için "Özel Seçim" seçeneğini etkinleştirin.

  2. Offerwall'unuzu yayınladığınız sitenin <head> ve </head> etiketleri arasına özel JavaScript ekleyin.

  3. Aşağıdaki bölümlerde tanımlandığı şekilde bir CustomOfferwallChoice nesnesi oluşturun ve pencerede Offerwall'unuzla kaydedin.

Örnek Kod

Hızlı bir başlangıç için Offerwall Custom Choice API uygulamasının çalışan örneğine göz atın.

API Kullanımı

CustomOfferwallChoice, özel para kazanma uygulamanızı entegre etmek için Offerwall'unuza bağladığınız bir JavaScript nesnesidir.

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

Yöntem Tanımları

Bu bölümde, CustomOfferwallChoice tarafından uygulanması gereken her yöntem açıklanmaktadır.

ilk kullanıma hazırlamak

initialize(params: InitializeParams): Promise<InitializeResponseEnum>

Özel para kazanma çözümünüzü başlatın. Bu işlev, diğer tüm işlevlerden önce çağrılır ve belirli bir sayfa yüklemesinde en fazla bir kez çağrılması beklenir.

Örnek

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

göster

show(): Promise<boolean>

Özel para kazanma çözümünüzü oluşturun ve kullanıcının para kazanma işlemlerini yönetin. Bu yöntem, kullanıcı özel seçim seçeneğini tıkladığında Offerwall'unuz tarafından çağrılır. Para kazanma, abonelik hizmeti, mikro ödeme hizmeti ve ödüllü reklam gibi çeşitli biçimlerde olabilir. Bu işlev çağrıldığında, söz konusu söz çözülene kadar teklif duvarınız gizlenir ve bu süre zarfında sayfa içeriğine erişimi engellemek CustomOfferwallChoice'ın sorumluluğundadır. Bu sorun çözüldükten sonra CustomOfferwallChoice artık web sayfasında görünmemelidir.

show() işlevinin sözü yerine getirildiğinde şunları yapmanız gerekir:

  • Oluşturulan para kazanma çözümünüzü gizleyin.

  • Kullanıcının sayfa içeriğine erişim kazanıp kazanmadığını belirten bir Boole değeri döndürür:

    • true: Kullanıcı, sayfa içeriğine erişim kazandı. Bu durumda, söz konusu sorun çözüldüğünde Offerwall'unuz tekrar oluşturulmaz.
    • false: Kullanıcı, sayfa içeriğine erişemedi. Bu durumda, söz konusu sorun çözüldüğünde Offerwall'unuz tekrar oluşturulur.

Örnek

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

Özel Seçim Kaydı

Kayıt, oluşturulan CustomOfferwallChoice nesnenizi aşağıdaki pencere kayıt defterine iletmeyi içerir: window.googlefc.offerwall.customchoice.registry

Örnek

    // 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 Türü Tanımları

Bu bölümde, API'deki her veri türü açıklanmaktadır.

Nesne Tanımları

Bu bölümde, API'deki her bir nesne tanımı açıklanmaktadır.

InitializeParams

initialize işlevi için parametre nesnesi türü.

Mülk Tür Açıklama
offerwallLanguageCode string | undefined BCP 47 ile tanımlanan, sunulan Offerwall'unuzun dil kodu.

Enum Tanımları

Bu bölümde, API'deki her enum tanımı açıklanmaktadır.

googlefc.offerwall.customchoice.InitializeResponseEnum

initialize işlevi için yanıt enum türü.

Numaralandırma üyesi Açıklama
CUSTOM_CHOICE_DISABLED Offerwall'unuzda özel seçim seçeneğini devre dışı bırakın. Özel seçim devre dışıysa Offerwall'unuz yalnızca
diğer uygun seçimlerle birlikte oluşturulabilir. Başka uygun seçim yoksa Offerwall'unuz sayfada hiçbir zaman oluşturulmaz.
ACCESS_GRANTED Sayfa yüklendiğinde kullanıcıya sayfa erişimi verin. Bu yanıt döndürülürse Offerwall'unuz sayfada hiçbir zaman oluşturulmaz.
ACCESS_NOT_GRANTED Sayfa yüklendiğinde kullanıcıya sayfa erişimi vermeyin. Bu yanıt döndürülürse Offerwall'unuz sayfada oluşturulmaya uygundur.