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

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

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

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

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

前提条件

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

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

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

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

InterstitialAdPreloader.start(
  preloadId: _adUnitId,
  preloadConfiguration: PreloadConfiguration(adUnitId: _adUnitId),
  callback: const PreloadCallback(),
);

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

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

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

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

次の例では、事前読み込みされた広告を取得して表示しています。

void _pollAndShowAd() async {
  final InterstitialAd? ad = await InterstitialAdPreloader.pollAd(_adUnitId);
  if (ad != null) {
    _interstitialAd = ad;
    ad.fullScreenContentCallback = FullScreenContentCallback(
      onAdImpression: (ad) {
        // Called when an impression occurs on the ad.
        debugPrint('Ad recorded an impression.');
      },
    );
    ad.onPaidEvent = (ad, valueMicros, precision, currencyCode) {
      // Called when an ad is estimated to have earned money.
      debugPrint('Ad paid: $valueMicros $currencyCode.');
    };
    // Show the ad.
    await ad.show();
  }
}

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

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

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

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

void _checkAdAvailability() async {
  final bool isAvailable = await InterstitialAdPreloader.isAdAvailable(
    _adUnitId,
  );
  debugPrint('Is ad available: $isAvailable');
}

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

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

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

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

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

InterstitialAdPreloader.start(
  preloadId: _adUnitId,
  preloadConfiguration: PreloadConfiguration(adUnitId: _adUnitId),
  callback: PreloadCallback(
    onAdPreloaded: (preloadId, responseInfo) {
      debugPrint('Ad preloaded for ID: $preloadId');
    },
    onAdFailedToPreload: (preloadId, error) {
      debugPrint('Ad failed to preload for ID: $preloadId. Error: $error');
    },
    onAdsExhausted: (preloadId) {
      debugPrint('All preloaded ads exhausted for ID: $preloadId');
    },
  ),
);

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

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

void _stopPreloading() async {
  await InterstitialAdPreloader.destroy(_adUnitId);
}

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

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

InterstitialAdPreloader.start(
  preloadId: _adUnitId,
  preloadConfiguration: PreloadConfiguration(
    adUnitId: _adUnitId,
    bufferSize: 3,
  ),
  callback: const PreloadCallback(),
);

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

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

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