リワード広告は、ユーザーが広告を操作することと引き換えに のアプリ内報酬を獲得しましょう。このガイドでは、アド マネージャーのリワード広告を iOS アプリに組み込む方法について説明します。
前提条件
- Google Mobile Ads SDK 8.0.0 以降
- スタートガイドを完了している。
必ずテスト広告でテストする
アプリを作成、テストする際は、テスト広告ではなく、 配信します。実際の広告を使用すると、アカウントが停止される可能性があります。
テスト広告を読み込むには、iOS 向けのテスト専用広告ユニット ID を使う方法が最も簡単です リワード広告:
/21775744923/example/rewarded
この ID は、すべてのリクエストに対してテスト広告を返すように構成されており、アプリのコーディング、テスト、デバッグで自由に使うことができます。作成するだけで アプリを公開する前に、必ずご自身の広告ユニット ID に置き換えてください。
Mobile Ads SDK のテスト広告の仕組みについて詳しくは、テスト広告の仕組みに関するページ 広告。
実装
リワード広告を統合する主な手順は次のとおりです。
- 広告を読み込む
- [省略可] SSV コールバックを検証する
- コールバックに登録する
- 広告を表示して報酬イベントを処理する
広告を読み込む
広告の読み込みは、load(adUnitID:request)
を使用して行います。
メソッド(GADRewardedAd
クラスのメソッド)でアクセスできます。
Swift
import GoogleMobileAds
import UIKit
class ViewController: UIViewController {
private var rewardedAd: GADRewardedAd?
func loadRewardedAd() async {
do {
rewardedAd = try await GADRewardedAd.load(
withAdUnitID: "/21775744923/example/rewarded", request: GAMRequest())
} catch {
print("Rewarded ad failed to load with error: \(error.localizedDescription)")
}
}
}
SwiftUI
import GoogleMobileAds
class RewardedViewModel: NSObject, ObservableObject, GADFullScreenContentDelegate {
@Published var coins = 0
private var rewardedAd: GADRewardedAd?
func loadAd() async {
do {
rewardedAd = try await GADRewardedAd.load(
withAdUnitID: "ca-app-pub-3940256099942544/1712485313", request: GADRequest())
rewardedAd?.fullScreenContentDelegate = self
} catch {
print("Failed to load rewarded ad 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:@"/21775744923/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: "/21775744923/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:@"/21775744923/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() async {
do {
rewardedAd = try await GADRewardedAd.load(
withAdUnitID: "/21775744923/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.")
}
}
SwiftUI
返された広告に fullScreenContentDelegate
プロパティを割り当てます。
rewardedAd?.fullScreenContentDelegate = self
プロトコルを実装します。
func adDidRecordImpression(_ ad: GADFullScreenPresentingAd) {
print("\(#function) called")
}
func adDidRecordClick(_ ad: GADFullScreenPresentingAd) {
print("\(#function) called")
}
func ad(
_ ad: GADFullScreenPresentingAd,
didFailToPresentFullScreenContentWithError error: Error
) {
print("\(#function) called")
}
func adWillPresentFullScreenContent(_ ad: GADFullScreenPresentingAd) {
print("\(#function) called")
}
func adWillDismissFullScreenContent(_ ad: GADFullScreenPresentingAd) {
print("\(#function) called")
}
func adDidDismissFullScreenContent(_ ad: GADFullScreenPresentingAd) {
print("\(#function) called")
// Clear the rewarded ad.
rewardedAd = nil
}
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.
}
}
SwiftUI
ビューの UI イベントをリッスンして、広告を表示するタイミングを決定します。
var body: some View {
VStack(spacing: 20) {
Button("Watch video for additional 10 coins") {
viewModel.showAd()
showWatchVideoButton = false
}
ビューモデルからリワード広告を表示します。
func showAd() {
guard let rewardedAd = rewardedAd else {
return print("Ad wasn't ready.")
}
rewardedAd.present(fromRootViewController: nil) {
let reward = rewardedAd.adReward
print("Reward amount: \(reward.amount)")
self.addCoins(reward.amount.intValue)
}
}
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 が
GADInitializationCompletionHandler
をstartWithCompletionHandler:
メソッドが使用されます(メディエーション ネットワークがまだ適用されていない場合も同様)。 初期化が完了しています。 - 初期化コールバックを受け取ったときに、準備が完了していないメディエーション ネットワークがある場合はどうなりますか?
広告の読み込みは
GADInitializationCompletionHandler
。メディエーションネットワークの準備ができていなくても Google Mobile Ads SDK はそのネットワークに広告をリクエストします。たとえば タイムアウト後にメディエーション ネットワークの初期化が終了しても、 そのセッションで今後の広告リクエスト数が記録されます。移行期間中は、引き続きすべてのアダプタの初期化ステータスをポーリングできます。
GADMobileAds.initializationStatus
を呼び出してアプリ セッションを開始します。- 特定のメディエーション ネットワークの準備ができていない理由を調べるにはどうすればよいですか?
GADAdapterStatus
オブジェクトのdescription
プロパティでは、 アダプタが広告リクエストを処理する準備ができていません。userDidEarnRewardHandler
完了ハンドラは常にadDidDismissFullScreenContent:
デリゲート メソッドの前に呼び出されますか?Google 広告の場合、
userDidEarnRewardHandler
の呼び出しはすべて発生しますadDidDismissFullScreenContent:
より前にご確認ください。Google 広告を介して配信される広告については、 メディエーションと第三者広告ネットワーク コールバックの順序は SDK の実装によって決まります。使用できる広告ネットワーク SDK が 報酬情報を含む単一のデリゲート メソッドを提供する、メディエーション アダプタadDidDismissFullScreenContent:
の前にuserDidEarnRewardHandler
を呼び出します。
GitHub の例
ご希望の言語でのリワード広告の例をご覧ください。
次のステップ
詳しくは、ユーザーのプライバシーについての説明をご覧ください。