Android用户运营SDK集成

重点提示

1.4.2.0版本更新注意：

需要集成com.getui:gtc:3.2.9.0及以上版本。

参数配置

配置Maven仓库

在项目根目录 build.gradle 文件的 allprojects.repositories 块中，添加maven 库地址 maven { url "https://mvn.getui.com/nexus/content/repositories/releases/"}，如下所示：

buildscript {
    repositories {
        mavenCentral()
        google()
    }
    dependencies {
        ......
    }
}

allprojects {
    repositories {
        mavenCentral()
        google()
        maven {
            url "https://mvn.getui.com/nexus/content/repositories/releases/"
        }
    }
}

配置依赖及参数

• 在 app/build.gradle 文件的 dependencies 块中添加SDK依赖。

dependencies {
      //用户运营sdk
    implementation 'com.getui:gsido:1.4.8.0'
      //个推核心组件
      implementation 'com.getui:gtc:3.2.17.0' 
}

• 在app/build.gradle 文件中的android.defaultConfig 下添加 manifestPlaceholders，配置相关的应用参数。

android {
    defaultConfig {
        manifestPlaceholders = [
              //开发者中心--应用管理--应用信息 中的appId
              GETUI_APPID : "${appId}", 
              //应用发布的渠道(如华为应用市场、小米应用市场、应用宝)
              //若为纯数字字符串，则不能超过int表示的范围
              GT_INSTALL_CHANNEL: "${installChannel}"
        ]        
    }
  ......
}

权限申明

为了生成用户画像，例如地理位置相关的标签和特征，为精细化运营提供必要数据支撑。用户运营服务需要向您申请以下权限：

    <!--    网络权限    -->
    <uses-permission android:name="android.permission.INTERNET"/>
    <!--    sd卡读取权限    -->
    <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE"/>
    <!--    获取设备标识    -->
    <uses-permission android:name="android.permission.READ_PHONE_STATE"/>
    <!--    获取wifi状态    -->
    <uses-permission android:name="android.permission.ACCESS_WIFI_STATE"/>
    <!--    网络状态获取    -->
    <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
    <!--    应用列表获取    -->
    <uses-permission android:name="android.permission.QUERY_ALL_PACKAGES" />
    <!--    地理位置获取    -->
    <uses-permission android:name="android.permission.ACCESS_FINE_LOCATION"/>
    <uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION"/>
    <uses-permission android:name="android.permission.ACCESS_BACKGROUND_LOCATION" />
    <uses-permission android:name="android.permission.ACCESS_LOCATION_EXTRA_COMMANDS" />
    <uses-permission android:name="android.permission.BLUETOOTH"/>
    <uses-permission android:name="android.permission.BLUETOOTH_ADMIN"/>

集成代码

设置开发者模式

默认开关是关闭的，可以通过以下代码开启开发者模式，该模式下会输出 SDK 相关日志。

GsConfig.setDebugEnable(true);

初始化

在您应用的启动入口调用SDK的初始化代码：注意：此时SDK功能尚未启用，gtcid暂未生成

GsManager.getInstance().preInit(context);

注意事项：为了保证 SDK 服务稳定，开发者需在 App《隐私政策》的 “与授权合作伙伴共享”条款中，将 个推的用户隐私政策 加入其中。并确保在 App 首次运行时通过明显方式提示终端用户阅读您的 App《隐私政策》，取得终端用户的合法授权后，再初始化 SDK ，详情可查看：个推合规指南 。

注册gtcid

• 调用注册gtcid代码：GsManager.getInstance().init(Context context) 进行gtcid的注册。
  为了保障用户运营功能可以正常使用，您务必确保用户同意《隐私政策》之后，调用初始化和注册gtcid方法。若不调用注册gtcid方法，用户运营功能无法正常使用。

渠道设置

初始化前调用，接口设置的渠道优先，应用发布的渠道(如华为应用市场、小米应用市场、应用宝)。若为纯数字字符串，则不能超过int表示的范围。

GsConfig.setInstallChannel(channel); 

获取gtcid

调用 init 初始化后，您可通过下面的回调方法获取gtcid，gtcid可用于用户画像标签的查询:

GsManager.getInstance().setGtcIdCallback(new IGtcIdCallback() {
    @Override
    public void onGetGtcId(String gtcId) {
        Log.d(TAG, "onGetGtcId: " + gtcId);
    }
});

应用活跃时长统计

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

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

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

2.从启动应用到应用退至后台，且在后台时间超过 30秒（该值可通过下面的方法修改，单位毫秒）；

GsConfig.setSessionTimeoutMillis(long time);

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

自定义事件

自定义事件可以统计某些用户自定义埋点的发生时间以及次数，例如广告点击、短信数量等。

通常由 event_id 作为一个事件的唯一标识。

自定义事件分为：

1. 统计事件：

• 次数统计事件：统计指定行为被触发的次数。

2. 用户属性事件：统计对应用户的相关信息。

每类事件都支持使用 jsonObject 参数类型，其中 key 必须为字符串类型，value 目前支持类型有 String、 Number 、 Boolean 、 Date 。

注意事项：
1.自定义参数设置后，类型以第一次上报为准。如果类型不一致，则数据会上报失败。如果遇到问题，请联系技术支持。
2.不管是事件的唯一标识event_id还是属性里的key 类型都为字符串类型，且不能出现空格、回车等特殊字符，也不可以$开头（$开头的是SDK的预置属性和预置属性，具体见文末）。

次数统计事件

在事件触发时调用次数统计方法，SDK 会根据事件 ID ，统计该事件的触发次数。

GsManager.getInstance().onEvent(String eventId, JSONObject jsonObject)

参数：

• eventId :自定义事件 Id ，用于标识事件的唯一
• jsonObject : key-value ，自定义属性，用于扩展统计需求

示例代码

public void onClick(View v) {
            // jsonObject 可不传
        try {
            JSONObject jsonObject = new JSONObject();
            jsonObject.put("buttonId", "onclick");
            GsManager.getInstance().onEvent("eventId", jsonObject);
        } catch (JSONException e) {
            e.printStackTrace();
        }
}

用户属性事件

设置⽤户属性，用于记录用户基本固定不变的属性，例如性别、年龄、注册时间、注册地域、注册渠道等。

GsManager.getInstance().setProfile(JSONObject jsonObject)

参数：

• jsonObject : key-value ，自定义用户属性，用于扩展统计需求

示例代码

public void onClick(View v) {
        try {
            JSONObject jsonObject = new JSONObject();
            jsonObject.put("sex","男");
            jsonObject.put("age", 22);
            GsManager.getInstance().setProfile(jsonObject);
        } catch (JSONException e) {
            e.printStackTrace();
        }
}

预置事件说明

预置事件主要应用于系统中所有事件相关功能，如app_start 可在事件分析、用户群等模块选用，进行对应的分析。
预置事件由SDK自动采集填充，开发者不可修改。

预置属性说明

预置属性中包含日常分析常用的一些维度，会由SDK自动采集，系统的看板等功能中会用到这些预置属性用于筛选分析。

统计事件预置属性

统计事件的预置属性由sdk自动采集填充，开发者不可以修改:

用户属性事件预置属性

用户属性事件的预置属性分为两部分。一部分是由SDK自动采集填充的，如下表：

另一部分需由用户手动设置，如下表：