集成

CloudX Android SDK 的 Singular 广告收入连接器。无需发布方编写胶水代码即可将 CloudX 广告收入转发至 Singular。

连接器(Connector)用于在 CloudX SDK 与其他产品之间传递数据。Singular 连接器会将 CloudX 广告收入转发至您的移动归因合作伙伴(MMP),使广告收入与您在 Singular 中的其他数据一并呈现,并用于 ROAS 衡量。只需添加依赖,收入上报即自动生效——连接器会在进程启动时自行注册,加入与 CloudX.addAdRevenueListener() 相同的全局广告收入监听器列表。其清单文件会合并到您应用的清单中,因此无需调用任何方法,也不必关心初始化顺序。

安装

repositories {
    maven(url = uri("https://maven.singular.net")) // 您应该已经配置了这一项
}

dependencies {
    implementation("io.cloudx:connector-singular:12.0.0.0")
}

Singular 将其 Android SDK 发布到自有的 Maven 仓库,而非 Maven Central,因此代码片段中包含了该仓库的声明。如果您的应用已经集成 Singular,则应该已经配置了这一项;只需在构建解析仓库的位置声明一次即可。

无需任何代码改动。连接器不会初始化 Singular,它使用您现有的 Singular 配置和 SDK key。

要求

  • CloudX Android SDK 4.3.0 或更高版本。
  • 您的应用已使用自己的 SDK key 和 secret 集成并初始化 Singular SDK。连接器仅在编译期依赖 Singular SDK,因此您的应用需自行声明 com.singular.sdk:singular_sdk 以及 Singular 的 Maven 仓库(https://maven.singular.net),运行时使用的是您的版本。
  • 受支持的 Singular SDK 版本:12.0.0 或更高版本。连接器基于 12.0.0 编译,且经验证,它所调用的广告收入 API 直到 12.16.0 均未发生变化。

上报内容

连接器会为每次 CloudX 竞得的展示调用一次 Singular 的 Singular.adRevenue,覆盖所有 CloudX 广告格式——banner、MREC、interstitial、rewarded、native 和 app open。每次调用会携带:

Singular 字段取值
广告平台(Ad platform)CloudX
币种(Currency)USD
收入(Revenue)该次展示的 CloudX 收入估算
收入精度(Revenue precision)estimated
广告网络名称(Network name)竞得的广告网络;若未上报网络则为 CloudX
广告单元 ID(Ad unit id)CloudX 广告单元 ID
广告类型(Ad type)BANNERMRECINTERSTITIALREWARDEDNATIVEAPP_OPEN
广告位名称(Ad placement name)CloudX 广告位
广告单元名称(Ad unit name)广告网络侧的广告位

兼容性

连接器版本Singular SDK最低 CloudX SDK
12.0.0.0Singular Android SDK >= 12.0.04.3.0

自行上报收入

如果您希望自行控制上报调用,可以不使用连接器,直接订阅 CloudX 广告收入:

CloudX.addAdRevenueListener { ad ->
    // 使用您自己的字段映射转发至 Singular 或任何其他目标。
}

CloudX.addAdRevenueListener() 是稳定的公开接口。请只选择连接器或自行注册监听器其中一种方式,不要同时使用。