logo
聚汇广告平台

开发文档

开发文档时对接过程中的指导规范

广告对接文档

落地页用户转化对接JS&API

一、概述

(一)对接价值

广告主在广告平台投放后,用户进入广告主落地页后会发生用户的转化行为,跟踪用户的这些后端数据,能够帮助广告主更好的优化广告效果。
广告平台为广告主提供人机结合、oCPC 等智能投放策略,落地页用户转化的回收可实时用于投放策略调整,更好稳定投放,以最低的成本帮助广告主带来最大的回收。

(二)应用场景

当广告主考核广告投放效果的主要指标为以下这些指标时,可进行落地页的后端数据对接:
  • 填表/申请;
  • 下单;
  • 注册;
  • 领取;
  • 完件;
  • ...

(三)对接流程

1、请联系与您对接的销售;
2、聚汇提供专业对接支持,配合广告主优化;
3、方案对接,联调
4、测试及后续优化

(四)基本名词介绍

1、曝光数据: 
  • PV,即页面浏览量,用户每 1 次对网站中的每个网页访问均被记录 1 次。用户对同一页面的多次访问,访问量累计;
  • UV,即访问页面的人数,根据 PV 去掉重复访问页面的用户数据。
2、落地页用户转化: 用户进入页面后,在落地页发生的转化行为,如点击,长按按钮,提交表单等
3、常用参数含义: 
  • a_oId :标识订单唯一 ID
  • advertkey :聚汇广告秘钥,请联系AE获取

二、落地页用户行为转化对接

根据不同需求,有如下两种对接方式:

a.落地页JS对接——轻量快速,可直接采集落地页相关数据

b.落地页API对接——稳定可靠,广告主可自主决定上传内容

以下分别介绍落地页的 JS 和 API 的对接方式,广告主可选择其中一种完成对接。

(一)落地页 JS 对接

1、落地页数据回传原理图

2、JS 对接流程图

3、曝光事件转化(引入曝光代码)

在落地页页面的 head 标签中加入脚本

<script type="text/javascript" src="http://g1.tagtic.cn/g2.js"></script>
                    

执行下面的曝光代码

<script >window.AD_SDK.report()</script>
                      

4、点击事件转化

广告主在按要求接入了 JS 后,广告主落地页在发生转化时,页面发生跳转,则转化请求会被中断,需要按以下方式进行跳转: 在转化发生时(提交或者注册成功时)通过调用window.AD_SDK.jump()函数进行跳转
                      
// 当落地页在发生转化时,页面发生跳转,那么转化请求就会被中断,需要将跳转行为通过回调函数执行,如function(){转化行为}。
// !提示: 无论转化数据是否发送成功都需设置跳转行为, 避免因转化数据上报出现问题而导致跳转行为失败.
function submit() {
  /*
  * 你的代码逻辑
  */
    window.AD_SDK.jump(function () { //# 调用点击事件
        // #发送数据之后执行的跳转
        window.location.href = 'http://g.tagtic.cn'
    })
}                        
                              
                      
                    

如下图:

(二)落地页API对接

1. 对接url

2. 请求方式

请求方式为:get / post

3. 传入参数字段

字段名 字段类型 注释 必填 注释
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 地区(省市区)

4. 返回字段

字段名 字段类型 注释
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无效时则不返回。

5. APP错误码解释

状态码 字段类型 注释
0 String 成功
50001 String 必要的参数不可空
+50002 String 订单ID填写错误
50003 String 字段类型格式错误