一.简介

WINGPLUS H5 SDK主要是为满足HTML5类型游戏以及微端游戏需要，为此类游戏提供登录、支付、数据收集等通用功能。该SDK同时封装了H5SDK以及微端js SDK，不但适用于pc端与移动端的浏览器，facebook的gameroom，同样适用于客户端如android和iOS中的webview调用原生功能。只需对接一套SDK，无需判断运行环境，SDK内部已做处理。
注：本文所提到的H5端是指运行在pc端或移动端的H5类型的游戏或应用，而微端是指在android或iOS客户端中的webview里面运行的H5类型的游戏或应用。

二.功能简介

2.1.登录

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

2.2.支付

各端支持的支付情况如下表所示：

2.4.数据收集

数据收集模块提供了数据收集的接口，多渠道灵活调用。数据收集包含了丰富的应用内的事件类型，还支持用户自定义事件类型。
各端支持的数据收集情况如下表所示：

2.5.调试模式

调试模式提供窗口查看日志，帮助开发者更快的集成SDK与定位相关的开发问题。
各端支持的调试模式情况如下表所示：

2.6 隐私政策

为了遵守欧盟近日发布的用户隐私政策，WINGSDK在用户首次登录时会显示用户隐私政策相关说明，用户需要同意才能进行下一步操作，在首次登录之后不会再出现此页面。此功能由WINGSDK内部处理，CP无需对接任何接口。

三.集成WINGPLUS H5 SDK

3.1.适用范围

WINGPLUS H5 SDK适用于HTML5类型的游戏或应用，比如在Facebook上线的页游，或者是同时拥有页游又有微端，而页游与微端功能有些功能不大相同但代码只有一套的游戏（比如支付，微端比H5端多了google/apple支付；而数据收集，微端比H5端多了appsflyer等渠道）。
WINGPLUS H5 SDK为这些游戏提供登录、支付、数据收集等基础功能，同时提供调试窗口，满足游戏能顺利运行的基本功能需求，更多的功能目前还在持续开发中。

3.2.如何集成

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

3.3.接口说明

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

3.3.1.初始化

初始化方法：

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

参数说明：

示例：

3.3.2.登录

3.3.2.1.用户登录

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

说明：该方法分为不弹出窗口（明确指定了platform）和弹出窗口方式（platform不传值则弹出登录方式选择框）

参数说明：

示例：

返回结果参数说明：

注：
1：platform 字段不传入时，将获取该应用可用的登录方式，用窗口展示给用户选择；
2：platform字段传入具体平台值时，不再弹出登录方式选择框，直接跳到对应的登录方式
3：针对Facebook Canvas游戏，sdk内部会根据游戏(Facebook后台的配置，参考第三方后台配置文档)链接中的from=fbcanvas参数来判断是否是Facebook Canvas游戏，调用方不需要设置platform参数

3.3.2.4.用户登出

方法：wingplus.user.logout();
说明：该方法是用来登出wingsdk的，此操作会删除sdk内部的一些缓存、登出第三方账号（如果可用）等。
参数：无
返回结果：无

3.3.3.支付

3.3.3.1.判断支付是否可用

方法：wingplus.pay.isPayServiceAvailable(callback);
参数说明：

3.3.3.2.获取商品列表

方法：wingplus.pay.getProducts();

参数说明：

返回结果参数说明：

示例：

3.3.3.3.购买商品

方法：wingplus.pay.pay(params);

参数说明：

返回结果参数说明：

示例：

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

3.3.5.公共参数设置

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

3.3.5.1.设置游戏用户id

wingplus.core.setGameUserId()

参数说明：

示例：

3.3.5.2.设置服务器id

wingplus.core.setServerId()

参数说明：

示例：

3.3.5.3.设置等级

wingplus.core.setLevel()

参数说明：

示例：

3.3.5.4.设置玩家昵称）

wingplus.core.setNickname()

参数说明：

示例：

3.3.5.5.展示收藏指引页（目前仅chipsgames平台中mobile端可用）

wingplus.user.showCollectGuide()

示例：

3.3.6.数据收集

使用SDK数据收集接口配合大数据平台，可以轻松统计玩家习惯以及充值等行为，为游戏的市场营销提供数据依据。
目前数据收集支持以下平台： WINGSDK，Facebook和Appsflyer（仅微端）。
WINGSDK数据收集使用在游戏的过程中打点的方式，如图所示:

1. 以上流程图中涉及到的几个接口是有时序要求的，请参考流程图中的逻辑步骤进行设置：setServerId、setGameUserId、setLevel、ghw_user_import事件、ghw_user_create事件
2. 其它的事件如ghw_level_achieved、ghw_self_tutorial_completed等请根据对应业务逻辑，在对应业务发生时调用接口发送。

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

3.3.6.1.数据发送

方法：wingplus.track.trackEvent(WAEvent);

参数说明：

示例：

示例说明：setDefaultEventName方法用于设置发送事件的名称，GHW_PURCHASE为SDK定义的购买事件名称，所有SDK预定义的事件名称可以在下文的<事件常量>章节查看。

setDefaultValue为设置事件默认价值，
addDefaultEventValue为设置默认事件参数/值，其中SDK定义参数在下文<参数常量>章节可查看。
setChannelEventName为设置渠道自定义事件名称，用于发往第三方平台时更改事件命名。
setChannelEventValues为事件渠道自定义的参数/值，用于发往第三方平台时，替换默认事件参数。

3.3.6.2.预定义事件

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

3.3.6.2.1. ghw_initiated_purchase点击购买（虚拟货币）

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

3.3.6.2.2. ghw_purchase购买完成（虚拟货币）

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

3.3.6.2.3. ghw_level_achieved 等级增长事件

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

3.3.6.2.4. ghw_user_create 创建角色

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

3.3.6.2.5. ghw_user_import导入用户事件

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

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

3.3.6.2.6. ghw_self_tutorial_completed完成新手任务

说明:完成新手任务时

参数 无

3.3.6.2.7. ghw_self_lv_x 到达关键等级时

说明:到达关键等级时，如ghw_self_lv_1、ghw_self_lv_3、ghw_self_lv_10

参数 无

3.3.6.3.自定义事件

自定义事件目前只支持事件名和累加值，见示例。

示例：

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

3.3.6.4.事件对象

全局对象：wingplus.track.WAEvent

实例化
方法：builder()

参数：无

示例：

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

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

参数：

示例：

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

参数：

示例：

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

参数：

示例：

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

参数：

示例：

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

方法：setChannelEventName(channelName, eventName)

参数：

示例：

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

方法：setChannelEventValues(channelName, obj)

参数：

示例：

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

方法：disableChannel(channelName)

参数：

示例：

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

方法：disableAllChannel()

参数：无

示例：

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

示例：

3.3.7.调试

3.3.7.1 H5端调试模式

H5端的调试模式具体打开方式如下：
在WING SDK 管理后台 设置》测试设备 中添加设备 Client ID 到测试设备列表（如下图所示），可打开LOG 日志窗口。

添加测试设备后，开发时浏览器打开开发者模式（一般浏览器快捷方式为F12），在控制台即可看到相关操作日志，开发者可以根据日志快速排查问题，提高效率。

3.3.7.2 微端调试模式

方法：wingplus.core.setDebugMode(boolean);
说明：开启/关闭微端的调试模式 （默认是关闭的）。
参数：boolean 是否为调试模式，true为调试模式，false非调试模式（默认）
返回结果：无

3.3.8.常量

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

3.3.8.1.事件常量

以下是SDK预定义事件。

事件对象：wingplus.track.WAEvent.WA_EVENT_TYPE

事件名称对应常量：

3.3.8.2.参数常量

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

参数常量：

3.3.8.3.第三方平台常量

参数对象：wingplus.track.WAEvent.TRACKING_CHANNEL

参数常量：

四.代码说明

4.1.登录类型对照表:

4.2.支付类型对照表:

4.3.状态码