InterstitialAdPreloader

Kotlin |Java

public final class InterstitialAdPreloader

---

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

סיכום

‫methods ציבוריות
static boolean	destroy(String preloadId) הפעולה הזו מפסיקה את הטעינה מראש של preloadId הנתון ומוחקת את כל המודעות המשויכות שנטענו מראש.
static void	destroyAll() מפסיק את הטעינה מראש ומשמיד מודעות שנטענו מראש בכל הגדרות הטעינה מראש.
static @Nullable PreloadConfiguration	getConfiguration(String preloadId) מחזירה את מודעת המעברון PreloadConfiguration שמשויכת ל- preloadId הזה, או null אם לא קיימת מודעה כזו.
static Map<String, PreloadConfiguration>	getConfigurations() מחזירה מפה של כל מודעות הביניים מסוג PreloadConfiguration, עם מפתח לפי מזהה הטעינה מראש המשויך.
static int	getNumAdsAvailable(String preloadId) הפונקציה מחזירה את מספר המודעות שזמינות למזהה הטעינה מראש שצוין.
static boolean	isAdAvailable(String preloadId) הפונקציה קובעת אם יש לפחות מודעה אחת שזמינה ל-preloadId שצוין.
static @Nullable InterstitialAd	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 שצוינו.

‫methods ציבוריות

כיבוי סופי

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 הזה, או null אם לא קיימת מודעה כזו.

פרמטרים
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)

הפונקציה קובעת אם יש לפחות מודעה אחת שזמינה ל-preloadId שצוין.

פרמטרים
String preloadId	מזהה הטעינה מראש שרוצים לבדוק את הזמינות שלו.

החזרות
boolean	‫true אם יש מודעה זמינה למזהה הטעינה מראש שצוין, false אחרת.

pollAd

public static @Nullable InterstitialAd pollAd(String preloadId)

מחזירה מודעה שנטענה מראש מ-start או מ-start ומסירה אותה מהמטמון.

שימו לב: יכול להיות שזו תהיה כל אחת מהמודעות שנטענו מראש עבור preloadId. אין ערובה לכך שהסדר של ההזמנות שמוחזרות יהיה זהה לסדר של אירועי onAdPreloaded.

פרמטרים
String preloadId	המזהה של הטעינה מראש של המודעה.

החזרות
@Nullable InterstitialAd	מודעת מעברון למזהה הטעינה מראש שצוין, או 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 if preloading started, false if the preloadId is in-use.

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	קריאה חוזרת שתופעל כשהזמינות של המודעה תשתנה עבור PreloadConfiguration שצוין.

החזרות
boolean	‫true if preloading started, false if the preloadId is in-use.