全面监控广告投放效果,优化精准化投放策略,让你的每一分钟都有据可循,通过SDK提取的设备ID等信息绝对不涉及任何用户隐私,做到安全、稳定的监控和追踪。

渠道追踪 Android SDK 集成说明

1 概要

1.1 文档目的

本文档的目的是讲解海度渠道追踪 Android SDK (以下统称追踪 SDK)的使用规则,方便开发者的集成使用。

1.2 适用范围

本文档适用于追踪 SDK 的使用者。 追踪 SDK 适用于 Android2.1(API Level 7) 及以上设备。

2 集成准备

2.1 获取 Appkey

登录移动统计系统,到管理后台中注册应用并填写应用相关信息获取 AppKey,用于唯一标识。

2.2 下载 SDK

下载追踪 SDK 包

2.3 导入 SDK

将下载追踪 SDK 包(hdadtracking-xxx.jar)合并到本地工程 libs 子目录下;在 Eclipse 中右键工程根目录,选择 Properties -> Java Build Path -> Libraries,然后点击 Add External JARs... 选择指向 jar 的路径,点击 OK,即导入成功。

3.基本功能集成

3.1 配置 ANDROIDMANIFEST.XML 文件

3.1.1 配置权限

需要的权限 | 用途 :---|:--- INTERNET | 用于程序联网和发送统计数据的权限。 READ_PHONE_STATE | 用于获取手机设备的信息。 ACCESS_WIFI_STATE | 用于获取设备的mac地址。 WRITE_EXTERNAL_STORAGE | 用于保存数据,日志。 ACCESS_NETWORK_STATE | 用于检测网络连接状态。

** AndroidManifest.xml 文件详细如下:**

<!--?xml version="1.0" encoding="utf-8"?-->
<manifest...>
    <uses-permission android:name="android.permission.READ_PHONE_STATE"></uses-permission>
    <uses-permission android:name="android.permission.ACCESS_WIFI_STATE"></uses-permission>
    <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE"></uses-permission>
    <uses-permission android:name="android.permission.INTERNET"></uses-permission>
    <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE"></uses-permission>
    <application ...=""></application>
</manifest...>

3.2 添加代码

使用渠道追踪需要至少添加以下调用方法,才能保证统计正确的激活量。

3.2.1 初始化 SDK(必须)

在 Android 应用全局 Application 的 onCreate() 中初始化 SDK。调用 HdAdTracking.instance().init(...) 方法,初始化 SDK。 这一步必须调用,不然 SDK 无法正常工作。

API:

void com.yy.hdadtracking.api.HdAdTracking.init(Context context, String appkey, String from, String ver);
// 初始化,在应用全局的 Application 或第一个 Activity 入口的 oncreate 中调用
// Parameters:
//      context 应用全局上下文 (必填)
//      appkey 应用标识 (必填)
//      from 渠道 (必填)
//      ver 应用版本 (可选)

例子:

// appkey 必须与后台申请的 appkey 保持一致,必选
String appKey = "your appkey";
// from 为发布的渠道,必选
String from = "your from";
// 应用的版本号,可选
String ver = "1.0.0";
HdAdTracking.instance().init(this, appKey, from, ver);

注意: 版本号如果不设置,SDK 将自动获取 versionName。

3.2.2 日活留存跟踪(可选)

如果你跟踪激活设备后续的留存,你可以在 Android 应用的每个 Activity 的 onResume(),onPause() 中分别调用 HdAdTracking.instance().onResume(),HdAdTracking.instance().onPause()

API:

void com.yy.hdadtracking.api.HdAdTracking.onResume(Context context);
// 在应用的每个 activity 的 onResume 中调用
// Parameters:
//      context

void com.yy.hdadtracking.api.HdAdTracking.onPause(Context context);
// 在应用的每个 activity 的 onPause 中调用
// Parameters:
//      context

例子:

4 更多效果追踪功能

4.1 用户注册

用户注册成功时,调用上报。

API:

void com.yy.hdadtracking.api.HdAdTracking.onRegister(String account);
// 用户注册成功时,调用上报
// Parameters:
//      account 帐号

例子:

//成功创建了 strong 角色
HdAdTracking.instance().onRegister("strong");

4.2 用户登录

用户登录成功时,调用上报。

API:

void com.yy.hdadtracking.api.HdAdTracking.onLogin(String account);
// 用户登录成功时,调用上报
// Parameters:
//      account 帐号

例子:

// 用户 strong 登录成功
HdAdTracking.instance().onLogin("strong");

4.3 用户退出

用户退出成功时,调用上报。

API:

void com.yy.hdadtracking.api.HdAdTracking.onLogout();
// 用户退出成功时,调用上报

例子:

// 用户退出了登录
HdAdTracking.instance().onLogout();

4.4 下订单

用户下订单成功时,调用上报。

API:

void com.yy.hdadtracking.api.HdAdTracking.onOrder(String orderId, double amount, String cType);
// 下订单
// Parameters:
//      orderId 订单号
//      amount 订单总额
//      cType 订单的货币类型,请使用国际标准组织 ISO 4217 中规范的 3 位字母代码标记货币类型。例:人民币 CNY,港元 HKD;

例子:

// 例如订单号为 o123456,金额为人民币 10 元
HdAdTracking.instance().onOrder("o123456","10","CNY");

4.5 订单支付成功

订单支付成功时,调用上报。

API:

void com.yy.hdadtracking.api.HdAdTracking.onOrderPay(String orderId, double amount, String cType, String pType);
// 订单支付成功
// Parameters:
//      orderId 订单号
//      amount 订单总额
//      cType 订单的货币类型
//      pType 订单的支付形式,如 appstore,alipay 等

例子:

//例如订单号为 o123456,金额为人民币 10 元的订单,利用了支付宝支付成功
HdAdTracking.instance().onOrderPay("o123456","10","CNY","alipay");

4.6 创建角色

游戏创建角色成功时,调用上报。

API:

void com.yy.hdadtracking.api.HdAdTracking.onCreateRole(String role);
// 创建角色时调用上报
// Parameters:
//      role 角色名称

例子:

//游戏中创建了 king 角色
HdAdTracking.instance().onCreateRole("king");

5 其他

5.1 日志开关配置

SDK 日志输出默认是关闭,在集成过程中,开发者可以在初始化时,打开日志开关,方便集成提示。

例子:

//打开日志模式
HdAdTracking.instance().setLogOn(true);  

5.2 集成检查

  1. 检查 appkey,是否正确。
  2. 检查是否有调用 SDK 的 init 方法初始化。
  3. 检查是否有在 AndroidManifest.xml 配置相关权限。
  4. 检查 logcat 日志输出,看到 “hdadtracking init finish” 相关信息,并且可以看到 appkey,渠道,版本相关信息,说明 SDK 集成成功。

5.3 测试流程

  1. 在网站上创建产品,获取 appkey。
  2. 下载 SDK 并集成。
  3. 创建推广活动,获取活动推广地址(短链)。
  4. 在浏览手机上打开短链,下载 app。
  5. 安装完 app,打开 app。
  6. 几分钟后,你会看到网站上显示点击数为1,激活数为1。