広告のプリロードは、GMA Next-Gen SDK の Google 管理の広告読み込み機能です。この機能は、広告の読み込みとキャッシュ保存をユーザーに代わって管理します。広告のプリロードでは、広告の読み込みを管理する方法を変更する必要があります。広告のプリロードを使用してパフォーマンスを最適化するには、カスタム キャッシュを無効にして、その責任を GMA Next-Gen SDK に委任します。
広告のプリロードには、手動による広告の読み込みに比べて次のようなメリットがあります。
- 参照管理: 読み込まれた広告を保持し、表示する準備ができるまで参照を維持する必要がなくなります。
- 自動再読み込み: キャッシュから広告を取り出すと、新しい広告が自動的に読み込まれます。
- マネージド再試行: 指数バックオフを使用して、失敗したリクエストを自動的に再試行します。
- 有効期限の処理: 広告が期限切れになる前に（通常は 1 時間後）、自動的に更新します。
- キャッシュの最適化: キャッシュサイズが 1 より大きい場合、GMA Next-Gen SDK はキャッシュの順序を最適化して最適な広告を配信します。
このガイドでは、プリロード広告の設定、プリロード広告の利用可能性の確認、プリロード広告の表示について説明します。
前提条件
このチュートリアルに進む前に、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 は利用可能な広告を取得し、バックグラウンドで次の広告を自動的にプリロードします。
広告を表示する準備が整うまでは、pollAd メソッドを呼び出さないでください。広告をキャッシュに保存しておくと、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 peekAdResponseInfo(preloadId: String) {
InterstitialAdPreloader.peekAdResponseInfo(preloadId)?.let {
Log.d(TAG, "Peeked ad response ID: ${it.responseId}")
}
}
Java
private void peekAdResponseInfo(String preloadId) {
ResponseInfo responseInfo = InterstitialAdPreloader.peekAdResponseInfo(preloadId);
if (responseInfo != null) {
Log.d(TAG, "Peeked ad response ID: " + responseInfo.getResponseId());
}
}
プリロード広告の可用性を確認する
広告の利用状況を確認するには、次のいずれかを選択します。
プリロードされた広告の利用可能性を取得する
次の例では、広告の利用可能性を確認します。
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 を呼び出します。すべてのプリローダーのプリロードを停止するには、destroyAll を呼び出します。
バッファサイズを設定する
バッファサイズは、メモリに保持されるプリロード済み広告の数を制御します。デフォルトでは、Google はメモリ消費量と広告配信のレイテンシのバランスを取るようにバッファサイズを最適化します。アプリで次の広告が読み込まれる前に広告を表示する場合は、カスタム バッファサイズを設定して、メモリに保持される広告の数を増やすことができます。
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);
}
プリロード キャッシュの上限
GMA Next-Gen SDK は、すべての広告ユニットとプリロード ID にわたるプリロードされた広告の総数にアプリ全体の制限を適用します。
- デフォルトの上限: GMA Next-Gen SDK は、メモリに最大 6 個のプリロードされた広告を保持します。この上限は、すべての形式とプリロード ID で共有されます。
- プリロード ID ごとに 2 ～ 3 のバッファサイズを維持することをおすすめします。