展示机会层级的广告收入

发生展示时，Google 移动广告 SDK 会用相关联的收入数据调用付费事件处理脚本。通过实现该处理脚本，您可以使用此数据来计算用户的生命周期价值，也可以将此数据传送到下游的其他相关系统。

本指南旨在帮助您在 iOS 应用中启用获取生命周期价值数据的功能。

前提条件

实现付费事件处理脚本

每种广告格式都有一个类型为 GADPaidEventHandler 的 paidEventHandler 属性。在广告事件的生命周期内，Google 移动广告 SDK 会监控展示事件，并用赚取的价值调用处理脚本。

Swift

class ViewController: UIViewController, FullScreenContentDelegate {
  var rewardedAd: RewardedAd?
  func requestRewardedAd() {
    RewardedAd.load(
      with: "AD_UNIT_ID", request: AdManagerRequest()
    ) { (ad, error) in
      if let error = error {
        print("Rewarded ad failed to load with error: \(error.localizedDescription)")
        return
      }
      if let ad = ad {
        self.rewardedAd = ad
        self.rewardedAd?.paidEventHandler = { adValue in
          // TODO: Send the impression-level ad revenue information to your preferred analytics
          // server directly within this callback.

          // Extract the impression-level ad revenue data.
          let value = adValue.value
          let precision = adValue.precision
          let currencyCode = adValue.currencyCode

          // Get the ad unit ID.
          let adUnitId = ad.adUnitID

          let responseInfo = ad.responseInfo
          let loadedAdNetworkResponseInfo = responseInfo?.loadedAdNetworkResponseInfo
          let adSourceId = loadedAdNetworkResponseInfo?.adSourceID
          let adSourceInstanceId = loadedAdNetworkResponseInfo?.adSourceInstanceID
          let adSourceInstanceName = loadedAdNetworkResponseInfo?.adSourceInstanceName
          let adSourceName = loadedAdNetworkResponseInfo?.adSourceName
        }
      }
    }
  }
}

Objective-C

@import GoogleMobileAds;
@import UIKit;

@interface ViewController ()
@property(nonatomic, strong) GADRewardedAd *rewardedAd;
@end

@implementation ViewController
- (void)requestRewardedAd {
  __weak ViewController *weakSelf = self;

  GAMRequest *request = [GAMRequest request];
  [GADRewardedAd
   loadWithAdUnitID:@"AD_UNIT_ID"
   request:request
   completionHandler:^(GADRewardedAd *ad, NSError *error) {
    if (error) {
      NSLog(@"Rewarded ad failed to load with error: %@", [error localizedDescription]);
      return;
    }
    self.rewardedAd = ad;
    self.rewardedAd.paidEventHandler = ^void(GADAdValue *_Nonnull value){
      ViewController *strongSelf = weakSelf;
      // TODO: Send the impression-level ad revenue information to your preferred analytics
      // server directly within this callback.

      // Extract the impression-level ad revenue data.
      NSDecimalNumber *value; = value.value;
      NSString *currencyCode = value.currencyCode;
      GADAdValuePrecision precision = value.precision;

      // Get the ad unit ID.
      NSString *adUnitId = strongSelf.rewardedAd.adUnitID;

      GADAdNetworkResponseInfo *loadedAdNetworkResponseInfo =
          strongSelf.rewardedAd.responseInfo.loadedAdNetworkResponseInfo;
      NSString *adSourceName = loadedAdNetworkResponseInfo.adSourceName;
      NSString *adSourceID = loadedAdNetworkResponseInfo.adSourceID;
      NSString *adSourceInstanceName = loadedAdNetworkResponseInfo.adSourceInstanceName;
      NSString *adSourceInstanceID = loadedAdNetworkResponseInfo.adSourceInstanceID;
    };
  ]};
}

确定自定义事件广告来源名称

对于自定义事件广告来源，adSourceName 属性可提供广告来源名称 Custom event。如果您使用多个自定义事件，则该广告来源名称不够精细，无法区分多个自定义事件。如需查找特定自定义事件，请执行以下步骤：

  1. 获取 adNetworkClassName 属性。
  2. 设置唯一的广告来源名称。

以下示例为自定义事件设置了唯一的广告来源名称：

Swift

func uniqueAdSourceName(for loadedAdNetworkResponseInfo: AdNetworkResponseInfo) -> String {
  var adSourceName: String = loadedAdNetworkResponseInfo.adSourceName ?? ""
  if adSourceName == "Custom Event" {
    if loadedAdNetworkResponseInfo.adNetworkClassName
      == "MediationExample.SampleCustomEventSwift"
    {
      adSourceName = "Sample Ad Network (Custom Event)"
    }
  }
  return adSourceName
}
ResponseInfoSnippets.swift

Objective-C

- (NSString *)uniqueAdSourceNameForAdNetworkResponseInfo:
    (AdNetworkResponseInfo *)loadedAdNetworkResponseInfo {
  NSString *adSourceName = loadedAdNetworkResponseInfo.adSourceName;
  if ([adSourceName isEqualToString:@"Custom Event"]) {
    if ([loadedAdNetworkResponseInfo.adNetworkClassName isEqualToString:@"SampleCustomEvent"]) {
      adSourceName = @"Sample Ad Network (Custom Event)";
    }
  }
  return adSourceName;
}
ResponseInfoSnippets.m

如需详细了解胜出的广告来源，请参阅检索有关广告响应的信息。

植入方面的最佳做法

  • 在创建或有权访问广告对象后立即设置该处理脚本，且一定要在展示广告之前进行设置。这样可以确保您不会错过任何付费事件回调。
  • 在系统调用 paidEventHandler 方法时，立即将付费事件信息发送到您的首选分析服务器。这样可以确保您不会意外丢掉任何回调，并能避免数据差异。

GADAdValue

GADAdValue 是一个类，用于表示展示某个广告可赚取的货币价值，它包括价值的货币代码及精度类型，代码说明如下。

GADAdValuePrecision 说明
GADAdValuePrecisionUnknown 广告价值未知。如果启用了生命周期价值回 ping，但数据不足，就会返回此代码。
GADAdValuePrecisionEstimated 广告价值是根据汇总数据估算的。
GADAdValuePrecisionPublisherProvided 广告价值是由发布商提供的，例如中介组中的人工每千次展示费用。
GADAdValuePrecisionPrecise 广告价值是为广告支付的费用的精准值。

测试通过公开出价投放的展示

通过测试请求为公开出价广告来源触发展示机会层级的广告收入事件后，您只会收到以下值：

  • GADAdValuePrecisionUnknown：表示精度类型。
  • 0：表示广告价值。

之前，您看到的精度类型值可能不是 GADAdValuePrecisionUnknown，且广告价值超过 0。

如需详细了解如何发送测试广告请求，请参阅启用测试设备。