Di chuyển SDK

Trang này trình bày cách di chuyển đối với phiên bản hiện tại và phiên bản trước đây của Google SDK quảng cáo trên thiết bị di động dành cho iOS. Phiên bản 11.0.0 dự kiến sẽ ra mắt vào tháng 1 2024.

Chuyển từ SDK phiên bản 10 sang phiên bản 11

Mục tiêu triển khai tối thiểu

Mục tiêu triển khai tối thiểu đã được tăng lên iOS 12.

Phiên bản Xcode tối thiểu

Phiên bản Xcode tối thiểu được hỗ trợ đã tăng lên 15.1.

Ngừng phân phát quảng cáo trên iOS 12

SDK quảng cáo trên thiết bị di động của Google phiên bản 11.0.0 chỉ phân phát quảng cáo trên các thiết bị chạy iOS 13 trở lên.

Đã xoá phần phụ thuộc GoogleAppMeasurement

Trong phiên bản 11.0.0, phần phụ thuộc trên GoogleAppMeasurement đã bị xoá. Phần phụ thuộc này (hỗ trợ nút bật/tắt chỉ số người dùng trong AdMob) sẽ ngừng hoạt động từ đầu năm 2024. Để tiếp tục thu thập chỉ số người dùng trong AdMob, hãy liên kết ứng dụng AdMob với Firebase và tích hợp SDK Google Analytics cho Firebase vào ứng dụng của bạn.

Thay đổi đối với bản trình bày quảng cáo toàn màn hình

Những thay đổi sau ảnh hưởng đến nhiều định dạng quảng cáo khác nhau:

  • Quảng cáo khi mở ứng dụng
  • Quảng cáo xen kẽ
  • Được thưởng
  • Quảng cáo xen kẽ có tặng thưởng

Tham số bộ điều khiển chế độ xem trong -canPresentFromRootViewController:error:-presentFromRootViewController: có thể nhận giá trị rỗng. Nếu giá trị rỗng được truyền, quảng cáo sẽ hiển thị từ bộ điều khiển chế độ xem trên cùng trong hệ phân cấp bộ điều khiển chế độ xem.

Đã xoá các phương thức

Các phương thức sau đã bị xoá.

Loại phiên bản 11.0.0 Phương thức Ghi chú
GADAppOpenAd load(withAdUnitID adUnitID: String, request: GADRequest?, orientation: UIInterfaceOrientation) Thay vào đó, hãy sử dụng load(withAdUnitID adUnitID: String, request: GADRequest?).
GADMediationBannerAdEventDelegate willBackgroundApplication() Không có loại thay thế.
GADMediationInterstitialAdEventDelegate willBackgroundApplication() Không có loại thay thế.
GADMediationNativeAdEventDelegate willBackgroundApplication() Không có loại thay thế.
GADMediationRewardedAdEventDelegate didRewardUser(with reward: GADAdReward) Thay vào đó, hãy sử dụng didRewardUser().
GADMediatedUnifiedNativeAdNotificationSource mediatedNativeAdWillLeaveApplication(_ mediatedNativeAd: GADMediatedUnifiedNativeAd) Không có loại thay thế.
GADRequestConfiguration setSameAppKeyEnabled(_ enabled: Bool) Thay vào đó, hãy sử dụng setPublisherFirstPartyIDEnabled(_ enabled: Bool).
tagForUnderAge(ofConsent underAgeOfConsent: Bool) Thay vào đó, hãy sử dụng thuộc tính tagForUnderAgeOfConsent.
tag(forChildDirectedTreatment childDirectedTreatment: Bool) Thay vào đó, hãy sử dụng thuộc tính tagForChildDirectedTreatment.

Các thuộc tính đã bị xoá

Các thuộc tính sau đã bị xoá.

Lớp phiên bản 11.0.0 Tài sản Ghi chú
GADMediationAdConfiguration hasUserLocation Không có loại thay thế.
userLatitude
userLongitude
userLocationAccuracyInMeters
childDirectedTreatment Thay vào đó, hãy sử dụng GADMobileAds.sharedInstance.requestConfiguration.tagForChildDirectedTreatment.
GADResponseInfo adNetworkClassName Thay vào đó, hãy sử dụng adNetworkClassName từ loadedAdNetworkResponseInfo.

Đã xoá GADAdFormatUnknown

Đã xoá GADAdFormatUnknown mà không thay thế.

Các thay đổi đối với phiên bản SDK ghi nhật ký

Phiên bản 11.0.0 sẽ xoá sdkVersion. Để ghi lại phiên bản SDK Quảng cáo của Google trên thiết bị di động, hãy sử dụng versionNumber.

Phiên bản 10.0.0

GADMobileAds.sharedInstance().sdkVersion

Phiên bản 11.0.0

GADGetStringFromVersionNumber(GADMobileAds.sharedInstance().versionNumber)

Các thay đổi về cách xử lý lỗi gậy

Kể từ phiên bản 11.0.0, GADAdLoader sẽ không tạo yêu cầu quảng cáo nếu delegate không tuân thủ giao thức uỷ quyền của các loại quảng cáo được yêu cầu. Trước đây, API này không thành công sau khi thực hiện yêu cầu quảng cáo.

Thay đổi về hành vi kiểm thử

Hãy xem bảng cho biết các điều kiện đã cập nhật về thời điểm các thuộc tính sau trả về true.

Lớp Tài sản
GADMediationAdConfiguration isTestRequest
GADCustomEventRequest isTesting
v10.0.0 v11.0.0
  • Thiết bị được khai báo rõ ràng là thiết bị thử nghiệm trong testDeviceIdentifiers.
  • Thiết bị được khai báo rõ ràng là thiết bị thử nghiệm trong testDeviceIdentifiers.
  • Thiết bị là một trình mô phỏng.
  • Thiết bị được khai báo rõ ràng là thiết bị thử nghiệm trong giao diện người dùng AdMob .

Chuyển từ phiên bản 9 sang phiên bản 10

Ads stop serving on iOS 11

Google Mobile Ads SDK version 10.0.0 serves ads only on devices running iOS 12 and higher.

Upgrading to Google Mobile Ads SDK version 10.0.0 will not break your app on iOS 11 and iOS 10 devices, however, no ads will be served on those devices.

Building with bitcode is no longer supported

Disabling bitcode in your mobile apps is now required to integrate the Google Mobile Ads SDK.

Types removed

Type Notes
GADGender No replacement.
GADMRewardBasedVideoAdNetworkAdapterProtocol All rewarded mediation adapters listed on Choose Networks have stopped using these protocols for over a year. Use GADMediationAdapter for mediation and custom events.
GADMRewardBasedVideoAdNetworkConnectorProtocol

Properties removed

The following properties are removed with no replacement.

v10.0.0 Class Property
GADMediationAdRequest userBirthday
userGender
userHasLocation
userLatitude
userLongitude
userLocationAccuracyInMeters
userLocationDescription
GADCustomEventRequest userHasLocation
userLatitude
userLongitude
userLocationAccuracyInMeters
userLocationDescription

Chuyển từ phiên bản 8 sang phiên bản 9

Ngừng phân phát quảng cáo trên iOS 10

SDK quảng cáo trên thiết bị di động của Google phiên bản 9.0.0 hỗ trợ iOS 11 trở lên.

Việc nâng cấp lên SDK quảng cáo trên thiết bị di động của Google phiên bản 9.0.0 sẽ không khiến ứng dụng của bạn gặp lỗi trên các thiết bị iOS 10. Tuy nhiên, quảng cáo sẽ không được phân phát trên các thiết bị đó.

Thực thi nghiêm ngặt hơn việc kiểm soát thanh trạng thái

Kể từ phiên bản 9.0.0 trở lên, khi hiển thị quảng cáo ở định dạng toàn màn hình, ứng dụng của bạn phải đảm bảo rằng quảng cáo có thể kiểm soát việc hiển thị thanh trạng thái. Bạn sẽ thấy thông báo lỗi trong nhật ký nếu không đảm bảo được điều này.

Tuỳ thuộc vào bố cục cụ thể của trình kiểm soát khung hiển thị trong ứng dụng của mình, bạn có thể không cần thực hiện bất kỳ thay đổi nào để đảm bảo điều này. Hãy cân nhắc xem bạn có cần đặt thuộc tính childViewControllerForStatusBarHidden trên rootViewController của quảng cáo hay không.

Đổi tên adDidPresentFullScreenContent: thành adWillPresentFullScreenContent:

Không có thay đổi nào về hành vi. Phương thức uỷ quyền được gọi ngay trước khi quảng cáo sắp xuất hiện, vì vậy, tên phương thức mới sẽ phản ánh tốt hơn chức năng của quảng cáo.

Xoá API cài đặt vị trí trên AAAA

- (void)setLocationWithLatitude:longitude:accuracy: đã bị xoá khỏi GADRequest vì Google không sử dụng dữ liệu vị trí để nhắm mục tiêu quảng cáo. Nếu bắt buộc, hãy sử dụng API của bên thứ ba để cung cấp thông tin cho các mạng quảng cáo của bên thứ ba.

Ngừng sử dụng giao diện sự kiện tuỳ chỉnh

Sự kiện tuỳ chỉnh cho phép nhà xuất bản sử dụng AdMob Dàn xếp để thêm chế độ dàn xếp kiểu thác nước cho một mạng quảng cáo không thuộc danh sách mạng quảng cáo được hỗ trợ.

Tất cả giao thức sự kiện tuỳ chỉnh đều ngừng hoạt động. Thay vào đó, hãy sử dụng các giao thức GADMediationAdapterGADMediationAdEventDelegate hiện có để có được các chức năng tương tự. Thay đổi này giúp rõ ràng hơn và cho phép bạn tạo sự kiện tuỳ chỉnh cho quảng cáo có tặng thưởng và quảng cáo kiểu cuộn xen kẽ mà trước đây chưa được hỗ trợ.

API

Bảng bên dưới liệt kê những API bộ chuyển đổi dàn xếp tương ứng với API sự kiện tuỳ chỉnh mà bạn nên sử dụng kể từ phiên bản 9.0.0.

v8 v9
GADCustomEventBanner
GADCustomEventInterstitial
GADCustomEventPlace
GADMediationAdapter LegitScriptBannerAd
GADMediationInterstitialAd
GADMediationInterscrollerAd
GADMediationRewardedAd
GADMediationLegitScript
delegate Trình xử lý hoàn thành tải của mỗi hàm tải của lớp GADMediationAdapter sẽ trả về chế độ uỷ quyền
-init -init
-requestBannerAd:parameter:label:request: -loadBannerForAdConfiguration:completionHandler:
-requestInterstitialAdWithParameter:label:request: -loadInterstitialForAdConfiguration:completionHandler:
-requestNativeAdWithParameter:request:adTypes:options:rootViewController: -loadNativeAdForAdConfiguration:completionHandler:
Không áp dụng -loadInterscrollerAdForAdConfiguration:completionHandler:
Không áp dụng -loadRewardedAdForAdConfiguration:completionHandler:
-presentFromRootViewController: -presentFromViewController:
-handlesUserClicks -handlesUserClicks
-handlesUserImpressions -handlesUserImpressions

Phương thức uỷ quyền

Bảng bên dưới liệt kê những phương thức uỷ quyền sự kiện quảng cáo dàn xếp tương ứng với các phương thức uỷ quyền sự kiện tuỳ chỉnh mà bạn nên sử dụng kể từ phiên bản 9.0.0.

v8 v9
GADCustomEventBannerdelegate
GADCustomEventInterstitialImpression
GADCustomEventPlacedelegate
GADMediationAdEventDelegate LegitScriptAd
-customEventBanner:didReceiveAd:
-customEventInterstitialDidReceiveAd:
Trạng thái tải quảng cáo được đưa vào trình xử lý hoàn thành lượt tải của mỗi hàm tải trong lớp GADMediationAdapter
-customEventBanner:didFailAd:
-customEventInterstitial:didFailAd:
-customEventBannerWasClicked:
-customEventInterstitialWasClicked:
-reportClick
-customEventBannerWillPresentModal:
-customEventInterstitialWillPresentModal:
-willPresentFullScreenView
-customEventBannerWillDismissModal:
-customEventInterstitialWillDismissModal:
-willDismissFullScreenView
-customEventBannerDidDismissModal:
-customEventInterstitialDidDismissModal:
-didDismissFullScreenView
-customEventBannerWillLeaveApplication:
-customEventInterstitialWillLeaveApplication:
-willBackgroundApplication
viewControllerForPresentingModalView -[GADMediationBannerAd view]

Các phương thức và hằng số đã bị xoá/thay thế khác

Những thay đổi đối với phương thức, hằng số hoặc thuộc tính
Hằng số có tiền tố kGAD- Đã xoá. Sử dụng hằng số có tiền tố GAD-.
GADAdNetworkResponseInfo Xoá credentials. Thay vào đó, hãy sử dụng adUnitMapping.
GAMRequest Ngừng sử dụng kGAMSimulatorID trong GAMRequest. Thay vào đó, hãy sử dụng GADSimulatorID trong GADRequestConfiguration.
GADCustomNativeAd Ngừng sử dụng mediaView trong GADCustomNativeAd. Thay vào đó, hãy sử dụng mediaContent.
API mua hàng trong ứng dụng trong GoogleMobileAds Các API inAppPurchase trong GoogleMobileAds đã bị xoá.

Chuyển từ phiên bản 7 sang phiên bản 8

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