AppOpenAdPreloader

Kotlin |Java

public final class AppOpenAdPreloader

---

ตัวโหลดล่วงหน้าสำหรับโฆษณาเปิดแอป

สรุป

เมธอดสาธารณะ
static boolean	destroy(String preloadId) หยุดการโหลดล่วงหน้าสำหรับ preloadId ที่ระบุและทำลายโฆษณาที่โหลดล่วงหน้าทั้งหมดที่เกี่ยวข้อง
static void	destroyAll() หยุดการโหลดล่วงหน้าและทำลายโฆษณาที่โหลดล่วงหน้าสำหรับการกำหนดค่าการโหลดล่วงหน้าทั้งหมด
static @Nullable PreloadConfiguration	getConfiguration(String preloadId) แสดงโฆษณาเปิดแอปที่PreloadConfigurationเชื่อมโยงกับpreloadIdนี้ หรือแสดงค่าว่างหากไม่มี
static Map<String, PreloadConfiguration>	getConfigurations() แสดงแผนที่ของโฆษณาแอปที่เปิดอยู่ทั้งหมด PreloadConfiguration โดยมีรหัสการโหลดล่วงหน้าที่เชื่อมโยงเป็นคีย์
static int	getNumAdsAvailable(String preloadId) แสดงผลจำนวนโฆษณาที่พร้อมใช้งานสำหรับรหัสการโหลดล่วงหน้าที่ระบุ
static boolean	isAdAvailable(String preloadId) กำหนดว่ามีโฆษณาอย่างน้อย 1 รายการพร้อมแสดงสำหรับ preloadId ที่ระบุหรือไม่
static @Nullable AppOpenAd	pollAd(String preloadId) แสดงโฆษณาที่โหลดล่วงหน้าจาก start หรือ start และนำออกจากแคช
static boolean	start(String preloadId, PreloadConfiguration preloadConfiguration) เริ่มโหลดโฆษณาล่วงหน้าสำหรับ preloadId และ PreloadConfiguration ที่ระบุ
static boolean	start(     String preloadId,     PreloadConfiguration preloadConfiguration,     PreloadCallbackV2 preloadCallback ) เริ่มโหลดโฆษณาล่วงหน้าสำหรับ preloadId, PreloadConfiguration และ PreloadCallbackV2 ที่ระบุ

เมธอดสาธารณะ

ทำลาย

public static boolean destroy(String preloadId)

หยุดการโหลดล่วงหน้าสำหรับ preloadId ที่ระบุและทำลายโฆษณาที่โหลดล่วงหน้าทั้งหมดที่เกี่ยวข้อง

พารามิเตอร์
String preloadId	รหัสการโหลดล่วงหน้าของการกำหนดค่าที่จะทำลาย

การคืนสินค้า
boolean	true หากมีการทำลายการกำหนดค่าการโหลดล่วงหน้าที่ใช้งานอยู่ แสดงผล false หากไม่มีการกำหนดค่าการโหลดล่วงหน้าที่ใช้งานอยู่สำหรับ preloadId ที่ระบุ

destroyAll

public static void destroyAll()

หยุดการโหลดล่วงหน้าและทำลายโฆษณาที่โหลดล่วงหน้าสำหรับการกำหนดค่าการโหลดล่วงหน้าทั้งหมด

getConfiguration

public static @Nullable PreloadConfiguration getConfiguration(String preloadId)

แสดงโฆษณาเปิดแอปที่PreloadConfigurationเชื่อมโยงกับpreloadIdนี้ หรือแสดงค่าว่างหากไม่มี

พารามิเตอร์
String preloadId	รหัสการโหลดล่วงหน้าที่ลิงก์กับการกำหนดค่านี้

การคืนสินค้า
@Nullable PreloadConfiguration	PreloadConfiguration สำหรับรหัสการโหลดล่วงหน้าที่ระบุ หรือ null หากไม่มีการกำหนดค่าสำหรับรหัสการโหลดล่วงหน้าที่ระบุ

getConfigurations

public static Map<String, PreloadConfiguration> getConfigurations()

แสดงแผนที่ของโฆษณาแอปที่เปิดอยู่ทั้งหมด PreloadConfiguration โดยมีรหัสการโหลดล่วงหน้าที่เชื่อมโยงเป็นคีย์

การคืนสินค้า
Map<String, PreloadConfiguration>	การกำหนดค่าโฆษณาเปิดแอป หรือแผนที่ว่างเปล่าหากไม่มีตัวโหลดล่วงหน้า

getNumAdsAvailable

public static int getNumAdsAvailable(String preloadId)

แสดงผลจำนวนโฆษณาที่พร้อมใช้งานสำหรับรหัสการโหลดล่วงหน้าที่ระบุ

พารามิเตอร์
String preloadId	รหัสการโหลดล่วงหน้าเพื่อตรวจสอบความพร้อมให้บริการ

การคืนสินค้า
int	จำนวนโฆษณาที่พร้อมแสดงสำหรับรหัสการโหลดล่วงหน้าที่ระบุ

isAdAvailable

public static boolean isAdAvailable(String preloadId)

กำหนดว่ามีโฆษณาอย่างน้อย 1 รายการพร้อมแสดงสำหรับ preloadId ที่ระบุหรือไม่

พารามิเตอร์
String preloadId	รหัสการโหลดล่วงหน้าเพื่อตรวจสอบความพร้อมให้บริการ

การคืนสินค้า
boolean	true หากมีโฆษณาที่พร้อมแสดงสำหรับรหัสการโหลดล่วงหน้าที่ระบุ false มิฉะนั้น

pollAd

public static @Nullable AppOpenAd pollAd(String preloadId)

แสดงโฆษณาที่โหลดล่วงหน้าจาก start หรือ start และนำออกจากแคช

โปรดทราบว่าโฆษณานี้อาจเป็นโฆษณาใดก็ได้ที่โหลดไว้ล่วงหน้าสำหรับ preloadId ระบบไม่รับประกันว่าลำดับที่แสดงจะตรงกับลำดับของเหตุการณ์ onAdPreloaded

พารามิเตอร์
String preloadId	รหัสการโหลดล่วงหน้าของโฆษณา

การคืนสินค้า
@Nullable AppOpenAd	โฆษณาที่เปิดแอปสำหรับรหัสการโหลดล่วงหน้าที่ระบุ หรือ null หากไม่มีโฆษณา

start

public static boolean start(String preloadId, PreloadConfiguration preloadConfiguration)

เริ่มโหลดโฆษณาล่วงหน้าสำหรับ preloadId และ PreloadConfiguration ที่ระบุ

SDK จะโหลดโฆษณาล่วงหน้าต่อไปจนกว่าจะมีโฆษณาตามจำนวนที่ getBufferSize ระบุไว้ โดยพยายามรักษาระดับบัฟเฟอร์ให้เต็มตลอดเซสชัน

หากมีการเริ่มต้น PreloadConfiguration ด้วย preloadId แล้ว เมธอดนี้จะไม่มีการดำเนินการใดๆ และจะแสดงผล false

พารามิเตอร์
String preloadId	ตัวระบุสตริงสำหรับ PreloadConfiguration นี้ ใช้ตัวระบุนี้เมื่อเรียก pollAd เพื่อรับโฆษณาสำหรับการกำหนดค่านี้
PreloadConfiguration preloadConfiguration	การกำหนดค่าสำหรับการโหลดโฆษณาล่วงหน้า

การคืนสินค้า
boolean	true หากเริ่มโหลดล่วงหน้า false หาก preloadId ใช้งานอยู่

start

public static boolean start(
    String preloadId,
    PreloadConfiguration preloadConfiguration,
    PreloadCallbackV2 preloadCallback
)

เริ่มโหลดโฆษณาล่วงหน้าสำหรับ preloadId, PreloadConfiguration และ PreloadCallbackV2 ที่ระบุ

SDK จะโหลดโฆษณาล่วงหน้าต่อไปจนกว่าจะมีโฆษณาตามจำนวนที่ getBufferSize ระบุไว้ โดยพยายามรักษาระดับบัฟเฟอร์ให้เต็มตลอดเซสชัน

สำหรับคำขอโฆษณาแต่ละรายการ SDK จะทริกเกอร์onAdPreloadedการเรียกกลับเมื่อโหลดล่วงหน้าสำเร็จ หรือonAdFailedToPreloadการเรียกกลับหากโหลดล่วงหน้าไม่สำเร็จ SDK จะลองส่งคำขอที่ไม่สำเร็จอีกครั้งโดยอัตโนมัติ

หาก PreloadConfiguration เริ่มต้นด้วย preloadId ที่ระบุแล้ว เมธอดนี้จะไม่ดำเนินการใดๆ และจะแสดงผล false จะไม่มีผลและแสดงผล false

พารามิเตอร์
String preloadId	สตริงที่ระบุ PreloadConfiguration นี้อย่างไม่ซ้ำกัน ใช้ตัวระบุนี้เมื่อเรียก pollAd เพื่อดึงโฆษณาที่โหลดล่วงหน้าสำหรับการกำหนดค่านี้
PreloadConfiguration preloadConfiguration	การกำหนดค่าที่กำหนดวิธีโหลดโฆษณาล่วงหน้า
PreloadCallbackV2 preloadCallback	Callback ที่จะเรียกใช้เมื่อความพร้อมใช้งานของโฆษณาเปลี่ยนแปลงสำหรับ PreloadConfiguration ที่ระบุ

การคืนสินค้า
boolean	true หากเริ่มโหลดล่วงหน้า false หาก preloadId ใช้งานอยู่