JSSDK API 文档

Step1: 引入JSSDK文件

<script type="text/javascript" src="https://h.cdn.pengpengla.com/up/opengamejs/1.3.1/assets/seed.js"></script>

Step2: JSSDK初始化

在使用openSdk提供的相关api之前必须要先调用openSdk.init方法进行初始化；

openSdk.init(Object object)

参数

Object object

参数名称 是否必须 默认值 描述
env 否 pro 当前运行环境。stage表示测试环境，pro表示生成环境
client_id 是 第三方应用的唯一标识
game_id 是 第三方应用中产品的唯一表示
mode 是 代表当前游戏模式，两个可选值，分别为diamond/gold/ad

例如 

openSdk.init({
    env: 'stage', 
    client_id: 'CLIENT_ID',
    game_id: 'GAME_ID',
    mode: 'diamond'  
});

Step3: API说明

openSdk.oauth(Object object)

当前用户的登录凭证过期时重新发起登录授权，授权成功后重新回到游戏页时，游戏地址上会增加code参数作为新的登录凭证。

参数

Object object

参数名称 是否必须 描述
redirect_url 是 授权后游戏的回调地址，通常直接传入当前游戏页面地址

例如 

openSdk.oauth({
    redirect_url: 'http://xxxx/index.html'
});

openSdk.recharge(Object object)

程序内使用充值功能，将唤起充值界面，进行充值

参数

Object object

参数名称 是否必须 描述
upliveCode 是 充值用户的up号
countryCode 是 国家码，使用ipay充值的充值渠道。目前对应的充值渠道：tw:mycard；id:codapay；in:paytm；其它:PayPal
lang 是 语言码。从游戏大厅进入游戏时URl上会携带相应的语言码, _lang=en-US
success 否 充值成功返回第三方应用的回调函数
fail 否 充值失败返回第三方应用的回调函数
cancel 否 取消充值的回调函数

例如 

openSdk.recharge({
    upliveCode: 'funpepper',
    countryCode: 'TW',
    lang: 'zh-CN',
    success: function(){
    	// success
    },
    fail: function(){
    	// fail
    },
    cancel: function(){
    	// cancel
    }
});

openSdk.ping(Object object)

*必须调用

用户登录上报（进入一款游戏时调用，用于统计游戏PV、UV）

参数

Object object

参数名称 是否必须 描述
success 否 上报成功的回调
open_id 是 用户在三方游戏中唯一的身份标识

例如 

openSdk.ping({
	open_id: 'OPEN_ID',
	success: function(){
		// ping success
	}
});

openSdk.quitGame()

退出游戏，返回游戏大厅

例如 

openSdk.quitGame();

openSdk.receiveGold(object object)

*必须调用
  • 游戏在金币模式下，每次进入游戏时，调用此方法，用以判定是否赠送用户免费金币。
  • 每个用户每天只有一次领取免费金币的机会

游戏在U钻模式下，不必调用此方法。

参数

Object object

参数名称 是否必须 描述
open_id 是 平台用户在游戏中的open_id
getGoldSuccess 是 领取免费金币成功的回调函数，游戏通常要在回调中刷新用户的金币余额

例如 

openSdk.receiveGold({
	open_id: 'OPEN_ID',
	getGoldSuccess: function(){
		// success
	}
});

openSdk.rechargeGold()

游戏在金币模式下跳转到金币充值页面，进行金币充值

例如 

openSdk.rechargeGold();

openSdk.showLandingVideo(object object)

展示游戏LandingPage页面，页面内容包含游戏简介以及视频广告。

参数

Object object

参数名称 是否必须 描述
start 是 点击“开始游戏”按钮触发的回调

例如 

openSdk.ads.showLandingVideo({
    start: function() {
        alert('点击进入游戏');
    }
});

openSdk.showRewardVideo(object object)

视频广告 - 奖励视频。广告允许开发者鼓励用户完成视频，以便SDK触发奖励条件。当用户完成激励视频的浏览任务时，SDK将触发“成功”方法告诉 开发商发送相应的奖励
参数

Object object

参数名称 是否必须 描述
open_id 是 平台用户在游戏中的open_id
success 是 当用户完成激励视频的浏览任务时，SDK将触发“success”方法告诉开发者发送相应的激励
close 是 广告关闭时的回调。当用户未观看完视频就关闭时，回传的值为false，当用户看完视频并在介绍页中点击关闭按钮时，回传的值为true
error 是 广告获取失败回调。没有可展示的广告内容或其他异常导致无法展示

例如 

openSdk.ads.showRewardVideo({
    open_id: 'OPEN_ID',
    success: function() {
        alert('激励广告观看成功，游戏服务器端可以给予用户对应的虚拟奖励')
    },
    close: function(status){
        if (status) {
            alert('激励广告观看成功之后关闭');
        } else {
            alert('激励广告未观看完就关闭');
        }
    },
    error: function() {
        alert('激励广告加载失败');
    }
});

Step4: v1.2.2 - v1.2.3升级指南

金币版

receiver方法在新的金币版本中被移除

新的金币版本将移除掉openSdk.receiver(Number)方法。

新增金币充值方法

新的金币版本增加openSdk.rechargeGold()方法，用来进行金币充值

领取金币接口修改

  • 新的金币版本中领取金币方法由原来的openSdk.getGold(object object)修改为openSdk.receiveGold(object object)
  • openSdk.receiveGold(object object)在每次进入游戏时调用

U钻版

U钻版较之前没有改变，开发者在接入U钻版游戏时仍可继续使用sdk v1.2.2版本

Step5: v1.2 - v1.3.0升级指南

新增邀请好友方法

新的版本增加openSdk.inviteFriendsPlayGame()方法，用来进行邀请好友，分享给好友

参数

Object object

参数名称 是否必须 描述
direction 是 0：底部，1：左侧底部（镜像） 2: 右侧底部（镜像）
gameId 是 游戏标识，客户端会用次字段做1小时分享一次的限制 ，限制维度是（相同的游戏对相同的人做1小时限制）
gameIcon 是 游戏图标url地址
inviteGameUrl 是 分享游戏的访问地址
titleList 是 邀请标题
contentList 是 描述介绍
highlightContentList 是 高亮内容部分
jsCallback 是 协议回调方法

例如 

openSdk.inviteFriendsPlayGame({
    direction: 0,
    gameId: 103,
    gameIcon,
    inviteGameUrl,
    titleList: {"en-US":"邀请标题",....},
    contentList: {"en-US":"描述介绍",....},
    highlightContentList: {"en-US":"高亮内容部分",....},
    jsCallback,
])