线索留资回传数据接口文档
广告主可以通过点击监测链接、跳转链接宏参数拿到发生广告行为的设备、广告请求等信息,然后在广告主侧后链路事件发生时,通过接口回传后链路的转化效果数据,帮助友盟优化投放模型,进而降低广告主投放成本。
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 | 是 | 页面浏览:page_view | 用户成功加载并访问了指定的关键页面(如落地页、活动页)。 |
填写信息:fill_info | 用户在表单或注册流程中完成了关键信息的输入行为。 | ||
点击关键按钮:key_button_click | 用户点击了具有明确转化意图的按钮。 | ||
领取卡券:coupon_claim | 用户成功领取优惠券、代金券或权益卡券。 | ||
提交表单:form_submit | 用户完成表单填写并点击提交,成功留下线索或完成注册。 | ||
在线咨询:online_consult | 用户点击咨询入口并发起有效沟通(如发送第一条消息或停留时长达标)。 | ||
页面跳转:page_jump | 用户从当前落地页成功跳转至下一级目标页面(如商品详情页、中间页)。 | ||
调起店铺:app_launch_shop | 用户通过广告成功唤起第三方 App 并进入指定店铺/小程序页面。 | ||
商品购买:product_purchase | 用户完成商品下单并成功支付,产生实际交易订单。 | ||
payload | 是 | 附加信息,根据字段a1中的事件类型不同有所区别 |
payload字段在a1为product_purchase(商品购买)时的取值:
字段 | 字段描述 | 描述 |
order_id | string | 商品购买的订单号 |
pay_amount | long | 商品购买的总金额,单位分 |
3.3 响应格式
成功响应:
返回"success"
失败响应:
返回"fail"