リワード広告を設定する

プラットフォームを選択: Android iOS Unity Flutter Android（レガシー）

リワード広告 を使用すると、動画広告、体験プレイ広告、アンケートを操作したユーザーに報酬としてアプリ内アイテムを進呈できます。

このガイドでは、リワード広告を Android アプリに統合する方法について説明します。

始める前に

続行する前に、次の操作を行います。

  • 設定しますGMA Next-Gen SDK。
  • テスト用リワード広告ユニット ID /21775744923/example/rewarded を使用します。
    • アプリの開発とテストでは、配信中の実際の広告ではなく、必ずテスト広告を使用してください。テスト広告ユニット ID を使用しない場合、Google はお客様のアカウントを一時停止することがあります。
    • アプリを公開する前に、この ID を実際の広告ユニット ID に置き換えてください。
    • GMA Next-Gen SDK テスト広告について詳しくは、 テスト広告を有効にするをご覧ください。

広告のプリロードについて（ベータ版）

GMA Next-Gen SDK の広告のプリロード（ベータ版）では、広告の読み込みとキャッシュへの保存が自動化されます。

広告のプリロードには次のようなメリットがあります。

  • 参照の管理: 広告が表示されるまで参照を維持します。
  • 自動再読み込み: キャッシュから広告が取得されたら、新しい広告を読み込みます。
  • 再試行の管理: 広告の読み込みに失敗したら、新しい広告を読み込みます。
  • 有効期限の処理: 有効期限が切れる前に広告を更新します。
  • キャッシュの最適化: キャッシュの順序を最適化して、優先度の高い 広告を配信します。
注: 広告を手動で読み込む方法については、単一のリワード広告を読み込むをご覧ください。

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

広告のプリロードを開始するには、アプリの起動時に start メソッドを 1 回呼び出します。start メソッドを呼び出すと、 GMA Next-Gen SDK は広告を自動的にプリロードし、 プリロードされた構成のリクエストが失敗した場合は再試行します。

次の例は、広告のプリロードを開始する方法を示しています。

Kotlin

val adRequest = AdRequest.Builder(adUnitId).build()
val preloadConfig = PreloadConfiguration(adRequest)
RewardedAdPreloader.start(adUnitId, preloadConfig)

Java

AdRequest adRequest = new AdRequest.Builder(adUnitId).build();
PreloadConfiguration preloadConfig = new PreloadConfiguration(adRequest);
RewardedAdPreloader.start(adUnitId, preloadConfig);

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

前の例では、広告ユニット ID をプリロード ID として使用する方法を示しています。プリロード ID は、広告のプリロード構成を識別するために作成する文字列識別子です。アプリで同じ広告ユニット ID に対して複数のターゲティング構成が必要な場合は、カスタム文字列識別子を渡します。

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

広告を表示する場合は、pollAd メソッドを呼び出します。 GMA Next-Gen SDK は利用可能な広告を取得し、次の広告をバックグラウンドで自動的にプリロードします。利用可能な広告がない場合、GMA Next-Gen SDK は広告を返しません。

利用可能な広告オブジェクトがある場合は、show メソッドを呼び出して広告を表示します。 リワード イベントを処理するには、リワード リスナーを使用します。次の例は、プリロードされた広告を取得して表示する方法を示しています。

Kotlin

private fun pollAndShowAd(activity: Activity, adUnitId: String) {
  // Polling returns the next available ad and loads another ad in the background.
  val ad = RewardedAdPreloader.pollAd(adUnitId)
  if (ad == null) {
    Log.e(TAG, "Rewarded ad is not available.")
    return
  }

  // Interact with the ad object as needed.
  Log.d(TAG, "Rewarded ad response info: ${ad.getResponseInfo()}")
  ad.adEventCallback =
    object : RewardedAdEventCallback {
      override fun onAdImpression() {
        Log.d(TAG, "Rewarded ad recorded an impression.")
      }
    }
  ad.show(activity) { rewardItem -> Log.d(TAG, "User earned reward: ${rewardItem.amount}") }
}

Java

private void pollAndShowAd(Activity activity, String adUnitId) {
  // Polling returns the next available ad and loads another ad in the background.
  final RewardedAd ad = RewardedAdPreloader.pollAd(adUnitId);

  // Interact with the ad object as needed.
  if (ad == null) {
    Log.e(TAG, "Rewarded ad is not available.");
    return;
  }

  Log.d(TAG, "Rewarded ad response info: " + ad.getResponseInfo());
  ad.setAdEventCallback(
      new RewardedAdEventCallback() {
        @Override
        public void onAdImpression() {
          Log.d(TAG, "Rewarded ad recorded an impression.");
        }
      });

  // Show the ad.
  ad.show(
      activity,
      rewardItem -> {
        Log.d(TAG, "User earned reward: " + rewardItem.getAmount());
      });
}

広告を表示する準備ができるまで、pollAd メソッドの呼び出しは避けてください。広告を表示せずに広告レスポンス情報を読み取る方法については、 レスポンス情報を読み取るをご覧ください。

広告のイベントをリッスンする

広告を表示する前に、広告のイベントをリッスンします。次の例では、広告イベントのコールバックを登録しています。

Kotlin

private fun listenToAdEvents() {
  // Listen for ad events.
  val ad = rewardedAd
  if (ad == null) {
    Log.e(TAG, "Rewarded ad is not ready yet.")
    return
  }

  ad.adEventCallback =
    object : RewardedAdEventCallback {
      override fun onAdShowedFullScreenContent() {
        // Rewarded ad did show.
      }

      override fun onAdDismissedFullScreenContent() {
        // Rewarded ad did dismiss.
        rewardedAd = null
      }

      override fun onAdFailedToShowFullScreenContent(
        fullScreenContentError: FullScreenContentError
      ) {
        // Rewarded ad failed to show.
        Log.e(TAG, "Rewarded ad failed to show: ${fullScreenContentError.message}")
      }

      override fun onAdImpression() {
        // Rewarded ad did record an impression.
      }

      override fun onAdClicked() {
        // Rewarded ad did record a click.
      }
    }
}

Java

private void listenToAdEvents() {
  // Listen for ad events.
  if (rewardedAd == null) {
    Log.e(TAG, "Rewarded ad is not ready yet.");
    return;
  }

  rewardedAd.setAdEventCallback(
      new RewardedAdEventCallback() {
        @Override
        public void onAdShowedFullScreenContent() {
          // Rewarded ad did show.
        }

        @Override
        public void onAdDismissedFullScreenContent() {
          // Rewarded ad did dismiss.
          rewardedAd = null;
        }

        @Override
        public void onAdFailedToShowFullScreenContent(
            FullScreenContentError fullScreenContentError) {
          // Rewarded ad failed to show.
          Log.e(TAG, "Rewarded ad failed to show: " + fullScreenContentError.getMessage());
        }

        @Override
        public void onAdImpression() {
          // Rewarded ad did record an impression.
        }

        @Override
        public void onAdClicked() {
          // Rewarded ad did record a click.
        }
      });
}

任意: サーバーサイド認証（SSV）コールバックを検証する

アプリでサーバーサイド認証 コールバック に追加データが必要な場合は、広告のカスタムデータ機能を使用します。Google 広告サーバーは、広告オブジェクトに設定されている文字列値を SSV コールバックの custom_data クエリ パラメータに渡します。カスタムデータ値が設定されていない場合、SSV コールバックに custom_data クエリ パラメータ値は存在しません。

次の例では、広告を表示する前に広告オブジェクトにカスタムデータを設定しています。

Kotlin

RewardedAd.load(
  context,
  AD_UNIT_ID,
  AdRequest.Builder().build(),
  object : RewardedAdLoadCallback() {
    override fun onAdLoaded(ad: RewardedAd) {
      rewardedAd = ad
      val options =
        ServerSideVerificationOptions.Builder().setCustomData("SAMPLE_CUSTOM_DATA_STRING").build()
      rewardedAd?.setServerSideVerificationOptions(options)
    }
  },
)

Java

RewardedAd.load(
    context,
    AD_UNIT_ID,
    new AdRequest.Builder().build(),
    new RewardedAdLoadCallback() {
      @Override
      public void onAdLoaded(RewardedAd ad) {
        rewardedAd = ad;
        ServerSideVerificationOptions options =
            new ServerSideVerificationOptions.Builder()
                .setCustomData("SAMPLE_CUSTOM_DATA_STRING")
                .build();
        rewardedAd.setServerSideVerificationOptions(options);
      }
    });

SAMPLE_CUSTOM_DATA_STRING は、実際のカスタムデータに置き換えてください。

任意: プリロード イベントをリッスンする

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

次の例は、広告のプリロード イベントを登録する方法を示しています。

Kotlin

val preloadCallback =
  object : PreloadCallback {
    override fun onAdFailedToPreload(preloadId: String, adError: LoadAdError) {
      Log.d(TAG, "Rewarded preload ad $preloadId failed to load with error: ${adError.message}")
    }

    override fun onAdsExhausted(preloadId: String) {
      Log.i(TAG, "Rewarded preload ad $preloadId is not available")
    }

    override fun onAdPreloaded(preloadId: String, responseInfo: ResponseInfo) {
      Log.i(TAG, "Rewarded preload ad $preloadId is available")
    }
  }
val adRequest = AdRequest.Builder(adUnitId).build()
val preloadConfig = PreloadConfiguration(adRequest)
RewardedAdPreloader.start(adUnitId, preloadConfig, preloadCallback)

Java

PreloadCallback preloadCallback =
    new PreloadCallback() {
      @Override
      public void onAdFailedToPreload(String preloadId, LoadAdError adError) {
        Log.d(
            TAG,
            String.format(
                "Rewarded preload ad %s failed to load with error: %s",
                preloadId, adError.getMessage()));
      }

      @Override
      public void onAdsExhausted(String preloadId) {
        Log.i(TAG, "Rewarded preload ad " + preloadId + " is not available");
      }

      @Override
      public void onAdPreloaded(String preloadId, ResponseInfo responseInfo) {
        Log.i(TAG, "Rewarded preload ad " + preloadId + " is available");
      }
    };

AdRequest adRequest = new AdRequest.Builder(adUnitId).build();
PreloadConfiguration preloadConfig = new PreloadConfiguration(adRequest);
RewardedAdPreloader.start(adUnitId, preloadConfig, preloadCallback);

広告の読み込みに失敗すると、GMA Next-Gen SDK は広告を自動的にプリロードし、プリロードされた構成のリクエストが失敗した場合は 再試行します。

任意: 広告の利用可否を確認する

広告が利用可能かどうかを確認する必要がある場合は、広告の利用可否を確認します。次の例では、プリロードされた広告が利用可能かどうかを確認しています。

Kotlin

private fun isAdAvailable(adUnitId: String): Boolean {
  return RewardedAdPreloader.isAdAvailable(adUnitId)
}

Java

private boolean isAdAvailable(String adUnitId) {
  return RewardedAdPreloader.isAdAvailable(adUnitId);
}

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

バッファサイズは、メモリに保持されるプリロードされた広告の数を制御します。デフォルトでは、Google はメモリ使用量と広告配信のレイテンシのバランスを取るようにバッファサイズを最適化します。カスタム バッファサイズを設定して、メモリに保持する広告の数を増やすことができます。プリロードされた広告のバッファサイズを 2 にすることをおすすめします。

次の例は、バッファサイズを設定する方法を示しています。

Kotlin

val adRequest = AdRequest.Builder(adUnitId).build()
// Define a PreloadConfiguration and set the buffer size to 2 preloaded ads.
val preloadConfig = PreloadConfiguration(adRequest, bufferSize = 2)
RewardedAdPreloader.start(adUnitId, preloadConfig)

Java

AdRequest adRequest = new AdRequest.Builder(adUnitId).build();
// Define a PreloadConfiguration and set the buffer size to 2 preloaded ads.
PreloadConfiguration preloadConfig = new PreloadConfiguration(adRequest, 2);
RewardedAdPreloader.start(adUnitId, preloadConfig);

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

GMA Next-Gen SDK では、すべての広告ユニットとプリロード ID でプリロードされる広告の合計数にアプリ全体の上限が適用されます。

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

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

セッションで特定のプリロード ID の広告を再度表示する必要がない場合は、広告のプリロードを停止できます。特定のプリロード ID の広告の読み込みを停止するには、プリロード ID を指定して destroy メソッドを呼び出します。destroy メソッドを呼び出すと、プリロード ID に関連付けられているプリロードされた広告がすべてキャッシュから削除されます。

次の例は、広告のプリロードを停止する方法を示しています。

Kotlin

private fun stopPreloading(adUnitId: String) {
  // Stops the preloading and destroy preloaded ads.
  RewardedAdPreloader.destroy(adUnitId)
}

Java

private void stopPreloading(String adUnitId) {
  // Stops the preloading and destroy preloaded ads.
  RewardedAdPreloader.destroy(adUnitId);
}

任意: レスポンス情報を読み取る

キャッシュから広告を削除せずに、次にプリロードされる広告のレスポンス情報を読み取ります。

次の例は、次にプリロードされる広告のレスポンス情報を読み取る方法を示しています。

Kotlin

val responseInfo = RewardedAdPreloader.peekAdResponseInfo(preloadId)
if (responseInfo == null) {
  Log.e(TAG, "Failed to peek ad response info.")
  return
}

Log.d(TAG, "Peeked ad response ID: ${responseInfo.responseId}")

Java

ResponseInfo responseInfo = RewardedAdPreloader.peekAdResponseInfo(preloadId);
if (responseInfo == null) {
  Log.e(TAG, "Failed to peek ad response info.");
  return;
}

Log.d(TAG, "Peeked ad response ID: " + responseInfo.getResponseId());