InterstitialAdPreloader

Kotlin |Java

public final class InterstitialAdPreloader

---

インタースティシャル広告のプリローダー。

概要

パブリック メソッド
static boolean	destroy(String preloadId) 指定された preloadId のプリロードを停止し、関連付けられているプリロードされた広告をすべて破棄します。
static void	destroyAll() すべてのプリロード構成でプリロードを停止し、プリロードされた広告を破棄します。
static @Nullable PreloadConfiguration	getConfiguration(String preloadId) この preloadId に関連付けられているインタースティシャル広告の PreloadConfiguration を返します。存在しない場合は null を返します。
static Map<String, PreloadConfiguration>	getConfigurations() 関連付けられたプリロード ID をキーとして、すべてのインタースティシャル広告 PreloadConfiguration のマップを返します。
static int	getNumAdsAvailable(String preloadId) 指定されたプリロード ID で利用可能な広告の数を返します。
static boolean	isAdAvailable(String preloadId) 指定された preloadId で少なくとも 1 つの広告が利用可能かどうかを判断します。
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 の広告のプリロードを開始します。

パブリック メソッド

destroy

public static boolean destroy(String preloadId)

指定された preloadId のプリロードを停止し、関連付けられているプリロードされた広告をすべて破棄します。

パラメータ
String preloadId	破棄する構成のプリロード ID。

戻り値
boolean	アクティブなプリロード構成が破棄された場合は true。指定された preloadId のアクティブなプリロード構成がない場合は、false を返します。

destroyAll

public static void destroyAll()

すべてのプリロード構成でプリロードを停止し、プリロードされた広告を破棄します。

getConfiguration

public static @Nullable PreloadConfiguration getConfiguration(String preloadId)

この preloadId に関連付けられているインタースティシャル広告の PreloadConfiguration を返します。存在しない場合は null を返します。

パラメータ
String preloadId	この構成にリンクされているプリロード ID。

戻り値
@Nullable PreloadConfiguration	指定されたプリロード ID の PreloadConfiguration。指定されたプリロード ID の構成がない場合は null。

getConfigurations

public static Map<String, PreloadConfiguration> getConfigurations()

関連付けられたプリロード ID をキーとして、すべてのインタースティシャル広告 PreloadConfiguration のマップを返します。

戻り値
Map<String, PreloadConfiguration>	インタースティシャル広告の設定。プリローダーが存在しない場合は空のマップ。

getNumAdsAvailable

public static int getNumAdsAvailable(String preloadId)

指定されたプリロード ID で利用可能な広告の数を返します。

パラメータ
String preloadId	利用可能かどうかを確認するプリロード ID。

戻り値
int	指定されたプリロード ID で利用可能な広告の数。

isAdAvailable

public static boolean isAdAvailable(String preloadId)

指定された preloadId で少なくとも 1 つの広告が利用可能かどうかを判断します。

パラメータ
String preloadId	利用可能かどうかを確認するプリロード ID。

戻り値
boolean	指定されたプリロード ID の広告が利用可能な場合は true、それ以外の場合は false。

pollAd

public static @Nullable InterstitialAd pollAd(String preloadId)

start または start からプリロードされた広告を返し、キャッシュから削除します。

これは、preloadId 用にプリロードされた広告のいずれかになります。返される順序が onAdPreloaded イベントの順序と一致する保証はありません。

パラメータ
String preloadId	広告のプリロード ID。

戻り値
@Nullable InterstitialAd	指定されたプリロード ID のインタースティシャル広告。広告が利用できない場合は null。

start

public static boolean start(String preloadId, PreloadConfiguration preloadConfiguration)

指定された preloadId と PreloadConfiguration の広告のプリロードを開始します。

SDK は、getBufferSize で指定された広告の数に達するまで広告のプリロードを続け、セッション全体でバッファをいっぱいに保とうとします。

preloadId で PreloadConfiguration がすでに開始されている場合、このメソッドは何もせずに false を返します。

パラメータ
String preloadId	この PreloadConfiguration の文字列識別子。この構成の広告を取得するために pollAd を呼び出す場合は、この識別子を使用します。
PreloadConfiguration preloadConfiguration	広告のプリロードの構成。

戻り値
boolean	プリロードが開始された場合は true、preloadId が使用中の場合は false。

start

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

指定された preloadId、PreloadConfiguration、PreloadCallbackV2 の広告のプリロードを開始します。

SDK は、getBufferSize で指定された広告の数に達するまで広告のプリロードを続け、セッション全体でバッファをいっぱいに保とうとします。

広告リクエストごとに、SDK はプリロードが成功した場合は onAdPreloaded コールバックを、プリロードが失敗した場合は onAdFailedToPreload コールバックをトリガーします。SDK は、失敗したリクエストを自動的に再試行します。

指定された preloadId で PreloadConfiguration がすでに開始されている場合、このメソッドは何もせずに false を返します。は no-op になり、false を返します。

パラメータ
String preloadId	この PreloadConfiguration を一意に識別する文字列。この構成のプリロードされた広告を取得するために pollAd を呼び出すときは、この識別子を使用します。
PreloadConfiguration preloadConfiguration	広告のプリロード方法を決定する構成。
PreloadCallbackV2 preloadCallback	指定された PreloadConfiguration の広告の利用可能性が変更されたときに呼び出されるコールバック。

戻り値
boolean	プリロードが開始された場合は true、preloadId が使用中の場合は false。