Airbridge 实时回传集成方案
请注意,第三方数据集成产生的数据会被纳入集群的消耗数据量
概要
接口简介
| 接口名 | 类型 | 粒度 | 归因 | 成本 | 收益 | 曝光 | 点击 | 转化 |
|---|---|---|---|---|---|---|---|---|
| Callbacks | 回传 | 用户级别 | ✅ | ✅ | ✅ |
Callbacks 接口提供了实时的 Airbridge 用户级别数据,其中包括了广告曝光、点击、转化等数据。
在开始接入 Airbridge 数据前,请确保您已经阅读 AE 系统用户识别规则,理解 AE 如何通过 #distinct_id 和 #account_id 识别一个用户。
集成流程
- 接入 Airbridge 客户端 SDK 与 AE SDK,并在 Airbridge SDK 中设置 AE 的用户识别 ID
- 登录 AE 后台,进入三方集成模块,新增 Airbridge 实时回传方案,并完成相关配置
- 登录 Airbridge 后台,完成回传配置
- 查看 AE 系统是否成功接收数据,并完成报表搭建
一、客户端 SDK 配置
集成 Airbridge 数据的第一步,是在客户端完成 AE SDK 与 Airbridge SDK 的打通,在 Airbridge SDK 中设置 AE 系统的用户识别 ID。
此步骤是整个链路的关键,确保 Airbridge 采集的数据中携带 AE 的访客id或账号id。
- 获取 ID: 在初始化 Airbridge SDK 之前或初始化过程中,调用数数 SDK 接口获取当前用户的访客id或账号id。
- 设置属性: 将获取的 ID 设置为 Airbridge 的 User Alias 或 Custom User Property。
以下各端 SDK 的代码样例:
- Android
//Android // Default Auto Start Tracking Enabled = true
val option = AirbridgeOptionBuilder("YOUR_APP_NAME", "YOUR_APP_SDK_TOKEN")
.setAutoStartTrackingEnabled(false)
.build()
Airbridge.initializeSDK(this, option)
Airbridge.setDeviceAlias("ADD_YOUR_KEY", "AND_YOUR_VALUE");
Airbridge.startTracking()
- iOS
let option = AirbridgeOptionBuilder(name: "YOUR_APP_NAME", token: "YOUR_APP_SDK_TOKEN")
.setAutoStartTrackingEnabled(true)
.build()
Airbridge.initializeSDK(option: option)
Airbridge.setDeviceAlias(key: "string", value: "string")
Airbridge.startTracking()
- Unity
Refer :https://help.airbridge.io/en/developers/unity-sdk-v4
- Unreal
经过以上设置后,回传数据中的custom_data 将带有 ta_distinct_id 字段.
二、方案配置
完成 SDK 配置后,接下来需要您登录 AE 系统后台,在「三方集成」模块中完成 Airbridge 的配置。下图是 Airbridge 的配置界面:
2.1 用户识别字段
由于 Airbridge 回传的是用户级别数据,因此需要为其设置用户识别规则,即 Airbridge 回传数据与#distinct_id 和 #account_id 对应的字段。AE 系统将根据该配置,在转换回传数据时,将这些字段设置为数据中的用户识别字段。
如果您按照本文档上一步进行客户端 SDK 配置,请使用以下配置:
- 访客 ID 关联字段:custom_data.ta_distinct_id
2.2 事件表入库设置
打开「事件表入库设置」开关后,回传的数据(包括激活事件和应用内事件)都将写入到事件表中
我们建议您开启事件数据入库。但需要注意,默认情况下,我们会接收所有 Airbridge 回传的数据。如果回传的事件类型过多,会导致 AE 项目的事件量过度膨胀。因此建议在 Airbridge 平台的设置回传时,只选择必要事件进行回传。
目前支持的 Airbridge 事件清单如下:
| 事件名称 event_name | 说明 |
|---|---|
| airbridge_user_signin | 用户登陆 |
| airbridge_user_signout | 用户登出 |
| airbridge_user_signup | 用户注册 |
| airbridge_adclick | 广告点击 |
| app_open | 打开 APP |
| app_deeplink_open | 打开 APP 链接 |
| airbridge_adimpression | 广告曝光 |
| app_install | APP 安装 |
2.3 标准化用户属性入库规则
在默认情况下,AE 系统会自动将 Airbridge 回传数据中的归因字段写入到标准化处理后的用户属性中,以下是写入用户属性的字段及其含义:
| 原始字段 | 标准化字段 | 含义 |
|---|---|---|
| attributedCampaign | te_ads_object.campaign_name | 广告计划名 |
| attributedCampaignId | te_ads_object.campaign_id | 广告计划 ID |
| attributedAdGroup | te_ads_object.ad_group_name | 广告组名 |
| attributedAdGroupId | te_ads_object.ad_group_id | 广告组 ID |
| attributedChannel | te_ads_object.media_source | 媒体渠道或变现渠道 |
| originalCurrency | te_ads_object.currency | 成本或收益的币种 |
如果需要进行修改,您可以点击「配置规则」进入到入库规则配置页,如下图所示
在此,您可以修改用户属性从哪些事件来。如果您不希望用户属性被频繁写入,可以关闭「包含所有事件」,并将来源事件名修改为 install。这样配置,则 AE 系统只会从 Airbridge 回传的 install 事件中提取需要写入用户属性的字段并进行写入。入库方式默认是 user_setOnce,也就是只会保留首次上报的信息。
如果您希望关闭用户属性入库,可以停止所有规则:
2.4 终端地址
终端地址中展示了 AE 系统接收 Airbridge 回传数据的地址。请您直接复制该地址,在接下来进行 Airbridge 回传配置时,请将该地址填入:
若此处没有显示地址,请进入右上角菜单「项目管理 → 项目配置 → 接入配置」处配置公网地址。该地址即 AE SDK 中配置的数据上报地址。配置后再回到 Airbridge 配置页的「终端地址」复制终端地址。
2.5 事件入库规则
- 使用数据中的 event_time_selected_timezone 字段,取其中的时间和时区信息,时间作为 #event_time,时区写为 #zone_offset。如果 event_time_selected_timezone 为空,则取 event_time 作为 #event_time,时区 #zone_offset 会被设置为 0
- 数据事件名为该事件在 Airbridge 中的事件名
- 其余字段都将会入库
三、Airbridge Push API 配置
完成 AE 后台的配置后,接下来请使用管理员账号登录 Airbridge 后台,在「Integration」- 「Advertiser Postback」找到如图所示部分,按照以下方法设置回调地址:
https://help.airbridge.io/en/guides/airbridge-event-types#list-of-standard-events
四、后续使用
4.1 数据入库检查
您可以在「数据管理」页面查看回传事件、用户属性是否被创建。
您也可以在分析模型,如事件分析模型、用户属性分析模型中通过分析的方式检查数据是否入库。
4.2 报表建议
以下提供几个构建报表的建议:
- 在事件分析模型中,使用 Airbridge 回传数据搭建广告投放、广告变现核心指标,创建广告分析报表
- 在漏斗分析模型中,将安装事件加入到新用户转化漏斗中,并使用媒体渠道、广告计划等粒度分析不同来源用户的转化情况

