展示机会层级的广告收入

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

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

前提条件

每种广告格式都有一个 onAdPaid 事件回调。 在广告事件的生命周期内，Google 移动广告 SDK（Beta 版）会监控展示事件，并以收获到的价值作为参数调用该处理脚本。

下例处理的就是激励广告的付费事件：

Kotlin

ad.adEventCallback =
  object : RewardedAdEventCallback {
    override fun onAdPaid(adValue: AdValue) {
      // 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 precisionType = adValue.precisionType

      val loadedAdSourceResponseInfo = ad.getResponseInfo().loadedAdSourceResponseInfo
      val adSourceName = loadedAdSourceResponseInfo?.name
      val adSourceId = loadedAdSourceResponseInfo?.id
      val adSourceInstanceName = loadedAdSourceResponseInfo?.instanceName
      val adSourceInstanceId = loadedAdSourceResponseInfo?.instanceId
      val extras = ad.getResponseInfo().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

ad.setAdEventCallback(
    new RewardedAdEventCallback() {
      @Override
      public void onAdPaid(@NonNull AdValue value) {
        // 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 = value.getValueMicros();
        String currencyCode = value.getCurrencyCode();
        PrecisionType precisionType = value.getPrecisionType();

        AdSourceResponseInfo loadedAdSourceResponseInfo =
            ad.getResponseInfo().getLoadedAdSourceResponseInfo();
        String adSourceName = loadedAdSourceResponseInfo.getName();
        String adSourceId = loadedAdSourceResponseInfo.getId();
        String adSourceInstanceName = loadedAdSourceResponseInfo.getInstanceName();
        String adSourceInstanceId = loadedAdSourceResponseInfo.getInstanceId();

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

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

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

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

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

Kotlin

private fun getUniqueAdSourceName(loadedAdapterResponseInfo: AdSourceResponseInfo): String {
  var adSourceName = loadedAdapterResponseInfo.name
  if (adSourceName == "Custom Event") {
    if (
      loadedAdapterResponseInfo.adapterClassName ==
        "com.google.ads.mediation.sample.customevent.SampleCustomEvent"
    ) {
      adSourceName = "Sample Ad Network (Custom Event)"
    }
  }
  return adSourceName
}

Java

private String getUniqueAdSourceName(@NonNull AdSourceResponseInfo loadedAdapterResponseInfo) {
  String adSourceName = loadedAdapterResponseInfo.getName();
  if (adSourceName.equals("Custom Event")) {
    if (loadedAdapterResponseInfo
        .getAdapterClassName()
        .equals("com.google.ads.mediation.sample.customevent.SampleCustomEvent")) {
      adSourceName = "Sample Ad Network (Custom Event)";
    }
  }
  return adSourceName;
}

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

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

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

合作伙伴 SDK
调整
AppsFlyer
Singular
Tenjin

实施方面的最佳实践

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

AdValue

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

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

使用 AdMob 中介时，对于经过优化的广告来源，AdMob 会尝试提供 ESTIMATED 值。如果广告来源未经优化，或者如果没有足够多的汇总数据，无法报告有意义的估算值，系统会返回 PUBLISHER_PROVIDED 值。

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

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

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

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

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