电商推广回传数据接口文档
广告主可以通过点击监测链接、跳转链接宏参数拿到发生广告行为的设备、广告请求等信息,然后在广告主侧后链路事件发生时,通过接口回传后链路的转化效果数据,帮助友盟优化投放模型,进而降低广告主投放成本。
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
协议:Content-Type: application/json
格式
字段 | 字段类型 | 是否必须 | 描述 |
a0 | string | 选填 | 对应点击的id |
a1 | string | 必填 | 下单/支付事件:ecom_order 退款事件:ecom_refund 商品页页面浏览:ecom_page_view 商品页填写信息:ecom_fill_info 商品页点击关键按钮:ecom_key_button_click 商品页领取卡券:ecom_coupon_claim 商品页提交表单:ecom_form_submit 商品页在线咨询:ecom_online_consult 商品页页面跳转:ecom_page_jump 商品页调起店铺:ecom_app_launch_shop |
device_id | string | 选填 | 如果有点击ID可以不回传,如果没有点击ID必填;Android: oaid、aaid;iOS:caid、aaid、idfv、idfa。 caid格式:格式: caid版本号_caid值;如 果有多个版本,则按照格式: caid01版本号_caid01 值,caid02版本号_caid02值, 进⾏","拼接。 |
device_id_type | string | 选填 | device_id的类型。如果有点击ID可以不回传,如果没有点击ID必填;Android取值: oaid、aaid;iOS取值:caid、aaid、idfv、idfa |
event_time | string | 必填 | 事件发生的时间戳,格式1757671034 |
payload | json | 必填 | 额外的信息,根据event_type的不同有所区别 |
payload字段在a1为下单/支付事件ecom_order时的取值:
字段 | 字段类型 | 描述 |
order_id | string | 本次下单支付的订单号 |
order_cnt | int | 本次下单支付的商品数 |
pay_amount | long | 本次下单支付的总成交金额,单位分 |
product_id | string | 商品id,多商品id用";"拼接 |
product_name | string | 商品名,多商品名用;拼接 |
shop_name | string | 店铺名 |
ecom_platform | string | 来源平台。纯中文。目前取值:拼多多、京东、淘宝、微信小程序、唯品会。其它暂不支持。 |
product_price | string | 商品价格。商品ID下的价格范围,比如50分-100分。多商品;拼接 |
product_category | string | 商品类目 |
product_pic_url | string | 商品大图url,多图使用;分隔 |
示例
{
"a0": "21a491c6-ac92-49f8-9606-62de42797d0c",
"a1":"in_app_order",
"event_time": 1757671034,
"payload": {
"order_id": "1234567",
"order_cnt": 1,
"pay_amount": 8990,
"product_id":"商品ID",
"product_name":"商品名称",
"shop_name":"店铺名称",
"ecom_platform":"来源平台",
"product_price":"商品价格",
"product_category":"商品类目",
"product_pic_url":"商品大图"
}
}
payload字段在a1为退款事件ecom_refund时的取值:
示例:
{
"a0": "21a491c6-ac92-49f8-9606-62de42797d0c",
"a1":"ecom_refund",
"event_time": 1757671034,
"payload": {
"order_id": "11212121",
"order_cnt": 1
}
}
payload字段在a1为open_landingpage时的取值:
字段 | 字段类型 | 描述 |
product_id | string | 商品id,多商品id用";"拼接 |
product_name | string | 商品名,多商品名用;拼接 |
shop_name | string | 店铺名 |
ecom_platform | string | 来源平台。纯中文。目前取值:拼多多、京东、淘宝、微信小程序、唯品会。其它暂不支持。 |
product_price | string | 商品价格。商品ID下的价格范围,比如50分-100分。多商品;拼接 |
product_category | string | 商品类目 |
product_pic_url | string | 商品大图url,多图使用;分隔 |
示例
{
"a0": "21a491c6-ac92-49f8-9606-62de42797d0c",
"a1":"open_landingpage",
"event_time": 1757671034,
"payload": {
"product_id":"商品ID",
"product_name":"商品名称",
"shop_name":"店铺名称",
"ecom_platform":"来源平台",
"product_price":"商品价格",
"product_category":"商品类目",
"product_pic_url":"商品大图"
}
}