一.简介

WING H5 SDK主要是为满足HTML5类型游戏需要，为此类游戏提供登录、支付、数据收集等通用功能。该SDK适用于pc端与移动端的浏览器，facebook的gameroom，以及移动端应用程序的webview等HTML5运行环境。

二.功能简介

2.1.登录

SDK提供了有界面登录方式和无界面登录方式。有界面方式内置所有已经集成的登录方式，无需编写登录界面就可以集成多种登录方式。而无界面方式则需要CP提供相对应的登录界面来调用具体登录方式。
目前WING H5 SDK 支持的登录方式有Guest，Facebook，应用内登录。

2.2.支付

支付包括Facebook支付以及Web支付，其中Web支付又包括了多种支付方式比如Paypal、MOL、Xsolla等。

2.3.数据收集

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

2.4.调试模式

调试模式提供窗口查看日志，帮助开发者更快的集成SDK与定位相关的开发问题。

三.集成WING H5 SDK

3.1.适用范围

该SDK适用于HTML5类型的游戏或应用，特别是在Facebook上线的页游。为这些游戏提供登录、支付、数据收集等基础功能，同时提供调试窗口，满足游戏能顺利运行的基本功能需求，更多的功能目前还在持续开发中。

3.2.如何集成

WING H5 SDK推荐使用标签方式引入JS，同时也支持AMD、CommonJS等方式引入。

3.3.接口说明

以下是WING H5 SDK各个接口的具体使用说明。

3.3.1.初始化

初始化方法：wing.init(paramObj);

初始化sdk库，在调用其他方法前，必须先调用此方法。

参数说明：

示例：

3.3.2.登录

3.3.2.1.获取登录方式

方法：wing.user.getLoginWay();

返回结果参数说明：

data数据结构：

示例：

3.3.2.2.用户登录

方法：wing.user.login(paramObj);

参数说明：

示例：

返回结果参数说明：

注：
1：platform 字段不传入时，将获取该应用可用的登录方式，用窗口展示给用户选择；
2：platform字段传入具体平台值时，不再弹出登录方式选择框，直接跳到对应的登录方式
3：Facebook内嵌游戏应当同时传入platform=FACEBOOK，FB=true。

3.3.3.支付

3.3.3.1.获取商品列表

方法：wing.pay.getProducts();

示例：

3.3.3.2.购买商品

方法：wing.pay.payUI(params);

参数说明：

示例：

注：
1：对于网页支付方式如Paypal等，支付后在弹出窗口关闭时回调，result不返回数据
2：对于Facebook支付，支付完成后，result返回Facebook所有数据
如：

3：channel字段为可选字段，传入该值则直接使用对应支付方式，否则弹出所有支付方式选择窗口

3.3.4.公共参数设置

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

3.3.4.1.设置游戏用户id

wing.setGameUserId()

参数说明：

示例：

3.3.4.2.设置服务器id

wing.setServerId()

参数说明：

示例：

3.3.4.3.设置等级

wing.setLevel()

参数说明：

示例：

3.3.5.数据收集

使用SDK数据收集接口配合大数据平台，可以轻松统计玩家习惯以及充值等行为，为游戏的市场营销提供数据依据。
目前数据收集支持以下平台： WING SDK 后台、 Facebook 后台
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事件则需要在事件发生的对应时机调用接口发送。

SDK内部集成多个数据收集渠道，对于同一个事件，不同的渠道对应的事件名称和参数值可能不尽相同，可以使用下面数据发送接口应对此类需求。

3.3.5.1.数据发送

方法：wing.trackEvent(WAEvent);

参数说明：

示例：

示例说明：setDefaultEventName方法用于设置发送事件的名称，GHW_PURCHASE为SDK定义的购买事件名称，所有SDK预定义的事件名称可以在下文的3.3.7.1.事件常量章节查看。setDefaultValue为设置事件默认价值，addDefaultEventValue为设置默认事件参数/值，其中SDK定义参数在下文3.3.7.2.参数常量章节可查看。setChannelEventName为设置渠道自定义事件名称，用于发往第三方平台时更改事件命名。setChannelEventValues为事件渠道自定义的参数/值，用于发往第三方平台时，替换默认事件参数。

下面是WAEvent对象的具体说明。

3.3.5.2.事件对象

全局对象：wing.WAEvent

实例化
方法：builder()

参数：无

示例：

WAEvent对象是SDK提供的帮助类，用于封装需要SDK追踪的数据，可以使用链式调用的方式使用该对象。在使用前必须调用初始化方法builder()才能使用。下列是WAEvent剩余的所有方法，点击链接跳转到具体的方法查看说明。

1)设置默认事件名称
方法：setDefaultEventName(eventName)
此方法为所有渠道的单个事件设置默认事件名称，如果渠道没有单独设置则使用此默认值。

参数：

示例：

2)设置默认事件值
方法：setDefaultValue(val)
此方法为所有渠道的单个事件设置默认事件值，如果渠道没有单独设置则使用此默认值。

参数：

示例：

3)设置一个事件参数
方法：addDefaultEventValue(paramName, val)
此方法为所有渠道的单个事件设置事件参数，如果渠道没有单独设置则使用此默认参数。每次添加一个，可调用多次。

参数：

示例：

设置多个事件参数
方法：addAllDefaultEventValue(obj)
此方法为所有渠道的单个事件设置事件参数，如果渠道没有单独设置则使用此默认参数。每次可添加多个，只可调用一次。

参数：

示例：

5)设置渠道自定义事件名称，针对渠道需要设置特定的事件名称
说明：使用该方法单独为某一渠道设置事件名称，该事件名称将替换掉setDefaultEventName设置的事件名称。

方法：setChannelEventName(channelName, eventName)

参数：

示例：

6)设置事件渠道自定义的参数/值
说明：使用该方法单独为某一渠道的某个事件设置参数值，如果不设置则使用addDefaultEventValue或addAllDefaultEventValue方法设置的默认参数。

方法：setChannelEventValues(channelName, obj)

参数：

示例：

7)禁用渠道
说明：发送某事件时，不发送该事件到指定渠道。

方法：disableChannel(channelName)

参数：

示例：

8)禁用所有第三方渠道
说明：发送某事件时，不发送该事件到所有第三方渠道。

方法：disableAllChannel()

参数：无

示例：

9)获取事件信息方法列表
说明：使用下面方法可以获取前面方法设置的参数值。

示例：

3.3.6.调试

SDK提供了调试模式供开发者使用，具体打开方式如下：

在初始化时设置debug=true，开发时浏览器打开开发者模式，在控制台即可看到相关操作日志，开发者可以根据日志快速排查问题，提高效率。

3.3.7.常量

以下是SDK内部预定义常量。

3.3.7.1.事件常量

以下是SDK预定义事件。

事件对象：wing.WAEvent.WA_EVENT_TYPE

事件名称对应常量：

3.3.7.2.参数常量

以下是SDK预定义事件的参数定义
参数对象：wing.WAEvent.WA_EVENT_PARAMETER_NAME

参数常量：

3.3.7.3.第三方平台常量

参数对象：wing.WAEvent.TRACKING_CHANNEL

参数常量：

四.代码说明

4.1.登录类型对照表:

4.2.支付类型对照表:

4.3.状态码