Android统计分析后台SDK接入说明文档
一、综述
1.适用范围
YZ网游手游统计SDK帮助游戏开发者解决玩家数据收集至数据标准化分析的全部繁琐问题,以行业标准指标形式将数据展现于报表中。
2.统计标准
为了与游戏自有体系更好的结合,统计中采用游戏自身的账号来作为一个玩家单元。数据中除了玩家的基本信息外,主要帮助处理游戏过程中的升级、任务、付费、消费等详细行为数据。
二、接入流程
STEP 1 为游戏申请APP ID
为每款游戏申请一个APP ID
STEP 2 向工程中导入追踪SDK
以Eclipse为例,其他开发工具导入外部JAR包请参照开发工具自身的使用手册。右键点击工程根目录→选择Properties→Java Build Path → Libraries→点击Add External JARs...找到本地目录下的yzsinglestatistics.jar文件,点击打开按钮即导入成功。
STEP 3 配置AndroidManifest.xml
SDK需要获取适当的权限才可以正常工作。开发者需要在AndroidManifest.xml里添加一下权限。
STEP 4 添加SDK初始化代码(必须)
1.appId
用来唯一标识您的游戏
2.appkey
游戏密钥
3.初始化代码
开发者可以通过YZServerDataInterface.YZ_Init方法手工初始化SDK;只有在SDK正常初始化以后,SDK的其他API才可以正常调用。
在游戏启动的时候(建议在自定义的Application的onCreate方法中,越早越好)调用以下方法:
YZ_Init(Context context,String appid,String appkey,String opid)
如果在同一进程中多次调用,且传入参数不同,会以最后一次调用为准。
注意:初始化是使SDK开始工作的关键,不进行初始化就对其他接口进行调用,会引发程序崩溃的严重危险。请开发者一定要注意。
STEP 5 添加调用方法
参考“三、 添加调用方法”的指导完成开发
STEP 6 进行数据测试
调用方法添加完毕后,应当对游戏打包并进行数据测试,以确保打包的正确
三、添加调用方法
1. SDK 初始化(必须调用)
用途和用法
用于初始化SDK,在程序启动之初调用。
接口说明(YZServerDataInterface类)
public static void YZ_Init(Context context,String appid,String appkey,String opid)
参数说明
context 应用程序实例
appid 游戏id
appkey 游戏密钥
opid 渠道id
示例代码
YZServerDataInterface.YZ_Init(this, appid, appkey, "11");
2. SDK登录日志
用途和用法
记录SDK的登录。SDK登陆成功后调用。
接口说明(YZServerDataInterface类)
public static void YZ_SDK_Login(String account,String remark)
参数说明
account 账号(填写SDK返回的渠道账号id, 如果没有账号id则传入账号)
示例代码
YZServerDataInterface.YZ_SDK_Login("abc", "this is a test");
3. 角色信息变化
用途和用法
用于记录角色信息的变化。
接口说明(YZServerDataInterface类)
public static void YZ_SDK_RoleChange(int server_id,String role_id,String role_name,String account,ChangeType change_type, String change_befor, String change_after,int role_level,String remark)
参数说明
server_id 角色所在区服
role_id 角色id
role_name 角色名称
account 角色账号,与登录接口所用account保持一致
change_type 变化类型,有角色的等级(ChangeType.RoleLevel)变化和角色副本的游戏进度(ChangeType.GameProgress) 变化,记录角色等级或副本的变化
change_befor 变化前
change_after 变化后
role_level 角色的当前等级
remark 备注
示例代码
YZServerDataInterface.YZ_SDK_RoleChange(1, "a001", "abc", "abc", ChangeType.RoleLevel, 1, 2, 2, "this a test");
4. 充值来源
用途和用法
用于记录玩家通过那个活动界面而进入充值页面充值。
接口说明(YZServerDataInterface类)
public static void YZ_SDK_RechargeBehavior(int server_id,String role_id,String role_name, String page_id,BehaviorState behavior_state,int role_level,String remark)
参数说明
server_id 角色所在区服
role_id 角色id
role_name 角色名称
page_id 充值界面来源id(由用户定义每个来源的id)
behavior_state 行为状态,进入充值界面(BehaviorState.ComeInRechargePage),点击充值按钮(BehaviorState.ClickRecharge)和充值成功(BehaviorState.RechargeSuccess)三种行为状态
role_level 角色的当前等级
remark 备注
示例代码
YZServerDataInterface.YZ_SDK_RechargeBehavior(1, "a001", "abc", 1, BehaviorState.ComeInRechargePage, 2, "this is a test");
5. SDK版本信息
用途和用法
用于查看SDK的版本信息。
接口说明(YZServerDataInterface类)
public static String YZ_SDK_Version()
示例代码
YZServerDataInterface.YZ_SDK_ Version ();