Offerwall Custom Choice API

Giới thiệu

API Lựa chọn tuỳ chỉnh Offerwall cho phép bạn tích hợp giải pháp kiếm tiền tuỳ chỉnh của riêng mình với Offerwall trong Google Ad Manager.

Để tích hợp giải pháp kiếm tiền của riêng bạn với Offerwall, hãy làm theo các bước thiết lập Lựa chọn tuỳ chỉnh này. Tóm tắt:

  1. Bật lựa chọn "Lựa chọn tuỳ chỉnh" cho Offerwall trong thẻ Quyền riêng tư và thông báo trong Ad Manager.

  2. Thêm JavaScript tuỳ chỉnh giữa các thẻ <head> và </head> của trang web mà bạn đã xuất bản Offerwall.

  3. Tạo thực thể cho một đối tượng CustomOfferwallChoice như được xác định trong các phần sau và đăng ký đối tượng đó với Offerwall trên cửa sổ.

Mã mẫu

Để bắt đầu nhanh chóng, hãy xem ví dụ đang hoạt động này về cách triển khai API Lựa chọn tuỳ chỉnh Offerwall.

Việc Sử Dụng API

CustomOfferwallChoice là một đối tượng JavaScript mà bạn cắm vào Offerwall để tích hợp phương thức triển khai kiếm tiền tuỳ chỉnh.

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

Định nghĩa phương thức

Phần này mô tả từng phương thức mà CustomOfferwallChoice bắt buộc phải triển khai.

khởi động

initialize(params: InitializeParams): Promise<InitializeResponseEnum>

Khởi chạy giải pháp kiếm tiền tuỳ chỉnh. Hàm này được gọi trước bất kỳ hàm nào khác và có thể được gọi tối đa một lần khi tải một trang nhất định.

Ví dụ

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

hiện (lên)/cho thấy

show(): Promise<boolean>

Kết xuất giải pháp kiếm tiền tuỳ chỉnh và xử lý các hành động kiếm tiền của người dùng. Phương thức này được Offerwall của bạn gọi khi người dùng nhấp vào lựa chọn tuỳ chỉnh. Việc kiếm tiền có thể diễn ra dưới nhiều hình thức, bao gồm cả dịch vụ thuê bao, dịch vụ thanh toán vi mô, quảng cáo có tặng thưởng và nhiều hình thức khác. Khi được gọi, Offerwall của bạn sẽ bị ẩn cho đến khi lời hứa này được giải quyết và CustomOfferwallChoice của bạn có trách nhiệm kiểm soát nội dung trang trong thời gian chờ đợi. Sau khi lời hứa này được thực hiện, CustomOfferwallChoice của bạn phải đảm bảo không còn xuất hiện trên trang web nữa.

Khi giải quyết lời hứa của hàm show(), bạn phải:

  • Ẩn giải pháp kiếm tiền đã hiển thị.

  • Trả về một giá trị boolean cho biết người dùng có được cấp quyền truy cập vào nội dung trang hay không:

    • true: Người dùng đã truy cập được nội dung trên trang. Trong trường hợp này, Offerwall sẽ không được kết xuất lại khi giải quyết lời hứa.
    • false: Người dùng không truy cập được vào nội dung trang. Trong trường hợp này, Offerwall của bạn sẽ được kết xuất lại khi lời hứa được thực hiện.

Ví dụ

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

Đăng ký Lựa chọn tuỳ chỉnh

Việc đăng ký bao gồm việc truyền đối tượng CustomOfferwallChoice đã khởi tạo của bạn vào sổ đăng ký cửa sổ sau đây: window.googlefc.offerwall.customchoice.registry

Ví dụ

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

Định nghĩa kiểu API

Phần này mô tả từng loại dữ liệu trong API.

Định nghĩa đối tượng

Phần này mô tả từng định nghĩa đối tượng trong API.

InitializeParams

Kiểu đối tượng tham số cho hàm initialize.

Thuộc tính Loại Mô tả
offerwallLanguageCode string | undefined Mã ngôn ngữ của Offerwall đang được phân phát, theo định nghĩa của BCP 47.

Định nghĩa về enum

Phần này mô tả từng định nghĩa enum trong API.

googlefc.offerwall.customchoice.InitializeResponseEnum

Loại enum phản hồi cho hàm initialize.

Thành viên liệt kê Mô tả
CUSTOM_CHOICE_DISABLED Tắt lựa chọn tuỳ chỉnh trong Offerwall. Nếu bạn tắt lựa chọn tuỳ chỉnh, Offerwall của bạn chỉ có thể
hiển thị với các lựa chọn đủ điều kiện khác; nếu không có lựa chọn nào khác đủ điều kiện, Offerwall của bạn sẽ không bao giờ hiển thị trên trang.
ACCESS_GRANTED Cấp cho người dùng quyền truy cập vào trang khi tải trang. Offerwall của bạn sẽ không bao giờ hiển thị trên trang nếu phản hồi này được trả về.
ACCESS_NOT_GRANTED Đừng cấp cho người dùng quyền truy cập vào trang khi tải trang. Offerwall của bạn đủ điều kiện hiển thị trên trang nếu phản hồi này được trả về.