快看广告文档中心

# 监测上报&转化回传指南

# 曝光/点击事件上报

您在创建广告计划或者创建转化目标的时候，会在计划上填写“曝光监测链接”或“点击监测链接”，用来接收后羿智投效果广告平台发出的展示或点击事件。通过约定指定格式的字符串，用以代表将来将要替换的字段位置，这个格式我们统称为“宏”。

# 宏替换说明

1.链接类型：

支持宏替换的链接包括：广告计划中的曝光监测链接、点击监测链接、落地页链接、小程序path字段；转化联调中的点击监测链接、落地页链接、小程序path字段

2.宏参数格式：

链接主要由”域名"+"路径"+"参数"组成，且总大小不得超过10K。具体格式如下：

① 链接的前缀格式为：https://XXX.XXX.com

② 宏“参数”的格式为“__参数__”，其中：

  • 参数必须全部大写

  • “__参数__”中参数两边为双下划线，即参数左右两边均为两个连续的英文字符'_'

  • 监测链接支持大小写字母、数字以及下划线字符

  • 您可以根据自己的需要选择具体填写哪些参数，支持参数详见参数列表

3.请求结构

① 通信协议：支持通过 HTTP 或 HTTPS 通道进行请求通信；为了获得更高的安全性，推荐您使用 HTTPS 通道

② 请求方法：支持 GET 方法发送请求，这种方式下请求参数需要包含在请求的URL中

4.支持替换的宏参数列表

模块 字段 含义 是否必须 所属系统
设备信息 mac_md5=__MAC_MD5__ mac地址 否 共有
os= __OS__ 操作系统 2:ios 3:android 否 共有
android_id= __ANDROID_ID__ 安卓ID 否 Android
imei=__IMEI__ 安卓设备号，全小写 Android设备必须 Android
imei_md5=__IMEI_MD5__ 安卓设备号，全小写，32位 Android设备必须 Android
oaid=__OAID__ Android Q及更高版本的设备号 Android设备必须 Android
oaid_md5=__OAID_MD5__ Android Q及更高版本的设备号，全小写，32位 Android设备必须 Android
idfa=__IDFA__ iOS设备号，需原始值 iOS设备必须 iOS
广告信息 group_id= __GROUP_ID__ 广告组ID 否 共有
campaign_id=__CAMPAIGN_ID__ 广告计划ID 否 共有
creative_id=__CREATIVE_ID__ 广告创意ID 否 共有
账户信息 advertiser_Id=__ADVERTISER_ID__ 广告主ID 否 共有
流量信息 uniqueid=__UNIQUE_ID__ 广告点击的唯一标志 必须 共有
ip=__IP__ IP地址 否 共有
其他信息 ts=__TS_SECOND__ 广告曝光/点击时间，需要精确到秒 必须 共有
callback=__CALLBACK__ 回调信息，该字段需要做urlencode编码 必须 共有

注：

所有的宏参数（前后均为英文双下划线，中间位英文单下划线）必须和表格中的保持一致，参数名没有说明必须一致的，可以自定义参数名。

# 落地页转化追踪拼接说明

当您进行一个落地页转化追踪时，后羿智投效果广告平台会在您的落地页链接上自动拼接参数，您需要将转化用户的参数进行回传，完成转化上报，追踪落地页转化效果。

模块 字段 含义 是否必须 所属系统
广告信息 group_id= __GROUP_ID__ 广告组ID 必须 共有
campaign_id=__CAMPAIGN_ID__ 广告计划ID 必须 共有
creative_id=__CREATIVE_ID__ 广告创意ID 必须 共有
流量信息 uniqueid=__UNIQUE_ID__ 广告点击的唯一标志 必须 共有
其他信息 ts=__TS_SECOND__ 广告曝光/点击时间，需要精确到秒 必须 共有
callback=__CALLBACK__ 回调信息，该字段需要做urlencode编码 必须 共有

注：

① 宏和参数名会由系统自动拼接到落地页链接上，暂不支持修改。

② 对于转化目标为曝光和点击的广告，后羿智投效果广告平台无法自动为您拼接参数，需要您手动将参数进行拼接。

# 转化事件回传

# 1.上报方式

广告主在完成转化归因后，需实时将归因后的数据上报到后羿智投效果广告平台，归因周期为7天。

# 2.参数说明

所有的参数名必须和表格中保持一致，否则会校验不通过。

字段 含义 是否必须
callback=__CALLBACK__ 回传加密字段 是
convTime=__CONV_TIME__ 转化时间，精确到秒 是
convType=__CONV_TYPE__ 转化类型：ACTIVE 激活 REGISTER 注册 AROUSE 唤起 FORM_SUBMIT 表单提交 PHONE_CONSULT 电话咨询 GOODS_BUY 商品购买 DOWNLOAD APP 下载 PAYMENT 付费 是
sign=__SIGN__ 签名 是

# 3.组装回传地址

在转化回传时，需要对回传的数据进行加密处理，防止信息泄露，加密采用在回调链接中增加 Signature 的方式，组装方式举例如下：

初始回传 url 地址：

https://houyi.kkmh.com/open-api/conversion/trail?callback=_CALLBACK_&convTime=_CONV_TIME_&convType=_CONV_TYPE_&sign=_SIGN_
1

第一步：替换已有参数（callback、convTime、convType）

callback:18c95f99f507424en8Y2cf88WrczV5X3w3vt9AUwEIMKaSkwh+eExmgSZJHe0eR2LRNINEHX9hHF/igdqW/XACNS4BGuUj97wLewsj2KjmXbbJiGbeTJbA2gGpgwWnT7Ta80zrtRosn7vV8/cPA21sK9+zJIoHIWMOeyYQf12IzFhl2utw/uF0gNNN5YJqfrIrgaW8wy6p538TtvnGEtSOy5h/SuD2gZWIYlXee/LfinoHvR3PgmBFhvuaU=
convTime:1605015955
convType:ACTIVE
1
2
3

注：这里的 callback 参数是 urldecode 后的结果。

第一次替换后的回传 url 地址：

https://houyi.kkmh.com/open-api/conversion/trail?callback=18c95f99f507424en8Y2cf88WrczV5X3w3vt9AUwEIMKaSkwh+eExmgSZJHe0eR2LRNINEHX9hHF/igdqW/XACNS4BGuUj97wLewsj2KjmXbbJiGbeTJbA2gGpgwWnT7Ta80zrtRosn7vV8/cPA21sK9+zJIoHIWMOeyYQf12IzFhl2utw/uF0gNNN5YJqfrIrgaW8wy6p538TtvnGEtSOy5h/SuD2gZWIYlXee/LfinoHvR3PgmBFhvuaU=&convTime=1605015955&convType=ACTIVE&sign=_SIGN_
1

第二步： 获取urlparam字符串

在宏参数替换后，将第一次替换后的回传 url 地址中的键值对去除 sign 参数后，按照键值的字母递增顺序依次排列（此时 url 中不应该出现 sign 参数），得到字符串 urlparam：

callback=18c95f99f507424en8Y2cf88WrczV5X3w3vt9AUwEIMKaSkwh+eExmgSZJHe0eR2LRNINEHX9hHF/igdqW/XACNS4BGuUj97wLewsj2KjmXbbJiGbeTJbA2gGpgwWnT7Ta80zrtRosn7vV8/cPA21sK9+zJIoHIWMOeyYQf12IzFhl2utw/uF0gNNN5YJqfrIrgaW8wy6p538TtvnGEtSOy5h/SuD2gZWIYlXee/LfinoHvR3PgmBFhvuaU=&convTime=1605015955&convType=ACTIVE
1

第三步：获取秘钥，生成sign



示例secret : 0000000000 注：每条转化跟踪记录会对应唯一的一个秘钥，请在转化跟踪创建页面中查找。

将 Secret 的值直接拼接到第二步中获取的 urlparam 末尾

callback=18c95f99f507424en8Y2cf88WrczV5X3w3vt9AUwEIMKaSkwh+eExmgSZJHe0eR2LRNINEHX9hHF/igdqW/XACNS4BGuUj97wLewsj2KjmXbbJiGbeTJbA2gGpgwWnT7Ta80zrtRosn7vV8/cPA21sK9+zJIoHIWMOeyYQf12IzFhl2utw/uF0gNNN5YJqfrIrgaW8wy6p538TtvnGEtSOy5h/SuD2gZWIYlXee/LfinoHvR3PgmBFhvuaU=&convTime=1605015955&convType=ACTIVE0000000000
1

对上述字符串做一个 md5 (小写)，生成签名的秘钥 sign：

0b710519c450d0d3ab4015675411154e
1

将 sign 参数替换后得到第二次替换后的回调 url 地址

https://houyi.kkmh.com/open-api/conversion/trail?callback=18c95f99f507424en8Y2cf88WrczV5X3w3vt9AUwEIMKaSkwh+eExmgSZJHe0eR2LRNINEHX9hHF/igdqW/XACNS4BGuUj97wLewsj2KjmXbbJiGbeTJbA2gGpgwWnT7Ta80zrtRosn7vV8/cPA21sK9+zJIoHIWMOeyYQf12IzFhl2utw/uF0gNNN5YJqfrIrgaW8wy6p538TtvnGEtSOy5h/SuD2gZWIYlXee/LfinoHvR3PgmBFhvuaU=&convTime=1605015955&convType=ACTIVE&sign=0b710519c450d0d3ab4015675411154e
1

第四步：组装url

最终的 url 如下（需要对 url 中的各参数进行 urlencode ）：

http://houyi.kkmh.com/open-api/conversion/trail?callback=18c95f99f507424en8Y2cf88WrczV5X3w3vt9AUwEIMKaSkwh%2BeExmgSZJHe0eR2LRNINEHX9hHF%2FigdqW%2FXACNS4BGuUj97wLewsj2KjmXbbJiGbeTJbA2gGpgwWnT7Ta80zrtRosn7vV8%2FcPA21sK9%2BzJIoHIWMOeyYQf12IzFhl2utw%2FuF0gNNN5YJqfrIrgaW8wy6p538TtvnGEtSOy5h%2FSuD2gZWIYlXee%2FLfinoHvR3PgmBFhvuaU%3D&convTime=1605015955&convType=ACTIVE&sign=0b710519c450d0d3ab4015675411154e
1

# 4.转化回传链接组装 Demo

转化回传演示 (opens new window)

# 5.回传接口响应格式和内容

① 响应格式：Json数据格式

② 响应内容：{"code": 200,"message": “ok"}

返回值 Code 含义
200 正确
201 系统错误，请联系管理员
202 字段内容非法
203 转化类型和广告计划绑定的不一致
204 签名校验失败

5、事件名称定义

事件 名称 定义
ACTIVE 激活 用户下载安装完毕应用之后，在联网环境下打开应用(①对于唤起类APP广告用户通过 Fallbcak 下载后打开应用的用户可记为激活②对于唤起小程序广告用户点击授权可记为激活)
REGISTER 注册 完成应用下载并且在联网环境打开应用后，完成个人账号/游戏角色注册信息提交
AROUSE 唤起 点击广告后有效唤起应用
FORM_SUBMIT 表单提交 完成表单填写并提交表单
PHONE_CONSULT 电话咨询 用户点击电话咨询
GOODS_BUY 商品购买 电商广告用户完成商品购买
DOWNLOAD APP 下载 落地页投放下载类型广告且用户成功下载应用
PAYMENT 付费 在完成应用下载后并且在联网环境打开应用后，应用内完成一笔付款
APP_STORE AppStore跳转 利用快看自建落地页功能，跳转到appstore进行iOS应用下载预约
RESERVE_DOWNLOAD 安卓预约下载 利用快看自建落地页功能，完成安卓apk包的下载预约
SECOND_RETENTION 次日留存 用户在初次完成转化后，次日仍打开目标app
THIRD_RETENTION 三日留存 用户在初次完成转化后，第三日仍打开目标app
SEVENTH_RETENTION 七日留存 用户在初次完成转化后，第七日仍打开目标app
更新于: 3/29/2024, 4:37:40 PM

← openAPI 接口文档 →