SDK の移行

このページでは、Google Cloud コンソールの現行バージョンと以前のバージョン iOS 向け Mobile Ads SDKバージョン 11.0.0 は 1 月にリリースされる予定です。 2024 年。

SDK バージョン v10 から v11 に移行する

最小デプロイ ターゲット

最小デプロイ ターゲットが iOS 12 に引き上げられました。

Xcode の最小バージョン

サポートされる Xcode の最小バージョンが 15.1 に引き上げられました。

iOS 12 での広告配信停止

Google Mobile Ads SDK バージョン 11.0.0 が iOS 13 を搭載するデバイスにのみ広告を配信 以上です。

GoogleAppMeasurement の依存関係を削除しました

バージョン 11.0.0 では、 GoogleAppMeasurement は 削除されます。AdMob でユーザーに関する指標を切り替えるこの依存関係は、 廃止されました。宛先 AdMob で引き続きユーザーに関する指標を収集し AdMob アプリを Firebase にリンクする 統合 Firebase 向け Google アナリティクス SDK を 説明します。

全画面広告の表示に関する変更

以下の変更は、各種広告フォーマットに影響します。

  • アプリ起動
  • インタースティシャル
  • 特典
  • リワード インタースティシャル

-canPresentFromRootViewController:error: のビュー コントローラ パラメータと -presentFromRootViewController: は null 値許容です。nil が渡されると、広告は ビュー コントローラ階層の最上位のビュー コントローラから表示されます。

削除されたメソッド

次のメソッドが削除されます。

v11.0.0 のタイプ メソッド メモ
GADAppOpenAd load(withAdUnitID adUnitID: String, request: GADRequest?, orientation: UIInterfaceOrientation) 代わりに load(withAdUnitID adUnitID: String, request: GADRequest?) を使用してください。
GADMediationBannerAdEventDelegate willBackgroundApplication() 代替機能はありません。
GADMediationInterstitialAdEventDelegate willBackgroundApplication() 代替機能はありません。
GADMediationNativeAdEventDelegate willBackgroundApplication() 代替機能はありません。
GADMediationRewardedAdEventDelegate didRewardUser(with reward: GADAdReward) 代わりに didRewardUser() を使用してください。
GADMediatedUnifiedNativeAdNotificationSource mediatedNativeAdWillLeaveApplication(_ mediatedNativeAd: GADMediatedUnifiedNativeAd) 代替機能はありません。
GADRequestConfiguration setSameAppKeyEnabled(_ enabled: Bool) setPublisherFirstPartyIDEnabled(_ enabled: Bool) を代わりに使用してください。
tagForUnderAge(ofConsent underAgeOfConsent: Bool) 代わりに tagForUnderAgeOfConsent プロパティを使用してください。
tag(forChildDirectedTreatment childDirectedTreatment: Bool) 代わりに tagForChildDirectedTreatment プロパティを使用してください。

削除されたプロパティ

次のプロパティが削除されます。

v11.0.0 クラス プロパティ メモ
GADMediationAdConfiguration hasUserLocation 代替機能はありません。
userLatitude
userLongitude
userLocationAccuracyInMeters
childDirectedTreatment 代わりに GADMobileAds.sharedInstance.requestConfiguration.tagForChildDirectedTreatment を使用してください。
GADResponseInfo adNetworkClassName 代わりに loadedAdNetworkResponseInfoadNetworkClassName を使用してください。

GADAdFormatUnknown を削除しました

GADAdFormatUnknown を置き換えずに削除しました。

Logging SDK バージョンの変更

バージョン 11.0.0 では sdkVersion が削除されました。Google Mobile Ads SDK のバージョンをロギングするには versionNumber を使用 してください。

バージョン 10.0.0

GADMobileAds.sharedInstance().sdkVersion

バージョン 11.0.0

GADGetStringFromVersionNumber(GADMobileAds.sharedInstance().versionNumber)

GADAdLoader エラー処理に関する変更

バージョン 11.0.0 以降では、GADAdLoaderdelegate リクエストされた広告タイプに準拠していません委任プロトコルを使用します。以前は、 失敗します

テスト動作の変更

表で、次の場合に更新された条件を確認してください。 プロパティは true を返します。

クラス プロパティ
GADMediationAdConfiguration isTestRequest
GADCustomEventRequest isTesting
v10.0.0 v11.0.0
  • デバイスが testDeviceIdentifiers でテストデバイスとして明示的に宣言されている。
  • デバイスが testDeviceIdentifiers でテストデバイスとして明示的に宣言されている。
  • デバイスがシミュレータである。
  • デバイスが AdMob UI でテストデバイスとして明示的に宣言されている。

v9 から v10 への移行

iOS 11 での広告配信が停止されます

Google Mobile Ads SDK バージョン 10.0.0 では、iOS 12 以降を搭載したデバイスにのみ広告が配信されます。

Google Mobile Ads SDK バージョン 10.0.0 へのアップグレードによって、iOS 11 と iOS 10 のデバイスでアプリが動作しなくなることはありませんが、広告は配信されなくなります。

ビットコードによるビルドのサポートが終了しました

Google Mobile Ads SDK を統合するには、モバイルアプリでビットコードを無効にする必要があります。

削除された型

種類 メモ
GADGender 代替はありません。
GADMRewardBasedVideoAdNetworkAdapterProtocol ネットワークの選択に関する記事に記載されているすべてのリワード メディエーション アダプタでは、これらのプロトコルの使用が 1 年以上停止しています。 メディエーションとカスタム イベントには、 GADMediationAdapter を使用してください。
GADMRewardBasedVideoAdNetworkConnectorProtocol

削除されたプロパティ

次のプロパティは削除され、代替はありません。

v10.0.0 クラス プロパティ
GADMediationAdRequest userBirthday
userGender
userHasLocation
userLatitude
userLongitude
userLocationAccuracyInMeters
userLocationDescription
GADCustomEventRequest userHasLocation
userLatitude
userLongitude
userLocationAccuracyInMeters
userLocationDescription

v8 から v9 への移行

iOS 10 での広告配信が停止されます

Google Mobile Ads SDK バージョン 9.0.0 がサポートする iOS バージョンは、iOS 11 以降です。

Google Mobile Ads SDK バージョン 9.0.0 にアップグレードしても、iOS 10 デバイスでアプリが動作しなくなることはありませんが、広告は配信されなくなります。

ステータスバー コントロールの適用強化

バージョン 9.0.0 以降では、全画面フォーマットの広告を表示する場合、その広告でステータスバーの表示を制御できるようにする必要があります。それができていない場合は、ログにエラー メッセージが表示されます。

アプリ内のビュー コントローラのレイアウトによっては、このレイアウトを実現するために変更する必要はありません。広告の rootViewControllerchildViewControllerForStatusBarHidden プロパティを設定する必要があるかどうかをご検討ください。

ad DidPresentFullScreenContent: の名前を adWillPresentFullScreenContent に変更します。

動作の変更はありません。デリゲート メソッドは、広告が表示される直前に呼び出されるため、新しいメソッド名がその機能をより適切に反映したものになります。

GADRequest の Location Settings API を削除

Google は位置情報を広告のターゲティングに使用しないため、- (void)setLocationWithLatitude:longitude:accuracy:GADRequest から削除されました。必要に応じて、第三者 API を使用して第三者広告ネットワークに情報を提供します。

カスタム イベント インターフェースのサポート終了

カスタム イベントを使用すると、 AdMob メディエーションを使用するパブリッシャーは、サポートされている広告ネットワーク以外の広告ネットワーク向けに、ウォーターフォール メディエーションを追加できます。

カスタム イベント プロトコルはすべて非推奨になりました。代わりに、既存の GADMediationAdapter プロトコルと GADMediationAdEventDelegate プロトコルを使用して、同じ機能を実現できます。この変更により明確さが増し、以前は利用できなかったリワード広告とインタースクローラー広告用のカスタム イベントを作成できるようになりました。

API

以下の表は、バージョン 9.0.0 以降の使用が推奨される、カスタム イベント API に対応するメディエーション アダプタ API の一覧です。

v8 v9
GADCustomEventBanner
GADCustomEvent インタースティシャル
GADCustomEventNativeAd
GADMediationAdapter GADMediationBannerAd
GADMediation インタースティシャル Ad
GADMediationInterscrollerAd
GADMediationRewardedAd
GADMediationNativeAd
delegate デリゲートは、GADMediationAdapter クラスの各読み込み関数の読み込み完了ハンドラによって返されます。
-init -init
-requestBannerAd:parameter:label:request: -loadBannerForAdConfiguration:completionHandler:
-requestInterstitialAdWithParameter:label:request: -loadInterstitialForAdConfiguration:completionHandler:
-requestNativeAdWithParameter:request:adTypes:options:rootViewController: -loadNativeAdForAdConfiguration:completionHandler:
なし -loadInterscrollerAdForAdConfiguration:completionHandler:
なし -loadRewardedAdForAdConfiguration:completionHandler:
-presentFromRootViewController: -presentFromViewController:
-handlesUserClicks -handlesUserClicks
-handlesUserImpressions -handlesUserImpressions

メソッドを委任する

以下の表は、バージョン 9.0.0 以降で使用される、カスタム イベント デリゲート メソッドに対応するメディエーション広告イベント デリゲート メソッドの一覧です。

v8 v9
GADCustomEventBannerDelegate
GADCustomEvent インタースティシャル Delegate
GADCustomEventNativeAdDelegate
GADMediationAdEventDelegate GADMediationAd
-customEventBanner:didReceiveAd:
-customEventInterstitialDidReceiveAd:
広告の読み込みステータスは、GADMediationAdapter クラスの各読み込み関数の読み込み完了ハンドラに含まれます。
-customEventBanner:didFailAd:
-customEventInterstitial:didFailAd:
-customEventBannerWasClicked:
-customEventInterstitialWasClicked:
-reportClick
-customEventBannerWillPresentModal:
-customEventInterstitialWillPresentModal:
-willPresentFullScreenView
-customEventBannerWillDismissModal:
-customEventInterstitialWillDismissModal:
-willDismissFullScreenView
-customEventBannerDidDismissModal:
-customEventInterstitialDidDismissModal:
-didDismissFullScreenView
-customEventBannerWillLeaveApplication:
-customEventInterstitialWillLeaveApplication:
-willBackgroundApplication
viewControllerForPresentingModalView -[GADMediationBannerAd view]

削除または置換されたその他のメソッドと定数

メソッド、定数、プロパティの変更
kGAD- プレフィックス付き定数 削除しました。接頭辞 GAD- の付いた定数を使用します。
GADAdNetworkResponseInfo credentials が削除されました。代わりに adUnitMapping を使用してください。
GAMRequest GAMRequestkGAMSimulatorID が非推奨になりました。代わりに GADRequestConfigurationGADSimulatorID を使用してください。
GADCustomNativeAd GADCustomNativeAdmediaView が非推奨になりました。代わりに mediaContent を使用してください。
GoogleMobileAds の In-App Purchase API GoogleMobileAdsinAppPurchase API が削除されました。

v7 から v8 への移行

Google Mobile Ads SDK version 8.0.0 introduces a few major changes as well as some renames and removals of APIs.

Full-screen format API updates

Starting with version 8.0.0, interstitial and rewarded ads share a generic full screen ad style for more consistency. These new full-screen ad APIs have two major distinctions from the version 7 full-screen ad APIs:

  1. Static class method load.

    The previous approach to load/show a full-screen ad is as follows:

    1. Create an ad object instance and hold a reference to it.
    2. Assign a delegate that handles load and show callbacks.
    3. Load an ad.
    4. Check if ad is loaded using isReady.
    5. Show the ad.

    In version 8, the approach changes slightly. Load callbacks are no longer part of a delegate. Instead, they're passed into the load method as a completion handler:

    1. Call a static load method on the ad class and provide a load completion handler.
    2. In the load completion callback, keep a reference to the loaded ad that's returned.
    3. Assign a delegate that handles show callbacks.
    4. Show the ad.

    The new approach provides these benefits:

    • You won't ever have a reference to an ad that is not loaded.
    • You don't have to hold onto an ad object while it's loading.
  2. Consistent ad events.

    Event type Existing API v8 API
    Load events GADInterstitialDelegate or GADRewardedAdDelegate GADInterstitialAdLoadCompletionHandler or GADRewardedAdLoadCompletionHandler
    Presentation events GADFullScreenContentDelegate

    Previously, to listen for any ad events, you would register a class that implements the GADInterstitialDelegate protocol to an interstitial's delegate property, or register a class that implements the GADRewardedAdDelegate protocol to a rewarded ad's delegate property depending on which format you're using. This same delegate had methods related to both the loading and presentation life cycle of an ad.

    With version 8, load and presentation events are separate. You can now register a GADFullScreenContentDelegate any time prior to showing an ad instead of being required to set a single delegate prior to loading the ad. Ad load events, which are specific to each format, move to a single load completion handler passed in the load method.

Interstitial

Load ad

The code snippets below show you how to load an interstitial ad and listen for events when the ad succeeds or fails to load.

v7

Swift

import GoogleMobileAds
import UIKit

class ViewController: UIViewController, GADInterstitialDelegate {

  var interstitial: GADInterstitial!

  override func viewDidLoad() {
    super.viewDidLoad()
    interstitial = GADInterstitial(adUnitID: "ca-app-pub-3940256099942544/4411468910")
    interstitial.delegate = self
    let request = GADRequest()
    interstitial.load(request)
  }

  /// Tells the delegate an ad request succeeded.
  func interstitialDidReceiveAd(_ ad: GADInterstitial) {
    print("Interstitial ad loaded.")
  }

  /// Tells the delegate an ad request failed.
  func interstitial(_ ad: GADInterstitial, didFailToReceiveAdWithError error: GADRequestError) {
    print("Interstitial ad failed to load with error: \(error.localizedDescription)")
  }
}

Objective-C

@import GoogleMobileAds;
@import UIKit;

@interface ViewController () 

@property(nonatomic, strong) GADInterstitial *interstitial;

@end

@implementation ViewController

- (void)viewDidLoad {
  [super viewDidLoad];
  self.interstitial = [[GADInterstitial alloc]
      initWithAdUnitID:@"ca-app-pub-3940256099942544/4411468910"];
  self.interstitial.delegate = self;
  GADRequest *request = [GADRequest request];
  [self.interstitial loadRequest:request];
}

/// Tells the delegate an ad request succeeded.
- (void)interstitialDidReceiveAd:(GADInterstitial *)ad {
  NSLog(@"Insterstitial ad loaded.");
}

/// Tells the delegate an ad request failed.
- (void)interstitial:(GADInterstitial *)ad
    didFailToReceiveAdWithError:(GADRequestError *)error {
  NSLog(@"Interstitial ad failed to load with error: %@", [error localizedDescription]);
}

v8

Swift

import GoogleMobileAds
import UIKit

class ViewController: UIViewController, GADFullScreenContentDelegate {

  var interstitial: GADInterstitialAd?

  override func viewDidLoad() {
    super.viewDidLoad()
    let request = GADRequest()
    GADInterstitialAd.load(withAdUnitID:"ca-app-pub-8123415297019784/4985798738",
                                request: request,
                      completionHandler: { (ad, error) in
                        if let error = error {
                          print("Failed to load interstitial ad with error: \(error.localizedDescription)")
                          return
                        }
                        self.interstitial = ad
                        self.interstitial.fullScreenContentDelegate = self
                      }
    )
  }
}

Objective-C

@import GoogleMobileAds;
@import UIKit;

@interface ViewController () 

@property(nonatomic, strong) GADInterstitialAd *interstitial;

@end

@implementation ViewController

- (void)viewDidLoad {
  [super viewDidLoad];
  GADRequest *request = [GADRequest request];
  [GADInterstitialAd loadWithAdUnitID:@"ca-app-pub-3940256099942544/4411468910"
                              request:request
                    completionHandler:^(GADInterstitialAd *ad, NSError *error) {
    if (error) {
      NSLog(@"Failed to load interstitial ad with error: %@", [error localizedDescription]);
      return;
    }
    self.interstitial = ad;
    self.interstitial.fullScreenContentDelegate = self;
  }];
}

Display ad

v7

Swift

func showInterstitial() {
  ...
  if interstitial.isReady {
    interstitial.present(fromRootViewController: self)
  } else {
    print("Ad wasn't ready")
  }
}

Objective-C

- (void)showInterstitial: {
  ...
  if (self.interstitial.isReady) {
    [self.interstitial presentFromRootViewController:self];
  } else {
    NSLog(@"Ad wasn't ready");
  }
}

v8

Swift

func showInterstitial() {
  ...
  if let ad = interstitial {
    ad.present(fromRootViewController: self)
  } else {
    print("Ad wasn't ready")
  }
}

Objective-C

- (void)showInterstitial: {
  ...
  if (self.interstitial) {
    [self.interstitial presentFromRootViewController:self];
  } else {
    NSLog(@"Ad wasn't ready");
  }
}

Presentation ad events

The code snippets below show you how to handle callbacks for when the ad presents (successfully or unsuccessfully) and when it is dismissed.

v7

Swift

override func viewDidLoad() {
  super.viewDidLoad()
  interstitial = GADInterstitial(adUnitID: "ca-app-pub-3940256099942544/4411468910")
  interstitial.delegate = self
  ...
}

/// Tells the delegate that an interstitial will be presented.
func interstitialWillPresentScreen(_ ad: GADInterstitial) {
  print("Interstitial ad will be presented.")
}

/// Tells the delegate the interstitial is to be animated off the screen.
func interstitialWillDismissScreen(_ ad: GADInterstitial) {
  print("Interstitial ad will be dismissed.")
}

/// Tells the delegate the interstitial had been animated off the screen.
func interstitialDidDismissScreen(_ ad: GADInterstitial) {
  print("Interstitial ad dismissed.")
}

/// Tells the delegate that a user click will open another app
/// (such as the App Store), backgrounding the current app.
///
/// This is not a reliable callback for an ad click event and is removed in
/// version 8. If you wish to listen to an ad causing a user to leave the app,
/// use applicationWillResignActive: or sceneWillResignActive: instead.
func interstitialWillLeaveApplication(_ ad: GADInterstitial) {
  print("Interstitial ad will leave application.")
}

Objective-C

- (void)viewDidLoad {
  [super viewDidLoad];
  self.interstitial = [[GADInterstitial alloc] initWithAdUnitID:"ca-app-pub-3940256099942544/4411468910"];
  self.interstitial.delegate = self;
  ...
}

/// Tells the delegate that an interstitial will be presented.
- (void)interstitialWillPresentScreen:(GADInterstitial *)ad {
  NSLog(@"Interstitial ad will be presented.");
}

/// Tells the delegate the interstitial is to be animated off the screen.
- (void)interstitialWillDismissScreen:(GADInterstitial *)ad {
  NSLog(@"Interstitial ad will be dismissed.");
}

/// Tells the delegate the interstitial had been animated off the screen.
- (void)interstitialDidDismissScreen:(GADInterstitial *)ad {
  NSLog(@"Interstitial ad dismissed.");
}

/// Tells the delegate that a user click will open another app
/// (such as the App Store), backgrounding the current app.
///
/// This is not a reliable callback for an ad click event and is removed in
/// version 8. If you wish to listen to an ad causing a user to leave the app,
/// use applicationWillResignActive: or sceneWillResignActive: instead.
- (void)interstitialWillLeaveApplication:(GADInterstitial *)ad {
  NSLog(@"Interstitial ad will leave application.");
}

v8

Swift

override func viewDidLoad() {
  super.viewDidLoad()
  let request = GADRequest()
  GADInterstitialAd.load(withAdUnitID:"ca-app-pub-8123415297019784/4985798738",
                              request: request,
                    completionHandler: { (ad, error) in
                      if let error = error {
                        print(error.localizedDescription)
                        return
                      }
                      self.interstitial = ad
                      self.interstitial.fullScreenContentDelegate = self
                    }
  )
}

func adDidPresentFullScreenContent(_ ad: GADFullScreenPresentingAd) {
  print("Ad did present full screen content.")
}

func ad(_ ad: GADFullScreenPresentingAd, didFailToPresentFullScreenContentWithError error: Error) {
  print("Ad failed to present full screen content with error \(error.localizedDescription).")
}

func adDidDismissFullScreenContent(_ ad: GADFullScreenPresentingAd) {
  print("Ad did dismiss full screen content.")
}

Objective-C

- (void)viewDidLoad {
  [super viewDidLoad];
  GADRequest *request = [GADRequest request];
  [GADInterstitialAd loadWithAdUnitID:@"ca-app-pub-3940256099942544/4411468910"
                              request:request
                    completionHandler:^(GADInterstitialAd *ad, NSError *error) {
    if (error) {
      NSLog(@"interstitial:didFailToReceiveAdWithError: %@", [error localizedDescription])
      return;
    }
    self.interstitial = ad;
    self.interstitial.fullScreenContentDelegate = self;
  }];
}

- (void)adDidPresentFullScreenContent:(id)ad {
  NSLog(@"Ad did present full screen content.");
}

- (void)ad:(id)ad didFailToPresentFullScreenContentWithError:(NSError *)error {
  NSLog(@"Ad failed to present full screen content with error %@.", [error localizedDescription]);
}

- (void)adDidDismissFullScreenContent:(id)ad {
  NSLog(@"Ad did dismiss full screen content.");
}

Rewarded

Load ad

v7

Swift

import GoogleMobileAds
import UIKit

class ViewController: UIViewController, GADRewardedAdDelegate {
  /// The rewarded ad.
  var rewardedAd: GADRewardedAd?

  override func viewDidLoad() {
    super.viewDidLoad()
    rewardedAd = GADRewardedAd(adUnitID: "ca-app-pub-3940256099942544/1712485313")
    rewardedAd.delegate = self
    rewardedAd?.load(GADRequest()) { error in
      if let error = error {
        print("Rewarded ad failed to load with error: \(error.localizedDescription)")
      } else {
        print("Rewarded ad loaded.")
      }
    }
  }
}

Objective-C

@import GoogleMobileAds;
@import UIKit;

@interface ViewController () 

@property(nonatomic, strong) GADRewardedAd *rewardedAd;

@end

@implementation ViewController

- (void)viewDidLoad {
  [super viewDidLoad];

  self.rewardedAd = [[GADRewardedAd alloc]
      initWithAdUnitID:@"ca-app-pub-3940256099942544/1712485313"];
  self.rewardedAd.delegate = self;
  GADRequest *request = [GADRequest request];
  [self.rewardedAd loadRequest:request completionHandler:^(GADRequestError * _Nullable error) {
    if (error) {
      NSLog(@"Rewarded ad failed to load with error: %@", [error localizedDescription]);
    } else {
      NSLog(@"Rewarded ad loaded.");
    }
  }];
}

v8

Swift

import GoogleMobileAds
import UIKit

class ViewController: UIViewController, GADFullScreenContentDelegate {
  /// The rewarded ad.
  var rewardedAd: GADRewardedAd?

  override func viewDidLoad() {
  super.viewDidLoad()
  let request = GADRequest()
  GADRewardedAd.load(withAdUnitID: "ca-app-pub-8123415297019784/9501821136",
                          request: request, completionHandler: { (ad, error) in
                            if let error = error {
                              print("Rewarded ad failed to load with error: \(error.localizedDescription)")
                              return
                            }
                            self.rewardedAd = ad
                            self.rewardedAd?.fullScreenContentDelegate = self
                          }
  )
  }
}

Objective-C

@import GoogleMobileAds;
@import UIKit;

@interface ViewController () 

@property(nonatomic, strong) GADRewardedAd *rewardedAd;

@end

@implementation ViewController

- (void)viewDidLoad {
  [super viewDidLoad];

  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.");
    self.rewardedAd.fullScreenContentDelegate = self;
}

Display ad and handle reward

Rewarded ads require you to handle the event when a user earns a reward. With version 7 of the GADRewardedAd API, you implement rewardedAd:userDidEarnReward: as part of the GADRewardedAdDelegate protocol. For version 8, you implement the GADUserDidEarnRewardHandler in order to present the ad.

v7

Swift

func showRewardedAd() {
  ...
  if rewardedAd.isReady {
    rewardedAd.present(fromRootViewController: self delegate:self)
  } else {
    print("Ad wasn't ready")
  }
}

/// Tells the delegate that the user earned a reward.
func rewardedAd(_ rewardedAd: GADRewardedAd, userDidEarnReward: GADAdReward) {
  // TODO: Reward the user.
}

Objective-C

- (void)showRewardedAd: {
  ...
  if (self.rewardedAd.isReady) {
    [self.rewardedAd presentFromRootViewController:self delegate:self];
  } else {
    NSLog(@"Ad wasn't ready");
  }
}

/// Tells the delegate that the user earned a reward.
- (void)rewardedAd:(GADRewardedAd *)rewardedAd userDidEarnReward:(GADAdReward *)reward {
  // TODO: Reward the user.
}

v8

Swift

func showRewardedAd() {
  ...
  if let ad = rewardedAd {
      ad.present(fromRootViewController: self,
               userDidEarnRewardHandler: {
                 let reward = ad.adReward
                 // TODO: Reward the user.
               }
      )
  } else {
    print("Ad wasn't ready")
  }
}

Objective-C

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

Presentation ad events

With the GADRewardedAd API you pass a GADRewardedAdDelegate to the method that presents the ad. With the GADRewardedAd API, you set a GADFullscreenContentDelegate as a property on the ad prior to presenting the ad.

v7

Swift

func showRewardedAd() {
  ...
  if rewardedAd.isReady {
    rewardedAd.present(fromRootViewController: self delegate:self)
  } else {
    print("Ad wasn't ready")
  }
}

/// Tells the delegate that the rewarded ad was presented.
func rewardedAdDidPresent(_ rewardedAd: GADRewardedAd) {
  print("Rewarded ad presented.")
}
/// Tells the delegate that the rewarded ad was dismissed.
func rewardedAdDidDismiss(_ rewardedAd: GADRewardedAd) {
  print("Rewarded ad dismissed.")
}
/// Tells the delegate that the rewarded ad failed to present.
func rewardedAd(_ rewardedAd: GADRewardedAd, didFailToPresentWithError error: Error) {
  print("Rewarded ad failed to present with error: \(error.localizedDescription).")
}

Objective-C

- (void)showRewardedAd: {
  ...
  if (self.rewardedAd.isReady) {
    [self.rewardedAd presentFromRootViewController:self delegate:self];
  } else {
    NSLog(@"Ad wasn't ready");
  }
}

/// Tells the delegate that the rewarded ad was presented.
- (void)rewardedAdDidPresent:(GADRewardedAd *)rewardedAd {
  NSLog(@"Rewarded ad presented.");
}

/// Tells the delegate that the rewarded ad failed to present.
- (void)rewardedAd:(GADRewardedAd *)rewardedAd didFailToPresentWithError:(NSError *)error {
  NSLog(@"Rewarded ad failed to present with error: %@",
        [error localizedDescription]);
}

/// Tells the delegate that the rewarded ad was dismissed.
- (void)rewardedAdDidDismiss:(GADRewardedAd *)rewardedAd {
  NSLog(@"Rewarded ad dismissed.");
}

v8

Swift

override func viewDidLoad() {
  super.viewDidLoad()
  let request = GADRequest()
  GADRewardedAd.load(withAdUnitID: "ca-app-pub-8123415297019784/9501821136",
                          request: request, completionHandler: { (ad, error) in
                            if let error = error {
                              print(error.localizedDescription)
                              return
                            }
                            self.rewardedAd = ad
                            self.rewardedAd?.fullScreenContentDelegate = self
                          }
  )
}

/// Tells the delegate that the rewarded ad was presented.
func adDidPresentFullScreenContent(_ ad: GADFullScreenPresentingAd) {
  print("Rewarded ad presented.")
}
/// Tells the delegate that the rewarded ad was dismissed.
func adDidDismissFullScreenContent(_ ad: GADFullScreenPresentingAd) {
  print("Rewarded ad dismissed.")
}
/// Tells the delegate that the rewarded ad failed to present.
func ad(_ ad: GADFullScreenPresentingAd,
    didFailToPresentFullScreenContentWithError error: Error) {
  print("Rewarded ad failed to present with error: \(error.localizedDescription).")
}

Objective-C

- (void)viewDidLoad {
  [super viewDidLoad];

  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.");
    self.rewardedAd.fullScreenContentDelegate = self;
}

/// Tells the delegate that the rewarded ad was presented.
- (void)adDidPresentFullScreenContent:(id)ad {
  NSLog(@"Rewarded ad presented.");
}

/// Tells the delegate that the rewarded ad failed to present.
- (void)ad:(id)ad
    didFailToPresentFullScreenContentWithError:(NSError *)error {
  NSLog(@"Rewarded ad failed to present with error: %@",
       [error localizedDescription]);
}

/// Tells the delegate that the rewarded ad was dismissed.
- (void)adDidDismissFullScreenContent:(id)ad {
  NSLog(@"Rewarded ad dismissed.");
}

Legacy GADRewardedBasedVideoAd API removal

The newer GADRewardedAd API was first introduced back in March 2019 and has been the preferred rewarded API for over 18 months. It has had more enhancements compared to the legacy GADRewardedBasedVideoAd API, including the ability to load more than one rewarded ad at a time.

The legacy GADRewardedBasedVideoAd API is removed in SDK version 8.0.0.

Smart banner deprecation in favor of adaptive banner

Smart banner ads are deprecated in favor of adaptive banner ads. Adaptive banners provide superior performance and more flexibility in setting ad width. If you prefer to continue using full-width banners, that can still be done using adaptive banner, as shown in the following code snippet:

Swift

class ViewController: UIViewController {

  override func viewDidAppear(_ animated: Bool) {
    super.viewDidAppear(animated)
    // Note: The safe area is not known until viewWillAppear.
    let adSize = getFullWidthAdaptiveAdSize()
  }

  func getFullWidthAdaptiveAdSize() -> GADAdSize {
    // Here safe area is taken into account, hence the view frame is used after the
    // view has been laid out.
    let frame = { () -> CGRect in
      if #available(iOS 11.0, *) {
        return view.frame.inset(by: view.safeAreaInsets)
      } else {
        return view.frame
      }
    }()
    return GADCurrentOrientationAnchoredAdaptiveBannerAdSizeWithWidth(frame.size.width)
  }
}

Objective-C

@implementation ViewController

- (void)viewDidAppear:(BOOL)animated {
  [super viewDidAppear:animated];
  // Note: The safe area is not known until viewWillAppear.
  GADAdSize adSize = [self getFullWidthAdaptiveAdSize];
}

- (GADAdSize)getFullWidthAdaptiveAdSize {
  CGRect frame = self.view.frame;
  // Here safe area is taken into account, hence the view frame is used after
  // the view has been laid out.
  if (@available(iOS 11.0, *)) {
    frame = UIEdgeInsetsInsetRect(self.view.frame, self.view.safeAreaInsets);
  }
  return GADCurrentOrientationAnchoredAdaptiveBannerAdSizeWithWidth(frame.size.width);
}

@end

Leave application callback removal

The willLeaveApplication callback for all ad formats has been removed in favor of the applicationDidEnterBackground: and sceneDidEnterBackground: methods. Using OS-level APIs notify you whenever users leave your app, regardless of whether or not it is due to an ad interaction.

Note that the willLeaveApplication callback was never intended to be an ad click handler, and relying on this callback to report clicks did not produce an accurate metric. For example, a click on the AdChoices icon that launched an external browser invoked the callback but did not count a click.

Class renames

The table below lists specific class names that have changed or been removed in version 8. In summary:

  • All classes related to GADUnifiedNativeAd have been renamed to GADNativeAd.
  • GADRewardBasedVideoAd, GADNativeExpressAdView, and GADInstreamAd have been removed.
  • All classes with the DFP prefix have been replaced with a GAM prefix.
v7.68.0 Class v8.0.0 Class
DFPBannerView GAMBannerView
DFPBannerViewOptions GAMBannerViewOptions
DFPInterstitial GAMInterstitialAd
DFPRequest GAMRequest
GADRequestError NSError
GADUnifiedNativeAdView GADNativeAdView
GADUnifiedNativeAd GADNativeAd
GADUnifiedNativeAdAssetIdentifiers GADNativeAdAssetIdentifiers
GADUnifiedNativeAdDelegate GADNativeAdDelegate
GADUnifiedNativeAdUnconfirmedClickDelegate GADNativeAdUnconfirmedClickDelegate
GADNativeCustomTemplateAd GADCustomNativeAd
GADNativeCustomTemplateAdLoaderDelegate GADCustomNativeAdLoaderDelegate
GADNativeAdDelegate GADCustomNativeAdDelegate
GADInAppPurchase Removed
GADInterstitial GADInterstitialAd
GADNativeExpressAdView Removed
GADRewardBasedVideoAd Removed
GADInstreamAd Removed
GADInstreamAdView Removed

Methods removed/replaced

The table below lists the specific changes in version 8. In summary:

  • Previously deprecated methods and properties have been removed.
  • -willLeaveApplication: delegate methods have been removed for all formats.
  • The ad network class name has moved to the GADResponseInfo property.
  • The test device identifier has moved to the GADRequestConfiguration property.
v7.68.0 Class v7.68.0 API v8.0.0 API Notes
GADMobileAds +configureWithApplicationID: -startWithCompletionHandler: The app ID is now set in Info.plist.
+disableAutomatedInAppPurchaseReporting -disableAutomatedInAppPurchaseReporting
+disableSDKCrashReporting -disableSDKCrashReporting
GADRequest testDevices GADRequestConfiguration.testdeviceidentifiers The testDeviceIdentifiers property applies to all ad requests, while the old testDevices property was set per-request.
gender Removed
birthday Removed
+sdkVersion GADMobileAds.sharedInstance.sdkVersion
-setBirthdayWithMonth:day:year: Removed
-setLocationWithDescription: -setLocationWithLatitude:longitude:accuracy:
-tagForChildDirectedTreatment: [GADMobileAds.sharedInstance.requestConfiguration tagForChildDirectedTreatment]
GADErrorCode kGADError* GADError* The k prefix is dropped from all error code constants.
GADBannerView hasAutoRefreshed autoloadEnabled
inAppPurchaseDelegate Removed
mediatedAdView Removed
adNetworkClassName responseInfo.adNetworkClassName
DFPBannerView -setValidAdSizesWithSizes: -setValidAdSizes:
DFPBannerViewOptions -adSizeDelegate Removed
GADBannerViewDelegate -adViewDidReceiveAd: -bannerViewDidReceiveAd:
-adView:didFailToReceiveAdWithError: -bannerView:didFailToReceiveAdWithError:
-adViewWillPresentScreen: -bannerViewWillPresentScreen:
-adViewWillDismissScreen: -bannerViewWillDismissScreen:
-adViewDidDismissScreen: -bannerViewDidDismissScreen:
-adViewWillLeaveApplication: Removed
GADNativeCustomTemplateAd templateID GADCustomNativeAd.formatID
-performClickOnAssetWithKey:customClickHandler: -performClickOnAssetWithKey:
GADNativeAdImageAdLoaderOptions preferredImageOrientation GADNativeAdMediaAdOptions.mediaAspectRatio
GADInterstitial inAppPurchaseDelegate Removed
isReady Removed Use canPresentFromRootViewController:error: instead.
hasBeenUsed Removed
-init -initWithAdUnitID:
-setAdUnitID: -initWithAdUnitID:
adNetworkClassName responseInfo.adNetworkClassName
-interstitialWillLeaveApplication: Removed
GADUnifiedNativeAd videoController mediaContent.videoController
adNetworkClassName responseInfo.adNetworkClassName