展示机会层级的广告收入

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

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

前提条件

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

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

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

Java

private void setOnPaidEventListener(RewardedAd ad) {
  ad.setOnPaidEventListener(
      new OnPaidEventListener() {
        @Override
        public void onPaidEvent(@NonNull AdValue adValue) {
          // 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 = ad.getAdUnitId();

          // Extract ad response information.
          AdapterResponseInfo loadedAdapterResponseInfo =
              ad.getResponseInfo().getLoadedAdapterResponseInfo();
          if (loadedAdapterResponseInfo != null) {
            String adSourceName = loadedAdapterResponseInfo.getAdSourceName();
            String adSourceId = loadedAdapterResponseInfo.getAdSourceId();
            String adSourceInstanceName = loadedAdapterResponseInfo.getAdSourceInstanceName();
            String adSourceInstanceId = loadedAdapterResponseInfo.getAdSourceInstanceId();

            Bundle extras = ad.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");
          }
        }
      });
}
ImpressionLevelAdRevenueSnippets.java

Kotlin

private fun setOnPaidEventListener(ad: RewardedAd) {
  ad.onPaidEventListener = OnPaidEventListener { adValue ->
    // 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 = ad.adUnitId

    // Extract ad response information.
    val loadedAdapterResponseInfo = ad.responseInfo.loadedAdapterResponseInfo
    val adSourceName = loadedAdapterResponseInfo?.adSourceName
    val adSourceId = loadedAdapterResponseInfo?.adSourceId
    val adSourceInstanceName = loadedAdapterResponseInfo?.adSourceInstanceName
    val adSourceInstanceId = loadedAdapterResponseInfo?.adSourceInstanceId
    val extras = ad.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")
  }
}
ImpressionLevelAdRevenueSnippets.kt

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

对于自定义事件广告来源，getAdSourceName() 方法会返回广告来源名称 Custom event。如果您使用多个自定义事件，则该广告来源名称不够精细，无法区分多个自定义事件。如需查找特定自定义事件，请执行以下操作：

  1. 调用 getAdSourceName() 方法。
  2. 设置唯一的广告来源名称。

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

Java

private String getUniqueAdSourceName(@NonNull AdapterResponseInfo loadedAdapterResponseInfo) {

  String adSourceName = loadedAdapterResponseInfo.getAdSourceName();
  if (adSourceName.equals("Custom Event")) {
    if (loadedAdapterResponseInfo
        .getAdapterClassName()
        .equals("com.google.ads.mediation.sample.customevent.SampleCustomEvent")) {
      adSourceName = "Sample Ad Network (Custom Event)";
    }
  }
  return adSourceName;
}

ResponseInfoSnippets.java

Kotlin

private fun getUniqueAdSourceName(loadedAdapterResponseInfo: AdapterResponseInfo): String {

  var adSourceName = loadedAdapterResponseInfo.adSourceName
  if (adSourceName == "Custom Event") {
    if (
      loadedAdapterResponseInfo.adapterClassName ==
        "com.google.ads.mediation.sample.customevent.SampleCustomEvent"
    ) {
      adSourceName = "Sample Ad Network (Custom Event)"
    }
  }
  return adSourceName
}

ResponseInfoSnippets.kt

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

实施方面的最佳实践

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

AdValue

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

PrecisionType 说明
UNKNOWN 广告价值未知。如果启用了生命周期价值回 ping，但数据不足，就会返回此代码。
ESTIMATED 根据汇总数据估算的广告价值。
PUBLISHER_PROVIDED 广告价值是由发布商提供的，例如中介组中的人工每千次展示费用。
PRECISE 相应广告的精准价值。
使用中介时，Ad Manager 会尝试为已启用自动数据收集功能的广告来源提供 ESTIMATED 值。 如果广告来源未经优化，或者如果没有足够多的汇总数据，无法报告有意义的估算值，系统会返回 PUBLISHER_PROVIDED 值。

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

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

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

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

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