2020-08-13

阿里汇川信息广告推广工具:激活API工具

激活API工具

产品介绍

激活数据API

主要用于实现广告主App激活数据与汇川投放数据的对接,从而实现可从投放平台直接查看应用激活数据,并为后续支持根据转化自动出价(OCPC)建立数据基础。 

对接背景

激活数据API是汇川广告平台帮助广告主提高优化效率的工具。

通过激活API的对接,广告主可以在投放平台便捷的统计到所投放计划、单元、创意的激活数量、激活成本、激活率等数据,同时后期汇川推出根据转化自动出价产品(OCPC)激活API的对接是前提条件。 

产品逻辑

功能原理:通过API的方式,实现投放汇川广告产生的激活数据的回调。 

适用推广资源:UC头条、UC精准。

适用投放方式:APP下载、打开落地页; 

适用操作系统:Android、IOS以及其他操作系统。 

操作使用说明

创建转化工具 

第一步:推广工具-转化工具-创建转化 

在使用转化工具之前,首先需根据技术手册进行相应开发,随后通过汇川平台完成以下操作,便可正常使用该功能。 

点击“创建转化”后,进入设置页面。

第二步:联调

扫描二维码→输入设备号→下载应用并激活→返回汇川激活信息→联调成功 

注:建立联调前,需参照技术对接文档(详情见下文)完成技术开发。

IDFA获取:iphone需关闭限制广告跟踪,在AppStore下载IDFAVerify或 My Device ID by AppsFlyer获取IDFA;
IMEI获取:安卓手机拨号键盘输入“*#06#” 

第三步:引用转化工具至单元 

操作入口:推广管理-单元层级-出价设置 

转化监测:转化监测选择激活 

引用转化:即引用已联调成功的转化工具: 

1、对于APP下载样式,引用转化对应的APP需与创意层级推广的APP一致。

2、对于打开页面样式,引用转化对应的APP需与页面推广的APP一致。

第四步:转化数据查看 

增加激活数量、转化率(激活/点击)、转化成本(消费/激活)指标用于单元和创意层级查看数据 

推广管理

入口:推广管理-自定义 

更新频率:天级 

时间范围:与整体一致 

 数据报告 

入口:数据报告-分推广层级报告/实时报告 

更新频率:分推广层级-天级/实时报告-小时 

时间范围:与整体一致 

激活数据API对接流程

背景

汇川现支持各广告主与汇川进行APP激活数据的实时服务器对接。

对接后数据可直接呈现在汇川数据报告模块指导广告主做投放优化,同时可用于后期基于转化的平台优化工具例如基于转化的动态出价。

该回调方案目前仅支持APP类激活数据对接,推广资源可同时支持UC头条和UC精准,操作系统可同时支持 Android和iOS,投放方式可同时支持打开页面和APP下载。

 

基本操作 

1、基本定义:

点击广告:用户在汇川平台点击广告相关内容的行为,其中广告相关内容包括标题、图片等,与客户报表中点击数对应的行为一致。

激活APP:用户下载、安装APP后并进行首次使用的行为。

feedback_url:接口一,客户填写的接收汇川点击数据的服务器地址和相关参数。

callback_url:接口二,客户向汇川返回激活数据地址和相关参数。

2、操作流程

用户点击广告,点击数据会上报给汇川广告服务器。

汇川广告服务器会向广告主设置好的feedback_url(接口一)发送请求,将点击数据的相关信息传递给广告主的服务器。

当广告主接收到feedback_url的请求后,根据请求参数中的用户信息(IDFA或IMEI),到激活用户的数据库中查询,检查该用户是否激活相应APP,如果激活信息匹配成功,则将激活信息以callback_url回调给汇川广告服务器,具体实现见接口二。

汇川广告服务器根据收到的回调信息进行匹配和分析,并生成激活数据用于客户报表以及转化相关工具。

3、流程示意图

接口一说明

1、简介:接口一为广告主提供的地址,用来接收汇川广告平台发送的广告点击信息,详细定义如下。

请求方:汇川广告服务器。

处理方:广告主提供的监测平台服务器

协议:http,get

点击发送地址:feedback_url即广告主在汇川平台创建转化时提供的点击发送地址,该url由服务器地址和通配符部分组成,汇川广告服务器会将通配符({}与内部参数)替换成对应的参数的内容,其中涉及到的参数见参数解释。

2、点击发送地址示例。

ios示例:http://xxx.xxxx.com?idfa={IDFA_SUM}&time={TS}&callback={ CALLBACK_URL }

android示例:http://xxx.xxxx.com?imei ={IMEI_SUM}&time={TS}&callback={ CALLBACK_URL }

3、参数解释

 参数 描述  格式  可选性 
 IDFA_SUM IOS设备唯一标识 原值转大写,计算32位md5sum,再转大写  IOS必选
 IMEI_SUM Android设备唯一标识  Android必填,原值转大写,计算32位md5sum,再转大写   安卓必选
 TS 客户端促发检测的时间   UTC时间戳   必选
 CALLBACK_URL 激活回调地址  经过url encode后的url 方案一必选 
 CALLBACK_PARAM 激活回调参数    方案二必选 
 AID 广告单元ID  原值  可选 
 CID 广告创意ID  原值  可选 
 MAC_SUM 用户设备的mac地址的md5  保留“:”,保持大写,取mad5sum,再转大写  可选 
 MAC_SUM1 用户设备的mac地址的md5  去除“:”,保持大写,取md5sum,再转大写  可选
 ANDROIDID_SUM 用户终端的AndroidID,md5加密  保持大写,取md5sum,再转大写  可选
 UA 数据上报终端设备的User Agent  经过 url encode的字符串  可选 
 OS 操作系统  0表示Ios,1表示Android,2其他  可选 
 LBS 经纬度  精确到两位小数,精度在前维度在后,用逗号分隔  可选 
 IP 媒体投放系统获取的用户终端的IP地址  A.B.C.D  可选 

4、响应方式

不要求广告主服务器返回具体内容,使用http 状态码表示是否成功,其中状态码为200 ,表示成功。

5、注意事项

■ feedback_url 大小不能超过10K 

 ■ feedback_url 不能是下载链接 

■ 所有参数需要放到英文半角大括号 { } 中 

■ 参数名均为大写 

■ 历史版本的地址仍进行支持,其中CALLBACK_URL 等同 

■ 使用热云的广告主可直接将点击监测所用的链接填写至点击发送地址,作为接口一

接口二说明

1、简介:接口二用于广告主将激活上报给汇川广告服务器,广告主必须在收到app激活后实时进行回调,以免出现统计无效的情况,导致激活数据不准确,影响汇川平台报表以及后续基于激活的优化效果。

2、激活接收示例(方案一)

■ 广告主在平台填写的点击监测地址即feedback_url为:http://xxx.xxxx.com?idfa={IDFA_SUM}&time={TS}&callback={CALLBACK_ULR}

汇川广告服务器访问广告主服务器时,会进行通配符替换并发送给广告主,替换的结果:http://xxx.xxxx.com?idfa=40C7084B4845EEBCE9D07B8A18A055FC&time=1486453741749&callback=http%3A%2F%2Fhuichuan%2Esm%2Ecn%2Ftd%3Ftp%5Ftype%3Droi%26click%5Fid%3D17602408199300842950%26convert%5Fid%3D6%26event%5Ftype%3D1

■ 广告主接收激活信息后,将CALLBACK_ULR对应的部分即上述黄色部分进行url decode,结果如下、

http://huichuan.sm.cn/td?tp_type=roi&click_id=17602408199300842950&convert_id=2&event_type=1

广告主无需关注里面参数的含义,只需要在feedback_url中对应的设备存在激活后,将参数的值进行url decode后,直接将callback_url返回。

3、激活接收示例(方案二)

■ 广告主在平台填写的点击监测地址即feedback_url为:

http://xxx.xxxx.com?idfa={IDFA_SUM}&time={TS}&callback={CALLBACK_PARAM }

■ 汇川广告服务器访问广告主服务器时,会进行通配符替换并发送给广告主,替换的结果。

http://xxx.xxxx.com?idfa=40C7084B4845EEBCE9D07B8A18A055FC &time=1486453741749&callback=r_15863400918861930368_100474101_1

■ 广告主接收激活信息后,若发现idfa对应的设备激活APP,则将CALLBACK_PARAM对应的部分返回给汇川,返回的形式如下:

汇川分配的地址&callback_param=r_15863400918861930368_100474101_1

1)汇川分配的地址:目前需线下获取,具体获取请联系运营同学。

2)callback_param:用于标识参数类型,不可进行更改。

3)黄色部分:汇川发给广告主CALLBACK_PARAM对应的值,无需进行更改直接添加至链接中返回即可。

4、相应方式

成功返回200,失败返回其他的http状态码。

常见疑问解答

1、联调状态显示未通过? 

答:首先需确定已通过平台操作流程正确输入设备号并下载且激活APP;其次,确认技术根据技术手册完成开发并成功返回汇川激活信息,若自查以上两项均正常完成24小时后仍未显示联调成功,可向平台反馈。

2、为何会有平台展示激活数与广告主统计的激活数存在不一致的情况? 

答: ■ 汇川接收到激活数据后会与5天内的点击进行拼接,若广告主返回的激活对应为5天前的点击,由于时效性,汇川平台未进行展示; 

■ 对于同一个点击广告主若返回多个激活信息,由于激活为首次打开APP,汇川仅统计最早返回的激活信息 

■ 若广告主未及时反馈激活信息,会造成平台激活数较少。

以上均会造成平台展示的激活数与广告主统计的激活数不一致,如出现10%以上的误差,可向自查后向平台反馈。

3、激活API的与点击监测的关系是? 

答:激活API与点击监测均会向广告主发送点击信息,点击监测无需向汇川返回激活信息,激活API需反馈激活信息,当广告主两种功能均使用时: 

■ 若点击监测地址与转化工具的点击发送地址完全一致,汇川平台只向广告主发送一次点击信息。

■ 若点击监测地址与转化工具的点击发送地址完全一致存在差异,仍会发送两次。