העברה של SDK

בדף הזה מפורט על ההעברות לגרסה הנוכחית ולגרסה הקודמת.

מעבר מגרסה 10 לגרסה 11

Minimum deployment target

The minimum deployment target has been increased to iOS 12.

Minimum Xcode version

The minimum supported Xcode version has been increased to 15.1.

Ads stop serving on iOS 12

Google Mobile Ads SDK version 11.0.0 serves ads only on devices running iOS 13 and higher.

Removed GoogleAppMeasurement dependency

In version 11.0.0, the dependency on GoogleAppMeasurement has been removed. This dependency that powered the user metrics toggle in AdMob will be discontinued in early 2024. To continue collecting user metrics in AdMob, link your AdMob app to Firebase and integrate the Google Analytics for Firebase SDK into your app.

Changes to full-screen ad presentation

The following changes affect the various ad formats:

  • App open
  • Interstitial
  • Rewarded
  • Rewarded interstitial

The view controller parameter in -canPresentFromRootViewController:error: and -presentFromRootViewController: is nullable. If nil is passed, the ad is presented from the topmost view controller in the view controller hierarchy.

Methods removed

The following methods are removed.

v11.0.0 Type Method Notes
GADAppOpenAd load(withAdUnitID adUnitID: String, request: GADRequest?, orientation: UIInterfaceOrientation) Use load(withAdUnitID adUnitID: String, request: GADRequest?) instead.
GADMediationBannerAdEventDelegate willBackgroundApplication() No replacement.
GADMediationInterstitialAdEventDelegate willBackgroundApplication() No replacement.
GADMediationNativeAdEventDelegate willBackgroundApplication() No replacement.
GADMediationRewardedAdEventDelegate didRewardUser(with reward: GADAdReward) Use didRewardUser() instead.
GADMediatedUnifiedNativeAdNotificationSource mediatedNativeAdWillLeaveApplication(_ mediatedNativeAd: GADMediatedUnifiedNativeAd) No replacement.
GADRequestConfiguration setSameAppKeyEnabled(_ enabled: Bool) Use setPublisherFirstPartyIDEnabled(_ enabled: Bool) instead.
tagForUnderAge(ofConsent underAgeOfConsent: Bool) Use the tagForUnderAgeOfConsent property instead.
tag(forChildDirectedTreatment childDirectedTreatment: Bool) Use the tagForChildDirectedTreatment property instead.

Properties removed

The following properties are removed.

v11.0.0 Class Property Notes
GADMediationAdConfiguration hasUserLocation No replacement.
userLatitude
userLongitude
userLocationAccuracyInMeters
childDirectedTreatment Use GADMobileAds.sharedInstance.requestConfiguration.tagForChildDirectedTreatment instead.
GADResponseInfo adNetworkClassName Use adNetworkClassName from loadedAdNetworkResponseInfo instead.

Removed GADAdFormatUnknown

Removed GADAdFormatUnknown with no replacement.

Changes to logging SDK version

Version 11.0.0 removes sdkVersion. To log the Google Mobile Ads SDK version, use versionNumber instead.

Version 10.0.0

GADMobileAds.sharedInstance().sdkVersion

Version 11.0.0

GADGetStringFromVersionNumber(GADMobileAds.sharedInstance().versionNumber)

Changes to GADAdLoader error handling

Starting in version 11.0.0, GADAdLoader doesn't make an ad request if its delegate doesn't conform to the requested ad types' delegate protocol. Previously, it failed after the ad request was made.

Changes to testing behavior

See the table which shows the updated conditions for when the following properties return true.

Class Property
GADMediationAdConfiguration isTestRequest
GADCustomEventRequest isTesting
v10.0.0 v11.0.0
  • The device is explicitly declared as a test device in testDeviceIdentifiers.
  • The device is explicitly declared as a test device in testDeviceIdentifiers.
  • The device is a simulator.
  • The device is explicitly declared as a test device in the Ad Manager UI.

מעבר מגרסה 9 לגרסה 10

הפסקת ההצגה של המודעות ב-iOS 11

בגרסה 10.0.0 של Google Mobile Ads SDK מוצגות מודעות רק במכשירים עם iOS מגרסה 12 ואילך.

שדרוג לגרסה 10.0.0 של Google Mobile Ads SDK לא יקטע את האפליקציה במכשירי iOS 11 ו-iOS 10, אבל לא יוצגו מודעות במכשירים האלה.

הדרישה למזהה אפליקציה ב-Ad Manager

עכשיו מזהה האפליקציה ב-Ad Manager נדרש עכשיו ב-Info.plist בכל האפליקציות ב-Ad Manager, ונדרש הפורמט ca-app-pub-################~##########. לפרטים נוספים, ראו עדכון ה-Info.plist.

דרישה של GoogleAppMeasurement.xcframework

עכשיו צריך להתקין את GoogleAppMeasurement.xcframework בכל האפליקציות של Ad Manager. אם מתקינים את Google Mobile Ads SDK דרך Cocoapods או Swift Package Manager, אין צורך לבצע פעולה נוספת. אם אתם מתקינים את frameworks באופן ידני, קראו את המאמר הורדה ידנית לקבלת פרטים נוספים.

אין יותר תמיכה במבנה עם קוד ביט

מעכשיו, כדי לשלב את Google Mobile Ads SDK צריך להשבית את ה-bitcode באפליקציות לנייד.

סוגים שהוסרו

תיאור הערות
GADGender אין החלפה.
GADMRewardBasedVideoAdNetworkAdapterProtocol כל המתאמים של תהליך בחירת הרשת ליחידת מודעות מתגמלות הרשומים ב- Choose Networks הפסיקו להשתמש בפרוטוקולים האלה במשך יותר משנה. שימוש ב- GADMediationAdapter לתהליך בחירת הרשת ולאירועים בהתאמה אישית.
GADMRewardBasedVideoAdNetworkConnectorProtocol

הנכסים הוסרו

המאפיינים הבאים הוסרו ללא החלפה.

רמה 10.0.0 נכס
GADMediationAdRequest userBirthday
userGender
userHasLocation
userLatitude
userLongitude
userLocationAccuracyInMeters
userLocationDescription
GADCustomEventRequest userHasLocation
userLatitude
userLongitude
userLocationAccuracyInMeters
userLocationDescription

מעבר מגרסה 8 לגרסה 9

הפסקת ההצגה של מודעות ב-iOS 10

גרסת iOS המינימלית שנתמכת בגרסה 9.0.0 של Google Mobile Ads SDK היא iOS 11.

שדרוג לגרסה 9.0.0 של Google Mobile Ads SDK לא יכבה את האפליקציה במכשירי iOS 10, אבל לא יוצגו מודעות במכשירים האלה.

אכיפה מחמירה יותר של הפקדים בשורת הסטטוס

החל מגרסה 9.0.0, כשמציגים מודעות בפורמט מסך מלא, באפליקציה צריך לוודא שאפשר לשלוט בהצגת שורת הסטטוס. במקרה שהפעולה לא תתבצע בהצלחה, תופיע ביומנים הודעת שגיאה.

בהתאם לפריסה הספציפית של בקרי התצוגה באפליקציה, יכול להיות שלא צריך לבצע שינויים כדי לוודא זאת. כדאי לשקול אם צריך להגדיר את המאפיין childViewControllerForStatusBarHidden בrootViewController של המודעה.

שינוי השם של adDidShowFullScreenContent: ל-adWillpresentFullScreenContent:

אין שינוי בהתנהגות. שיטת הענקת הגישה מופעלת ממש לפני שהמודעה עומדת להופיע, ולכן השם של השיטה החדשה משקף בצורה טובה יותר את הפונקציונליות שלה.

הסרת API של הגדרת מיקום ב-GADRequest

- (void)setLocationWithLatitude:longitude:accuracy: נמחק מ-GADRequest מפני ש-Google לא משתמשת בנתוני מיקום כדי למקד מודעות. שימוש בממשקי API של צד שלישי כדי לספק את המידע לרשתות המודעות של הצד השלישי, במקרה הצורך.

הוצאה משימוש של ממשקים של אירועים מותאמים אישית

אירועים מותאמים אישית מאפשרים לבעלי אפליקציות שמשתמשים ב Ad Manager תהליך בחירת הרשת (Mediation) להוסיף את תהליך בחירת הרשת (Mediation) ב-Waterfall עבור רשת מודעות שאינה אחת מרשתות המודעות הנתמכות.

כל הפרוטוקולים של אירועים מותאמים אישית הוצאו משימוש. במקום זאת, כדאי להשתמש בפרוטוקולים הקיימים GADMediationAdapter ו-GADMediationAdEventDelegate כדי להשיג את אותן פונקציות. השינוי הזה משפר את הבהירות ומאפשר לך ליצור אירועים מותאמים אישית למודעות מתגמלות ולמודעות מעברון גלילה שלא היו זמינות קודם לכן.

ממשקי API

בטבלה הבאה מפורטים ממשקי ה-API המתאימים של המתאמים לתהליך בחירת הרשת אל ממשקי API של אירועים מותאמים אישית, שבהם יש להשתמש החל מגרסה 9.0.0.

v8 v9
GADCustomEventBanner
GADCustomEventInterstitial
GADCustomEventNativeAd		 GADMediationAdapter GADMediationBannerAd
GADMediationInterstitialAd
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
GADCustomEventBannerOwner
GADCustomEventInterstitial()
GADCustomEventNativeAd בוצע
 GADMediationAdEventDelegate מודעת GADMediation
-customEventBanner:didReceiveAd:
-customEventInterstitialDidReceiveAd: 		סטטוס טעינת המודעות נכלל ב-handler של השלמת הטעינה של כל פונקציית טעינה במחלקה GADMediationAdapter
-customEventBanner:didFailAd:
-customEventInterstitial:didFailAd:
-customEventBannerWasClicked:
-customEventInterstitialWasClicked: 		-reportClick
-customEventBannerWillPresentModal:
-customEventInterstitialWillPresentModal: 		-willPresentFullScreenView
-customEventBannerWillDismissModal:
-customEventInterstitialWillDismissModal: 		-willDismissFullScreenView
-customEventBannerDidDismissModal:
-customEventInterstitialDidDismissModal: 		-didDismissFullScreenView
-customEventBannerWillLeaveApplication:
-customEventInterstitialWillLeaveApplication: 		-willBackgroundApplication
viewControllerForPresentingModalView -[GADMediationBannerAd view]

שיטות וקבועים אחרים שהוסרו/הוחלפו

שינויים ב-method, בקבוע או בנכס
קבועים (kGAD-) עם קידומת הנושא הוסר. שימוש בקבועים עם קידומת GAD-.
GADAdNetworkResponseInfo credentials הוסרו. במקומה צריך להשתמש במדיניות adUnitMapping.
GAMRequest האפשרות kGAMSimulatorID ב-GAMRequest הוצאה משימוש. במקום זאת, יש להשתמש בתוסף GADSimulatorID ב-GADRequestConfiguration.
GADCustomNativeAd האפשרות mediaView ב-GADCustomNativeAd הוצאה משימוש. במקומה צריך להשתמש במדיניות mediaContent.
ממשקי API לרכישה מתוך האפליקציה ב-GoogleMobileAds הוסרו inAppPurchase ממשקי API ב-GoogleMobileAds.

מעבר מגרסה 7 לגרסה 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 GAMInterstitialAdLoadCompletionHandler 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: DFPInterstitial!

  override func viewDidLoad() {
    super.viewDidLoad()
    interstitial = DFPInterstitial(adUnitID: "/6499/example/interstitial")
    interstitial.delegate = self
    let request = GAMRequest()
    interstitial.load(request)
  }

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

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

Objective-C

@import GoogleMobileAds;
@import UIKit;

@interface ViewController () 

@property(nonatomic, strong) DFPInterstitial *interstitial;

@end

@implementation ViewController

- (void)viewDidLoad {
  [super viewDidLoad];
  self.interstitial = [[DFPInterstitial alloc]
      initWithAdUnitID:@"/6499/example/interstitial"];
  self.interstitial.delegate = self;
  GAMRequest *request = [GAMRequest request];
  [self.interstitial loadRequest:request];
}

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

/// Tells the delegate an ad request failed.
- (void)interstitial:(DFPInterstitial *)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: GAMInterstitialAd?

  override func viewDidLoad() {
    super.viewDidLoad()
    let request = GAMRequest()
    GAMInterstitialAd.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) GAMInterstitialAd *interstitial;

@end

@implementation ViewController

- (void)viewDidLoad {
  [super viewDidLoad];
  GAMRequest *request = [GAMRequest request];
  [GAMInterstitialAd loadWithAdUnitID:@"/6499/example/interstitial"
                              request:request
                    completionHandler:^(GAMInterstitialAd *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 = DFPInterstitial(adUnitID: "/6499/example/interstitial")
  interstitial.delegate = self
  ...
}

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

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

/// Tells the delegate the interstitial had been animated off the screen.
func interstitialDidDismissScreen(_ ad: DFPInterstitial) {
  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: DFPInterstitial) {
  print("Interstitial ad will leave application.")
}

Objective-C

- (void)viewDidLoad {
  [super viewDidLoad];
  self.interstitial = [[DFPInterstitial alloc] initWithAdUnitID:"/6499/example/interstitial"];
  self.interstitial.delegate = self;
  ...
}

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

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

/// Tells the delegate the interstitial had been animated off the screen.
- (void)interstitialDidDismissScreen:(DFPInterstitial *)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:(DFPInterstitial *)ad {
  NSLog(@"Interstitial ad will leave application.");
}

v8

Swift

override func viewDidLoad() {
  super.viewDidLoad()
  let request = GAMRequest()
  GAMInterstitialAd.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];
  GAMRequest *request = [GAMRequest request];
  [GAMInterstitialAd loadWithAdUnitID:@"/6499/example/interstitial"
                              request:request
                    completionHandler:^(GAMInterstitialAd *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(GAMRequest()) { 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;
  GAMRequest *request = [GAMRequest 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 = GAMRequest()
  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];

  GAMRequest *request = [GAMRequest 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 = GAMRequest()
  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];

  GAMRequest *request = [GAMRequest 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