插页式激励广告

请选择平台： Android iOS Unity Flutter

插页式激励广告是一种激励用户的广告格式，采用这种格式时，您可以通过在应用中的自然过渡点自动展示的广告向用户提供奖励。与激励广告不同，用户无需自行选择即可观看插页式激励广告。

前提条件

• 通读入门指南。

植入步骤

植入插页式激励广告的主要步骤如下所示：

• 加载广告
• [可选] 验证 SSV 回调
• 注册回调
• 展示广告并处理奖励事件

加载广告

广告的加载是通过针对 GADRewardedInterstitialAd 类使用 load(adUnitID:request) 方法完成的。

Swift

func loadAdManagerRewardedInterstitialAd() async {
  do {
    rewardedInterstitialAd = try await RewardedInterstitialAd.load(
      // Replace this ad unit ID with your own ad unit ID.
      with: "adUnitID", request: AdManagerRequest())
    rewardedInterstitialAd?.fullScreenContentDelegate = self
  } catch {
    print("Rewarded ad failed to load with error: \(error.localizedDescription)")
  }
}
RewardedInterstitialAdSnippets.swift

SwiftUI

import GoogleMobileAds

class RewardedInterstitialViewModel: NSObject, ObservableObject,
  FullScreenContentDelegate
{
  @Published var coins = 0
  private var rewardedInterstitialAd: RewardedInterstitialAd?

  func loadAd() async {
    do {
      rewardedInterstitialAd = try await RewardedInterstitialAd.load(
        with: "ca-app-pub-3940256099942544/6978759866", request: Request())
      rewardedInterstitialAd?.fullScreenContentDelegate = self
    } catch {
      print(
        "Failed to load rewarded interstitial ad with error: \(error.localizedDescription)")
    }
  }
RewardedInterstitialViewModel.swift

Objective-C

- (void)loadAdManagerRewardedInterstitialAd {
  [GADRewardedInterstitialAd loadWithAdUnitID:"adUnitID"
                                      request:[GAMRequest request]
                            completionHandler:^(GADRewardedInterstitialAd *ad, NSError *error) {
                              if (error) {
                                NSLog(@"Failed to load rewarded interstitial ad with error: %@",
                                      error.localizedDescription);
                                return;
                              }
                              self.rewardedInterstitialAd = ad;
                              self.rewardedInterstitialAd.fullScreenContentDelegate = self;
                            }];
}
RewardedInterstitialAdSnippets.m

请将 adUnitID 替换为您实际的广告单元 ID。

提示：您可以在打算展示广告之前，使用广告加载调用来构建预加载广告的缓存，以便在需要时以零延迟展示广告。由于广告会在一小时后过期，因此您应每小时清除此缓存并重新加载新广告。

[可选] 验证服务器端验证 (SSV) 回调

对于在服务器端验证回调中需要额外数据的应用，应使用激励广告的自定义数据功能。在激励广告对象上设置的任何字符串值都将传递给 SSV 回调的 custom_data 查询参数。如果未设置自定义数据值，custom_data 查询参数值不会出现在 SSV 回调中。

以下代码示例演示了如何在请求广告之前对插页式激励广告对象设置自定义数据。

Swift

private func validateAdManagerServerSideVerification() async {
  do {
    rewardedInterstitialAd = try await RewardedInterstitialAd.load(
      // Replace this ad unit ID with your own ad unit ID.
      with: "adUnitID", request: AdManagerRequest())
    let options = ServerSideVerificationOptions()
    options.customRewardText = ""SAMPLE_CUSTOM_DATA_STRING""
    rewardedInterstitialAd?.serverSideVerificationOptions = options
  } catch {
    print("Rewarded ad failed to load with error: \(error.localizedDescription)")
  }
}
RewardedInterstitialAdSnippets.swift

Objective-C

- (void)validateAdManagerServerSideVerification {
  // Replace this ad unit ID with your own ad unit ID.
  [GADRewardedInterstitialAd loadWithAdUnitID:"adUnitID"
                                      request:[GAMRequest request]
                            completionHandler:^(GADRewardedInterstitialAd *ad, NSError *error) {
                              if (error) {
                                NSLog(@"Rewarded interstitial ad failed to load with error: %@",
                                      error.localizedDescription);
                                return;
                              }
                              self.rewardedInterstitialAd = ad;
                              GADServerSideVerificationOptions *options =
                                  [[GADServerSideVerificationOptions alloc] init];
                              options.customRewardString = @""SAMPLE_CUSTOM_DATA_STRING"";
                              ad.serverSideVerificationOptions = options;
                            }];
}
RewardedInterstitialAdSnippets.m

将 SAMPLE_CUSTOM_DATA_STRING 替换为您的自定义数据。

要点：自定义奖励字符串是百分比转义字符串，通过 SSV 回调解析时可能需要解码。

注册回调

如需接收关于展示事件的通知，您必须将 GADFullScreenContentDelegate 分配给返回的广告的 fullScreenContentDelegate 属性：

Swift

rewardedInterstitialAd?.fullScreenContentDelegate = self
RewardedInterstitialAdSnippets.swift

SwiftUI

rewardedInterstitialAd?.fullScreenContentDelegate = self
RewardedInterstitialViewModel.swift

Objective-C

self.rewardedInterstitialAd.fullScreenContentDelegate = self;
RewardedInterstitialAdSnippets.m

GADFullScreenContentDelegate 协议会在广告成功展示或展示失败以及用户关闭广告时处理回调。以下代码演示了如何实现此协议并将其分配给广告：

Swift

func adDidRecordImpression(_ ad: FullScreenPresentingAd) {
  print("\(#function) called.")
}

func adDidRecordClick(_ ad: FullScreenPresentingAd) {
  print("\(#function) called.")
}

func adWillPresentFullScreenContent(_ ad: FullScreenPresentingAd) {
  print("\(#function) called.")
}

func adWillDismissFullScreenContent(_ ad: FullScreenPresentingAd) {
  print("\(#function) called.")
}

func adDidDismissFullScreenContent(_ ad: FullScreenPresentingAd) {
  print("\(#function) called.")
  // Clear the rewarded interstitial ad.
  rewardedInterstitialAd = nil
}

func ad(
  _ ad: FullScreenPresentingAd,
  didFailToPresentFullScreenContentWithError error: Error
) {
  print("\(#function) called with error: \(error.localizedDescription).")
}
RewardedInterstitialAdSnippets.swift

SwiftUI

func adDidRecordImpression(_ ad: FullScreenPresentingAd) {
  print("\(#function) called")
}

func adDidRecordClick(_ ad: FullScreenPresentingAd) {
  print("\(#function) called")
}

func ad(
  _ ad: FullScreenPresentingAd,
  didFailToPresentFullScreenContentWithError error: Error
) {
  print("\(#function) called")
}

func adWillPresentFullScreenContent(_ ad: FullScreenPresentingAd) {
  print("\(#function) called")
}

func adWillDismissFullScreenContent(_ ad: FullScreenPresentingAd) {
  print("\(#function) called")
}

func adDidDismissFullScreenContent(_ ad: FullScreenPresentingAd) {
  print("\(#function) called")
  // Clear the rewarded interstitial ad.
  rewardedInterstitialAd = nil
}
RewardedInterstitialViewModel.swift

Objective-C

- (void)adDidRecordImpression:(id<GADFullScreenPresentingAd>)ad {
  NSLog(@"%s called", __PRETTY_FUNCTION__);
}

- (void)adDidRecordClick:(id<GADFullScreenPresentingAd>)ad {
  NSLog(@"%s called", __PRETTY_FUNCTION__);
}

- (void)adWillPresentFullScreenContent:(id<GADFullScreenPresentingAd>)ad {
  NSLog(@"%s called", __PRETTY_FUNCTION__);
}

- (void)adWillDismissFullScreenContent:(id<GADFullScreenPresentingAd>)ad {
  NSLog(@"%s called", __PRETTY_FUNCTION__);
}

- (void)adDidDismissFullScreenContent:(id<GADFullScreenPresentingAd>)ad {
  NSLog(@"%s called", __PRETTY_FUNCTION__);
  // Clear the rewarded interstitial ad.
  self.rewardedInterstitialAd = nil;
}

- (void)ad:(id)ad didFailToPresentFullScreenContentWithError:(NSError *)error {
  NSLog(@"%s called with error: %@", __PRETTY_FUNCTION__, error.localizedDescription);
}
RewardedInterstitialAdSnippets.m

展示广告并处理奖励事件

要点：在向用户展示插页式激励广告之前，您必须向用户展示介绍画面，在其中提供明确的奖励消息和一个让用户可以在广告开始播放前跳过广告的选项。了解详情。

展示广告时，您必须提供 GADUserDidEarnRewardHandler 对象，用于处理用户奖励。

以下代码演示了展示插页式激励广告的最佳方法。

Swift

func showRewardedInterstitialAd() {
  guard let rewardedInterstitialAd = rewardedInterstitialAd else {
    return print("Ad wasn't ready.")
  }

  // The UIViewController parameter is an optional.
  rewardedInterstitialAd.present(from: nil) {
    let reward = rewardedInterstitialAd.adReward
    print("Reward received with currency \(reward.amount), amount \(reward.amount.doubleValue)")
    // TODO: Reward the user.
  }
}
RewardedInterstitialAdSnippets.swift

SwiftUI

监听视图中的界面事件以展示广告。

var rewardedInterstitialBody: some View {
  // ...
  }
  .onChange(
    of: showAd,
    perform: { newValue in
      if newValue {
        viewModel.showAd()
      }
    }
  )
RewardedInterstitialContentView.swift

从视图模型呈现插页式激励广告：

func showAd() {
  guard let rewardedInterstitialAd = rewardedInterstitialAd else {
    return print("Ad wasn't ready.")
  }

  rewardedInterstitialAd.present(from: nil) {
    let reward = rewardedInterstitialAd.adReward
    print("Reward amount: \(reward.amount)")
    self.addCoins(reward.amount.intValue)
  }
}
RewardedInterstitialViewModel.swift

Objective-C

- (void)showRewardedInterstitialAd {
  [self.rewardedInterstitialAd presentFromRootViewController:self
                                    userDidEarnRewardHandler:^{
                                      GADAdReward *reward = self.rewardedInterstitialAd.adReward;

                                      NSString *rewardMessage = [NSString
                                          stringWithFormat:@"Reward received with "
                                                           @"currency %@ , amount %ld",
                                                           reward.type, [reward.amount longValue]];
                                      NSLog(@"%@", rewardMessage);
                                      // TODO: Reward the user.
                                    }];
}
RewardedInterstitialAdSnippets.m

GitHub 示例

查看以您的首选语言提供的完整插页式激励广告示例：

• Swift
• SwiftUI
• Objective-C

后续步骤

详细了解用户隐私。