应用推广回传数据接口文档
广告主可以通过点击监测链接、跳转链接宏参数拿到发生广告行为的设备、广告请求等信息,然后在广告主侧后链路事件发生时,通过接口回传后链路的转化效果数据,帮助友盟优化投放模型,进而降低广告主投放成本。
1. 点击监测链接
1.1 宏参数
宏 | 说明 |
__REQUEST_ID__ | 本次广告的跟踪的唯一id |
__TS__ | 当前时间戳(秒) |
__TS_MS__ | 当前时间戳(毫秒),13位 |
__IP__ | 客户端真实IP |
__OS__ | iOS:1,Android:2 |
__IDFA__ | ios端可获取时必替换,不可获取时不替换 |
__IMEI__ | 安卓端可获取时必替换,不可获取时不替换 |
__OAID__ | 可获取时必替换,不可获取时不替换 |
1.2 使用方式
广告主在点击监测链接中增加相应的宏,我们会在发生点击时,把相应的宏参数字段换成真实的广告信息,并使用HTTP GET方法调用该点击监测链接。广告主客户发生相应的的事件时,可以调用【归因回调接口】通知友盟。
2. 跳转链接
2.1 宏参数
宏“参数”的格式为“__参数__”,其中:
参数必须全部大写,支持宏参数请见下方;
“__参数__”两边为双下划线,即参数左右两边均为两个连续的英文字符'_';
广告主可以根据自己的需要选择具体填写哪些参数,支持参数详见参数列表;
宏 | 含义 | |
__REQUEST_ID__ | 本次广告的跟踪的唯一id | |
__OAID__ | 安卓设备oaid | |
__IDFA__ | 苹果设备idfa |
2.2 使用方式
广告主在落地页或者deeplink跳转链接后拼接对应的宏参数,则在发生跳转事件时,我们会把相应的宏参数字段换成真实的广告信息,通过跳转链接发送给广告主。广告主客户发生相应的的事件时,可以调用【归因回调接口】通知友盟。
3. 归因回调接口
3.1 调用方式
请求url:https://dsp.ads.umeng.com/callback
请求方法:POST
协议:https/http
3.2 请求参数
参数名 | 必填 | 说明 | 释义 | 场景 |
a0 | 是 | 落地页中的__REQUEST_ID__ | ||
a1 | 是 | 应用拉起:in_app | 用户启动App的行为 | 促活 |
当日首次唤起:in_app_first | 用户当日首次启动App的行为 | 促活 | ||
应用激活:active | 用户下载App完成激活行为 | 拉新 | ||
注册:active_register | 用户在推广的应用/落地页场景下完成注册(手机号/微信等)行为,示例:招商加盟行业,用户下载app后完成注册行为;游戏行业,用户下载游戏后完成激活+注册;电商行业,完成注册 | 拉新 | ||
成交:in_app_order | 用户在App内点击购买按钮,直接调用系统支付接口(如Apple Pay、华为支付), 完成支付并返回App。示例:游戏内购买虚拟物品(如皮肤、道具),通过手机厂商支付完成。 | 促活/拉新 | ||
付费:in_app_pay | 用户在推广的应用/落地页场景下发生交易并完成至少一笔付款。示例:App内下单后跳转到微信支付页面完成付款。 | 促活/拉新 | ||
应用内页面浏览:in_app_page_view | 用户打开App后,成功加载并访问了指定的关键页面(如落地页、活动页)。 | 促活/拉新 | ||
应用内填写信息:in_app_fill_info | 用户打开App后,在表单或注册流程中完成了关键信息的输入行为。 | 促活/拉新 | ||
应用内点击关键按钮:in_app_key_button_click | 用户打开App后,点击了具有明确转化意图的按钮。 | 促活/拉新 | ||
应用内领取卡券:in_app_coupon_claim | 用户打开App后,成功领取优惠券、代金券或权益卡券。 | 促活/拉新 | ||
应用内提交表单:in_app_form_submit | 用户打开App后,完成表单填写并点击提交,成功留下线索或完成注册。 | 促活/拉新 | ||
应用内在线咨询:in_app_online_consult | 用户打开App后,点击咨询入口并发起有效沟通(如发送第一条消息或停留时长达标)。 | 促活/拉新 | ||
应用内页面跳转:in_app_page_jump | 用户打开App后,从当前落地页成功跳转至下一级目标页面(如商品详情页、中间页)。 | 促活/拉新 | ||
应用内调起店铺:in_app_app_launch_shop | 用户打开App后,通过广告成功唤起第三方 App 并进入指定店铺/小程序页面。 | 促活/拉新 | ||
活跃1日后留存:retention_inapp_1d | 用户唤起应用1日后启动应用 | 促活 | ||
活跃2日后留存:retention_inapp_2d | 用户唤起应用2日后启动应用 | 促活 | ||
活跃3日后留存:retention_inapp_3d | 用户唤起应用3日后启动应用 | 促活 | ||
活跃4日后留存:retention_inapp_4d | 用户唤起应用4日后启动应用 | 促活 | ||
活跃5日后留存:retention_inapp_5d | 用户唤起应用5日后启动应用 | 促活 | ||
活跃6日后留存:retention_inapp_6d | 用户唤起应用6日后启动应用 | 促活 | ||
活跃7日后留存:retention_inapp_7d | 用户唤起应用7日后启动应用 | 促活 | ||
活跃14日后留存:retention_inapp_14d | 用户唤起应用14日后启动应用 | 促活 | ||
活跃30日后留存:retention_inapp_30d | 用户唤起应用30日后启动应用 | 促活 | ||
激活1日后留存:retention_active_1d | 用户激活应用1日后启动应用 | 拉新 | ||
激活2日后留存:retention_active_2d | 用户激活应用2日后启动应用 | 拉新 | ||
激活3日后留存:retention_active_3d | 用户激活应用3日后启动应用 | 拉新 | ||
激活4日后留存:retention_active_4d | 用户激活应用4日后启动应用 | 拉新 | ||
激活5日后留存:retention_active_5d | 用户激活应用5日后启动应用 | 拉新 | ||
激活6日后留存:retention_active_6d | 用户激活应用6日后启动应用 | 拉新 | ||
激活7日后留存:retention_active_7d | 用户激活应用7日后启动应用 | 拉新 | ||
激活14日后留存:retention_active_14d | 用户激活应用14日后启动应用 | 拉新 | ||
激活30日后留存:retention_active_30d | 用户激活应用30日后启动应用 | 拉新 | ||
payload | 是 | 额外的信息,根据字段a1中的event_type的不同有所区别 |
payload字段在a1为in_app_order(成交)、in_app_pay(付费)时的取值:
字段 | 字段描述 | 描述 |
order_id | string | 本次成交/付费的订单号 |
pay_amount | long | 本次成交/付费的总金额,单位分 |
3.3 响应格式
成功响应:
返回"success"
失败响应:
返回"fail"