IOS统计分析后台SDK接入说明文档
一、综述
1.适用范围
YZ单机手游统计SDK帮助游戏开发者解决玩家数据收集至数据标准化分析的全部繁琐问题,以行业标准指标形式将数据展现于报表中。
2.统计标准
为了与游戏自有体系更好的结合,统计中采用游戏自身的账号来作为一个玩家单元。数据中除了玩家的基本信息外,主要帮助处理游戏过程中的升级、任务、付费、消费等详细行为数据。
3.兼容性
支持IOS 6.0以上的系统,支持arm64、armv7
4.软硬件支持
硬件:macbook或者苹果一体机。苹果移动设备。
软件:安装Xcode6.0以上版本
二、接入流程
STEP 1 为游戏申请APP ID
为每款游戏申请一个APP ID
STEP 2 添加依赖库
本SDK需要依赖SystemConfiguation.framework AdSupport.framework CoreTelephony.framework。在Build Phases -> Link Binary With Libraries 中添加上述的依赖库。
STEP3 添加SDK的头文件及静态库
需要将头文件YZSingleStatistics.h及libYZSingleStatistics.a引入到工程中
STEP 4 添加SDK初始化代码(必须)
1.appId
用来唯一标识您的游戏
2.appkey
游戏密钥
3.初始化代码
开发者可以通过YZ_InitWithAppid:appkey: opid:方法手工初始化SDK;只有在SDK正常初始化以后,SDK的其他API才可以正常调用。
如果在同一进程中多次调用,且传入参数不同,会以最后一次调用为准。
注意:初始化是使SDK开始工作的关键,不进行初始化就对其他接口进行调用,会引发程序崩溃的严重危险。请开发者一定要注意。
STEP 5 添加调用方法
参考“三、 添加调用方法”的指导完成开发
STEP 6 进行数据测试
调用方法添加完毕后,应当对游戏打包并进行数据测试(使用真机),以确保打包的正确
三、添加调用方法
1. SDK 初始化
用途和用法
用于初始化SDK,在程序运行之初调用。
接口说明(YZServerStatistics类)
+(void) YZ_InitWithAppid:(NSString *)appid appkey:(NSString*) appkey opid:(NSString*)opid;
参数说明
appid 游戏的appid
opid 渠道id
示例代码
[YZServerStatistics YZ_InitWithAppid:@"10" appkey:@"f0a00316485f33bdd71377736fdfd4be" opid:@"2"];
2. SDK登录日志
用途和用法
用于记录SDK登录信息,SDK登陆成功后调用。
接口说明(YZServerStatistics类)
+(void) YZ_SDK_LoginWithAccount:(NSString*) account remark:(NSString*) remark;
参数说明
account 用户名称(填写SDK返回的渠道账号id, 如果没有账号id则传入账号)
remark 备注
示例代码
[YZServerStatistics YZ_SDK_LoginWithAccount:@"abc" remark:@"this is a test"];
3. 角色信息变化
用途和用法
用于记录角色信息的变化。
接口说明(YZServerStatistics类)
+(void) YZ_SDK_RoleChangeWithServerId:(int)serverid account:(NSString*)account roleId:(NSString*)roleId roleName:(NSString*)roleName changeType:(ChangeType)type changeBefor:(NSString*)changeBefor changeAfter:(NSString*)changeAfter roleLevel:(int)roleLevel remark:(NSString*)remark;
参数说明
serverid 角色所在区服
account 角色账号,与登录接口所用account保持一致
roleId 角色id
roleName 角色名称
changeType 变化类型,有角色的等级(RoleLevel)变化和角色副本的游戏进度(GameProgress) 变化,记录角色等级或副本的变化
changeBefor 变化前
changeAfter 变化后
roleLevel 角色的当前等级
remark 备注
示例代码
[YZServerStatistics YZ_SDK_RoleChangeWithServerId:1 account:@"abc" roleId:@"001" roleName:@"abc" changeType:GameProgress changeBefor:@"副本第一章第一关" changeAfter:@"副本第一章第二关" roleLevel:2 remark:@"this is a test"];
4. 充值来源
用途和用法
用于记录玩家通过那个活动界面而进入充值页面充值。
接口说明(YZServerStatistics类)
+(void) YZ_SDK_RechargeBehaviorWithServerId:(int)serverid roleId:(NSString*)roleId roleName:(NSString*)roleName pageId:(NSString*)pageId behaviorState:(BehaviorState)behaviorState roleLevel:(int)roleLevel remark:(NSString*)remark;
参数说明
server_id 角色所在区服
role_id 角色id
role_name 角色名称
page_id 充值界面来源id(由用户定义每个来源的值)
behavior_state 行为状态,进入充值界面(ComeInRechargePage),点击充值按钮(ClickRecharge)和充值成功(RechargeSuccess)三种行为状态
role_level 角色的当前等级
remark 备注
示例代码
[YZServerStatistics
YZ_SDK_RechargeBehaviorWithServerId:1 roleId:@"001"
roleName:@"abc" pageId:@"购买体力" behaviorState:ComeInRechargePage roleLevel:2
remark:@"this is a test"];
5. SDK版本信息
用途和用法
用于查看SDK当前的版本信息。
接口说明(YZServerStatistics类)
+(NSString*) YZ_SDK_Verson;
示例代码
[YZServerStatistics YZ_SDK_Verson];