SDK 接入概要

初始化接口

void init ( ... );

事件接口调用结构

						
onStart // 应用启动
    onSubStart // 关卡或页面的开始
        // 关卡中发生的事件
        onBuy, onUse, onEvent … 等事件接口
        onPassFail 关卡成功或失败
    onSubEnd // 关卡或页面的结束
    
    // 关卡外发生的事件
onEnd // 应用退出，Back按键强制退出调用onExit
					

获取 APPKEY

1，登录 天梯游戏统计 后台，进入我的应用界面，在应用汇总窗口点击 “创建新应用”。如图：

2，输入应用的相关信息后，点击 “提交应用”，即可。如图：

3，得到唯一的 APPKEY，接入 SDK 时使用。如图：

Unity SDK 导入

在 Unity 编译器中选择 Assets -> Import Package -> Custom Package 找到本地目录下的 AppLogger_c11_XXX.unitypackage 文件
（或：AppLogger_c99_XXX.unitypackage 两者区别见下文），点击 Open 按钮，然后 Import 即可导入成功。

由于开发者选用的 c++ 标准库可能有所不同（是否支持 C++0x），所以我们对 liblogger 也做了对应的区分，分别为：

1，如果使用LLVM C++ standard library with C++11 support (如下图) 或者 Complier Default,使用 AppLogger_c11.unitypackage

2，如果使用GNU C++ standard library (如下图),使用 AppLogger_c99.unitypackage

Unity SDK 初始化

定义

void init (const char* appId, const char* appChannel=NULL);

在初始化游戏的 MonoBehaviour 子类中添加如下代码，Awake()和 Start() 中均可以添加:

using Tianti;

void Awake() {
	...
	AppLogger.init ("appId", "appChannel");
}
					

// 宏判断 IPHONE || ANDROID
#if UNITY_IPHONE
	AppLogger.init ("iOS 版本的 appID", "App Store");
#elif UNITY_ANDROID
	AppLogger.init ("Android 版本的 appID", "appChannel");
#endif
						

功能

初始化数据统计服务

用法

必须指定 appId 和 appChannel，通常指定 appChannel 为"AppStore"

现在可以登录 天梯游戏统计 后台，然后运行您的游戏，即可实时看到当前启动游戏的记录。实时心跳数据，如图：

恭喜，基本的统计 SDK 已经接入完成！

如果您的项目是关卡类型游戏或者需要统计分析移动应用的具体页面数据，您可以继续接入 “关卡与页面”。

初次接入天梯游戏统计 SDK 建议开启调试信息输出接口 “setDebugLog”

关卡与页面

关卡或页面开始 onSubStart

定义

void onSubStart (const char* name);

功能

进入一个关卡或页面

用法

在进入一个关卡或页面时，调用 onSubStart 接口

onSubStart 事件接口可以帮助统计系统获得关卡 新增用户，活跃用户，启动次数，进入次数，离开次数，滞留人数，最大关卡，最后关卡 等各种指标数据。如图：

关卡或页面结束 onSubEnd

定义

void onSubEnd (const char* name);

功能

退出指定关卡或页面

用法

在退出一个关卡或页面时，调用 onSubEnd 接口

关卡过关或失败 onPassFail

定义

void onPassFail (bool bPass);

功能

过关或失败

用法

关卡过关或失败时，立即调用 onPassFail 接口

关卡与页面子事件

所有子事件缺省都算在最后关卡中（STAGE_LAST）

如果需要把子事件计算到特定关卡或页面，请指定子事件中的 stage 参数

现金购买 onBuy

定义

void onBuy (const char* payService, const char* item, int count, float value, const char* stage = STAGE_LAST);

功能

现金购买虚拟币， onBuy 事件接口提交的数据，将作为收入数据，在后端报表中用各种收入图表展现。

用法

当用现金进行购买时，请调用 onBuy 事件接口

onBuy 事件缺省统计到最后关卡中，所以你可以看到各个关卡的各种与收入相关的数据，如，收入，新增付费用户，活跃付费用户，当天购买用户

虚拟货币交易 onExchange

定义

void onExchange (const char* item, int count, const char* stage = STAGE_LAST);

功能

虚拟币兑换为道具

用法

数据分析人员可以观察到各个关卡的兑换次数，兑换项目等详细数据，以及各个数据的分布状况

道具使用 onUse

定义

void onUse (const char* item, int count, const char* stage = STAGE_LAST);

功能

使用道具或点数

收集 onCollect

定义

void onCollect (const char* item, int count, const char* stage = STAGE_LAST);

功能

收集点数/道具

奖励 onReward

定义

void onReward (const char* item, int count, const char* stage = STAGE_LAST);

功能

奖励虚拟币或道具

用法

发生奖励行为时，立即调用 onReward 接口

分享 onShare

定义

void onShare (const char* service, const char* item, const char* stage = STAGE_LAST);

功能

分享到社交服务上

用法

当用户进行分享操作时，立即调用 onShare 事件接口

产出与消耗(游戏平衡) onBalance

定义

void onBalance (const char* name, const char* item, int value, const char* stage = STAGE_LAST);

功能

游戏内虚拟货币的产出与消耗数据分析，通过产出与消耗可以观察游戏平衡情况。

用法

name 用 +,- 符号前缀，声明是产出或消耗。

玩家分享奖励： onBalance ("+宝石", "奖励", 100);

玩家购买时装： onBalance ("-宝石", "时装A", 200);

升级事件(玩家/角色/宠物) onLevelUp

定义

void onLevelUp (const char* name, const char* oldLevel, const char* newLevel, const char* stage = STAGE_LAST);

功能

玩家/角色/宠物的等级变化事件，统计玩家等级分布

用法

级别(oldLevel, newLevel)建议用版本号形式

自定义事件 onEvent

定义

void onEvent (const char* name, const char* stage = STAGE_LAST);

功能

用户自定义事件

用法

自定义事件将以列表形式罗列出来，并显示最近几天的自定义事件变化

自定义事件可以是一个简单的名称，例如 dm_show，也可以是包含 / 的多级名称，例如 main/dm_show, main/dm_close, …

对于 main/dm_show 形式的事件，在统计报表中将把所有 main/ 开头的时间一起对比显示。

所以如果想对比观察一组事件，可以给这些事件一个一样的分组名称作为前缀，并用 / 分隔。

事件列表：

相同前缀的事件之间对比：

在线参数

启用在线参数

定义

void enableOnlineConfig ();

功能

启用在线参数同步功能，缺省不启用在线参数功能

用法

在 init 接口后调用 enableOnlineConfig

获取在线参数

定义

string getOnlineConfig (string key, string defaultValue="");

功能

获得某个在线参数的具体数据，如果没有指定，返回 defaultValue

用法

先调用 enableOnlineConfig，然后可以任意多次调用 getOnlineConfig

存量数据统计

清除存量数据

定义

void clearStatus();

功能

清除所有存量数据

设置存量数据

定义

void setStatus(const char* key, int value, bool bAutoConvert = true);

功能

设置存量数据，服务器端将对存量数据自动分区间统计，或根据指定的区间统计

例如：玩家当前有多少宝石，用了多少宝石，收集了多少宝石等等这类长期累积的数据可以通过 setStatus 的接口统计。

用法

通常在 init 之后尽快调用 setStatus 接口，把客户端的累计存量数据汇报给服务器

存量数据每天第一次启动的时候提交到服务器

开发者

启用错误统计

定义

void enableCrashReport();

功能

启用错误统计，捕捉应用中发生崩溃时的堆栈信息，用于定位程序中引起错误的代码，缺省为不启用崩溃统计

用法

在 init 接口之后调用 enableCrashReport

日志输出设置

定义

void setDebugLog (int mode, int level);

功能

调试信息输出控制

用法

mode 与 level 具体定义：

							
#define DEBUG_OFF       0    //不输出调试信息
#define DEBUG_LOGCAT    1    //输出到 logcat(用于联机调试)
#define DEBUG_LOGFILE   2    //输出到 文件（applogger.log）, 用于脱机调试
#define DEBUG_LOGALL    3    //输出到 logcat 和 文件（applogger.log）

#define DEBUG_LEVEL_VERBOSE    0    //输出所有级别调试信息
#define DEBUG_LEVEL_INFO       1    //输出INFO级别以上调试信息
#define DEBUG_LEVEL_WARN       2    //输出WARN级别以上调试信息
#define DEBUG_LEVEL_ERROR      3    //输出ERROR级别以上调试信息
					

其他

启动间隔控制参数

定义

void setSessionInterval (int v);

功能

设置合并间隔，当上次退出时间与本次启动时间间隔小于该参数所指定的值时，合并上次与本次启动

联网控制

定义

void setOnline (bool online);

功能

一般仅用于小范围测试时（如，玩家输入邀请码才能进入游戏）。邀请码验证通过后，才算正常初始化 SDK

玩家/用户参数

定义

void setUser (const char* level, int age = -1, const char* gender = NULL, const char* userId = NULL, const char* userService = NULL);

功能

设置用户信息，包括用户级别，年龄，性别, …