Offerwall Custom Choice API

บทนำ

Offerwall Custom Choice API ช่วยให้คุณผสานรวมโซลูชันการสร้างรายได้ที่กำหนดเองของคุณเองกับ Offerwall ใน Google Ad Manager ได้

หากต้องการผสานรวมโซลูชันการสร้างรายได้ของคุณเองกับ Offerwall ให้ทำตามขั้นตอนการตั้งค่าทางเลือกที่กำหนดเอง เหล่านี้ โดยสรุป

  1. เปิดใช้ตัวเลือก "ทางเลือกที่กำหนดเอง" สำหรับ Offerwall จากภายในแท็บความเป็นส่วนตัวและการแสดงข้อความแจ้งผู้ใช้ใน Ad Manager

  2. เพิ่ม JavaScript ที่กำหนดเองระหว่างแท็ก <head> กับ </head> ของเว็บไซต์ที่คุณเผยแพร่ Offerwall

  3. สร้างออบเจ็กต์ CustomOfferwallChoice ตามที่กำหนดไว้ในส่วนที่ตามมา และลงทะเบียนกับ Offerwall ในหน้าต่าง

โค้ดตัวอย่าง

หากต้องการเริ่มต้นใช้งานอย่างรวดเร็ว โปรดดูตัวอย่าง การติดตั้งใช้งาน Offerwall Custom Choice API ที่ใช้งานได้นี้

การใช้ 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>

เริ่มต้นโซลูชันการสร้างรายได้ที่กำหนดเอง ระบบจะเรียกใช้ฟังก์ชันนี้ก่อนฟังก์ชันอื่นๆ และคาดว่าจะเรียกใช้ได้ไม่เกิน 1 ครั้งเมื่อโหลดหน้าเว็บที่กำหนด

ตัวอย่าง

  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 จะเรียกใช้เมธอดนี้เมื่อผู้ใช้คลิกตัวเลือกทางเลือกที่กำหนดเอง การสร้างรายได้อาจอยู่ในรูปแบบใดก็ได้ ซึ่งรวมถึงบริการสมัครใช้บริการ บริการการชำระเงินขนาดเล็ก โฆษณาที่มีการให้รางวัล และอื่นๆ เมื่อเรียกใช้ ระบบจะซ่อน Offerwall จนกว่าจะมีการแก้ไขสัญญาดังกล่าว และเป็นความรับผิดชอบของ CustomOfferwallChoice ในการควบคุมเนื้อหาของหน้าเว็บในระหว่างนี้ เมื่อ สัญญาได้รับการแก้ไขแล้ว CustomOfferwallChoice ต้องไม่ปรากฏในหน้าเว็บอีกต่อไป

เมื่อสัญญาของฟังก์ชัน show() ได้รับการแก้ไขแล้ว คุณต้องดำเนินการต่อไปนี้

  • ซ่อนโซลูชันการสร้างรายได้ที่แสดง

  • ส่งคืนค่าบูลีนที่ระบุว่าผู้ใช้ได้รับสิทธิ์เข้าถึงเนื้อหาในหน้าเว็บหรือไม่

    • true: ผู้ใช้ได้รับสิทธิ์เข้าถึงเนื้อหาในหน้า ในกรณีนี้ ระบบจะไม่แสดง Offerwall อีกครั้งเมื่อมีการแก้ไข Promise
    • false: ผู้ใช้ไม่ได้รับสิทธิ์เข้าถึงเนื้อหาในหน้า ในกรณีนี้ Offerwall จะแสดงอีกครั้งเมื่อมีการแก้ไข Promise

ตัวอย่าง

  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 ของคุณจะมีสิทธิ์แสดงในหน้าเว็บหากมีการส่งคืนการตอบกลับนี้