一、说明
1.适用范围
热云TrackingIO作为国内第三方移动广告监测平台,能够更好的帮助广告主更精准的评估每次广告投放效果,以及帮助广告网络做广告系统的投放优化或业务数据的完。本文档仅适用于服务器针对自定义事件的报送。
2.统计说明
为了能够在接入过程中保持概念统一,针对通用概念做如下说明:
- 设备
指某台安装了应用的终端。 - 账号
指用户在某台设备上安装了应用之后,在应用中的唯一标识。
通常用作账号的标识符可以是用户注册应用时的唯一用户名(如邮件地址),也可以是用户注册时自动生成的唯一字符串 - 报送逻辑
用于统计用户在应用内的任意行为,如打开某个面板、点击某个Button、参与某个活动等,请勿批量报送否则将可能造成归因异常。
3.注意事项
1)数据报送地址:https://log.trackingio.com
2)所有请求格式统一使用UTF-8编码,请求方式使用post。
3)所有必填参数,请务必上报,有下划线的参数必须携带下划线。
IOS必填参数,Android不需上报,
Android必填参数,IOS不需上报。
4)_deviceid为基本参数,是用来记录用户设备身份信息(IOS获取idfa,Android获取IMEI、OAID或者AndroidID,但要保证一致)
6)报送的头信息中一定要有Content-Type=application/json参数。
4.数据报送
统计用户自定义事件:/receive/tkio/event
- 参数说明:
参数名 | 是否必填 | 参数类型 | 长度 | 说明 |
---|---|---|---|---|
appid | 是 | String | 32位 | 创建产品时获得的32位字符长度的APPKEY |
who | 是 | String | 最长64位 | 账号唯一标识,支持英文、数字、下 |
what | 是 | String | 最长32位 | 自定义事件名称,必须为event_1到event_30 |
context | 是 | HashMap | 上下文信息 |
上下文信息:
参数名 | 是否必填 | 参数类型 | 长度 | 说明 |
---|---|---|---|---|
_deviceid | 是 | String | 最长128位 | IOS:填写idfa的值,如果idfa为全0,则填写IFV_(idfv的值),例如idfa=000,idfv=123,则deviceid的值为IFV_123。Android填写优先级:imei>oaid>androidid |
_idfa | IOS必填 | String | 广告标识 | |
_imei | Android必填 | String | 手机的唯一识别号码 | |
_androidid | Android必填 | String | ||
_oaid | Android必填 | String | 安卓设备匿名标识符,详情参见:MSA官网地址 | |
_mac | Android必填 | String | ||
_ip | 是 | String | 客户端IP,IPV4 | |
_ipv6 | 是 | String | 客户端IP,IPV6 | |
_tz | 是 | String | 时区,默认 +8 | |
_ryos | 是 | String | 设备系统类型,iOS/Android | |
_isreyundefaultevent | 是 | String | 识别是否自定义事件,默认传 1。 | |
_rydevicetype | 是 | String | 设备类型如iphone5s、sansung-GT9300 | |
_pkgname | 是 | String | com.reyun.tkio | |
_ryosversion | **投放adwords渠道必填,**其他渠道否 | String | 设备系统的版本,例如10.1.2,请务必只传版本号,不要附加其他内容,如version | |
_app_version | 投放adwords渠道必填,其他渠道否 | String | app版本例如:1.0.0 | |
_lib_version | 投放adwords渠道必填,其他渠道否 | String | SDK版本,默认1.0.0 | |
_timestamp | 投放adwords渠道必填,其他渠道否 | long | 当前13位时间戳 | |
param1 | 投放快手渠道关键行为必填,其他渠道否 | String | 根据行为类型回传对应枚举值):1 广告观看/2 通过关卡/3 游戏时长/4 LTV/0 其他 例:param1 =1 | |
param2 | 投放快手渠道关键行为必填,其他渠道否 | String | 根据关键行为定义的次数/数量/等级回传具体数值 例:param2 =15 | |
param3 | 投放穿山甲渠道必传,其他渠道否 | String | 针对穿山甲渠道回传所用到的ltv0 值,同一设备 24 小时内产生的 ltv 累加值。例如:当前广告展示收益 ltv0=5;则事件上报时上传"param3"="5"了解累加值的详情可参考文档: [https://bytedance.feishu.cn/docs/doccnJubvtVfwztRJn98uihfsWh#LM2k80 |
- 示例代码:
注:jsonObject格式(下列为iOS应用示例,如需报送Android应用请去掉idfa。添加imei和androidid参数)
{"appid":"xxxxxxxxxxxxxxxx","who":"userid001","what":"event_1","context":{"_deviceid":"3DEA635F-B24F-434B-833F-4ED028FEAEEF","_idfa":"3DEA635F-B24F-434B-833F-4ED028FEAEEF","_ip":"111.1.11.111","_tz":"+8","param1":"1","_isreyundefaultevent":"1"}}
服务返回json数据:
{"status":0}