REST付费报送说明文档

一、说明

1.适用范围

热云TrackingIO作为国内第三方移动广告监测平台,能够更好的帮助广告主更精准的评估每次广告投放效果,以及帮助广告网络做广告系统的投放优化或业务数据的完善。

本文档适用于服务器报送付费数据。

2.统计说明

为了能够在接入过程中保持概念统一,针对通用概念做如下说明:

  • 设备

指某台安装了应用的终端。

  • 账号

指用户在某台设备上安装了应用之后,在应用中的唯一标识。

通常用作账号的标识符可以是用户注册应用时的唯一用户名(如邮件地址),也可以是用户注册时自动生成的唯一字符串

二、接入流程

1.申请APPKEY

1)打开https://www.trackingio.com,使用您的热云账号进行登录。

2)进入“产品中心”,点击左上方**“+新建产品”**,完成产品创建,您将获得一串32位的16进制APPKEY;

如果您已经完成产品创建,请在如下位置获取APPKEY:“管理中心”-“产品中心”-“产品管理”-APPKEY

3)APPKEY为应用的唯一标识,用于数据报送。

注:为了保证您的数据安全,请勿泄露您的APPKEY。

2.数据报送

详见“三、数据报送说明”

3.测试

1)进入热云调试页面查看调试数据:

“管理中心” - “产品中心” - “产品管理” - “操作”–“调试”

注:热云SDK所有API接口的http response均以status:0表示成功,若不成功,会在返回的json里提示详细错误信息。

三、数据报送说明

1.注意事项

1)数据报送地址:

https://log.trackingio.com

2)所有请求格式统一使用UTF-8编码,请求方式使用post。

3)所有必填参数,请务必上报,有下划线的参数必须携带下划线。

  • IOS必填参数,Android不需上报
  • Android必填参数,IOS不需上报

4)_deviceid为基本参数,是用来记录用户设备身份信息(IOS获取idfa,Android获取IMEI或者MAC地址或者AndroidID,但要保证一致)

5)报送的头信息中一定要有Content-Type=application/json参数。

2.统计用户充值方法:

/receive/tkio/payment
  • 方法用途:
    用于用户充值成功,统计充值数据,所有付费相关分析的数据报表均依赖此方法。

  • 参数说明:

参数名是否必填参数类型长度说明
appidString32位创建产品时获得的32位字符长度的APPKEY
whoString最长64位账号唯一标识,支持英文、数字、下
contextHashMap上下文信息

上下文信息:

参数名是否必填参数类型长度说明
_deviceidString最长128位IOS:内容填写idfa的值。Android填写优先级:imei>oaid>androidid
_transactionidString最长64位交易流水号,请确保唯一。
_paymenttypeString最长16位支付类型,例如支付宝(alipay),银联(unionpay),微信支付(weixinpay),易宝支付(yeepay),paymentType不能填写:FREE(FREE不统计付费)
_currencytypeString最长3位货币类型,按照国际标准组织ISO 4217中规范的3位字母,例如:CNY
_currencyamountfloat最长16位支付的真实货币金额,人民币单位:元
_idfaIOS必填String广告标识
_imeiAndroid必填String手机的唯一识别号码
_androididAndroid必填String
_oaidAndroid必填String安卓设备匿名标识符,详情参见:MSA官网地址
_macAndroid必填String
_ipString客户端IP,IPV4
_ipv6String客户端IP,IPV6
_tzString时区,默认 +8
_ryosString设备系统类型,iOS/Android
_rydevicetypeString设备类型如iphone5s、sansung-GT9300
_ryosversion**投放adwords渠道必填,**其他渠道否String设备系统的版本,例如10.1.2,请务必只传版本号,不要附加其他内容,如version
_app_version投放adwords渠道必填,其他渠道否Stringapp版本例如:1.0.0
_lib_version投放adwords渠道必填,其他渠道否StringSDK版本,默认1.0.0
_timestamp投放adwords渠道必填,其他渠道否long当前13位时间戳
  • 示例代码:

注:jsonObject格式(下列为iOS应用示例,如需报送Android应用请去掉idfa。添加imei、androidid、mac参数)

{"appid":"xxxxxxxxxxxxxxxx","who":"userid001","context":{"_deviceid":"3DEA635F-B24F-434B-833F-4ED028FEAEEF","_transactionid":"t01020304","_paymenttype":"alipay","_currencytype":"CNY","_currencyamount":"6","_idfa":"3DEA635F-B24F-434B-833F-4ED028FEAEEF","_ip":"111.1.11.111","_tz":"+8","_ryos":"ios"}}

服务返回json数据:

{"status":0}