oCPX广告主对接文档
更新日志
| 版本 | 更新日期 | 更新描述 |
|---|---|---|
| 1.0.0 | 2026-05-27 | 初始版本，增加⼴告主转化回传接⼝ |
概述
本文档介绍，如何把从众宸渠道产生转化数据，回传到众宸渠道广告平台，帮助广告主优化转化效果
业务流程
1、用户点击广告， 众宸收集用户的点击事件。
2、众宸把点击事件相关参数发送给广告主设置的点击监控 url（点击监控接口）。
3、当广告主或第三方监控平台接受到点击监控的请求后，保存此请求相关的参数（例如 用户的oaid等）
4、用户完成转化（激活、注册、付费等）后，通过设备号等用户信息，匹配点击数据
5、匹配成功后，应第一时间通过 __CALLBACK__ 回调给众宸（转化上报接口）
接口设置流程
1、请求方：众宸平台点击后台 2、处理方：广告主后台 3、请求协议：HTTP/HTTPS 4、请求方式：Get 5、请求地址：广告主在众宸投放时提供的监测 URL，监测 URL 中，使⽤双下滑线__参数__的形式来 设置所需返回的数据。用户点击广告时，我们会把__参数__替换成真实值上报给广告主
例如广告主提供的监控链接为 https://xxx.com/track/click, 则示例如下:
https://xxx.com/track/click?bnd=__BRAND__&m0=__OPENUDID__&m11=__OAID__&m70s=__CAIDS__&m11a=__OAID1__&m1a=__ANDROIDID__&m2=__IMEI__&m2a=__SIMEI__&m4=__AAID__&m5=__IDFA__&m5a=__IDFA1__&m6=__MAC1__&m6a=__MAC__&m70=__CAID__&m70a=__CAID1__&mdl=__MODEL__&mo=__OS__&nn=__APP__&ns=__IP__&tr=__REQUESTID__&ts=__TS__&ua=__UA__&wf=__WIFI__&cb=__CALLBACK__&amod=c
参数说明
| 字段含义 | 宏参数 | 字段定义 | 是否必填 |
|---|---|---|---|
| 操作系统 | __OS__ | 枚举值0: Android; 1: iOS; 2:WindowsPhone;3:Others | 必填 |
| IP地址 | __IP__ | 投放系统服务器观察到的用户远程IP | 必填 |
| OAID | __OAID__ | 终端的oaid，原值 | 条件必填 |
| OAID MD5 | __OAID1__ | 针对设备OAID取md5 | 选填 |
| AndroidID MD5 | __ANDROIDID__ | Android设备ID，AndroidID取md5值 | 选填 |
| APP NAME | __APP__ | App名 urlencode | 选填 |
| APK NAME | __APK__ | App包名 urlencode | 选填 |
| OS version | __OSV__ | 操作系统版本号 15.0.0 | 选填 |
| Android ID | __AndroidID__ | AndroidID原值 | 选填 |
| IMEI | __IMEI__ | IMEI（Android设备ID），IMEI取md5 | 必填 |
| IMEI | __SIMEI__ | IMEI，取原值 | 选填 |
| IDFA | __IDFA__ | IOS设备ID。取原值，32位十六进制数字+4位连接符"-"，iOS6及以上使用 | 条件必填 |
| IDFA MD5 | __IDFA1__ | IDFA原值转大写后取md5 | 选填 |
| MAC | __MAC__ | 去除分隔符”:”的大写MAC地址取md5 | 选填 |
| MAC MD5 | __MAC1__ | 保留分隔符":"，(保持大写)，取 md5 | 选填 |
| CAID | __CAID__ | CAID原值，格式为caid版本_caid（取最新的版本） | 条件必填 |
| CAID MD5 | __CAID1__ | CAID原值取md5，格式为"版本_caid" md5（取最新的版本） | 选填 |
| 时间戳 | __TS__ | 投放发⽣时的Unix时间戳，毫秒 | 必填 |
| UA | __UA__ | User Agent信息，明文 | 必填 |
| 设备品牌 | __BRAND__ | 手机设备厂商，明文 | 选填 |
| 设备型号 | __MODEL__ | 手机机型，明文 | 选填 |
| 网络类型 | __WIFI__ | 枚举值： 0：非wifi; 1： wifi | 选填 |
| 请求id | __REQUESTID__ | 曝光/点击的唯一标识 | 必填 |
| 激活回调监测 | __CALLBACK__ | 用于广告主回调转化事件给众宸平台 | 必填 |
| 广告主ID | __ADVERTISERID__ | 媒体方广告主ID或者标识 | 选填 |
| 创意ID | __CREATIVEID__ | 媒体方创意ID | 选填 |
| 素材ID | __MATERIALID__ | 媒体方素材ID | 选填 |
| 广告组ID | __ADGROUPID__ | 媒体方广告组ID | 选填 |
| 广告ID | __ADID__ | 媒体方广告ID | 选填 |
| 广告计划ID | __CAMPAIGNID__ | 媒体方广告计划ID | 选填 |
点击监测补充说明
点击监测上支持宏 __CALLBACK__ 广告主收到用户转化数据后，针对动态回调，需要在 callback_url 地址后拼接参数event_type（注意：此参数为必填）。
event_type 枚举值如下：
| 事件 | 值 |
|---|---|
| 激活 | activate |
| 注册 | register |
| 表单提交 | commit_msg |
| 唤起 | open_app |
| 下载 | download |
| 加购 | add_cart |
| 支付 | pay |
| 次日留存 | retained |
| 2日留存 | retained_2d |
| 3日留存 | retained_3d |
| 4日留存 | retained_4d |
| 5日留存 | retained_5d |
| 6日留存 | retained_6d |
| 7日留存 | retained_7d |
| 授信 | credit |
| 首次下单 | new_order |
| 下单 | old_order |
| 关键行为 | addiction |
| 自定义1 | custom1 |
| 自定义2 | custom2 |
例如:callback_url 为 http://abc.com?param1=a ，广告主拼接参数后 http://abc.com?param1=a&event_type=activate