AppOpenAdPreloader

public final class AppOpenAdPreloader


アプリ起動時広告のプリローダー。

概要

パブリック メソッド

static boolean
destroy(String preloadId)

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

static void

プリロードを停止し、すべてのプリロード構成のプリロード済み広告を破棄します。

static @Nullable PreloadConfiguration

この preloadId に関連付けられているアプリ起動時広告 PreloadConfiguration を返します。存在しない場合は null を返します。

static Map<StringPreloadConfiguration>

関連するプリロード ID をキーとする、すべてのアプリ起動広告 PreloadConfiguration のマップを返します。

static int

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

static boolean
isAdAvailable(String preloadId)

指定された preloadId で利用可能な広告が 1 つ以上あるかどうかを判断します。

static @Nullable AppOpenAd
pollAd(String preloadId)

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

static boolean
start(String preloadId, PreloadConfiguration preloadConfiguration)

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

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

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

パブリック メソッド

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<StringPreloadConfigurationgetConfigurations()

関連するプリロード ID をキーとする、すべてのアプリ起動広告 PreloadConfiguration のマップを返します。

戻り値
Map<StringPreloadConfiguration>

アプリのオープン広告設定、またはプリローダが存在しない場合は空のマップ。

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 AppOpenAd pollAd(String preloadId)

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

これは、preloadId 用にプリロードされた任意の広告です。返される順序が onAdPreloaded イベントの順序と一致するとは限りません。

パラメータ
String preloadId

広告のプリロード ID。

戻り値
@Nullable AppOpenAd

指定されたプリロード ID のアプリ起動時広告。広告が利用できない場合は null

start

public static boolean start(String preloadId, PreloadConfiguration preloadConfiguration)

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

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

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

パラメータ
String preloadId

この PreloadConfiguration の文字列識別子。pollAd を呼び出してこの構成の広告を取得するときに、この識別子を使用します。

PreloadConfiguration preloadConfiguration

広告の事前読み込みの設定。

戻り値
boolean

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

start

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

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

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

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

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

パラメータ
String preloadId

この PreloadConfiguration を一意に識別する文字列。pollAd を呼び出して、この構成のプリロード広告を取得するときに、この識別子を使用します。

PreloadConfiguration preloadConfiguration

広告のプリロード方法を指定する構成。

PreloadCallbackV2 preloadCallback

指定された PreloadConfiguration の広告の提供状況が変更されたときに呼び出されるコールバック。

戻り値
boolean

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