Android SDK 接入文档

Android SDK 接入文档

个数是个推旗下基于大数据的应用统计产品,从用户属性、使用行为、行业对比等多指标多维度进行全面的移动应用统计分析,帮助 APP 运营者深层次挖掘用户需求,准确了解自身行业地位,从而更好地指导产品运营。

1. 获取应用 Appid

1、登录 个推开发者中心 ,进入个数应用统计

gs1

2、创建个数应用,并获取 AppId

gs1

2. 资源包导入方式

添加 maven 库地址

在以项目名为命名的顶层 build.gradle 文件中,添加个推 maven 库地址,如下所示:

gs1

// Maven URL 地址
maven{
    url 'http://mvn.gt.getui.com/nexus/content/repositories/releases'
}

配置依赖

app/build.gradle 文件中引用个数 SDK 依赖库,如下图所示:

gs2

dependencies{
     compile 'com.getui:gssdk:2.4.0.0'
}

3. SDK 配置

注意:为兼容Android9.0,务必在 application 节点添加 android:usesCleartextTraffic="true"

配置混淆

代码混淆配置

在混淆文件中加入如下配置即可:

-dontwarn com.getui.**
-keep class com.getui.**{*;}

资源文件混淆配置

如果您的工程使用了AndResGuard进行资源精简,为了避免个数SDK所需资源被错误精简导致功能异常,需要为个数添加白名单配置。

gradle集成AndResGuard的方式,需要您在andResGuardwhiteList节点下添加如下代码:

andResGuard {
    ...
    whiteList = [
           ...
           // for geshu
           "R.layout.geshu_*"
           "R.id.geshu_*"
    ]
    ...
}

命令行使用AndResGuard的方式,需要您在config.xml文件中的<issue id=whitelist>节点下添加如下代码

<issue id="whitelist" isactive="true">
    <path value="<your_package_name>.R.layout.geshu_*"/>
    <path value="<your_package_name>.R.id.geshu_*"/>
</issue>

配置个数应用参数

app/build.gradle 文件中的 android.defaultConfig 下添加 manifestPlaceholders ,配置个数相关的应用参数,如下所示:

defaultConfig {
    applicationId "你的应用包名"
     ....

    manifestPlaceholders = [
                  //从 2.4.1.0 版本开始,APPID 占位符从 GS_APPID 切换为 GETUI_APPID 
                  //后续所有产品的 APPID 均统一配置为 GETUI_APPID 占位符
            GETUI_APPID       : "APP_ID",

                  //渠道若为纯数字则不能超过 int 表示的范围。 
            GT_INSTALL_CHANNEL      : "APP_CHANNEL"
    ]
}

APP_ID 为步骤1中从官方网站获取到的值,APP_CHANNEL 为将要发布的渠道。(渠道若为纯数字字符串不能超过int表示的范围)

APP_CHANNEL 也能够通过 Gsconfig 类的 setInstallChannel 方法设置。

注意: 对于同时集成个推多个产品SDK,且SDK之间的APPID值不一致的用户,可以任选一个SDK的APPID配置到GETUI_APPID占位符中,其余SDK在AndroidManifest文件中务必添加对应的标签来补充APPID,参考以下配置:

<application>

  ....
  <!-- 补充个推SDK的appid -->
  <meta-data
        android:name="PUSH_APPID"
    android:value="个推SDK的appid" />

  <!-- 补充个验SDK的appid -->
  <meta-data
        android:name="GY_APP_ID"
    android:value="个验SDK的appid" />

  <!-- 补充个数SDK的appid -->
  <meta-data
        android:name="GS_APPID"
    android:value="个数SDK的appid" />

  <!-- 补充个像SDK的appid -->
  <meta-data
        android:name="GI_APPID"
    android:value="个像SDK的appid" />

  ....
</application> 


4. SDK 初始化

在您应用的启动入口(Application的onCreate中)调用SDK的初始化代码:

void GsManager.getInstance().init(Context context);

参数:

context 设备上下文

5. 设置开发者模式

默认开关是关闭的,可以通过以下代码开启开发者模式:

void GsConfig.setDebugEnable(boolean enable);

该模式下,数据会实时上传,且将输出 SDK 相关日志。

注意: 上线时请关闭开关或者注释该行代码。

6. 应用时长统计

应用时长统计用于统计启动次数和应用的真实活跃时长,集成 SDK 后不需要开发者调用额外的接口。

其中 Android 平台一次完整的启动包括如下两种情况:

1.从启动应用到关闭应用

2.从启动应用到应用退至后台,且在后台运行时间超过 30s 。也可以修改该默认值:

void GsConfig.setSessionTimoutMillis(long time);

注意:GsConfig 配置类需要在 SDK 初始化之前配置。

7. 集成验证

  1. 通过开发者模式下的日志验证是否集成成功。

开启开发者模式:

void GsConfig.setDebugEnable(boolean enable);

重启应用,会在 logcat 输出

gssdk init success,sdk verison is xxx appid is xxx
  1. 在平台查看实时数据验证是否集成成功。

SDK 集成完成后,在 gradlemanifestPlaceholders 配置对应的 appid,在 web 端打开 appid 对应的个数服务平台。重启应用,稍等几秒可以看到启动次数刷新。

文档中心搜索