Android_SDK_接入说明文档

一、说明

1.适用范围

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

本文档适用于Android 2.3（API Level 9）及以上的操作系统。

2.统计说明

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

  • 设备

指某台安装了Android应用的终端，例如SAMSUNG Galaxy Note 8、HTC U11、SAMSUNG Galaxy S8等。

  • 账号

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

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

二、接入流程

1.申请APPKEY

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

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

如果您已经完成产品创建，请在如下位置获取APPKEY：“全部产品按钮”-“对应产品”-APPKEY

3)APPKEY为应用的唯一标识，用于集成到SDK中。

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

2.导入SDK

1)前往http://doc.trackingio.com/sdkwen-dang.html下载SDK压缩包，解压至本地目录。

2)将目录中tracking1.0.x.jar导入到您的工程目录下的libs文件夹中。

导入方法：在工程目录结构中，右键选择Properties->Java Build Path，点击右侧Libraries选项卡，点击Add JARs按钮在Project/libs目录选择tracking1.0.x.jar，点击OK导入。

3.接入SDK

详见“三、接入方法说明”

4.测试

1)在开发环境中进行Debug测试，日志TAG为Tracking：

ReYunConst.DebugMode=true;

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

2)进入热云调试页面查看调试数据：

“全部产品按钮” - “待调试产品”–“调试”

三、接入方法说明

1.在AndroidManifest.xml文件中添加如下权限

//网络访问权限

<uses-permissionandroid:name="android.permission.INTERNET"/>

//获取网络状态权限
<uses-permissionandroid:name="android.permission.ACCESS_NETWORK_STATE"/>

//获取wifi状态权限
<uses-permissionandroid:name="android.permission.ACCESS_WIFI_STATE"/>

//读取手机IMEI的权限，须在获得此权限后再初始化sdk，如果缺少此权限，会以AndroidID作为设备唯一标识符
<uses-permissionandroid:name="android.permission.READ_PHONE_STATE"/>

//获取gps的权限
<uses-permissionandroid:name="android.permission.ACCESS_FINE_LOCATION"/>
<uses-permissionandroid:name="android.permission.ACCESS_COARSE_LOCATION"/>

//读写sd卡的权限
<uses-permissionandroid:name="android.permission.WRITE_EXTERNAL_STORAGE"/>
<uses-permissionandroid:name="android.permission.READ_EXTERNAL_STORAGE"/>

注：Android系统版本6.0以上，必须先获取权限，再调用初始化接口。反之，会影响激活数据精准度。

2.初始化热云SDK

  • 方法用途：

用于应用启动后，初始化热云SDK。报送应用安装或启动事件。

  • 使用方法：

调用Tracking.initWithKeyAndChannelId方法进行初始化。

  • 方法接口：
Tracking.initWithKeyAndChannelId(Context appContext,String appKey,String channelId);
  • 参数说明：
参数 类型 是否必填 长度 说明
appContext Context 是 全局应用上下文
appKey String 是 创建产品时获得的32位字符长度的APPKEY
channelId String 是 最长64位 用于标识推广渠道，支持英文、数字、下划线，默认填写_default_；分包（应用市场）模式，该值必须与热云后台“配置”-“推广活动管理”-新建推广活动（分包）填写的渠道ID一一对应。
  • 示例代码：
Tracking.initWithKeyAndChannelId(getApplicationContext(),"8283e21a7484c03edee3d61cc12e93ss","_default_");

3.统计用户注册数据

  • 方法用途：

用于用户注册完成，报送应用注册事件。

  • 使用方法：

在用户注册完成时调用Tracking.setRegisterWithAccountID方法。

如果开发者没有自己的用户系统，希望使用用户设备ID作为accountId，直接调用Tracking.getDeviceId()方法即可。

  • 方法接口：
Tracking.setRegisterWithAccountID(String accountId);
  • 参数说明：
参数 类型 是否必填 长度 说明
accountId String 是 最长64位 账号唯一标识，仅支持英文、数字、下划线
  • 示例代码：
Tracking.setRegisterWithAccountID(“123456”);

4.统计用户登录数据

  • 方法用途：

用于用户登录完成、切换账号时，报送应用登录事件。

  • 使用方法：

调用Tracking.setLoginSuccessBusiness方法。

  • 方法接口：
Tracking.setLoginSuccessBusiness(String accountId);
  • 参数说明：
参数 类型 是否必填 长度 说明
accountId String 是 最长64位 账号唯一标识，仅支持英文、数字、下划线
  • 示例代码：
Tracking.setLoginSuccessBusiness(“123456”);

5.统计用户充值成功数据（建议使用服务器REST报送）

  • 方法用途：

用于用户充值成功，统计充值数据，所有付费相关分析的数据报表均依赖此方法。

注：前端报送支付有掉单风险，收入数据会出现误差，为确保支付数据准确，建议使用服务器报送支付（请参考“REST”文档）。

  • 使用方法：

用户充值成功且后端发货成功后调用Tracking.setPayment方法。

  • 方法接口：
Tracking.setPayment(String transactionId,String paymentType,String  currencyType,float currencyAmount);
  • 参数说明：
参数 类型 是否必填 长度 说明
transactionId String 是 最长64位 付费数据按此参数排重，交易流水号，请务必确保唯一。
paymentType String 是 最长16位 支付类型，例如支付宝(alipay)，银联(unionpay)，微信支付（weixinpay）,易宝支付（yeepay），paymentType不能填写：FREE（FREE不统计付费）
currencyType String 是 最长3位 货币类型，按照国际标准组织ISO 4217中规范的3位字母，例如CNY人民币、USD美金等
currencyAmount float 是 最长16位 支付的真实货币金额，人民币单位：元
  • 示例代码：
Tracking.setPayment(“0062001242”,“alipay”,“CNY”,1000.00f);

6.统计用户自定义事件

  • 方法用途：

用于统计用户在应用内的任意行为，如打开某个面板、点击某个Button、参与某个活动等。

eventName必须为event_1到event_12。

  • 使用方法：

在自定义用户行为的地方，调用Tracking.setEvent方法。

  • 方法接口：
setEvent(final String eventName);
  • 参数说明：
参数 类型 是否必填 长度 说明
eventName String 是 最长32位 自定义事件名称，必须为event_1到event_12
  • 示例代码：
Tracking.setEvent(“event_1”);

7.上报订单事件

  • 方法用途：

上报订单事件。

  • 使用方法：

当订单产生成功时调用此方法进行事件上报。

  • 方法接口：
Tracking.setOrder(String transactionId, String currencyType, float currencyAmount);
  • 参数说明：
参数 类型 是否必填 长度 说明
transactionId String 是 最长64位 交易流水号，请确保唯一。
currencyType String 是 最长3位 货币类型，按照国际标准组织ISO 4217中规范的3位字母，例如CNY人民币、USD美金等
currencyAmount float 是 最长16位 支付的真实货币金额，人民币单位：元
  • 示例代码：
Tracking.setOrder(“f93182bc6”, “CNY”, 9.04f);

8.退出SDK

  • 方法用途：

应用退出时释放sdk占用资源。

  • 使用方法：

用于程序退出时调用Tracking.exitSdk方法。

  • 方法接口：
Tracking.exitSdk();
  • 示例代码：
Tracking.exitSdk();

四、技术支持

如有任何问题，请及时联系我们的技术支持工程师：

results matching ""

    No results matching ""