このページは Cloud Translation API によって翻訳されました。

リワード広告

リワード広告は、ユーザーが広告を操作することと引き換えに、アプリ内で報酬を獲得できる広告です。このガイドでは、アドマネージャーのリワード広告を iOS アプリに組み込む方法について説明します。

前提条件

Google Mobile Ads SDK 8.0.0 以降
スタートガイドを完了している。

必ずテスト広告でテストする

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

テスト広告を読み込むには、次に示す iOS リワード広告向けのテスト専用広告ユニット ID を使う方法が最も簡単です。

/6499/example/rewarded

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

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

実装

リワード広告を統合する主な手順は次のとおりです。

広告を読み込む
[省略可] SSV コールバックを検証する
コールバックに登録する
広告を表示して報酬イベントを処理する

広告を読み込む

広告の読み込みは、GADRewardedAd クラスの静的 loadWithAdUnitID:request:completionHandler: メソッドを使用して行います。読み込みメソッドには、広告ユニット ID、GAMRequest オブジェクト、広告の読み込みの成功時または失敗時に呼び出される完了ハンドラが必要です。読み込まれた GADRewardedAd オブジェクトは、完了ハンドラのパラメータとして提供されます。次の例は、ViewController クラスで GADRewardedAd を読み込む方法を示しています。

Swift

import GoogleMobileAds
import UIKit

class ViewController: UIViewController {

  private var rewardedAd: GADRewardedAd?

  func loadRewardedAd() {
    do {
      rewardedAd = try await GADRewardedAd.load(
        withAdUnitID: "/6499/example/rewarded", request: GAMRequest())
    } catch {
      print("Rewarded ad failed to load with error: \(error.localizedDescription)")
    }
  }
}

Objective-C

@import GoogleMobileAds;
@import UIKit;

@interface ViewController ()

@property(nonatomic, strong) GADRewardedAd *rewardedAd;

@end

@implementation ViewController
- (void)loadRewardedAd {
  GAMRequest *request = [GAMRequest request];
  [GADRewardedAd
      loadWithAdUnitID:@"/6499/example/rewarded"
                request:request
      completionHandler:^(GADRewardedAd *ad, NSError *error) {
        if (error) {
          NSLog(@"Rewarded ad failed to load with error: %@", [error localizedDescription]);
          return;
        }
        self.rewardedAd = ad;
        NSLog(@"Rewarded ad loaded.");
      }];
}

[省略可] サーバー側の検証（SSV）コールバックを検証する

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

次のコードサンプルは、広告をリクエストする前にリワード広告オブジェクトにカスタムデータを設定する方法を示しています。

Swift

do {
  rewardedAd = try await GADRewardedAd.load(
    withAdUnitID: "/6499/example/rewarded", request: GAMRequest())
  let options = GADServerSideVerificationOptions()
  options.customRewardString = "SAMPLE_CUSTOM_DATA_STRING"
  rewardedAd.serverSideVerificationOptions = options
} catch {
  print("Rewarded ad failed to load with error: \(error.localizedDescription)")
}

Objective-C

[GADRewardedAd
     loadWithAdUnitID:@"/6499/example/rewarded"
              request:[GAMRequest request];
    completionHandler:^(GADRewardedAd *ad, NSError *error) {
      if (error) {
        // Handle Error
        return;
      }
      self.rewardedAd = ad;
      GADServerSideVerificationOptions *options =
          [[GADServerSideVerificationOptions alloc] init];
      options.customRewardString = @"SAMPLE_CUSTOM_DATA_STRING";
      ad.serverSideVerificationOptions = options;
    }];

コールバックに登録する

表示イベントの通知を受け取るには、GADFullScreenContentDelegate プロトコルを実装し、返された広告の fullScreenContentDelegate プロパティに割り当てる必要があります。GADFullScreenContentDelegate プロトコルは、広告の表示が成功または失敗した場合と閉じられた場合のコールバックを処理します。次のコードは、プロトコルを実装して広告に割り当てる方法を示しています。

Swift

import GoogleMobileAds
import UIKit

class ViewController: UIViewController, GADFullScreenContentDelegate {

  private var rewardedAd: GADRewardedAd?

  func loadRewardedAd() {
    do {
      rewardedAd = try await GADRewardedAd.load(
        withAdUnitID: "/6499/example/rewarded", request: GAMRequest())
      rewardedAd?.fullScreenContentDelegate = self
    } catch {
      print("Rewarded ad failed to load with error: \(error.localizedDescription)")
    }
  }

  /// Tells the delegate that the ad failed to present full screen content.
  func ad(_ ad: GADFullScreenPresentingAd, didFailToPresentFullScreenContentWithError error: Error) {
    print("Ad did fail to present full screen content.")
  }

  /// Tells the delegate that the ad will present full screen content.
  func adWillPresentFullScreenContent(_ ad: GADFullScreenPresentingAd) {
    print("Ad will present full screen content.")
  }

  /// Tells the delegate that the ad dismissed full screen content.
  func adDidDismissFullScreenContent(_ ad: GADFullScreenPresentingAd) {
    print("Ad did dismiss full screen content.")
  }
}

Objective-C

@interface ViewController () <GADFullScreenContentDelegate>

@property(nonatomic, strong) GADRewardedAd *rewardedAd;

@end

@implementation ViewController
- (void)loadRewardedAd {
  GAMRequest *request = [GAMRequest request];
  [GADRewardedAd
      loadWithAdUnitID:@"ca-app-pub-3940256099942544/4806952744"
                request:request
      completionHandler:^(GADRewardedAd *ad, NSError *error) {
        if (error) {
          NSLog(@"Rewarded ad failed to load with error: %@", [error localizedDescription]);
          return;
        }
        self.rewardedAd = ad;
        NSLog(@"Rewarded ad loaded.");
        self.rewardedAd.fullScreenContentDelegate = self;
      }];
}

/// Tells the delegate that the ad failed to present full screen content.
- (void)ad:(nonnull id<GADFullScreenPresentingAd>)ad
    didFailToPresentFullScreenContentWithError:(nonnull NSError *)error {
    NSLog(@"Ad did fail to present full screen content.");
}

/// Tells the delegate that the ad will present full screen content.
- (void)adWillPresentFullScreenContent:(nonnull id<GADFullScreenPresentingAd>)ad {
    NSLog(@"Ad will present full screen content.");
}

/// Tells the delegate that the ad dismissed full screen content.
- (void)adDidDismissFullScreenContent:(nonnull id<GADFullScreenPresentingAd>)ad {
    NSLog(@"Ad did dismiss full screen content.");
}

GADRewardedAd は使い捨てオブジェクトです。つまり、一度表示されたリワード広告は二度と表示されません。GADFullScreenContentDelegate の adDidDismissFullScreenContent: メソッドで別のリワード広告を読み込み、前のリワード広告の表示が終了したらすぐに次のリワード広告の読み込みを開始することをおすすめします。

広告を表示して報酬イベントを処理する

リワード広告をユーザーに表示する前に、報酬と引き換えにリワード広告のコンテンツを視聴するかどうか、明確な選択肢をユーザーに提示する必要があります。リワード広告は、常にオプトイン方式で表示されるようにする必要があります。

広告を表示するときは、ユーザーへの報酬を処理する GADUserDidEarnRewardHandler オブジェクトを提供する必要があります。

リワード広告を表示する最適な方法を次のコードに示します。

Swift

func show() {
  guard let rewardedAd = rewardedAd else {
    return print("Ad wasn't ready.")
  }

  // The UIViewController parameter is an optional.
  ad.present(fromRootViewController: nil) {
    let reward = ad.adReward
    print("Reward received with currency \(reward.amount), amount \(reward.amount.doubleValue)")
    // TODO: Reward the user.
  }
}

Objective-C

- (void)show {
  if (self.rewardedAd) {
    // The UIViewController parameter is nullable.
    [self.rewardedAd presentFromRootViewController:nil
                                  userDidEarnRewardHandler:^{
                                  GADAdReward *reward =
                                      self.rewardedAd.adReward;
                                  // TODO: Reward the user!
                                }];
  } else {
    NSLog(@"Ad wasn't ready");
  }
}

よくある質問

GADRewardedAd の特典の詳細を教えてもらえますか？

はい。userDidEarnReward コールバックが呼び出される前に報酬額が必要な場合、GADRewardedAd の adReward プロパティを使用すると、広告の読み込み後に報酬額を確認できます。

初期化の呼び出しにタイムアウトはありますか？

10 秒が経過すると、メディエーションネットワークの初期化が完了していなくても、Google Mobile Ads SDK は startWithCompletionHandler: メソッドに指定された GADInitializationCompletionHandler を呼び出します。

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

広告は GADInitializationCompletionHandler 内で読み込むことをおすすめします。メディエーションネットワークの準備ができていない場合でも、Google Mobile Ads SDK はそのネットワークに広告をリクエストします。そのため、タイムアウト後にメディエーションネットワークが初期化を完了した場合でも、そのセッションの以降の広告リクエストは引き続き処理されます。

アプリセッション中は、GADMobileAds.initializationStatus を呼び出すことで、引き続きすべてのアダプタの初期化ステータスをポーリングできます。

特定のメディエーションネットワークの準備ができていない理由を調べるにはどうすればよいですか？

GADAdapterStatus オブジェクトの description プロパティは、アダプタが広告リクエストを処理できない理由を示します。

userDidEarnRewardHandler 完了ハンドラは常に adDidDismissFullScreenContent: デリゲートメソッドの前に呼び出されますか？

Google 広告では、すべての userDidEarnRewardHandler 呼び出しが adDidDismissFullScreenContent: の前に行われます。メディエーションを介して配信される広告の場合、コールバックの順序は第三者広告ネットワーク SDK の実装によって決定されます。報酬情報を単一のデリゲートメソッドに提供する広告ネットワーク SDK の場合、メディエーションアダプタは adDidDismissFullScreenContent: の前に userDidEarnRewardHandler を呼び出します。

GitHub の例

リワード広告の例: Swift | Objective-C

次のステップ

詳しくは、ユーザーのプライバシーについての説明をご覧ください。