开发文档
开发文档时对接过程中的指导规范
开发文档时对接过程中的指导规范
根据不同需求,有如下两种对接方式:
a.落地页JS对接——轻量快速,可直接采集落地页相关数据
b.落地页API对接——稳定可靠,广告主可自主决定上传内容
以下分别介绍落地页的 JS 和 API 的对接方式,广告主可选择其中一种完成对接。
在落地页页面的 head 标签中加入脚本
<script type="text/javascript" src="http://g1.tagtic.cn/g2.js"></script>
执行下面的曝光代码
<script >window.AD_SDK.report()</script>
// 当落地页在发生转化时,页面发生跳转,那么转化请求就会被中断,需要将跳转行为通过回调函数执行,如function(){转化行为}。
// !提示: 无论转化数据是否发送成功都需设置跳转行为, 避免因转化数据上报出现问题而导致跳转行为失败.
function submit() {
/*
* 你的代码逻辑
*/
window.AD_SDK.jump(function () { //# 调用点击事件
// #发送数据之后执行的跳转
window.location.href = 'http://g.tagtic.cn'
})
}
如下图:
请求方式为:get / post
字段名 | 字段类型 | 注释 | 必填 | 注释 |
---|---|---|---|---|
ordid | String | 订单ID | 是 | 从落地页URL中截取 |
advertKey | String | 广告密匙 | 是 | 联系牛油果AE获取 |
timestamp | String | 转化时间戳 | 是 | |
ip | String | 用户IP | 是 | |
deviceid | String | 机器标识 | 否 | imei 或者 idfa |
os | String | 用户系统 | 否 | IOS,ANDROID |
osver | String | 系统版本 | 否 | |
model | String | 手机型号 | 否 | |
ua | String | 用户user-agent | 需encode 参考格式:Mozilla/5.0 (Linux; Android 6.0.1; MI 4LTE Build/MMB29M; wv) AppleWebKit/537.36 (KHTML, like Gecko) Version/4.0 Chrome/51.0.2704.81 Mobile Safari/537.36 |
|
channelid | String | APP所属渠道号 | 否 | |
brand | String | 手机品牌 | 否 | |
signature | String | 签名 | 否 | |
sex | int | 性别 | 否 | 1男;2女 |
phone | String | 用户手机号 | 否 | |
age | Int | 用户年龄 | 否 | |
area | String | 地区(省市区) | 否 |
字段名 | 字段类型 | 注释 |
---|---|---|
ordid | String | 订单ID |
errdesc | String | 错误描述 |
errcode | String | 错误码 |
返回demo如下
{"ordid":"nyg-001","errcode":"0","errdesc":"success"}
失败:
{"ordid":"nyg-001","errcode":"50001","errdesc":"required parama_oId missing"}
注意:只有在ordid有效的情况下才会返回ordid字段,测试情况或者ordid无效时则不返回。
状态码 | 字段类型 | 注释 |
---|---|---|
0 | String | 成功 |
50001 | String | 必要的参数不可空 |
+50002 | String | 订单ID填写错误 |
50003 | String | 字段类型格式错误 |