InterstitialAdPreloader

class InterstitialAdPreloader


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

概要

パブリック関数

java-static Boolean
destroy(preloadId: String!)

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

java-static Unit

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

java-static PreloadConfiguration?
getConfiguration(preloadId: String!)

この関数は非推奨になりました。

交換は行いません。

java-static (Mutable)Map<String!, PreloadConfiguration!>!

この関数は非推奨になりました。

交換は行いません。

java-static Int

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

java-static Boolean
isAdAvailable(preloadId: String!)

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

java-static InterstitialAd?
pollAd(preloadId: String!)

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

java-static Boolean
start(preloadId: String!, preloadConfiguration: PreloadConfiguration!)

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

java-static Boolean
start(
    preloadId: String!,
    preloadConfiguration: PreloadConfiguration!,
    preloadCallback: PreloadCallbackV2!
)

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

パブリック関数

destroy

java-static fun destroy(preloadId: String!): Boolean

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

パラメータ
preloadId: String!

破棄する構成のプリロード ID。

戻り値
Boolean

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

destroyAll

java-static fun destroyAll(): Unit

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

getConfiguration

java-static fun getConfiguration(preloadId: String!): PreloadConfiguration?

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

パラメータ
preloadId: String!

この構成にリンクされているプリロード ID。

戻り値
PreloadConfiguration?

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

getConfigurations

java-static fun getConfigurations(): (Mutable)Map<String!, PreloadConfiguration!>!

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

戻り値
(Mutable)Map<String!, PreloadConfiguration!>!

インタースティシャル広告の設定。プリローダーが存在しない場合は空のマップ。

getNumAdsAvailable

java-static fun getNumAdsAvailable(preloadId: String!): Int

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

パラメータ
preloadId: String!

利用可能かどうかを確認するプリロード ID。

戻り値
Int

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

isAdAvailable

java-static fun isAdAvailable(preloadId: String!): Boolean

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

パラメータ
preloadId: String!

利用可能かどうかを確認するプリロード ID。

戻り値
Boolean

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

pollAd

java-static fun pollAd(preloadId: String!): InterstitialAd?

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

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

パラメータ
preloadId: String!

広告のプリロード ID。

戻り値
InterstitialAd?

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

start

java-static fun start(preloadId: String!, preloadConfiguration: PreloadConfiguration!): Boolean

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

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

preloadIdPreloadConfiguration がすでに開始されている場合、このメソッドは no-op になり、false を返します。

パラメータ
preloadId: String!

この PreloadConfiguration の文字列識別子。この構成の広告を取得するために pollAd を呼び出す場合は、この識別子を使用します。

preloadConfiguration: PreloadConfiguration!

広告のプリロードの構成。

戻り値
Boolean

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

start

java-static fun start(
    preloadId: String!,
    preloadConfiguration: PreloadConfiguration!,
    preloadCallback: PreloadCallbackV2!
): Boolean

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

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

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

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

パラメータ
preloadId: String!

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

preloadConfiguration: PreloadConfiguration!

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

preloadCallback: PreloadCallbackV2!

指定された PreloadConfiguration の広告の利用可能性が変更されたときに呼び出されるコールバック。

戻り値
Boolean

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