一.简介

WING FB小游戏SDK主要是为满足Facebook Instant Game（以下称小游戏）需要，为此类游戏封装Facebook小游戏正常运行所需的功能。该SDK仅适用于Facebook小游戏。

二.Facebook小游戏概述

Facebook小游戏是Facebook近期推出的HTML5类型的即时游戏，这类游戏主要以体积小，启动快，可同时运行于Facebook页端，Facebook PC端和移动端Messenger，Gameroom等HTML5环境中。依赖于Facebook庞大的用户群体，小游戏有望迅速积累用户。

2.1 小游戏上架步骤

小游戏新手入门可以参照Facebook官方文档：https://developers.facebook.com/docs/games/instant-games
以下是小游戏快速上架简单步骤：

1)开发小游戏

对接小游戏SDK（也可以先使用Facebook官方提供的demo来做测试）。参考链接： https://developers.facebook.com/docs/games/instant-games/getting-started/quickstart 中的First steps with the SDK部分。

2)Facebook后台配置小游戏

在Facebook应用管理后台的‘+Add Product’->‘Instant Game’->‘Set Up’添加小游戏。填写该产品必填信息，如下图所示：

配置好Instant Games之后，还需要添加配置‘Web Hosting’，如下图：

参考链接：
https://developers.facebook.com/docs/games/instant-games/test-publish-share

3)测试游戏

配置好后便可以测试游戏了，测试游戏可以先在本地服务器运行，参考链接：
https://developers.facebook.com/docs/games/instant-games/test-publish-share
中的Testing the game from a local server部分。

本地测试完成后可以上传小游戏到Facebook后台进行托管，在上面提到的‘Web Hosting’中上传。小游戏上传成功后把状态改成‘production’，测试人员便可在Messenger，浏览器或者Gameroom中进行测试。

4)发布游戏

首先需要把‘App Review’中的‘Make xxx public’切换到‘Yes’,如下图所示。这样内部人员就可以做内部测试了。

在内部测试结束后便可提交Facebook审核上线了，如下图，提交的过程需要按照要求配置好相关信息。

三.SDK功能简介

WING FB小游戏SDK主要包括以下模块：

3.1. 玩家模块

用于获取玩家基本信息及设置获取储存的游戏数据。

3.2. 环境模块

用于邀请其他玩家、分享游戏信息及获取当前游戏唯一标志及切换到指定环境等功能。

3.3. 公共模块

用于获取玩家语言、平台、小游戏版本、设置游戏载入进度、开始游戏、设置玩家等级、 服务区服、游戏用户ID等功能。

3.4. 调试模式

开启调试模式我们将会打印所有SDK在运行过程中的LOG，方便在集成阶段检查。同时我们提供一个可视化的图标及页面，方便在手机端也能查看log日志。

四.集成WING FB小游戏SDK

4.1. 适用范围

该SDK适用于Facebook小游戏。Facebook小游戏可以运行于移动端messenger app、pc浏览器、Facebook Gameroom等环境中。

4.2. 如何集成

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

4.3. 接口说明

此章节结合Facebook小游戏SDK对接文档来看会更清晰：
https://developers.facebook.com/docs/games/instant-games/sdk/fbinstant5.0

注意：如无特别说明，本文档接口的回调方法中的对象形式如下：
{ code:成功或失败代码, message:相关提示消息, data:具体数据}；

如接口wing.fbinstant.initializeAsync({…});的成功回调函数结果对象如下：
{code:200, message: “success”, data:{…}}

4.3.1.初始化与登录

1.初始化

WING SDK在使用前需要设置初始化参数，初始化调用接口：
wing.init(config);

参数说明：

示例：
//初始化数据

2.登录接口(小游戏初始化)

WING 小游戏SDK只有一种登录方式，调用初始化接口之后必须调用登录接口才可以使用到跟玩家相关的接口。

Wing.fbinstant.initializeAsync({…});

参数说明：

示例

3调试

3.1 开发者调试模式
SDK提供了调试模式供开发者使用，具体打开方式如下：
示例：
//初始化数据

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

3.2 测试设备打开 LOG 日志
通过在WING SDK 管理后台 设置》测试设备 中添加设备ID 到测试设备列表，可打开LOG 日志。

4.3.2.玩家模块

1.获取玩家ID

获取fb小游戏玩家ID，接口如下所示：
wing.fbinstant.getPlayerID()
参数：无
示例：

2.获取获取玩家的唯一标识和签名

异步获取小游戏唯一标识和签名, 接口如下所示
wing.fbinstant.getSignedPlayerInfoAsync()

参数说明：

示例：

返回结果参数说明：

3.获取经本地化显示的玩家姓名

wing.fbinstant.getName()
参数说明：无
示例 ：

4.获取玩家公开头像的网址

wing.fbinstant.getPhoto()
参数说明：无
示例 ：

5.设置要保存到指定云存储的当前玩家的数据, 对于每个独立玩家，游戏最多可存储 1MB 的数据。

wing.fbinstant.setDataAsync()
参数说明：

示例：

返回结果参数说明：

6.从指定的云存储中检索当前玩家的数据

wing.fbinstant.getDataAsync()
参数说明：

示例：

返回结果参数说明：

7.设置要保存到指定云存储的当前玩家的统计数据

wing.fbinstant.setStatsAsync()
参数说明：

示例：

返回结果参数说明：

8.立即将玩家数据的任何更改刷新到指定的云存储中

wing.fbinstant.flushDataAsync()
参数说明：

示例：

返回结果参数说明：

9.保存到指定云存储的当前玩家的增量统计数据

wing.fbinstant.incrementStatsAsync()
参数说明：

示例：

返回结果参数说明：

10.从指定云存储检索当前玩家的统计数据

wing.fbinstant.getStatsAsync()
参数说明：

示例：

返回结果参数说明：

11.提取 ConnectedPlayer对象的数组，这些对象包含与当前玩家关联的玩家的信息

wing.fbinstant.getConnectedPlayersAsync()
参数说明：

示例：

返回结果参数说明：

4.3.3.环境模块

1.当前游戏环境的唯一标识

wing.fbinstant.getContextID()
参数说明：
无
示例：

2.当前游戏环境的类型

wing.fbinstant.getContextType()
参数说明：
无
示例：

3.确定加入当前游戏环境的玩家数量是否在给定的最小值和最大值之间

wing.fbinstant.isSizeBetween()
参数说明：

返回值：对象，有值时包含answer，minSize，maxSize属性，也可以为null，如上表说明和备注。

示例：

4.请求切换到指定环境（使用此接口可以在不同玩家环境中切换）

wing.fbinstant.switchAsync()
参数说明：

示例：

5.为玩家打开一个环境选择对话框, 邀请好友进行游戏

wing.fbinstant.chooseAsync()

参数说明：

示例：

6.尝试在指定玩家和当前玩家之间创建环境或切换环境

wing.fbinstant.createAsyncData()

参数说明：

示例：

7.获取#contextplayer 对象的数组，其中包含与当前环境相关的活跃玩家（在过去90天内玩过游戏的用户）的信息。这可能包含当前玩家。

Wing.fbinstant.getPlayersAsync()

参数说明：

示例：

4.3.4.公共模块

1.当前的语言设置

wing.fbinstant.getLocale()

参数说明：无
示例：

2.当前运行游戏的平台, 可能返回的值有：(“IOS” | “ANDROID” | “WEB” | “MOBILE_WEB”)

wing.fbinstant.getPlatform()

参数说明：无
示例：

3.报告游戏的初始加载进度(此函数Facebook要求调用，见本文后面的发布检查表)

wing.fbinstant.setLoadingProgress(value);

参数说明：value, 0~100
示例：

4.返回与启动游戏的入口点相关的任何数据对象（具体功能说明可参考Facebook官方对接文档）

wing.fbinstant.getEntryPointData()

参数说明：无
示例：

返回值示例：{“myReplayData”:”…”}

5.返回启动游戏的入口点（具体功能说明可参考Facebook官方对接文档）

wing.fbinstant.getEntryPointAsync()

参数说明：

示例：

6.为当前环境设置与单个游戏会话相关的数据

wing.fbinstant.setSessionData()

参数说明：

示例：

7.开始游戏，此接口应在初始化接口调用成功后尽早调用（表示游戏已完成初始加载， 并准备就绪可以开始游戏）

wing.fbinstant.startGameAsync()

参数说明：

示例：

8.分享

wing.fbinstant.shareAsync()

参数说明：

示例：

9.更新游戏内容（一般调用此接口后，Facebook会在Messenger中通知对应的玩家）

wing.fbinstant.updateAsync()
参数说明：

示例：

10.退出游戏

wing.fbinstant.quit()
参数说明：无
示例：

11.记录事件

wing.fbinstant.logEvent()
参数说明：

示例：

注1：调用该接口会将事件同时发往FACEBOOK及WING SDK
注2：小游戏内部集成了WING H5 SDK事件收集相关接口，如果需要使用，可以参考《WING H5 SDK使用指南》中公共参数设置及数据收集章节的相关内容。

12.设置发生暂停事件时将触发的回调

wing.fbinstant.onPause()
参数说明：

示例：

13.设置游戏用户id

wing.fbinstant.setGameUserId()

参数说明：

示例：

14.设置服务器id

wing.fbinstant.setServerId()

参数说明：

示例：

15.设置等级

wing.fbinstant.setLevel()

参数说明：

示例：

五.代码说明

本SDK接口调用状态码如下：

六.参考

Facebook小游戏说明文档：
https://developers.facebook.com/docs/games/instant-games

Facebook官方接口对接文档：
https://developers.facebook.com/docs/games/instant-games/sdk/fbinstant5.0

Facebook小游戏发布检查表：
https://developers.facebook.com/docs/games/instant-games/getting-started/launch-checklist