展示机会层级的广告收入

发生展示时,Google 移动广告 SDK 会提供与该次展示相关联的广告收入数据。您可以使用此数据来计算用户的生命周期价值,也可以将此数据传送到下游的其他相关系统。

本指南旨在帮助您在 Android 应用中启用获取展示机会层级的广告收入数据的功能。

前提条件

  • 导入 Google 移动广告 SDK 21.1.0 或更高版本。

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

以下示例处理激励广告的付费事件:

Kotlin

import com.google.android.gms.ads.rewarded.RewardedAd

class MainActivity : AppCompatActivity() {
  private var rewardedAd: RewardedAd? = null
  private final var TAG = "MainActivity"

  override fun onCreate(savedInstanceState: Bundle?) {
    val adRequest = AdRequest.Builder().build()

    RewardedAd.load(this, "AD_UNIT_ID",
      adRequest, object: RewardedAdLoadCallback() {
        override fun onAdLoaded(ad: RewardedAd) {
          rewardedAd = ad
          // Set paid event listener
          rewardedAd.onPaidEventListener = OnPaidEventListener { adValue ->
            // TODO: Send the impression-level ad revenue information to your preferred
            // analytics server directly within this callback.

            // Extract the impression-level ad revenue data.
            val valueMicros = adValue.valueMicros
            val currencyCode = adValue.currencyCode
            val precision = adValue.precisionType

            // Get the ad unit ID.
            val adUnitId = rewardedAd.adUnitId

            val loadedAdapterResponseInfo = rewardedAd.responseInfo.loadedAdapterResponse
            val adSourceName = loadedAdapterResponseInfo.adSourceName
            val adSourceId = loadedAdapterResponseInfo.adSourceId
            val adSourceInstanceName = loadedAdapterResponseInfo.adSourceInstanceName
            val adSourceInstanceId = loadedAdapterResponseInfo.adSourceInstanceId
            val extras = rewardedAd.responseInfo.responseExtras
            val mediationGroupName = extras.getString("mediation_group_name")
            val mediationABTestName = extras.getString("mediation_ab_test_name")
            val mediationABTestVariant = extras.getString("mediation_ab_test_variant")
          }
        }
    })
  }
}

Java

import com.google.android.gms.ads.rewarded.RewardedAd;

public class MainActivity extends Activity {
  private RewardedAd rewardedAd;
  private final String TAG = "MainActivity";

  @Override
  protected void onCreate(Bundle savedInstanceState) {
    AdRequest adRequest = new AdRequest.Builder().build();

    RewardedAd.load(this, "AD_UNIT_ID",
      adRequest, new RewardedAdLoadCallback(){
        @Override
        public void onAdLoaded(@NonNull RewardedAd ad) {
          rewardedAd = ad;
          // Set paid event listener
          rewardedAd.setOnPaidEventListener(new OnPaidEventListener() {
            @Override
            public void onPaidEvent(AdValue adValue) {
              // TODO: Send the impression-level ad revenue information to your
              //preferred analytics server directly within this callback.

              // Extract the impression-level ad revenue data.
              long valueMicros = adValue.getValueMicros();
              String currencyCode = adValue.getCurrencyCode();
              int precision = adValue.getPrecisionType();

              // Get the ad unit ID.
              String adUnitId = rewardedAd.getAdUnitId();
              
              AdapterResponseInfo loadedAdapterResponseInfo = rewardedAd.getResponseInfo().
                  getLoadedAdapterResponseInfo();
              String adSourceName = loadedAdapterResponseInfo.getAdSourceName();
              String adSourceId = loadedAdapterResponseInfo.getAdSourceId();
              String adSourceInstanceName = loadedAdapterResponseInfo.getAdSourceInstanceName();
              String adSourceInstanceId = loadedAdapterResponseInfo.getAdSourceInstanceId();

              Bundle extras = rewardedAd.getResponseInfo().getResponseExtras();
              String mediationGroupName = extras.getString("mediation_group_name");
              String mediationABTestName = extras.getString("mediation_ab_test_name");
              String mediationABTestVariant = extras.getString("mediation_ab_test_variant");
            }
          });
        }
    });
  }
}

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

应用归因合作伙伴 (AAP) 集成

如需全面了解如何将广告收入数据传送到分析平台,请参阅相应的合作伙伴指南:

合作伙伴 SDK
调整
AppsFlyer
Singular
Tenjin

植入方面的最佳实践

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

AdValue

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

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

使用 AdMob 中介时,对于经过优化的广告来源,AdMob 会尝试提供 ESTIMATED 值。

如果广告来源未经优化,或者如果没有足够多的汇总数据,无法报告有意义的估算值,系统会返回 PUBLISHER_PROVIDED 值。

测试来自出价广告来源的展示

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

  • UNKNOWN:表示精度类型。
  • 0:表示广告价值。

以前,您可能会看到精确度类型为 UNKNOWN 以外的值,并且广告价值超过 0

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