本页用于指导广告归因平台(Adjust、AppsFlyer 等 MMP)或广告主的s2s服务,将转化回传(Postback)发送至本服务。
以下域名 postback.example.com 为占位伪域名,对接前确认及分配本服务采用通用回传(Postback)格式。对接方只需按下方参数说明拼接回传地址即可,其余参数含义、取值均保持一致。
HTTP GET,所有参数通过 Query String 传递。https://postback.example.com# 计费事件
https://postback.example.com/install?clickid=xxx&campuuid=xxx&...
# 非计费事件
https://postback.example.com/event?clickid=xxx&campuuid=xxx&event_name=purchase&...
所有参数均通过 URL Query String 传递,下表为支持的回传参数:
| 参数名 | 是否必传 | 含义 |
|---|---|---|
clickid | 是 | 点击 ID(点击唯一标志,例:mtg0a1b2c3d4e5f6g7h8i9j1x2y) |
campuuid | 是 | 广告单元 ID(推广唯一标志,例:game_ios_us_mtg) |
idfa | 特定场景 | 推广 iOS 应用时必传,Android 不传(例:3E0046F7-8BD4-4F3E-9F91-358B137D2BF0) |
md5_idfa | 特定场景 | IDFA 原值 MD5(32 位小写);以 IDFA MD5 匹配归因时必传,Android 不传 |
gaid | 特定场景 | 推广非中国地区 Android 应用时必传,iOS 不传(例:7268ceb0-5411-4004-b7cb-bd1fee4b6277) |
md5_gaid | 特定场景 | GAID 原值 MD5(32 位小写);推广非中国地区 Android 应用时必传,iOS 不传 |
imei | 特定场景 | 推广中国地区 Android 应用时必传(Android 10+ 获取不到可不填),iOS 不传 |
md5_imei | 特定场景 | IMEI 原值 MD5(32 位小写);以 IMEI MD5 匹配归因时必传,iOS 不传 |
devid | 特定场景 | 推广 Android 应用以 Android ID 匹配归因时必传,iOS 不传 |
md5_devid | 特定场景 | Android ID 原值 MD5(32 位小写);以 Android ID MD5 匹配归因时必传,iOS 不传 |
oaid | 特定场景 | 推广 Android 应用以 OAID 匹配归因时必传,iOS 不传 |
md5_oaid | 特定场景 | OAID 原值 MD5(32 位小写);以 OAID MD5 匹配归因时必传,iOS 不传 |
mac | 特定场景 | 以 MAC 地址匹配归因时必传(例:10:2A:B3:D1:52:F4) |
md5_mac | 特定场景 | MAC 原值 MD5(32 位小写);以 MAC MD5 匹配归因时必传 |
pl | 否 | 系统平台(例:android) |
os | 否 | 系统版本(例:8.0.1) |
device | 否 | 设备型号(例:Mi-4c) |
ip | 否 | 用户 IP 地址(例:59.189.187.99) |
country | 否 | 用户所在地区简码(例:CN) |
app_version | 否 | 推广的应用版本(例:1.1.2) |
type | 否 | 三方名称或广告主名称(例:s2s) |
install_time | 是 | 计费转化事件触发时间戳,所有事件(计费 + 非计费)回调均必传(Unix 秒,例:1486088825) |
event_time | 是 | 非计费转化事件触发时间戳(Unix 秒,例:1486088825) |
event_name | 特定场景 | 事件类型,调用非计费事件回调时必传,计费回调时选填。如:app_open、reged、login、purchase 等 |
event_value | 特定场景 | 事件关联数据值,event_name 为付费相关(如 purchase)时必传,其他选填(例:1.90) |
currency | 特定场景 | 货币类型,event_name 为付费相关时必传,其他选填。如:CNY、USD、EUR、JPY、GBP |
attribu_type | 否 | 是否归因给本平台,0 或 1;1 为归因给本平台 |
app_id | 否 | 应用包名(Android:com.xxx;iOS:idxxx) |
is_pwa | 否 | 标记该回传对应的包是否为 PWA 包。取值:1 表示是,0 表示否。计费回调(/install)命中该标记(值为 1)时,本服务会自动补发一次 app_open 激活事件。 |
注意:我方提供的 campuuid 是带动态后缀的,例如 game_ios_us_0713_wbl_*——
刚开始可能是 game_ios_us_0713_wbl_cpi,过一段时间会变成 game_ios_us_0713_wbl_cpm。
因此对接方需要保存当时 clickid 对应的 campuuid,在回传(Postback)时原样带回。
200error 字段。error 值为 0 时表示成功;不为 0 时表示失败。ret 字段与 msg 字段。ret 值为 0 时表示成功;不为 0 时表示失败,msg 返回错误信息,枚举如下:| msg | 含义 |
|---|---|
"Event Name Not Correct" | event_name 参数不能为空 |
"Campaign Not Correct" | campuuid(即 uuid)参数不能为空 |
"Clickid Not Correct" | clickid 参数格式不正确 |
# 计费回传示例(PWA 包,自动补发 app_open 激活)
https://postback.example.com/install?campuuid=game_ios_us_0713_wbl_cpi&clickid=mtg0a1b2c3d4e5f6g7h8i9j1x2y&idfa=3E0046F7-8BD4-4F3E-9F91-358B137D2BF0&type=s2s&install_time=1486088825&is_pwa=1
# 非计费回传示例
https://postback.example.com/event?campuuid=game_ios_us_0713_wbl_cpi&clickid=mtg0a1b2c3d4e5f6g7h8i9j1x2y&idfa=3E0046F7-8BD4-4F3E-9F91-358B137D2BF0&type=s2s&event_time=1486088900&event_name=purchase&event_value={"currency":"USD","revenue":1.9}
说明:event_name 指的是事件类型,是一个字符串类型枚举值。具体取值如下:
| 取值 | 事件名称 | 定义 |
|---|---|---|
app_open | 激活APP | 用户下载安装完毕应用之后,打开应用 |
reged | 注册 | 用户完成下载、安装并且打开应用后,完成注册账号信息提交 |
login | 登录 | 用户完成下载、安装并且打开应用后,完成账号登录操作 |
search | 搜索 | 用户完成下载、安装并且打开应用后,完成一次搜索操作 |
content_view | 浏览 | 用户完成下载、安装并且打开应用后,完成一次浏览行为 |
share | 分享 | 用户完成下载、安装并且打开应用后,完成一次分享操作 |
purchase | 付费 | 用户完成下载、安装并且打开应用后,完成一笔付款行为 |
first_purchase | 首次付费 | 用户完成下载、安装并且打开应用后,完成在该应用的第一次付费行为 |
add_paymentinfo | 添加付款信息 | 用户完成添加付款信息操作,如选择选择付款方式/绑定付款方式等 |
add_wish | 加入收藏夹 | 用户完成加入收藏夹/心愿单的操作 |
add_Cart | 加入购入车 | 用户完成将商品加入购物车的操作 |
fill_order | 填写订单 | 用户进行订单提交前,填写并提交订单信息的操作 |
add_deliveryinfo | 添加快递信息 | 用户添加快递信息的操作,如收件人姓名/电话/地址等 |
generate_lead | 带来潜力客户 | 用于在应用内提交用户信息等操作 |
initiate_checkout | 退出登录 | 用户在应用内进行退出登录操作 |
lv_complete_Xt | 游戏关卡 | 对于游戏类应用,用户完成下载、安装并且打开应用后,完成指定游戏关卡通关操作 |
create_role | 创建游戏角色 | 对于游戏类应用,用户完成下载、安装并且打开应用后,完成创建游戏角色操作 |
tutorial_begin | 进入新手指引 | 用户完成下载、安装并且打开应用后,完成进入新手指引操作 |
tutorial_complete | 完成新手指引 | 用户完成下载、安装并且打开应用后,完成进入新手指引学习 |
nextday | 次日留存 | 用户首日完成下载、安装并打开应用后,第二个自然日再次打开应用 |
key_conversion | 关键行为 | 用户完成下载、安装并打开应用后,触发多重行为(自定义)后可被判定为高质量用户(主要用于IAA产品判断首日回收是否达标) |