Android 统计 SDK 开发者使用指南 Android 统计 SDK 开发者使用指南腾讯分析出品目录 Android 统计 SDK 开发者使用指南安装和部署... 3 Step 1 获取 AppKey... 3 Step 2 向工程中导入 SDK... 3 Step 3 配

Size: px

Start display at page:

Download "Android 统计 SDK 开发者使用指南 Android 统计 SDK 开发者使用指南腾讯分析出品目录 Android 统计 SDK 开发者使用指南安装和部署... 3 Step 1 获取 AppKey... 3 Step 2 向工程中导入 SDK... 3 Step 3 配"

祖表国
5 years ago
Views:

1 腾讯分析出品目录安装和部署... 3 Step 1 获取 AppKey... 3 Step 2 向工程中导入 SDK... 3 Step 3 配置 AndroidManifest.xml 文件... 4 Step 4 在代码中添加 SDK 的引用基础指标统计页面统计会话统计错误统计自定义事件次数统计 Key-Value 参数的事件次数统计带任意参数的事件时长统计 Key-Value 参数事件时长统计带有统计时长的自定义参数事件接口监控高级功能用户画像... 15

2 5.2 在线配置更新数据上报数据上报策略数据上报相关的设置接口 APP 设置接口注意事项何时调用 StatConfig 配置接口调试 app 发布 app... 19

1 安装和部署欢迎使用腾讯分析 Android 统计 SDK, 您可以按照下面 4 步完成 SDK 的安装和部署 Step 1 获取 AppKey 登陆腾讯分析移动统计前台 :http://mta.oa.

3 1 安装和部署欢迎使用腾讯分析 Android 统计 SDK, 您可以按照下面 4 步完成 SDK 的安装和部署 Step 1 获取 AppKey 登陆腾讯分析移动统计前台 : 按照步骤提示注册应用, 可获得 AppKey Step 2 向工程中导入 SDK 下载统计 SDK 压缩包, 解压至本地目录, 将其中 lib 目录下的 mta_sdk.jar 1 导入到您的应用工程中以 Eclipse 为例, 其它开发工具请参照开发工具自身的用户手册 : 右键点击工程根目录选择 Properties Java Build Path Libraries 点击 Add External JARs 找到本地目彔下的 mta_sdk.jar 文件, 点击打开按钮即导入成功 1 以实际 SDK 的名字为准

4 Step 3 配置 AndroidManifest.xml 文件需要添加下面两类配置 : Meta-Data 类型用途必选 TA_APPKEY String, 不能为纯数字字符串 MTA 提供给每个 app 的 appkey, 用来定位该应用程序的唯一性 InstallChannel String, 若为纯数字字符串不用来标注应用推广渠道, 区分新用户的能超过 int 表示的范围来源来查看统计需要的权限用途必选 INTERNET 允许应用程序联网, 以便向我们的服务器端发送数据 READ_PHONE_STATE 获取用户手机的 IMEI, 用来唯一的标识用户 ( 运行在平板上的应用会读取 mac 地址作为用户的唯一标识 ACCESS_NETWORK_STATE 获取设备的网络状态 ACCESS_WIFI_STATE 获取设备的 WIFI 网络状态示例文件 : <?xml version="1.0" encoding="utf-8"?> <manifest...> <uses-sdk android:minsdkversion="7" android:targetsdkversion="7"/> <uses-permission android:name="android.permission.internet"/> <uses-permission android:name="android.permission.access_network_state"/> <uses-permission android:name="android.permission.access_wifi_state"/> <uses-permission android:name="android.permission.read_phone_state"/> <application...> <activity...>... </activity>...  <meta-data android:name="ta_appkey" android:value="abcdefg "/>  <meta-data android:name="installchannel" android:value="play"/>  </application> </manifest>

5 Step 4 在代码中添加 SDK 的引用 import com.tencent.stat.statconfig import com.tencent.stat.statservice StatConfig 类 :MTA 配置类, 可以设置上报策略 Debug 开关 session 超时时间等, 通常使用 SDK 默认配置即可 ( 注意 :StatConfig 类接口最好在 app 的 main activity 的 oncreate 处初始化 ) StatService 类 :MTA 统计类, 需要开发者按下面的步骤主动调用接口 2 基础指标统计基础指标包括页面统计, 会话统计, 错误统计 3 个部分 2.1 页面统计使用下面的函数统计某个页面的访问情况 : 标记一次页面访问的开始 void StatService.onResume(Context ctx) 参数 :Ctx 调用位置 : 每个 activity 的 protected void onresume() { super.onresume(); StatService.onResume(this); 标记一次页面访问的结束 void StatService.onPause (Context ctx) 参数 :Ctx 调用位置 : 每个 activity 的 protected void onpause() { super.onpause(); StatService.onPause(this);

6 ( 注意 :onresume 和 onpause 需要成对使用才能正常统计 activity, 为了统计准确性, 建议在每个 activity 中都调用以上接口 ) 通过继承的方式统计页面访问开发者可以通过 app 本身的 acivity 基类, 调用 MTA 的 onresume 和 onpause, 并在所有子类中, 重载这 2 个方法, 实现页面统计功能可参考 MtaDemo 中的 BaseActivity 和 DrivedActivity 代码另外,MTA SDK 中的下面两个类实现了 StatService.onResume() 和 StatService.onPause() 的调用, 可直接继承以下类并在子类中重载页面统计接口 com.tencent.stat.easyactivity com.tencent.stat.easylistactivity 继承自 android.app.activity 继承自 android.app.listactivity

7 2.2 会话统计以下 3 种情况下, 会视为用户打开一次新的会话 : 1) 应用第一次启动, 或者应用进程在后台被杀掉之后启动 2) 应用退到后台超过 X 秒钟之后再次回到前台 X 秒通过 StatConfig.setSessionTimoutMillis(int) 函数设置, 默认为 30000ms, 即 30 秒 3) 调用 SDK 提供的 startnewsession() 函数 void StatService.startNewSession(Context ctx) 参数 :Ctx 2.3 错误统计收集应用程序的异常信息可以帮助您完善自己的程序此外,SDK 可以帮助开发者检查 app 未捕获的异常 1) 上报 app 捕获的错误或异常 void StatService.reportError(Context ctx, String errormsg) 参数 :Ctx errmsg 出错信息字符串调用位置 : 需要上报错误信息的地方 void StatService.reportException(Context ctx, Throwable err) 参数 :Ctx err 抛出的异常调用位置 : 需要上报异常信息的地方

8 try{ int retval = totalnumber / personinroom; catch (ArithmeticException e){ StatService.reportException(this, e); 2) 未捕获的异常 SDK 将异常处理类设置到线程上, 作为所有线程出现未捕获异常时的缺省行为因此, 只要集成了 SDK,app 中未捕获到的异常也能上报 ( 注意 : 如果 app 已设置 Thread.setDefaultUncaughtExceptionHandler(), 那么 MTA 会在处理完异常后, 再调用原来的异常处理函数继续处理 ) 可以通过下面的接口关闭自动捕获异常功能 ( 默认为 true) void StatConfig.setAutoExceptionCaught(boolean isautoexceptioncaught) 注意 : 必须在所有 StatService protected void oncreate(bundle savedinstancestate) { super.oncreate(savedinstancestate); // app 的最初始代码处 StatConfig.setAutoExceptionCaught(false); 通过 LogCat 检查有以下警告, 表明已经成功禁用了本功能

9 3 自定义事件可以统计某些用户自定义事件的发生次数, 时间, 变化趋势, 例如广告点击, 短信数量等等, 通常 event_id 用于表示某种行为或功能的统计 ( 如统计点击按钮被触发多少次 ), 而参数则用于标识统计的具体对象 ( 如名称为 OK 的按钮 ), 由 event_id 和参数唯一标识一个事件自定义事件分为 2 大类 : 1 统计次数 : 统计指定行为被触发的次数 2 统计时长 : 统计指定行为消耗的时间, 单位为秒需要 begin 接口与 end 接口成对使用才生效其中每类事件都有 Key-Value 参数类型和不定长字符串参数类型, 由于 Key-Value 参数类型的接口能表达更丰富的内容, 我们推荐优先使用 Key-Value 类参数接口另外, 如果代码同时使用了这 2 种参数类型,event_id 最好不一样注意 :event_id 需要先在腾讯分析网站上面注册, 才能参与正常的数据统计 ( 由于前台自定义事件页面尚在开发中, 若要注册计算事件请 rtx 联系 :foreachli 或 bwarliao) event_id 不能包含空格或转义字符 3.1 次数统计 Key-Value 参数的事件 void StatService.trackCustomEvent(Context ctx, String event_id, Properties properties) 参数 : Ctx event_id 事件标识 properties Key-Value 参数对,key 和 value 都是 String 类型调用位置 : 代码任意处

10 public void onokbtnclick(view v) { // 统计按钮被点击次数, 统计对象 :OK 按钮 Properties prop = new Properties(); prop.setproperty("name", " OK "); StatService.trackCustomEvent(this, " button_click", prop); public void onbackbtnclick(view v) { // 统计按钮被点击次数, 统计对象 :back 按钮 Properties prop = new Properties(); prop.setproperty("name", " back "); StatService.trackCustomEvent(this, " button_click", prop); 3.2 次数统计带任意参数的事件 void StatService.trackCustomEvent(Context ctx, String event_id, String... args) 参数 : Ctx event_id 事件标识 args 事件参数调用位置 : 代码任意处 public void onclick(view v) { // 统计按钮被点击次数, 统计对象 :OK 按钮 StatService.trackCustomEvent(this, "button_click", "OK "); 3.3 时长统计 Key-Value 参数事件可以指定事件的开始和结束时间, 来上报一个带有统计时长的事件 void StatService.trackCustomBeginKVEvent( Context ctx, String event_id, Properties properties) void StatService.trackCustomEndKVEvent( Context ctx, String event_id, Properties properties)

11 参数 : Ctx event_id 事件标识 properties Key-Value 参数对,key 和 value 都是 String 类型调用位置 : 代码任意处 public void onclick(view v) { Properties prop = new Properties(); prop.setproperty("level", "5"); // 统计用户通关所花时长, 关卡等级 : 5 // 用户通关前 StatService.trackCustomBeginKVEvent(this, " playtime", prop); // 用户正在游戏中. //. // 用户通关完成时 StatService.trackCustomEndKVEvent(this, " playtime", prop); 注意 :trackcustombeginkvevent 和 trackcustomendkvevent 必须成对出现, 且参数列表完全相同, 才能正常上报事件 3.4 时长统计带有统计时长的自定义参数事件可以指定事件的开始和结束时间, 来上报一个带有统计时长的事件 void StatService.trackCustomBeginEvent( Context ctx, String event_id, String... args) void StatService.trackCustomEndEvent( Context ctx, String event_id, String... args) 参数 : Ctx event_id 事件标识

12 args 事件参数调用位置 : 代码任意处 public void onclick(view v) { // 统计用户通关所花时长 // 用户通关前 StatService.trackCustomBeginEvent(this, " playtime", "level5"); // 用户正在游戏中. //. // 用户通关完成时 StatService.trackCustomEndEvent(this, " playtime", " level5"); 注意 :trackcustombeginevent 和 trackcustomendkvent 必须成对出现, 且参数列表完全相同, 才能正常上报事件

13 4 接口监控统计应用对某个外部接口 ( 特别是网络类的接口, 如连接登陆下载等 ) 的调用情况当开发者用到某个外部接口, 可调用该函数将一些指标进行上报,MTA 将统计出每个接口的调用情况, 并在接口可用性发生变化时进行告警通知 ; 对于调用量很大的接口, 也可以采样上报, 云监控统计将根据 sampling 参数在展现页面进行数量的还原 void StatService.reportAppMonitorStat ( Context ctx, StatAppMonitor monitor) 参数 : ctx monitor 监控对象, 需要根据接口情况设置接口名称耗时返回值类型返回码请求包大小响应包大小和采样率等信息, 详见 doc/api 目录下的文档调用位置 : 被监控的接口 // 新建监控接口对象 StatAppMonitor monitor = new StatAppMonitor("ping: String ip = " Runtime run = Runtime.getRuntime(); java.lang.process proc = null; try { String str = "ping -c 3 -i 0.2 -W 1 " + ip; long starttime = System.currentTimeMillis(); // 被监控的接口 proc = run.exec(str); proc.waitfor(); long difftime = System.currentTimeMillis() - starttime; // 设置接口耗时 monitor.setmillisecondsconsume(difftime); int retcode = proc.waitfor(); // 设置接口返回码 monitor.setreturncode(retcode); // 设置请求包大小, 若有的话 monitor.setreqsize(1000); // 设置响应包大小, 若有的话 monitor.setrespsize(2000);

14 // 设置抽样率, 若有的话 // monitor.setsampling(0); if (retcode == 0) { logger.debug("ping 连接成功 "); // 标记为成功 monitor.setresulttype(statappmonitor.success_result_type); else { logger.debug("ping 测试失败 "); // 标记为逻辑失败, 可能由网络未连接等原因引起的 // 但对于业务来说不是致命的, 是可容忍的 monitor.setresulttype(statappmonitor.logic_failure_result_type); catch (Exception e) { logger.e(e); // 接口调用出现异常, 致命的, 标识为失败 monitor.setresulttype(statappmonitor.failure_result_type); finally { proc.destroy(); // 上报接口监控 StatService.reportAppMonitorStat(ctx, monitor);

15 5 高级功能 5.1 用户画像用户画像统计需要 app 开发者主动上报 QQ 号码, 若没有上报 QQ 号码, 则无法使用用户画像及 QQ 登录数等特色功能 void StatService.reportQQ(Context ctx, String qq) 参数 :Ctx qq qq 号码调用位置 : 用户登陆成功或其它能获取 qq protected void userlogin() { // 获取 QQ 号码 String qq = getuserqq(); StatService.reportQQ(qq); 5.2 在线配置更新开发者在腾讯分析网站上设置 Key-Value 值之后, 可以调用下面的接口动态获取线上最新的参数值 String StatConfig.getCustomProperty(String key) 返回值 : 对应 key 的 value 值, 若不存在则返回 null String StatConfig.getCustomProperty(String key, String defaultvalue) 返回值 : 对应 key 的 value 值, 若不存在则返回 defaultvalue

16 6 数据上报 6.1 数据上报策略设置数据上报策略, 可以有效节省流量使用以下 3 种方式调整 app 的数据上报策略 : 1) app 启动时指定上报策略 ( 默认为 APP_LAUNCH) void StatConfig.setStatSendStrategy(StatReportStrategy statsendstrategy) 腾讯分析目前支持的上报策略包括 6 种, 默认采用 APP_LAUNCH: 编号策略名称说明 1 INSTANT 实时发送,app 每产生一条消息都会发送到服务器 2 ONLY_WIFI 只在 wifi 状态下发送, 非 wifi 情况缓存到本地 3 BATCH 批量发送, 默认当消息数量达到 30 条时发送一次 4 APP_LAUNCH 只在启动时发送, 本次产生的所有数据在下次启动时发送 5 DEVELOPER 开发者模式, 只在 app 调用 void commitevents(context) 时发送, 否则缓存消息到本地 6 PERIOD 间隔一段时间发送, 每隔一段时间一次性发送到服务器 2) 考虑到 wifi 上报数据的代价比较小, 为了更及时获得用户数据,SDK 默认在 WIFI 网络下实时发送数据可以调用下面的接口禁用此功能 ( 在 wifi 条件下仍使用原定策略 ) void StatConfig.setEnableSmartReporting (boolean isenable) 3) 通过在 Web 界面配置, 开发者可以在线更新上报策略, 替换 app 内原有的策略, 替换后的策略立即生效并存储在本地,app 后续启动时会自动加载该策略上面 3 种方式的优先级顺序 :wifi 条件下智能实时发送 >web 在线配置 > 本地默认 6.2 数据上报相关的设置接口 1) 设置最大缓存未发送消息个数 ( 默认 1024)

17 void StatConfig.setMaxStoreEventCount(int maxstoreeventcount) 缓存消息的数量超过阈值时, 最早的消息会被丢弃 2) ( 仅在发送策略为 BATCH 时有效 ) 设置最大批量发送消息个数 ( 默认 30) void StatConfig.setMaxBatchReportCount(int maxbatchreportcount) 3) ( 仅在发送策略为 PERIOD 时有效 ) 设置间隔时间 ( 默认为 24*60, 即 1 天 ) void StatConfig.setSendPeriodMinutes(int minutes) 4) 开启 SDK LogCat 开关 ( 默认 false) void StatConfig.setDebugEnable(boolean debugenable) ( 注意 : 在发布产品时, 请将此开关设为 false)

18 7 APP 设置接口使用这些函数可以动态调整 APP 和 SDK 的相关设置 1) 会话时长 ( 默认 30s,30s 会到应用的用户视为同一次会话 ) void StatConfig.setSessionTimoutMillis(int sessiontimoutmillis) 2) 消息失败重发次数 ( 默认 3) void StatConfig.setMaxSendRetryCount(int maxsendretrycount) 3) 用户自定义时间类型事件的最大并行数量 ( 默认 1024) void StatConfig.setMaxParallelTimmingEvents(int max) 4) 设置安装渠道 void StatConfig.setInstallChannel(String installchannel) 5) 设置 app key void StatConfig.setAppKey(String appkey) 6) 设置统计功能开关 ( 默认为 true) void StatConfig.setEnableStatService(boolean enablestatservice) 如果为 false, 则关闭统计功能, 不会缓存或上报任何信息 7) 设置 session 内发送消息限制 ( 默认为 0, 即无限制 ) void StatConfig.setMaxSessionStatReportCount(int maxsessionstatreportcount) 如果为 0, 则不限制 session 内发送消息的个数 ; 若大于 0, 每个 session 内发送的消息不会超过此值, 若超过了, 新产生的消息将会被丢弃

19 8 注意事项开发者使用 SDK 过程中, 需要注意的事项 8.1 何时调用 StatConfig 配置接口为了使 StatConfig 配置及时生效, 请在 app 初始化时 ( 例如 mainactivity.oncreate 函数 ) 调用 StatConfig 提供的接口, 保证 StatConfig 接口在 StatService 接口前被调用 8.2 调试 app 开发者在开发 app, 调试的过程中, 需要注意的事项 1 SDK Debug 开关如果需要查看 SDK 日志及上报数据内容, 请设置 StatConfig.setDebugEnable(true) 为开启状态, 但发布时, 请保持关闭状态 2 App 异常处理 SDK 默认开启捕获 app 未处理的异常并在 LogCat 打印异常信息, 如果开发者在调试的时候, 不希望 SDK 对 app 未处理的异常进行捕获, 请将 StatConfig.setAutoExceptionCaught(false) 设置为禁用状态, 发布版本时, 再根据情况决定是否开启 8.3 发布 app 开发者在完成 app 开发, 准备发布的过程中, 需要注意的事项 1 SDK Debug 开关请保持 SDK 的 debug 开关为关闭状态, 即调用 StatConfig.setDebugEnable(false) 2 App 异常处理如果 app 上线时, 需要收集 app 未处理的异常, 请保持 StatConfig.setAutoExceptionCaught(true) 为开启状态

20 3 渠道设置请根据不同的发布渠道, 在 AndroidManifest.xml 配置或代码中调用 StatConfig.setInstallChannel() 接口设置对应的渠道名称 4 Appkey 及权限请检查 appkey 设置是否正确, 且 AndroidManifest.xml 添加 SDK 所需权限

1. 概述通过集成讯飞开放统计 SDK 可以跟踪移动应用的用户属性及操作行为, 您可以登入讯飞开放平台进入我的语音云 - 我的应用, 开通应用的开放统计服务, 即可查看下载到数据处理的结果阅读如下文档, 您可以在几分钟之内轻松完成集成过程 2. 集成说明 2.

1. 概述通过集成讯飞开放统计 SDK 可以跟踪移动应用的用户属性及操作行为, 您可以登入讯飞开放平台进入我的语音云 - 我的应用, 开通应用的开放统计服务, 即可查看下载到数据处理的结果阅读如下文档, 您可以在几分钟之内轻松完成集成过程 2. 集成说明 2. 科大讯飞股份有限公司 iflytek CO.,LTD 科大讯飞统计分析 SDK 集成指南 1 1. 概述通过集成讯飞开放统计 SDK 可以跟踪移动应用的用户属性及操作行为, 您可以登入讯飞开放平台 www.xfyun.cn, 进入我的语音云 - 我的应用, 开通应用的开放统计服务, 即可查看下载到数据处理的结果阅读如下文档, 您可以在几分钟之内轻松完成集成过程 2. 集成说明 2.1 申请

Android 统计 SDK 开发者使用指南 Android 统计 SDK 开发者使用指南 腾讯分析出品 目录 Android 统计 SDK 开发者使用指南 安装和部署... 3 Step 1 获取 AppKey... 3 Step 2 向工程中导入 SDK... 3 Step 3 配

Android 统计 SDK 开发者使用指南 Android 统计 SDK 开发者使用指南腾讯分析出品目录 Android 统计 SDK 开发者使用指南安装和部署... 3 Step 1 获取 AppKey... 3 Step 2 向工程中导入 SDK... 3 Step 3 配