Offerwall Custom Choice API

מבוא

ממשק ה-API לבחירה מותאמת אישית של Offerwall מאפשר לכם לשלב פתרון מונטיזציה מותאם אישית משלכם עם Offerwall ב-Google Ad Manager.

כדי לשלב פתרון מונטיזציה משלכם עם Offerwall, צריך לפעול לפי השלבים של הגדרת בחירה מותאמת אישית. לסיכום:

  1. בכרטיסייה פרטיות והודעות ב-Ad Manager, מפעילים את האפשרות 'בחירה בהתאמה אישית' עבור Offerwall.

  2. מוסיפים JavaScript בהתאמה אישית בין התגים <head> ו-</head> באתר שבו פרסמתם את הודעת ה-Offerwall.

  3. יוצרים מופע של אובייקט CustomOfferwallChoice כמו שמוגדר בקטעים הבאים, ורושמים אותו ב-Offerwall בחלון.

קוד לדוגמה

כדי להתחיל במהירות, אפשר לעיין בדוגמה של הטמעה של ממשק ה-API של הבחירה המותאמת אישית ב-Offerwall.

שימוש ב-API

‫CustomOfferwallChoice הוא אובייקט JavaScript שמשלבים בהודעת Offerwall כדי להטמיע פתרון מונטיזציה בהתאמה אישית.

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

הגדרות של שיטות

בקטע הזה מתוארת כל שיטה שנדרשת להטמעה של CustomOfferwallChoice.

אתחול

initialize(params: InitializeParams): Promise<InitializeResponseEnum>

מאתחלים את פתרון המונטיזציה בהתאמה אישית. הפונקציה הזו מופעלת לפני כל פונקציה אחרת, ואפשר לצפות שהיא תופעל פעם אחת לכל היותר בכל טעינת דף.

דוגמה

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

הצג

show(): Promise<boolean>

הצגת פתרון המונטיזציה המותאם אישית וטיפול בפעולות המונטיזציה של המשתמש. השיטה הזו מופעלת על ידי הודעת ה-Offerwall כשמשתמש לוחץ על אפשרות הבחירה המותאמת אישית. מונטיזציה יכולה להיות בכל צורה, כולל שירות מינויים, שירות מיקרו-תשלומים, מודעה מתגמלת ועוד. כשמפעילים את הקוד, חומת התשלום נסתרת עד שההבטחה הזו מתקיימת, והאחריות של CustomOfferwallChoice היא להגביל את הגישה לתוכן הדף בינתיים. אחרי שההבטחה הזו תתממש, חשוב לוודא שהרכיב CustomOfferwallChoice לא יוצג יותר בדף האינטרנט.

אחרי שההבטחה של הפונקציה show() נפתרת, צריך:

  • הסתרת פתרון המונטיזציה שעבר רינדור.

  • הפונקציה מחזירה ערך בוליאני שמציין אם המשתמש קיבל גישה לתוכן הדף:

    • ‫true: המשתמש קיבל גישה לתוכן הדף. במקרה כזה, הודעת ה-Offerwall לא תוצג שוב אחרי שההבטחה תתממש.
    • ‫false: למשתמש לא הייתה גישה לתוכן הדף. במקרה כזה, הודעת ה-Offerwall תוצג שוב אחרי שההבטחה תמומש.

דוגמה

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

הרשמה לבחירה מותאמת אישית

ההרשמה כוללת העברה של אובייקט CustomOfferwallChoice שהופעל אל מאגר הרישום של החלון הבא: window.googlefc.offerwall.customchoice.registry

דוגמה

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

בקטע הזה מתואר כל סוג נתונים ב-API.

הגדרות של אובייקטים

בקטע הזה מתוארת כל הגדרת אובייקט ב-API.

InitializeParams

סוג אובייקט הפרמטר של הפונקציה initialize.

נכס סוג תיאור
offerwallLanguageCode string | undefined קוד השפה של ה-Offerwall שמוצג, כפי שמוגדר ב-BCP 47.

הגדרות של טיפוסים בני מנייה (enum)

בקטע הזה מתוארת כל הגדרת enum ב-API.

googlefc.offerwall.customchoice.InitializeResponseEnum

סוג ה-enum של התגובה לפונקציה initialize.

חבר/ה בקבוצת ספירה תיאור
CUSTOM_CHOICE_DISABLED משביתים את האפשרות של בחירה בהתאמה אישית בהודעת ה-Offerwall. אם השבתתם את אפשרות הבחירה בהתאמה אישית, הודעת ה-Offerwall תוצג רק אם יש אפשרויות בחירה אחרות שעומדות בדרישות. אם אין אפשרויות בחירה אחרות שעומדות בדרישות, הודעת ה-Offerwall לא תוצג בדף.
ACCESS_GRANTED הענקת גישה לדף המשתמש במהלך טעינת הדף. אם התשובה הזו תוחזר, ה-Offerwall לא יוצג בדף.
ACCESS_NOT_GRANTED לא להעניק למשתמש גישה לדף בזמן טעינת הדף. אם התגובה הזו מוחזרת, ה-Offerwall עומד בדרישות להצגה בדף.