SDK 迁移

本文介绍了现行版本和以往版本的迁移。

从 10 迁移到 v11

部署目标下限

最低部署目标已提高至 iOS 12。

最低 Xcode 版本

支持的最低 Xcode 版本已提高至 15.1。

广告停止在 iOS 12 设备上投放

Google 移动广告 SDK 版本 11.0.0 仅在搭载 iOS 13 及更高版本的设备上投放广告。

移除了 GoogleAppMeasurement 依赖项

在版本 11.0.0 中,移除了对 GoogleAppMeasurement 的依赖。这个为 AdMob 中用户指标切换开关提供支持的依赖项将于 2024 年初停用。如需继续在 AdMob 中收集用户指标,请将您的 AdMob 应用关联到 Firebase,并将 Google Analytics for Firebase 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 请改用 loadedAdNetworkResponseInfo 中的 adNetworkClassName

移除了 GADAdFormatUnknown

移除了 GADAdFormatUnknown,且无替代项。

日志记录 SDK 版本的更改

11.0.0 版移除了 sdkVersion。如需记录 Google 移动广告 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 中将设备明确声明为测试设备。
  • 设备是一个模拟器。
  • 在 Ad Manager 界面中将设备明确声明为测试设备。

从 v9 迁移到 v10

广告停止在 iOS 11 设备上投放

Google 移动广告 SDK 版本 10.0.0 仅在搭载 iOS 12 及更高版本的设备上投放广告。

升级到 Google 移动广告 SDK 版本 10.0.0 不会影响您的应用在 iOS 11 和 iOS 10 设备上的行为,但广告不会在这些设备上投放。

需要 Ad Manager 应用 ID

现在,所有 Ad Manager 应用的 Info.plist 中都需要 Ad Manager 应用 ID,并且该 ID 需要采用 ca-app-pub-################~########## 格式。如需了解详情,请参阅更新您的 Info.plist

需要 GoogleAppMeasurement.xcframework

现在,所有 Ad Manager 应用都需要 GoogleAppMeasurement.xcframework。如果您通过 CocoaPodsSwift Package Manager 安装 Google 移动广告 SDK,则无需执行任何其他操作。如果您手动安装框架,请参阅手动下载,了解更多详情。

不再支持使用位码构建

现在,您必须在移动应用中停用位码,才能集成 Google 移动广告 SDK。

已移除的类型

类型 备注
GADGender 无替代项。
GADMRewardBasedVideoAdNetworkAdapterProtocol 选择广告联盟一文中列出的所有激励广告中介适配器已停止使用这些协议超过一年了。将 GADMediationAdapter 用于中介和自定义事件。
GADMRewardBasedVideoAdNetworkConnectorProtocol

已移除的属性

以下属性已移除且无替代项。

v10.0.0 中的类 媒体资源
GADMediationAdRequest userBirthday
userGender
userHasLocation
userLatitude
userLongitude
userLocationAccuracyInMeters
userLocationDescription
GADCustomEventRequest userHasLocation
userLatitude
userLongitude
userLocationAccuracyInMeters
userLocationDescription

从 v8 迁移到 v9

广告停止在 iOS 10 设备上投放

Google 移动广告 SDK 版本 9.0.0 支持的最低 iOS 版本是 iOS 11。

升级到 Google 移动广告 SDK 版本 9.0.0 不会影响您的应用在 iOS 10 设备上的行为,但广告不会在这些设备上投放。

状态栏控制规定的执行更严格

从版本 9.0.0 开始,当您展示全屏格式的广告时,您的应用应确保广告能够控制状态栏的显示。如果您未能这样做,将会在日志中看到一条错误消息。

根据应用中视图控制器的具体布局,您可能无需做出任何更改即可确保实现这一点。考虑您是否需要在广告的 rootViewController 上设置 childViewControllerForStatusBarHidden 属性。

将 adDidPresentFullScreenContent: 重命名为 adWillPresentFullScreenContent:

行为无变化。委托方法在广告即将展示之前调用,因此新的方法名称可以更好地体现其功能。

移除了 GADRequest 上的 Location Settings API

- (void)setLocationWithLatitude:longitude:accuracy: 已从 GADRequest 中删除,因为 Google 不使用位置数据来定位广告。如果需要,请使用第三方 API 向第三方广告联盟提供该信息。

弃用了自定义事件接口

借助自定义事件,使用 Ad Manager 中介的发布商可以为支持的广告联盟以外的广告联盟添加广告瀑布流中介。

所有自定义事件协议均已弃用。请改用现有的 GADMediationAdapterGADMediationAdEventDelegate 协议来实现相同的功能。这项变更让表达更加清晰明确,还可让您为之前不可用的激励广告和插页式滚显广告创建自定义事件。

API

下表列出了从版本 9.0.0 开始应使用的 Custom Events API 所对应的 Mediation Adapter API。

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
GADCustomEventBannerDelegate
GADCustomEventInterstitialDelegate
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 废弃了 GAMRequest 中的 kGAMSimulatorID。请在 GADRequestConfiguration 中改用 GADSimulatorID
GADCustomNativeAd 废弃了 GADCustomNativeAd 中的 mediaView。请改用 mediaContent
GoogleMobileAds 中的 In-App Purchase API 移除了 GoogleMobileAds 中的 inAppPurchase API。

从 v7 迁移到 v8

Google 移动广告 SDK 版本 8.0.0 引入了一些重大更改,并对 API 进行了一些重命名和移除。

有关全屏广告格式 API 的更新

从版本 8.0.0 开始,插页式广告和激励广告会共用通用的全屏广告样式,以提高一致性。这些新的全屏广告 API 与版本 7 的全屏广告 API 有两大主要区别:

  1. 静态类方法 load

    之前加载/展示全屏广告的方法如下:

    1. 创建一个广告对象实例并保留对其的引用。
    2. 分配一个处理加载和显示回调的委托。
    3. 加载广告。
    4. 使用 isReady 检查广告是否已加载。
    5. 展示广告。

    在版本 8 中,此方法略有变化。加载回调不再是委托的一部分。而是会作为完成处理程序传入 load 方法:

    1. 对广告类调用静态加载方法,并提供加载完成处理程序。
    2. 在加载完成回调中,保留对返回的已加载广告的引用。
    3. 分配一个处理显示回调的代理。
    4. 展示广告。

    新方法具有以下优势:

    • 您永远不会引用未加载的广告。
    • 加载广告对象时,您无需保留广告对象。
  2. 一致的广告事件

    事件类型 现有 API v8 API
    加载事件 GADInterstitialDelegateGADRewardedAdDelegate GAMInterstitialAdLoadCompletionHandlerGADRewardedAdLoadCompletionHandler
    展示事件 GADFullScreenContentDelegate

    以前,如需监听任何广告事件,您需要向插页式广告的委托属性注册一个实现 GADInterstitialDelegate 协议的类,或者向激励广告的委托属性注册一个实现 GADRewardedAdDelegate 协议的类,具体取决于您使用的格式。同一代理具有与广告的加载和展示生命周期都相关的方法。

    在版本 8 中,加载事件和展示事件是分开的。现在,您可以在展示广告之前随时注册 GADFullScreenContentDelegate,而无需在加载广告之前设置单个代理。每种广告格式特有的广告加载事件将移至加载方法中传递的单个加载完成处理程序。

插页式广告

加载广告

以下代码段展示了如何加载插页式广告,并在广告加载成功或失败时监听事件。

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;
  }];
}

展示广告

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");
  }
}

展示广告事件

以下代码段展示了如何在广告展示(成功或失败)以及用户关闭广告时处理回调。

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.");
}

已奖励

加载广告

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;
}

展示广告并处理奖励

激励广告要求您在用户获得奖励时处理该事件。借助版本 7 的 GADRewardedAd API,您可以将 rewardedAd:userDidEarnReward: 作为 GADRewardedAdDelegate 协议的一部分实现。对于版本 8,您需要实现 GADUserDidEarnRewardHandler 才能展示广告。

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");
  }
}

展示广告事件

借助 GADRewardedAd API,您可以将 GADRewardedAdDelegate 传递给展示广告的方法。借助 GADRewardedAd API,您可以在展示广告之前将 GADFullscreenContentDelegate 设为广告的属性。

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.");
}

移除旧版 GADRewardedBasedVideoAd API

较新的 GADRewardedAd API 于 2019 年 3 月首次推出,在超过 18 个月的时间里一直是首选激励广告 API。与旧版 GADRewardedBasedVideoAd API 相比,新版 API 具备更多增强功能,包括一次加载多个激励广告的功能。

SDK 版本 8.0.0 中移除了旧版 GADRewardedBasedVideoAd API。

弃用智能横幅广告,改为使用自适应横幅广告

弃用了智能横幅广告,取而代之的是自适应横幅广告。自适应横幅广告的效果更好,可以让您更灵活地设置广告宽度。如果您想继续使用全宽横幅广告,仍然可以使用自适应横幅广告来实现,如以下代码段所示:

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

移除退出应用回调

移除了所有广告格式的 willLeaveApplication 回调函数,改为使用 applicationDidEnterBackground:sceneDidEnterBackground: 方法。使用操作系统级 API 时,无论用户是否因广告互动而打开您的应用,只要他们离开您的应用,您都会收到通知。

请注意,切勿将 willLeaveApplication 回调用作广告点击处理程序,如果依赖此回调来报告点击,将无法生成准确的指标。例如,用户点击“广告选择”图标时会启动外部浏览器,这时系统会调用该回调函数,但不会将其计为一次点击。

重命名类

下表列出了版本 8 中已更改或移除的具体类名称。总结:

  • GADUnifiedNativeAd 相关的所有类均已重命名为 GADNativeAd
  • 移除了 GADRewardBasedVideoAdGADNativeExpressAdViewGADInstreamAd
  • 所有带有 DFP 前缀的类都已替换为 GAM 前缀。
v7.68.0 中的类 v8.0.0 中的类
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 已移除
GADInterstitial GADInterstitialAd
GADNativeExpressAdView 已移除
GADRewardBasedVideoAd 已移除
GADInstreamAd 已移除
GADInstreamAdView 已移除

移除/替换的方法

下表列出了版本 8 中的具体更改。总结:

  • 移除了之前已废弃的方法和属性。
  • 针对所有格式移除了 -willLeaveApplication: 委托方法。
  • 广告网络类名称已移至 GADResponseInfo 属性。
  • 测试设备标识符已移至 GADRequestConfiguration 属性。
v7.68.0 中的类 v7.68.0 中的 API v8.0.0 中的 API 备注
GADMobileAds +configureWithApplicationID: -startWithCompletionHandler: 现在,此应用 ID 是在 Info.plist 中设置。
+disableAutomaticInAppPurchaseReporting -disableAutomaticInAppPurchaseReporting
+disableSDKCrashReporting -disableSDKCrashReporting
GADRequest testDevices GADRequestConfiguration.testdeviceidentifiers testDeviceIdentifiers 属性适用于所有广告请求,而旧的 testDevices 属性是按请求设置的。
性别 已移除
生日 已移除
+sdkVersion GADMobileAds.sharedInstance.sdkVersion
-setBirthdayWithMonth:day:year: 已移除
-setLocationWithDescription: -setLocationWithLatitude:longitude:accuracy:
-tagForChildDirectedTreatment: [GADMobileAds.sharedInstance.requestConfiguration tagForChildDirectedTreatment]
GADErrorCode kGADError* GADError* 移除了所有错误代码常量中的 k 前缀。
GADBannerView hasAutoRefreshed autoloadEnabled
inAppPurchaseDelegate 已移除
mediatedAdView 已移除
adNetworkClassName responseInfo.adNetworkClassName
DFPBannerView -setValidAdSizesWithSizes: -setValidAdSizes:
DFPBannerViewOptions -adSizeDelegate 已移除
GADBannerViewDelegate -adViewDidReceiveAd: -bannerViewDidReceiveAd:
-adView:didFailToReceiveAdWithError: -bannerView:didFailToReceiveAdWithError:
-adViewWillPresentScreen: -bannerViewWillPresentScreen:
-adViewWillDismissScreen: -bannerViewWillDismissScreen:
-adViewDidDismissScreen: -bannerViewDidDismissScreen:
-adViewWillLeaveApplication: 已移除
GADNativeCustomTemplateAd templateID GADCustomNativeAd.formatID
-performClickOnAssetWithKey:customClickHandler: -performClickOnAssetWithKey:
GADNativeAdImageAdLoaderOptions preferredImageOrientation GADNativeAdMediaAdOptions.mediaAspectRatio
GADInterstitial inAppPurchaseDelegate 已移除
isReady 已移除 请改用 canPresentFromRootViewController:error:。
hasBeenUsed 已移除
-init -initWithGMSID:
-setAdUnitID: -initWithGMSID:
adNetworkClassName responseInfo.adNetworkClassName
-interstitialWillLeaveApplication: 已移除
GADUnifiedNativeAd videoController mediaContent.videoController
adNetworkClassName responseInfo.adNetworkClassName