Appearance
Unity接入
WARNING
在接入SDK之前, 建议先请仔细阅读:接入流程
SDK提供了Unity的Demo,里面对Android/iOS层的逻辑进行了简单的封装,故本文档仅供参考,游戏层也可以自行处理调用逻辑
基础配置
1、将UnityDemo/Assets/Scripts/SDK目录拷贝到游戏工程的Assets/Scripts目录下, 如果游戏层已经存在SDK目录,可以重新创建一个目录,将上述目录中的代码拷贝进去;SDK目录下是封装好的Unity层的API调用组件。
2、 将UnityDemo/Assets/Plugins/文件拷贝到游戏工程的Assets/Plugins/下。Plugins/Android目录下,是Android平台相关的SDK库和配置文件;Plugins/iOS目录下,是iOS平台相关的SDK库和配置文件。
接口调用
1、初始化
csharp
UGSDKInterface.Instance.Init();
// 设置回调:
UGSDKInterface.Instance.OnLoginSuc = delegate(UGLoginResult result)
{
// SDK登录成功回调, result为SDK登录结果
// result.userID: 用户在SDK中的唯一用户ID
// result.username: 用户名
// result.token: 登陆token,需要和userID一起发给服务端,服务端去SDK服务器做登录验证,具体协议参考服务端文档
// result.newAccount: 1:新用户;0:老用户
};
UGSDKInterface.Instance.OnLogout = delegate()
{
// 当玩家从SDK中登出时,会触发该回调。 游戏层需要引导玩家返回到游戏登录界面重新登录进入游戏
};2、登录
在玩家进入游戏之前, 需要调用登录接口,弹出SDK的登陆界面:
csharp
UGSDKInterface.Instance.Login();3、登出
如果游戏内有登出按钮, 当玩家点击登出按钮的时候, 调用登出接口后(不用等待回调结果),立即返回到游戏登陆界面(不用等待回调结果)
csharp
UGSDKInterface.Instance.Logout();4、角色数据上报
csharp
UGRoleData data = new UGRoleData();
data.roleID = "1"; //玩家角色ID
data.roleName = "测试角色"; //玩家角色名称
data.roleLevel = "15"; // 玩家角色等级
data.serverID = "10"; // 当前服务器ID
data.serverName = "地狱之恋"; // 当前
data.vip = "1"; // 当前角色VIP等级
data.createTime = "0"; // 角色创建时间,从1970年到现在的时间,单位秒
data.lastLevelUpTime = "0"; // 角色等级变化时间,从1970年到现在的时间,单位秒
data.type = UGRoleData.TYPE_CREATE_ROLE; //上报类型. 1: 创建角色;2:进入游戏;3:等级提升;4:退出游戏
UGSDKInterface.Instance.SubmitGameData(data);5、支付
csharp
UGPayParams data = new UGPayParams();
data.productID = "1"; //游戏内商品ID,可以和google后台的商品ID不一致。 在SDK后台配置商品ID的映射关系即可
data.productName = "元宝"; //商品名称
data.productDesc = "购买100元宝,赠送20元宝"; //商品描述
data.price = 100; //商品价格,单位分
data.currency = "CNY"; //货币单位,默认CNY
data.serverID = "10"; //服务器ID
data.serverName = "地狱之恋"; //服务器名称
data.roleID = "1"; //角色ID
data.roleName = "测试角色"; //角色名称
data.roleLevel = "15"; //角色等级
data.vip = "1"; // vip
data.payNotifyUrl = "http://localhost:8080/payCallback"; //游戏服的支付回调地址,用于接收支付回调通知
data.cpOrderID = "test_00000001"; //游戏自己的订单号
data.extra = "test_data"; //扩展数据, 支付成功回调通知游戏服务器的时候,会原封不动返回这个值
UGSDKInterface.Instance.Pay(data);6、自定义埋点上报
6.1 插件说明
SDK中通过插件抽象的形式, 定义了统计埋点插件:UGAnalytics, 并接入了多个第三方买量投放埋点上报SDK,基本不需要游戏层调用,即可实现数据的自动上报。
SDK内部已经预制了一些数据埋点的时机,参考如下:
| 事件名称 | 事件接口 | 事件说明 |
|---|---|---|
| SDK初始化开始 | onInitBegin | 在SDK初始化接口开始调用时触发 |
| SDK初始化成功 | onInitSuc | 在SDK初始化接口成功后触发 |
| SDK登录开始 | onLoginBegin | 在SDK登录接口开始调用时触发 |
| SDK登录成功 | onLogin | 在SDK登录成功后触发 |
| SDK账号注册成功 | onRegister | 在玩家首次登录/注册成功时触发 |
| SDK支付开始 | onPurchaseBegin | 在SDK支付接口开始调用时触发 |
| SDK支付成功 | onPurchase | 在SDK支付成功后触发 |
| 创建角色成功 | onCreateRole | 在游戏层调用角色上报接口并且dataType是1时触发 |
| 进入游戏成功 | onEnterGame | 在游戏层调用角色上报接口并且dataType是2时触发 |
| 角色升级成功 | onLevelUp | 在游戏层调用角色上报接口并且dataType是3时触发 |
6.2 自定义上报
如果游戏层有自己其他的事件需要上报到第三方统计/买量/监测平台, 可以调用如下接口:
csharp
Dictionary<string, object> eventParams = new Dictionary<string, object>();
eventParams.Add("$ta_account_id", "1111111");
eventParams.Add("$ta_distinct_id", "2222222");
eventParams.Add("$third_platform_type", "shushu");
UGSDKInterface.Instance.CustomReport("eventName", eventParams);6.3 插件参数配置
Android的插件参数在assets/ug_plugins.json中配置,Unity工程/Plugins/Android/sdk-core-release.aar用解压工具(比如7zip)打开,将assets中ug_plugins.json中插件参数修改为游戏对应的参数。(因为Unity工程中不支持直接放assets目录下的文件);
iOS端导出XCODE工程后, 需要在Info Plist中配置插件参数(UGSDK->Plugins节点),可以参考:iOS插件配置。