広告のプリロード（ベータ版）

広告のプリロードは、Google Mobile Ads SDK (Legacy) の Google 管理の広告読み込み機能で、広告の読み込みとキャッシュ保存を自動的に管理します。広告のプリロードを使用するには、広告の読み込みを管理する方法を変更する必要があります。広告のプリロードを使用してパフォーマンスを最適化するには、カスタム キャッシュを無効にして、その処理を Google Mobile Ads SDK (Legacy) に委任します。

広告のプリロードには、手動による広告の読み込みと比較して、次のようなメリットがあります。

  • 参照管理: 読み込まれた広告を保持するため、広告を表示する準備が整うまで参照を維持する必要がありません。
  • 自動再読み込み: キャッシュから広告が取得されると、新しい広告を自動的に読み込みます。
  • マネージド再試行: 指数バックオフを使用して、失敗したリクエストを自動的に再試行します。
  • 有効期限の処理: 広告の有効期限（通常は 1 時間）が切れる前に自動的に更新します。
  • キャッシュの最適化: キャッシュ サイズが 1 より大きい場合、Google Mobile Ads SDK (Legacy) はキャッシュの順序を最適化して最適な広告を配信します。

このガイドでは、プリロード広告の設定、プリロード広告の可用性の確認、プリロード広告の表示について説明します。

前提条件

このチュートリアルを進める前に、Google Mobile Ads SDK (Legacy) を設定する必要があります。

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

アプリの起動時に、start メソッドを 1 回呼び出します。start メソッドを呼び出すと、Google Mobile Ads SDK (Legacy) は自動的に広告をプリロードし、プリロードされた構成の失敗したリクエストを再試行します。

次の例では、広告のプリロードを開始します。

Kotlin

// Define a PreloadConfiguration.
val configuration = PreloadConfiguration.Builder("AD_UNIT_ID").build()
// Start the preloading with a given preload ID, preload configuration.
InterstitialAdPreloader.start("AD_UNIT_ID", configuration)

Java

// Define a PreloadConfiguration.
PreloadConfiguration configuration = new PreloadConfiguration.Builder("AD_UNIT_ID").build();
// Start the preloading with a given preload ID, preload configuration.
InterstitialAdPreloader.start("AD_UNIT_ID", configuration);

AD_UNIT_ID は、実際の広告ユニット ID に置き換えてください。

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

広告のプリロードを使用する場合、Google Mobile Ads SDK (Legacy) はキャッシュされた広告を保持します。広告を表示するには、pollAd メソッドを呼び出します。Google Mobile Ads SDK (Legacy) は利用可能な広告を取得し、次の広告をバックグラウンドで自動的にプリロードします。

広告を表示する準備が整うまで、pollAd メソッドを呼び出さないでください。広告をキャッシュに保存すると、Google Mobile Ads SDK (Legacy) は期限切れの広告を自動的に更新し、キャッシュの最適化を行うことができます。

次の例では、プリロードされた広告を取得して表示しています。

Kotlin

// pollAd() returns the next available ad and loads another ad in the background.
val ad = InterstitialAdPreloader.pollAd("AD_UNIT_ID")

// [Optional] Interact with the ad as needed.
ad?.onPaidEventListener = OnPaidEventListener {
  // [Optional] Send the impression-level ad revenue information to your preferred
  // analytics server directly within this callback.
}

// Show the ad immediately.
ad?.show(activity)

Java

// pollAd() returns the next available ad and loads another ad in the background.
InterstitialAd ad = InterstitialAdPreloader.pollAd("AD_UNIT_ID");

if (ad != null) {
  // [Optional] Interact with the ad object as needed.
  ad.setOnPaidEventListener(
      adValue -> {
        // [Optional] Send the impression-level ad revenue information to your preferred
        // analytics server directly within this callback.
      });

  // Show the ad immediately.
  ad.show(activity);
}

広告のプリロードが利用可能かどうかを確認する

広告の在庫状況を確認するには、次のいずれかを選択します。

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

次の例では、広告が利用可能かどうかを確認しています。

Kotlin

// Verify that a preloaded ad is available.
if (!InterstitialAdPreloader.isAdAvailable("AD_UNIT_ID")) {
  // No ads are available to show.
}

Java

// Verify that a preloaded ad is available.
if (!InterstitialAdPreloader.isAdAvailable("AD_UNIT_ID")) {
  // No ads are available to show.
}

プリロード広告の可用性をリッスンする

Preload イベントを登録して、広告が正常にプリロードされたとき、プリロードに失敗したとき、広告キャッシュが使い果たされたときに通知を受け取ります。

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

  • start は呼び出さないでください。
  • 広告をすぐに表示する場合を除き、pollAd を呼び出さないでください。

次の例では、広告イベントを登録しています。

Kotlin

// Define a callback to receive preload events.
val callback =
  object : PreloadCallbackV2() {
    override fun onAdPreloaded(preloadId: String, responseInfo: ResponseInfo?) {
      // Called when preloaded ads are available.
    }

    override fun onAdsExhausted(preloadId: String) {
      // Called when no preloaded ads are available.
    }

    override fun onAdFailedToPreload(preloadId: String, adError: AdError) {
      // Called when preloaded ads failed to load.
    }
  }

Java

// Define a callback to receive preload events.
PreloadCallbackV2 callback =
    new PreloadCallbackV2() {
      @Override
      public void onAdPreloaded(
          @NonNull String preloadId, @Nullable ResponseInfo responseInfo) {
        // Called when preloaded ads are available.
      }

      @Override
      public void onAdsExhausted(@NonNull String preloadId) {
        // Called when no preloaded ads are available.
      }

      @Override
      public void onAdFailedToPreload(@NonNull String preloadId, @NonNull AdError adError) {
        // Called when preloaded ads failed to load.
      }
    };

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

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

Kotlin

// Stops the preloading and destroy preloaded ads.
InterstitialAdPreloader.destroy("AD_UNIT_ID")
// Stops the preloading and destroy all ads.
InterstitialAdPreloader.destroyAll()

Java

// Stops the preloading and destroy preloaded ads.
InterstitialAdPreloader.destroy("AD_UNIT_ID");
// Stops the preloading and destroy all ads.
InterstitialAdPreloader.destroyAll();

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

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

Kotlin

// Define a PreloadConfiguration and set the buffer size to 2 preloaded ads.
val configuration = PreloadConfiguration.Builder("AD_UNIT_ID").setBufferSize(2).build()

Java

// Define a PreloadConfiguration and set the buffer size to 2 preloaded ads.
PreloadConfiguration configuration =
    new PreloadConfiguration.Builder("AD_UNIT_ID").setBufferSize(2).build();

プリロード キャッシュの上限

Google Mobile Ads SDK (Legacy) は、すべての広告ユニットとプリロード ID にわたるプリロード広告の合計数に、アプリ全体の上限を適用します。

  • デフォルトの上限: Google Mobile Ads SDK (Legacy) は、メモリに最大 6 つのプリロード広告を保持します。この上限は、すべてのフォーマットとプリロード ID で共有されます。
  • プリロード ID ごとに 2 つのバッファサイズを維持することをおすすめします。