百度移动统计SDK

一、简介

百度移动统计SDK(Android)是百度官方推出的移动统计SDK在Android平台上的版本(以下简称SDK)。SDK的发行版本(完整下载包为android.zip)中包括JAR包、文档、示例以及您正在阅读的用户手册。 以下使用代表android.zip解压后的根目录。

JAR包：/android_api.jar，开发过程中导入Android项目；

文档：/android_doc，提供开发帮助信息；

示例：/android_demo，统计示例程序代码，帮助您迅速熟悉SDK的使用方式；

用户手册：本文档。

二、阅读对象

本文档面向所有使用该SDK的开发人员、测试人员、合作伙伴以及对此感兴趣的其他用户。

三、运行环境

可运行于Android 1.5(API Level 3)及以上版本。

四、开发指南

(注：以下提及的各个文件均可在/android_demo中找到。)

1.申请应用AppKey

AppKey(BaiduMobAd_STAT_ID)在百度移动统计申请，用于标识您的应用程序。

2.申请自定义事件

为确保您在后续代码中添加的自定义事件能够出现在我们的统计结果中，请在百度移动统计平台申请自定义事件。

3.导入JAR包

将SDK中的JAR包导入您创建的Android项目，以下假设您已经创建了项目A。

右键点击你的工程，然后选择“Properties”；

在工程属性对话框左边选择“Java Build Path”；

在工程属性对话框主窗口选择“Libraries”；

点击“Add JARs”，添加/android_api.jar。

注：示例(/android_demo)中已经引入了该jar，位于/android_demo/lib/Baidu_Mobstat_Android_SDK.jar；如果您安装的ADT版本大于16，请重命名lib为libs，并重新引入jar。

4.文档使用

若是在eclipse或其他IDE下开发，可设置JAR包的Javadoc路径为/doc，便于在IDE中获得即时的开发帮助信息；

也可以直接在浏览器中打开/doc/index.html查看该文档。

5.配置AndroidManifest.xml

android:versionCode="1" android:versionName="1.0">

图1 AndroidManifest.xml

具体的信息参见图1。

注释中标示了需要配置的信息：

申明App版本信息，有助于为App进行版本统计(android:versionCode和android:versionName)

添加必要的权限

必须权限：您必须申明的权限

可选权限：您可根据实际需求设置

meta-data：

BaiduMobAd_STAT_ID需要在百度移动统计申请，是标识应用的唯一信息，如此处为“abcd1234”；

BaiduMobAd_CHANNEL为应用程序的分发渠道，如此处为"Baidu Market"，请根据需要替换。

BaiduMobAd_EXCEPTION_LOG 为是否开启错误日志统计，默认为false。设置为true时，其作用等同于调用接口StatService.setOn(StatService. EXCEPTION_LOG)。推荐使用此配置来替代setOn接口。

BaiduMobAd_SEND_STRATEGY 为日志发送策略，可选值：APP_START、 ONCE_A_DAY、 SET_TIME_INTERVAL，默认为APP_START。此flag以及下面两个flag的作用等同于调用StatService. setSendLogStrategy接口，推荐使用此配置。

BaiduMobAd_TIME_INTERVAL 当日志发送策略为SET_TIME_INTERVAL时，需设定时间间隔。取值为1-24的整数，默认为1。

BaiduMobAd_ONLY_WIFI 为日志仅在wifi网络下发送的flag，默认为false。

五、功能和接口

百度移动统计提供了基本统计、渠道统计、版本统计、错误统计、自定义事件统计的功能，需要开发者显示调用的接口有以下几条：

1.基本统计接口

SDK提供两种调用基本统计接口的方法：

1.嵌入API的方式，开发者需要在每个Activity的onResume()和onPause()中调用SDK提供的StatService.onResume(Context context)和StatService.onPause (Context context)；

2.第二种方法是直接继承SDK提供的StatActivity类。StatActivity封装了StatService.onResume(context)和StatService.onPause(context)方法，方便开发者统计页面信息。

下面主要介绍第一种方式的2个API：

void onResume(Context context)

1.嵌入位置：每个Activity的onResume()回调方法内。

2.功能：基本统计，统计一次页面访问的开始。

3.参数：Context页面的设备上下文。

void onPause (Context context)

1.嵌入位置：每个Activity的onPause()回调方法内。

2.功能：基本统计，统计一次页面访问的结束。

3.参数：Context页面的设备上下文。

2.开关型功能接口—出错分析

void setOn(Context context， int flag)

1.嵌入位置：启动Activity的OnCreate()回调方法内。

2.功能：开关类型的API，功能是否被启用，通过参数flag控制。目前，提供了错误分析的功能，后续版本的SDK会支持更多的功能。

3.参数：

a)context：启动页面的设备上下文

b)flag：二进制表示的每一位表示一个功能开关，通过或运算实现开启多个功能，现在flag可选的参数有：StatService.EXCEPTION_LOG 出错分析开关位

3.自定义事件接口(1)

注：自定义事件需要在百度移动统计的设置中的自定义事件管理中添加对应的事件ID。

void onEvent(Context context, String event_id, String label)

1.嵌入位置：任何地方。

2.功能：统计开发者的自定义事件，自增计数。

3.参数：context设备上下文

event_id业务端注册的事件id

label事件添加的标签

4.自定义事件接口(2)

void onEvent(Context context, String event_id, String label, int acc)

1.嵌入位置：任何地方。

2.功能：统计开发者的自定义事件。

3.参数：context设备上下文

event_id业务端注册的事件id

label事件添加的标签

aac事件的发生次数

5.日志发送策略接口(1)

void setSendLogStrategy(Context context,SendStrategyEnum sst,int rtime_interval,boolean only_wifi)

1.嵌入位置: 最好在Activity.onCreate函数中。

2. 功能：设置日志发送策略。

3. 参数：

context调用页面的设备上下。

sst为枚举类型SendStrategyEnum。可取值

SendStrategyEnum.APP_START(启动时发送)，

SendStrategyEnum.ONCE_A_DAY (每日发送)

SendStrategyEnum.SET_TIME_INTERVAL(设定发送时间)

rtime_interval 当参数sst为SET_TIME_INTERVAL时，此值有效。为1-24之间的整数,即1<=rtime_interval<=24

only_wifi若为true，则仅在wifi网络下发送;默认为false;

6.日志发送策略接口(2)

void setSendLogStrategy(Context context,SendStrategyEnum sst,int rtime_interval)

1.嵌入位置: 最好在Activity.onCreate函数中。

2. 功能：设置日志发送策略。

3. 参数：

context调用页面的设备上下文

sst为枚举类型SendStrategyEnum。可取值

SendStrategyEnum.APP_START(启动时发送)，

SendStrategyEnum.ONCE_A_DAY (每日发送)

SendStrategyEnum.SET_TIME_INTERVAL(设定发送时间)

rtime_interval 当参数sst为SET_TIME_INTERVAL时，此值有效。为1-24之间的整数,即1<=rtime_interval<=24

六、示例

Demo工程已经嵌入了SDK提供的所有功能接口，开发者只需将APPSID更换成自己申请的ID，然后运行，在网络畅通的情况下，统计数据就会被发送到业务端(http://mtj.baidu.com) ，开发者可以查看相应报表。

七、联系我们

感谢您的阅读,如果有问题请email我们。

邮箱: apptongji@baidu.com