広告のプリロードは、GMA Next-Gen SDK の Google 管理の広告読み込み機能で、 広告の読み込みとキャッシュを代行して管理します。広告のプリロードを使用するには、広告の読み込み方法を変更する必要があります。広告のプリロードを使用してパフォーマンスを最適化するには、 カスタム キャッシュを無効にして、その処理を GMA Next-Gen SDK に委任します。
広告のプリロードには、手動での広告読み込みに比べて次のようなメリットがあります。
- 参照の管理: 読み込まれた広告を保持するため、広告を表示する準備ができるまで参照を維持する必要はありません。
- 自動再読み込み: キャッシュから広告を取り出すと、新しい広告が自動的に読み込まれます。
- 再試行の管理: 失敗したリクエストは、指数バックオフを使用して自動的に再試行されます。
- 有効期限の処理: 広告の有効期限が切れる前に（通常は 1 時間後）、広告が自動的に更新されます。
- キャッシュの最適化: キャッシュサイズを 1 より大きく設定すると、GMA Next-Gen SDK キャッシュの順序を最適化して、最適な広告を配信します。
このガイドでは、プリロード広告の設定、プリロード広告の可用性の確認、プリロードされた広告の表示について説明します。
前提条件
チュートリアルに進む前に、次の項目を完了する必要があります。
- GMA Next-Gen SDK バージョン 0.14.0-alpha01 以降をインストールします。
- 設定しますGMA Next-Gen SDK。
- 省略可: サンプルアプリをダウンロードして実行します。
広告のプリロードを開始する
広告のプリロードを開始するには、startPreload() を呼び出します。このメソッドは、アプリの起動時に 1 回だけ呼び出します。
startPreload() を呼び出すと、GMA Next-Gen SDK は広告を自動的に
プリロードし、プリロードされた構成のリクエストが失敗した場合は再試行します。
次の例では、広告のプリロードを開始します。
Kotlin
private fun startPreloading(adUnitId: String) {
val adRequest = AdRequest.Builder(adUnitId).build()
val preloadConfig = PreloadConfiguration(adRequest)
InterstitialAdPreloader.start(adUnitId, preloadConfig)
}
Java
private void startPreloading(String adUnitId) {
AdRequest adRequest = new AdRequest.Builder(adUnitId).build();
PreloadConfiguration preloadConfig = new PreloadConfiguration(adRequest);
InterstitialAdPreloader.start(adUnitId, preloadConfig);
}
プリロードされた広告を取得して表示する
広告のプリロードを使用すると、GMA Next-Gen SDK はキャッシュされた広告を保持します。
広告を表示する場合は、pollAd() を呼び出します。GMA Next-Gen SDK は利用可能な広告を取得し、
次の広告をバックグラウンドで自動的にプリロードします。
広告を表示する準備ができるまで、このメソッドの呼び出しは避けてください。広告を キャッシュに保持することで、GMA Next-Gen SDK は有効期限切れの広告を自動的に更新し、 キャッシュの最適化を行うことができます。
次の例では、プリロードされた広告を取得して表示します。
Kotlin
private fun pollAndShowAd(activity: Activity, adUnitId: String) {
// Polling returns the next available ad and loads another ad in the background.
val ad = InterstitialAdPreloader.pollAd(adUnitId)
// Interact with the ad object as needed.
ad?.apply {
Log.d(TAG, "Interstitial ad response info: ${this.getResponseInfo()}")
this.adEventCallback =
object : InterstitialAdEventCallback {
override fun onAdImpression() {
Log.d(TAG, "Interstitial ad recorded an impression.")
}
override fun onAdPaid(value: AdValue) {
Log.d(TAG, "Interstitial ad onPaidEvent: ${value.valueMicros} ${value.currencyCode}")
}
}
// Show the ad.
ad.show(activity)
}
}
Java
private void pollAndShowAd(Activity activity, String adUnitId) {
// Polling returns the next available ad and loads another ad in the background.
final InterstitialAd ad = InterstitialAdPreloader.pollAd(adUnitId);
// Interact with the ad object as needed.
if (ad != null) {
Log.d(TAG, "Interstitial ad response info: " + ad.getResponseInfo());
ad.setAdEventCallback(
new InterstitialAdEventCallback() {
@Override
public void onAdImpression() {
Log.d(TAG, "Interstitial ad recorded an impression.");
}
@Override
public void onAdPaid(AdValue value) {
Log.d(
TAG,
"Interstitial ad onPaidEvent: "
+ value.getValueMicros()
+ " "
+ value.getCurrencyCode());
}
});
// Show the ad.
ad.show(activity);
}
}
プリロード広告の可用性を確認する
広告の可用性を確認するには、次のいずれかを選択します。
プリロードされた広告の可用性を取得する
次の例では、広告の可用性を確認します。
Kotlin
private fun isAdAvailable(adUnitId: String): Boolean {
return InterstitialAdPreloader.isAdAvailable(adUnitId)
}
Java
private boolean isAdAvailable(String adUnitId) {
return InterstitialAdPreloader.isAdAvailable(adUnitId);
}
プリロードされた広告の可用性をリッスンする
プリロード イベントに登録すると、広告が正常にプリロードされた場合、プリロードに失敗した場合、広告キャッシュがなくなった場合に通知を受け取ることができます。
プリロード イベントは分析を目的としています。プリロード イベントのコールバック内では、次の点に注意してください。
startPreload()は呼び出さないでください。- 広告がすぐに表示される場合を除き、
pollAd()の呼び出しは避けてください。
次の例では、広告イベントに登録します。
Kotlin
private fun startPreloadingWithCallback(adUnitId: String) {
val preloadCallback =
// [Important] Don't call ad preloader start() or pollAd() within the PreloadCallback.
object : PreloadCallback {
override fun onAdFailedToPreload(preloadId: String, adError: LoadAdError) {
Log.i(
TAG,
("Interstitial preload ad $preloadId failed to load with error: ${adError.message}"),
)
// [Optional] Get the error response info for additional details.
// val responseInfo = adError.responseInfo
}
override fun onAdsExhausted(preloadId: String) {
Log.i(TAG, "Interstitial preload ad $preloadId is not available")
// [Important] Don't call ad preloader start() or pollAd() from onAdsExhausted.
}
override fun onAdPreloaded(preloadId: String, responseInfo: ResponseInfo) {
Log.i(TAG, "Interstitial preload ad $preloadId is available")
}
}
val adRequest = AdRequest.Builder(adUnitId).build()
val preloadConfig = PreloadConfiguration(adRequest)
InterstitialAdPreloader.start(adUnitId, preloadConfig, preloadCallback)
}
Java
private void startPreloadingWithCallback(String adUnitId) {
PreloadCallback preloadCallback =
// [Important] Don't call ad preloader start() or pollAd() within the PreloadCallback.
new PreloadCallback() {
@Override
public void onAdFailedToPreload(String preloadId, LoadAdError adError) {
Log.e(
TAG,
String.format(
"Interstitial preload ad %s failed to load with error: %s",
preloadId, adError.getMessage()));
// [Optional] Get the error response info for additional details.
// ResponseInfo responseInfo = adError.getResponseInfo();
}
@Override
public void onAdsExhausted(String preloadId) {
Log.i(TAG, "Interstitial preload ad " + preloadId + " is not available");
// [Important] Don't call ad preloader start() or pollAd() from onAdsExhausted.
}
@Override
public void onAdPreloaded(String preloadId, ResponseInfo responseInfo) {
Log.i(TAG, "Interstitial preload ad " + preloadId + " is available");
}
};
AdRequest adRequest = new AdRequest.Builder(adUnitId).build();
PreloadConfiguration preloadConfig = new PreloadConfiguration(adRequest);
InterstitialAdPreloader.start(adUnitId, preloadConfig, preloadCallback);
}
広告のプリロードを停止する
セッションでプリロード ID の広告を再度表示する必要がない場合は、広告のプリロードを停止できます。特定のプリロード ID の広告のプリロードを停止するには、プリロード ID を指定して destroy() を呼び出します。
バッファサイズを設定する
バッファサイズは、メモリに保持されるプリロードされた広告の数を制御します。デフォルトでは、Google はバッファサイズを最適化して、メモリ使用量と広告配信のレイテンシのバランスを取ります。次の広告が読み込まれる前にアプリに広告が表示される場合は、カスタム バッファサイズを設定して、メモリに保持する広告の数を増やすことができます。バッファサイズは最大 4 にすることをおすすめします。
Kotlin
private fun setBufferSize(adUnitId: String) {
val adRequest = AdRequest.Builder(adUnitId).build()
val preloadConfig = PreloadConfiguration(adRequest, bufferSize = 3)
InterstitialAdPreloader.start(adUnitId, preloadConfig)
}
Java
private void setBufferSize(String adUnitId) {
AdRequest adRequest = new AdRequest.Builder(adUnitId).build();
PreloadConfiguration preloadConfig = new PreloadConfiguration(adRequest, 3);
InterstitialAdPreloader.start(adUnitId, preloadConfig);
}