一、简介

1.1 用户模块

用户模块提供用户登录接口，支持匿名登录和Facebook登录。

1.2 支付模块

支付模块提供支付充值接口，集成简单，无需理会复杂的支付流程，轻松完成商品的购买（充值）。

1.3 数据收集模块

数据收集模块提供了数据收集的接口，多渠道灵活调用。数据收集包含了丰富的应用内的事件类型，还支持用户自定义事件类型。

二、快速集成

2.1 环境配置要求

需要使用 Unity 5.0 的基本版 SDK；

下载并安装包含 Facebook 构建支持的 Unity（可用的最低版本为 5.6）：访问Unity商店即可下载

更多详细要求请参考Facebook Gameroom游戏开发要求。

说明：
1）SDK内部已经包含Facebook SDK，版本：7.10.1

2.2 集成SDK到项目

新建或打开游戏工程项目，在菜单中打开File→Build Settings选项，在Platform中选中”PC,Mac & Linux Standalone”，然后点击下方的“Switch Platform”按钮切换到该平台。

打开菜单Assets→Import Package→Custom Package…，浏览选中WASdk Unity的package，导入到项目，导入时请将所有文件勾选。

到这已经完成了WINGSDK的集成。

提示：
1）导入unitypackage之后Unity编辑器如果没有显示WINGSDK菜单，请重启Unity编辑器。

2.3 SDK配置及初始化

2.3.1 SDK配置

导入SDK到项目后，在菜单栏上有一个“WASdk”的菜单项，点击在下拉菜单中选中“Edit Settings”，在Inspector面板上显示SDK的配置项，在“WA Settings”配置WINGSDK的相关参数，勾选“Enable facebook”启用Facebook渠道（Gameroom必须启用Facebook渠道），并配置Facebook App Id。

说明：
1）WINGSDK ApiUrl:https://api.wingsdk.com/sdkapi
2）WINGSDK TrackUrl:https://api.wingsdk.com/data

2.3.2 SDK初始化

调用下面接口对SDK进行初始化：

WACoreProxy.Initialize ();

注意：SDK初始化必须在第一个Scene脚本中调用,强烈建议在UI线程中调用，可以在Awake（）或者Start（）中进行。

2.4 登录

2.4.1使用接口登录

使用登录接口登录，调用以下接口：
WAUserProxy.Login(string platform, string extInfo, WAOnResult<WALoginResult> onLoginResult)

参数说明：

2.4.2 处理登录结果

登录结果通过传入的回调返回，数据封装在WALoginResult类中。

WALoginResult字段说明

2.4.3 用户登出

退出游戏的时候，必须执行登出操作。用户登出调用以下接口：

WAUserProxy.LogOut();

注意：调用Logout接口后，serverId、gameUseId、level字段值会被重置，如果需要保持相应字段的值不重置，需要重新设置相应字段的值，参考3.1 公共参数设置

2.5 支付

WINGSDK支付大致流程如下所示：

2.5.1 初始化支付

初始化支付，SDK会对所有已经支持的支付平台做初始化，初始化调用接口

WAPayProxy.Initialize(WAOnResult<WAResultBase> onResult);

参数说明：

WAResultBase实体类说明：

调用支付前必须进行支付初始化，初始化成功才能使用支付功能。

2.5.2 查询商品列表

通过查询商品列表，可以获取所有可以购买的商品，查询商品列表调用接口

WAPayProxy.QueryInventory(WAOnResult<WAProductResult> onResult);

注意：这里返回的商品信息是WINGSDK平台的商品信息，并非第三方平台的商品信息。

参数说明：

WAProductResult实体类说明：

WAProduct实体类说明：

2.5.3 购买商品

购买指定商品，调用以下接口发起支付：

WAPayProxy.Pay(string waProductId, string extInfo, WAOnResult<WAPayResult> onResult);

参数说明：

WAPayResult实体类说明：

2.5.4 资源释放

不再使用支付时需要对资源进行释放，可以清理所有支付渠道所占用的资源，调用接口:

WAPayProxy.Destroy();

2.6 数据收集

使用WINGSDK数据收集接口配合大数据平台，可以轻松统计玩家习惯以及充值等行为，为游戏的市场营销提供数据依据。WINGSDK数据收集使用在游戏的过程中打点的方式，如图所示：

以上流程图中涉及到的几个接口：SetServerId、SetGameUserId、SetLevel、ghw_user_import事件、ghw_user_create事件是有时序要求的，其它的事件如ghw_initiated_purchase、ghw_purchase、ghw_level_achieved、ghw_user_info_update、ghw_gold_update和ghw_task_update事件则需要在事件发生的对应时机调用接口发送。

2.6.1 发送数据

2.6.1.1 构建WAEvent对象

使用WAEvent.Builder构建一个WAEvent类对象，并设置数据收集的相关参数：

2.6.1.2 发送数据

调用第一步创建WAEvent对象的Track()方法发送数据

waEvent.Track();

或者调用以下接口发送：

WATrackProxy.TrackEvent(WAEvent waEvent)

2.6.1.3 WAEvent.Builder方法介绍

• 设置默认的事件名称

public Builder SetDefaultEventName(string eventName)

参数：
eventName事件名称

• 设置渠道自定义事件名称，针对某个渠道需要设置特定的事件名称

public Builder SetChannelEventName(string eventChannel, string eventName)

参数：
eventChannel 渠道名称
eventName 事件名称

注意：
1）如果不进行设置，所有的渠道将采用设置的默认值。

• 设置默认累加值

public Builder SetDefaultValue(float value)

参数：
value 累加统计的数值

• 设置渠道自定义累加值，针对某个渠道需要设定特定的累加值

public Builder SetChannelValue(string eventChannel, float value)

参数：
eventChannel 渠道名称
value累加统计的数值

注意：
1）如果不进行设置，所有的渠道将采用设置的默认值。

• 设置事件默认的参数/值，每次可添加多个

public Builder SetDefaultEventValues(Dictionary<string, object> eventValues)

参数：
eventValues 参数/值Dictionary

• 添加一个事件默认的参数/值，每次添加一个

public Builder AddDefaultEventValue(string paramName, object paramValue)

参数：
paramName 参数名称
paramValue 参数值

• 设置事件渠道自定义的参数/值，每次可添加多个，针对某个渠道需要设定特定的参数或者值

public Builder SetChannelEventValues(string eventChannel, Dictionary<string, object> eventValues)

参数：
eventChannel 渠道名称
eventValues参数/值Dictionary

注意：
1）如果不进行设置，所有的渠道将采用设置的默认值。

• 设置事件渠道自定义的参数/值,每次添加一个，针对某个渠道需要设定特定的参数或者值

public Builder AddChannelEventValue(string eventChannel,string paramName, object paramValue)

参数：
eventChannel 渠道名称
paramName参数名
paramValue参数值

注意：
1）如果不进行设置，所有的渠道将采用设置的默认值。

• 禁用渠道，禁用后的渠道不会发送数据

public Builder DisableChannel(string eventChannel)

参数：
eventChannel 渠道名称

注意：
1）默认情况下是所有启用的渠道都发送
2）该接口只是针对当前事件禁用发送到某个渠道

2.6.2 SDK预定义事件

WINGSDK包括了以下预定义事件。

建议参数属性：（参数对应的静态变量名请看4.2.2 SDK预定义参数名）

2.6.2.1 ghw_initiated_purchase点击购买（虚拟货币）

说明：点击购买的时候调用（用于游戏内部虚拟交易统计）。

2.6.2.2 ghw_purchase购买完成（虚拟货币）

说明：购买完成的时候调用（用于游戏内部虚拟交易统计）。

2.6.2.3 ghw_level_achieved 等级增长事件

说明：统计玩家等级增长事件，达到等级时调用。

注意：发送ghw_level_achieved事件前需调用3.1.3 设置用户等级level接口更新用户等级信息。

2.6.2.4 ghw_user_create 创建角色

说明：创建游戏角色，游戏角色创建时调用

2.6.2.5 ghw_user_info_update更新用户信息

说明:更新用户资料

2.6.2.6 ghw_gold_update货币状况更新

说明:玩家货币状况变更统计

2.6.2.7 ghw_task_update玩家任务统计

说明:玩家任务信息统计

2.6.2.8 ghw_user_import导入用户事件

说明：导入用户事件，玩家第一次进某个服时调用

注意：发送ghw_user_import事件前需调用3.1.1 设置服务器ID接口更新服务器id

2.6.3 自定义事件

说明：支持自定义事件的统计

三、高级功能

3.1 公共参数设置

WINGSDK包括serverId等公共参数，这些参数主要用于数据跟踪和统计。
公共参数必须严格按照文档进行设置，在后续的接口中会使用到这些公共的参数，没有按照要求配置会导致部分接口调用失败。

3.1.1 设置服务器ID

当用户的服务器ID发生改变时，需要调用设置服务器ID接口设置新的服务器ID，例如每次进入服务器。

WACoreProxy.SetServerId(string serverId)

注意：设置服务器id的操作在每次选服后都需要进行，必须在调用其他接口前设置。

3.1.2 设置gameUserId

当gameUserId发生改变时，需要调用设置gameUserId接口设置新的gameUserId，例如成功登录账号后、切换账号成功后。

WACoreProxy.SetGameUserId(string gameUserId)

注意：必须在调用其他接口前设置。

3.1.3 设置用户等级Level

当用户角色等级发生改变时，需要调用设置等级接口设置新的等级，例如开始进入游戏、等级提升等。

WACoreProxy.SetLevel(int level)

注意：第一次进服获取玩家等级或玩家等级变更后，需要及时调用这个接口设置玩家等级，必须在调用其他接口前设置。

四、附录

4.1 代码说明

4.1.1 状态码说明

SDK中的状态码统一以静态变量方式封装在WAStatusCode类里面，如果使用到状态码，强烈建议采用静态变量的方式调用，不要直接使用数值。

4.1.2 平台取值

4.2 事件说明

4.2.1 SDK预定义事件名

在WAEventType接口中定义

4.2.2 SDK预定义参数名

在WAEventParameterName接口中定义