リワード広告は、ユーザーが広告を操作することと引き換えにアプリ内で報酬を獲得できる広告です。このガイドでは、 AdMobリワード広告を iOS アプリに組み込む方法について説明します。 お客様の成功事例をいくつかご覧ください。 ケーススタディ 1 ケーススタディ 2
前提条件
- Google Mobile Ads SDK 8.0.0 以降。
- スタートガイドを完了している。
必ずテスト広告でテストする
アプリの作成とテストの際は、実際の実際の広告ではなく、テスト広告を使用してください。実際の広告を使用すると、アカウントが停止される可能性があります。
以下の iOS リワード広告向けのテスト専用広告ユニット ID を使うと、テスト広告を簡単に読み込むことができます。
ca-app-pub-3940256099942544/1712485313
この ID は、すべてのリクエストに対してテスト広告を返すように構成されており、アプリのコーディング、テスト、デバッグで自由に使うことができます。なお、テスト用 ID は、アプリを公開する前に必ずご自身の広告ユニット ID に置き換えてください。
Mobile Ads SDK のテスト広告の仕組みについて詳しくは、テスト広告をご覧ください。
実装
リワード インタースティシャル広告を組み込む主な手順は、以下のとおりです。
- 広告を読み込む
- [省略可] SSV コールバックを検証する
- コールバックに登録する
- 広告を表示して報酬イベントを処理する
広告を読み込む
広告の読み込みは、GADRewardedAd
クラスで静的 loadWithAdUnitID:request:completionHandler:
メソッドを使用して行います。読み込みメソッドには、広告ユニット ID と GADRequest
オブジェクトのほか、広告の読み込みの成功時または失敗時に呼び出される完了ハンドラが必要です。読み込まれた GADRewardedAd
オブジェクトは、完了ハンドラのパラメータとして提供されます。次の例は、ViewController
クラスで GADRewardedAd
を読み込む方法を示しています。
Swift
import GoogleMobileAds
import UIKit
class ViewController: UIViewController {
private var rewardedAd: GADRewardedAd?
func loadRewardedAd() {
do {
rewardedAd = try await GADRewardedAd.load(
withAdUnitID: "ca-app-pub-3940256099942544/1712485313", request: GADRequest())
} 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 {
GADRequest *request = [GADRequest request];
[GADRewardedAd
loadWithAdUnitID:@"ca-app-pub-3940256099942544/1712485313"
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
クエリ パラメータに渡されます。カスタムデータ値が設定されていない場合、SSV コールバックは custom_data
クエリ パラメータ値を持ちません。
次のコードサンプルは、広告をリクエストする前に、リワード広告オブジェクトにカスタムデータを設定する方法を示しています。
Swift
do {
rewardedAd = try await GADRewardedAd.load(
withAdUnitID: "ca-app-pub-3940256099942544/1712485313", request: GADRequest())
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:@"ca-app-pub-3940256099942544/1712485313"
request:[GADRequest 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: "ca-app-pub-3940256099942544/1712485313", request: GADRequest())
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 {
GADRequest *request = [GADRequest 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
次のステップ
詳しくは、ユーザーのプライバシーをご覧ください。