広告の事前読み込み（アルファ版）

広告のプリロードは、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)
}
InterstitialAdSnippets.kt

Java

private void startPreloading(String adUnitId) {
  AdRequest adRequest = new AdRequest.Builder(adUnitId).build();
  PreloadConfiguration preloadConfig = new PreloadConfiguration(adRequest);
  InterstitialAdPreloader.start(adUnitId, preloadConfig);
}
InterstitialAdSnippets.java

プリロードされた広告を取得して表示する

広告のプリロードを使用する場合、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)
  }
}
InterstitialAdSnippets.kt

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);
  }
}
InterstitialAdSnippets.java

プリロード広告の利用可能性を確認する

広告の利用可能性を確認するには、次のいずれかを選択します。

プリロード広告の利用可否を取得する
プリロード広告の利用可否をリッスンする

プリロードされた広告の利用可能性を取得する

次の例では、広告の利用可能性を確認します。

Kotlin

private fun isAdAvailable(adUnitId: String): Boolean {
  return InterstitialAdPreloader.isAdAvailable(adUnitId)
}
InterstitialAdSnippets.kt

Java

private boolean isAdAvailable(String adUnitId) {
  return InterstitialAdPreloader.isAdAvailable(adUnitId);
}InterstitialAdSnippets.java

プリロードされた広告の利用可能性をリッスンする

プリロードイベントを登録すると、広告のプリロードが成功したとき、プリロードに失敗したとき、広告キャッシュがなくなったときに通知を受け取ることができます。

プリロードイベントは分析を目的としています。プリロードイベントのコールバック内:

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)
}
InterstitialAdSnippets.kt

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);
}
InterstitialAdSnippets.java

広告のプリロードを停止する

セッションでプリロード ID の広告を再度表示する必要がない場合は、広告のプリロードを停止できます。特定のプリロード ID の広告のプリロードを停止するには、プリロード ID を指定して destroy() を呼び出します。

バッファサイズを設定する

バッファサイズは、メモリに保持されるプリロード済み広告の数を制御します。デフォルトでは、メモリ消費量と広告配信のレイテンシのバランスを取るようにバッファサイズが最適化されます。アプリで次の広告が読み込まれる前に広告を表示する場合は、カスタムバッファサイズを設定して、メモリに保持される広告の数を増やすことができます。バッファサイズは最大 4 にすることをおすすめします。

Kotlin

private fun setBufferSize(adUnitId: String) {
  val adRequest = AdRequest.Builder(adUnitId).build()
  val preloadConfig = PreloadConfiguration(adRequest, bufferSize = 3)
  InterstitialAdPreloader.start(adUnitId, preloadConfig)
}
InterstitialAdSnippets.kt

Java

private void setBufferSize(String adUnitId) {
  AdRequest adRequest = new AdRequest.Builder(adUnitId).build();
  PreloadConfiguration preloadConfig = new PreloadConfiguration(adRequest, 3);
  InterstitialAdPreloader.start(adUnitId, preloadConfig);
}
InterstitialAdSnippets.java

広告の事前読み込み（アルファ版） コレクションでコンテンツを整理 必要に応じて、コンテンツの保存と分類を行います。

前提条件

広告のプリロードを開始する

Kotlin

Java

プリロードされた広告を取得して表示する

Kotlin

Java

プリロード広告の利用可能性を確認する

プリロードされた広告の利用可能性を取得する

Kotlin

Java

プリロードされた広告の利用可能性をリッスンする

Kotlin

Java

広告のプリロードを停止する

バッファサイズを設定する

Kotlin

Java

広告の事前読み込み（アルファ版）