用户运营SDK接入文档

对接说明与准备

1. 功能

通过在app内嵌入用户运营SDK进行埋点上报，提供数据统计和分析服务，来实现数据驱动精细化运营。

 

2. 合规要求

SDK 名称 合作方式 个人信息类型与字段 用途和目的
用户运营SDK 提供数据统计和分析服务

【必要信息】

（开发者与禅游合作所需的基础信息）

设备信息：

设备品牌、型号、操作系统版本、分辨率、网络类型、IP地址、设备语言、操作、使用、服务日志等基础信息、设备标识符（如IMEI、IMSI、ICCID）、AndroidID、设备序列号build_serial，具体字段因软硬件版本不同而存在差异）

应用信息：

开发者应用名、应用包名、运行中的进程信息、版本号、应用前后台状态

其他信息:设备时区

 用于提供数据统计和分析服务，来实现数据驱动精细化运营。

 

3. 申请参数

使用SDK前您需要联系运营申请appid

 

快速集成

1. 手动导入SDK

下载链接

http://open.zen-game.com/sdkDownload.html

repositories {
    flatDir {
        dirs 'libs'
    }
}

dependencies {
    implementation fileTree(include: '*.aar', dir: 'libs')
}

 


//方式一
<application
    android:usesCleartextTraffic="true">
</application>

//方式二 先从demo拷贝/src/res/xml/network_security_config.xml
<application
    android:networkSecurityConfig="@xml/network_security_config">
</application>

 

2.  SDK接入

2.1 设置用户唯一标识（可选）

Java
// 设置您自己的账号体系ID或设备ID, 并保证其唯一性 ！
AppLog.setUserUniqueID("YourUserAccountId");

2.2 初始化

Java
//请填写分配的appId 渠道为cp自定义
InitConfig config = new InitConfig(appId, channel);
// 心跳上报 游戏时长统计
config.setEnablePlay(true);
// 设置调试模式
config.setDebug(true);
AppLog.init(context.getApplicationContext(), config);

2.3 敏感api采集关闭

注：默认不采集相关权限 （SDK没有声明相关权限，如READ_PHONE_STATE） app根据需要声明相关权限并请求成功该权限且开关打开，SDK才会采集

//AndroidManifest.xml
<manifest xmlns:android="http://schemas.android.com/apk/res/android">
//添加这行声明
<uses-permission android:name="android.permission.READ_PHONE_STATE" />
</manifest>


Java
// 开关关闭后相关代码不运行，属性不采集，关闭后会随机生成
config.setAndroidIdEnabled(false);
// 开关关闭后相关代码不运行，属性不采集
config.setImeiEnable(false);
// 开关关闭后相关代码不运行，属性不采集
config.setIccIdEnabled(false);

2.4 上报行为数据

统计埋点必须上报：注册、支付，两个埋点事件由SDK预定义

Java
//内置事件:“注册”,属性:注册方式,是否成功,属性值为:wechat,true
AppLog.onEventRegister("wechat",true);

//内置事件:“登录”,属性:录方式,是否成功,属性值为:wechat,true
AppLog.onEventLogin("wechat",true);

//内置事件“支付”,属性:商品类型,商品名称,商品ID,支付渠道,币种,是否成功(必传),金额（必传）
// 付费金额单位为元
AppLog.onEventPurchase("gold","test", "1","wechat","¥", true, 1);

 

Java
 JSONObject paramsObj = new JSONObject();
 paramsObj.put("key", "value"); // 添加原始事件名称参数
 paramsObj.put("levelup", "5"); //升到5级
 paramsObj.put("duration", 600); //升级所花时间
 AppLog.onEvent("first_launch", paramsObj);

 

注：自定义埋点事件设计原则如下：

  - 字符串

  -  整型

  - 浮点型

数据联调

1. 测试前提

请务必确认已按照上方接入文档完成接入，再进行此步骤。如尚未完成接入，请首先按照对接包中的文档和示例代码完成接入，再进行上报测试的相关操作。

2. 测试入口位置

首页-数据检测

3. 联调（需要上报对应事件）

先务必确认SDK包已通过测试，再进行此步骤。

联调需要上报真实事件，包含：激活，注册，付费