リワード広告

bookmark_border コレクションでコンテンツを整理 必要に応じて、コンテンツの保存と分類を行います。

前提条件

• Google Mobile Ads SDK 19.7.0 以降。
• スタートガイドの手順を完了していること。

常にテスト広告でテストする

アプリの開発とテストでは必ずテスト広告を使用し、配信中の実際の広告は使用しないでください。実際の広告を使用すると、アカウントが停止される可能性があります。

テスト広告を読み込む際は、次に示す Android リワード広告向けのテスト専用広告ユニット ID を使うと便利です。

ca-app-pub-3940256099942544/5224354917

この ID は、すべてのリクエストに対してテスト広告を返すように構成されており、アプリのコーディング、テスト、デバッグで自由に使うことができます。なお、アプリを公開する前に、必ずテスト用 ID をご自身の広告ユニット ID に置き換えてください。

Mobile Ads SDK のテスト広告の仕組みについて詳しくは、テスト広告をご覧ください。

リワード広告のオブジェクトを読み込む

リワード広告を読み込むには、RewardedAd クラスの静的 load() メソッドを呼び出して RewardedAdLoadCallback を渡します。通常、これは Activity の onCreate() メソッドで行います。他の形式の読み込みコールバックと同様に、RewardedAdLoadCallback では LoadAdError を利用して、より再現性の高いエラーの詳細を提供します。

RewardedAd.load(
    this,
    "AD_UNIT_ID",
    new AdRequest.Builder().build(),
    new RewardedAdLoadCallback() {
      @Override
      public void onAdLoaded(@NonNull RewardedAd rewardedAd) {
        Log.d(TAG, "Ad was loaded.");
        MainActivity.this.rewardedAd = rewardedAd;
      }

      @Override
      public void onAdFailedToLoad(@NonNull LoadAdError loadAdError) {
        Log.d(TAG, loadAdError.getMessage());
        rewardedAd = null;
      }
    });
MainActivity.java

RewardedAd.load(
  this,
  "AD_UNIT_ID",
  AdRequest.Builder().build(),
  object : RewardedAdLoadCallback() {
    override fun onAdLoaded(ad: RewardedAd) {
      Log.d(TAG, "Ad was loaded.")
      rewardedAd = ad
    }

    override fun onAdFailedToLoad(adError: LoadAdError) {
      Log.d(TAG, adError.message)
      rewardedAd = null
    }
  },
)
MainActivity.kt

AD_UNIT_ID は、実際の広告ユニット ID に置き換えます。

FullScreenContentCallback を設定する

FullScreenContentCallback は、RewardedAd の表示に関連するイベントを処理します。RewardedAd を表示する前に、コールバックを以下のように設定してください。

rewardedAd.setFullScreenContentCallback(
    new FullScreenContentCallback() {
      @Override
      public void onAdDismissedFullScreenContent() {
        // Called when fullscreen content is dismissed.
        Log.d(TAG, "Ad was dismissed.");
        // Don't forget to set the ad reference to null so you
        // don't show the ad a second time.
        rewardedAd = null;
      }

      @Override
      public void onAdFailedToShowFullScreenContent(AdError adError) {
        // Called when fullscreen content failed to show.
        Log.d(TAG, "Ad failed to show.");
        // Don't forget to set the ad reference to null so you
        // don't show the ad a second time.
        rewardedAd = null;
      }

      @Override
      public void onAdShowedFullScreenContent() {
        // Called when fullscreen content is shown.
        Log.d(TAG, "Ad showed fullscreen content.");
      }

      @Override
      public void onAdImpression() {
        // Called when an impression is recorded for an ad.
        Log.d(TAG, "Ad recorded an impression.");
      }

      @Override
      public void onAdClicked() {
        // Called when an ad is clicked.
        Log.d(TAG, "Ad was clicked.");
      }
    });
MainActivity.java

rewardedAd?.fullScreenContentCallback =
  object : FullScreenContentCallback() {
    override fun onAdDismissedFullScreenContent() {
      // Called when fullscreen content is dismissed.
      Log.d(TAG, "Ad was dismissed.")
      // Don't forget to set the ad reference to null so you
      // don't show the ad a second time.
      rewardedAd = null
    }

    override fun onAdFailedToShowFullScreenContent(adError: AdError) {
      // Called when fullscreen content failed to show.
      Log.d(TAG, "Ad failed to show.")
      // Don't forget to set the ad reference to null so you
      // don't show the ad a second time.
      rewardedAd = null
    }

    override fun onAdShowedFullScreenContent() {
      // Called when fullscreen content is shown.
      Log.d(TAG, "Ad showed fullscreen content.")
    }

    override fun onAdImpression() {
      // Called when an impression is recorded for an ad.
      Log.d(TAG, "Ad recorded an impression.")
    }

    override fun onAdClicked() {
      // Called when an ad is clicked.
      Log.d(TAG, "Ad was clicked.")
    }
  }
MainActivity.kt

広告を表示する

リワード広告を表示する際は、OnUserEarnedRewardListener オブジェクトを使ってリワード イベントを処理します。

rewardedAd.show(
    MainActivity.this,
    new OnUserEarnedRewardListener() {
      @Override
      public void onUserEarnedReward(@NonNull RewardItem rewardItem) {
        Log.d(TAG, "User earned the reward.");
        // Handle the reward.
      }
    });
MainActivity.java

rewardedAd?.show(
  this,
  OnUserEarnedRewardListener { rewardItem ->
    Log.d(TAG, "User earned the reward.")
    // Handle the reward.
    val rewardAmount = rewardItem.amount
    val rewardType = rewardItem.type
  },
)
MainActivity.kt

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

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

次のコード例は、広告をリクエストする前に、リワード広告オブジェクトにカスタムデータを設定する方法を示したものです。

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

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

SAMPLE_CUSTOM_DATA_STRING は、カスタムデータに置き換えます。

カスタム リワード文字列を設定する場合は、広告を表示する前に行う必要があります。

よくある質問

初期化の呼び出しでタイムアウトは発生しますか？

メディエーション ネットワークの初期化が完了していなくても、Google Mobile Ads SDK では 10 秒が経過すると OnInitializationCompleteListener が呼び出されます。

初期化コールバックを取得したときに、対応準備が完了していないメディエーション ネットワークはどうなりますか？

広告は、OnInitializationCompleteListener のコールバック内で読み込むことをおすすめします。メディエーション ネットワークの対応準備が完了していなくても、Google Mobile Ads SDK はそのネットワークに対して広告を要求します。そのため、いったんタイムアウトされても、その後に初期化が完了すれば、メディエーション ネットワークはそのセッション中に発生する後続の広告リクエストに対応することができます。

MobileAds.getInitializationStatus() を呼び出せば、アプリ セッションの間、すべてのアダプタの初期化ステータスを継続的にポーリングすることができます。

特定のメディエーション ネットワークの対応準備が完了していない理由を確認するには、どうすればよいですか？

AdapterStatus.getDescription() を参照すると、アダプタが広告リクエストの処理に対応できない理由を確認できます。

onUserEarnedReward() コールバックは、常に onAdDismissedFullScreenContent() コールバックの前に呼び出されますか？

Google 広告では、すべての onUserEarnedReward() 呼び出しは onAdDismissedFullScreenContent() の前に行われます。メディエーションを通じて配信される広告の場合、サードパーティの広告ネットワーク SDK の実装によってコールバックの順序が決まります。リワード情報を含む単一のクローズ コールバックを提供する広告ネットワーク SDK の場合、メディエーション アダプタは、onAdDismissedFullScreenContent() の前に onUserEarnedReward() を呼び出します。

GitHub の例

• リワード広告の例: Java | Kotlin

次のステップ

次のトピックをご覧ください。

• ユーザーのプライバシー
• SDK の初期化と広告読み込みの最適化（ベータ版）