シングルロード API を使用する次世代 SDK
リワード インタースティシャル広告は、アプリの画面が変わる自然なタイミングで自動的に表示される広告に対して報酬を提供できるフォーマットです。リワード広告とは異なり、ユーザーはリワード インタースティシャル広告を表示するためにオプトインする必要はありません。 詳しくは、 リワード インタースティシャルのガイダンスをご覧ください。
このガイドでは、リワード インタースティシャル広告を Android アプリに組み込む方法を説明します。
前提条件
必ずテスト広告でテストする
アプリの開発とテストでは、配信中の実際の広告ではなく、必ずテスト広告を使用してください。テスト広告を使用しない場合、Google によってアカウントが停止される可能性があります。
下記の Android リワード インタースティシャル広告向けのテスト専用広告ユニット ID を使うと、テスト広告を簡単に読み込むことができます。
ca-app-pub-3940256099942544/5354046379
この広告ユニット ID は、どのリクエストに対してもテスト広告を返すように設定されています。アプリのコード編集、テスト、デバッグの際には、この ID を自由に使うことができます。なお、この広告ユニットの ID は、アプリを公開する前に必ずご自身の広告ユニット ID に置き換えてください。
GMA Next-Gen SDK テスト広告について詳しくは、 テスト広告を有効にするをご覧ください。
広告を読み込む
次の例は、単一の広告を読み込む方法を示しています。
Kotlin
// Load ads after you initialize MobileAds. RewardedInterstitialAd.load( AdRequest.Builder(adUnitId).build(), object : AdLoadCallback<RewardedInterstitialAd> { override fun onAdLoaded(ad: RewardedInterstitialAd) { // Rewarded interstitial ad loaded. rewardedInterstitialAd = ad } override fun onAdFailedToLoad(adError: LoadAdError) { // Rewarded interstitial ad failed to load. Log.e(TAG, "Rewarded interstitial ad failed to load: ${adError.message}") rewardedInterstitialAd = null } }, )
Java
// Load ads after you initialize MobileAds. RewardedInterstitialAd.load( new AdRequest.Builder(adUnitId).build(), new AdLoadCallback<RewardedInterstitialAd>() { @Override public void onAdLoaded(@NonNull RewardedInterstitialAd ad) { // Rewarded interstitial ad loaded. rewardedInterstitialAd = ad; } @Override public void onAdFailedToLoad(@NonNull LoadAdError adError) { // Rewarded interstitial ad failed to load. Log.e(TAG, "Rewarded interstitial ad failed to load: " + adError.getMessage()); rewardedInterstitialAd = null; } });
テストを行う際は、テスト広告ユニット ID ca-app-pub-3940256099942544/5354046379 を使用してください。
広告を表示する
リワード インタースティシャル広告を表示するには、show メソッドを使用します。OnUserEarnedRewardListener オブジェクトを使って、リワード イベントを処理します。
Kotlin
private fun showAd(rewardedInterstitialAd: RewardedInterstitialAd, activity: Activity) { // Show the ad. rewardedInterstitialAd.show( activity, object : OnUserEarnedRewardListener { override fun onUserEarnedReward(rewardItem: RewardItem) { // User earned the reward. val rewardAmount = rewardItem.amount val rewardType = rewardItem.type } }, ) }
Java
private void showAd(RewardedInterstitialAd rewardedInterstitialAd, Activity activity) { // Show the ad. rewardedInterstitialAd.show( activity, new OnUserEarnedRewardListener() { @Override public void onUserEarnedReward(@NonNull RewardItem rewardItem) { // User earned the reward. int rewardAmount = rewardItem.getAmount(); String rewardType = rewardItem.getType(); } }); }
広告イベントをリッスンする
広告を表示する前に、広告のライフサイクル イベントをリッスンします。
Kotlin
private fun listenToAdEvents() { // Listen for ad events. val ad = rewardedInterstitialAd if (ad == null) { Log.e(TAG, "Rewarded interstitial ad is not ready yet.") return } ad.adEventCallback = object : RewardedInterstitialAdEventCallback { override fun onAdShowedFullScreenContent() { // Rewarded interstitial ad did show. } override fun onAdDismissedFullScreenContent() { // Rewarded interstitial ad did dismiss. rewardedInterstitialAd = null } override fun onAdFailedToShowFullScreenContent( fullScreenContentError: FullScreenContentError ) { // Rewarded interstitial ad failed to show. Log.e(TAG, "Rewarded interstitial ad failed to show: ${fullScreenContentError.message}") } override fun onAdImpression() { // Rewarded interstitial ad did record an impression. } override fun onAdClicked() { // Rewarded interstitial ad did record a click. } } }
Java
private void listenToAdEvents() { // Listen for ad events. if (rewardedInterstitialAd == null) { Log.e(TAG, "Rewarded interstitial ad is not ready yet."); return; } rewardedInterstitialAd.setAdEventCallback( new RewardedInterstitialAdEventCallback() { @Override public void onAdShowedFullScreenContent() { // Rewarded interstitial ad did show. } @Override public void onAdDismissedFullScreenContent() { // Rewarded interstitial ad did dismiss. rewardedInterstitialAd = null; } @Override public void onAdFailedToShowFullScreenContent( @NonNull FullScreenContentError fullScreenContentError) { // Rewarded interstitial ad failed to show. Log.e( TAG, "Rewarded interstitial ad failed to show: " + fullScreenContentError.getMessage()); } @Override public void onAdImpression() { // Rewarded interstitial ad did record an impression. } @Override public void onAdClicked() { // Rewarded interstitial ad did record a click. } }); }
省略可: サーバーサイド認証(SSV)コールバックを検証する
アプリでサーバーサイド認証コールバックに追加データが必要な場合は、リワードインタースティシャル広告のカスタムデータ機能を使用します。リワード インタースティシャル広告オブジェクトに設定されている文字列値はすべて、SSV
コールバックの custom_data クエリ パラメータに受け渡されます。カスタムデータ値が設定されていない場合、SSV コールバックは
custom_data クエリ パラメータ値を持ちません。
次のコードサンプルは、広告をリクエストする前に、リワード インタースティシャル広告オブジェクトにカスタムデータを設定する方法を示したものです。
Kotlin
Java
SAMPLE_CUSTOM_DATA_STRING は、カスタムデータに置き換えてください。
カスタム リワード文字列を設定する場合は、広告を表示する前に行う必要があります。