VIGOO广告接入文档

一 接入前须知

1.共同属性（BaseMsg）：每条消息都有的基础属性

参数	参数类型	最大长度	说明	必须
deviceId	String	50	根据本地缓存默认生成	Y
timestamp	String	40	动作产生的时间	Y
os	String	100	系统名：iOS、Android等	Y
clientIp	String	64	客户端IP	Y
deviceBrand	String	100	设备提供商： 小米、华为、三星、苹果	Y
deviceModel	String	100	设备型号：小米note、华为meta7 iphone 6 plus等	Y
deviceScreen	String	20	设备屏幕大小: 1024*920等	Y
imei	String	36	Android设备编号（android独有），如果取不到为空就OK	Y

2.角色信息（RoleInfo）

参数	参数类型	最大长度	说明	必须
channel	String	128	渠道ID	Y
channelDesc	String	128	渠道描述	Y
accountId	String	40	账号ID：平台的UID	Y
roleId	String	40	角色ID	Y
roleName	String	60	角色名	Y

二 接入HGSDK

以下所有接口都必须接入~

1.初始化
调用该函数初始化广告SDK，该函数需要在GameSDK.init()之后调用

HGSDK.init();

2.创建横幅广告
游戏调用该函数创建横幅广告，仅支持单个banner横幅创建

var banner=HGSDK.createBannerAd(adId,bannerAdId,position,BaseMsg,RoleInfo,GameId);

• 参数说明：

参数	含义	类型	是否为空	备注
adId	广告序号ID	String	非空	标识广告(游戏自定义)
bannerId	广告位ID	String	非空	广告位ID，需申请
position	广告位置	Int	非空	1、顶部；2、底部；
BaseMsg	共通属性	object	非空	参考接入须知
RoleInfo	角色信息	object	非空	参考接入须知
GameId	当前游戏ID	String	非空	CP游戏ID

3.监听横幅广告加载成功事件
游戏调用该函数注册回调函数，当加载广告成功时平台会通知游戏，游戏收到该回调后，在调用展示操作。

banner.onLoad (func());

• 方法说明

参数	含义	类型	是否为空	备注
func	横幅广告加载成功回调函数	function	非空	游戏定义回调函数

4.监听横幅广告加载失败事件
游戏调用该函数注册回调函数，当加载广告失败时函数会执行

banner.onError(func(param));

• 方法说明

参数	含义	类型	是否为空	备注
func	横幅广告加载失败回调函数	function	非空	游戏定义回调函数

• 参数说明

参数	含义	类型	是否为空	备注
param	广告加载失败	Json对象	非空	Json对象，见下文

• Param Json对象:

{
    adId,  // string 加载失败的广告Id
    errorCode//string 错误码
    //errorCode请查看本文最下方错误列表
}

5.展示横幅广告
横幅广告组件默认是隐藏的，调用广告实例的show函数展示横幅广告，banner广告显示操作的结果

建议在监听到横幅广告加载成功的回调函数中调用该函数。

banner.show(function(){
    console.log('banner 广告显示成功')
},function(err){
    console.log('banner 广告显示失败')
})

• 方法说明：

参数	含义	类型	是否为空	备注
function()	展示广告成功回调	function	否	游戏自定义该方法
function(err)	展示广告失败回调	function	否	游戏自定义该方法

6.隐藏横幅广告
调用广告实例的hide函数隐藏横幅广告

banner.hide();

7.销毁横幅广告
调用广告实例的destroy函数销毁横幅广告

banner.destroy();

8.创建插屏广告
调用该函数创建插屏广告，建议开发者提前创建的广告，这样展示广告的时候无需加载，体验上更好。

var interstitialAd = HGSDK.createInterstitialAd(adId，interstitialAdId, style,BaseMsg,RoleInfo,GameId)

参数	含义	类型	是否为空	备注
adId	广告序号ID	String	非空	标识广告(游戏自定义)
interstitialAdId	广告位ID	String	非空	插屏广告位ID，需申请
style	展示样式	Int	非空	1、全屏；2、半屏
BaseMsg	共通属性	object	非空	参考接入须知
RoleInfo	角色信息	object	非空	参考接入须知
GameId	当前游戏ID	String	非空	CP游戏ID

9.监听插屏广告加载成功事件
游戏调用该函数注册回调函数，当加载插屏广告成功时平台会通知游戏，游戏收到该回调后，在调用展示操作。

interstitialAd.onLoad(func());

• 方法说明

参数	含义	类型	是否为空	备注
func	插屏广告加载成功回调函数	function	非空	游戏定义回调函数

10.监听插屏广告加载失败事件
游戏调用该函数注册回调函数，当加载广告失败时函数会执行。如广告加载失败，确保游戏正常继续运行

interstitialAd.onError(func(param));

• 方法说明

参数	含义	类型	是否为空	备注
func	插屏广告加载失败回调函数	function	非空	游戏定义回调函数

• 参数说明

参数	含义	类型	是否为空	备注
param	广告加载失败	Json对象	非空	Json对象，见下文

• Param Json对象:

{
    adId,  // string 加载失败的广告Id
    errorCode//string 错误码
    //errorCode请查看本文最下方错误列表
}

11.展示插屏广告
调用广告实例的show函数展示插屏广告，返回广告显示操作的结果

建议在监听到插屏广告加载成功的回调函数中调用该函数。

interstitialAd.show(function(){
    console.log('banner 广告显示成功')
},function(err){
    console.log('banner 广告显示失败')
})

• 方法说明：

参数	含义	类型	是否为空	备注
function()	展示广告成功回调	function	否	游戏自定义该方法
function(err)	展示广告失败回调	function	否	游戏自定义该方法

12.隐藏插屏广告
调用广告实例的hide函数隐藏插屏广告

interstitialAd.hide();

13.销毁插屏广告
调用广告实例的destroy函数销毁插屏广告

interstitialAd.destroy();

14.创建视频广告
调用该函数创建视频广告，仅支持单个视频广告创建。建议开发者提前创建的广告，这样展示广告的时候无需加载，体验上更好。

var videoAd=HGSDK.createRewardedVideoAd(adId，videoAdId, screenOrientation,BaseMsg,RoleInfo,GameId);

参数	含义	类型	是否为空	备注
adId	广告序号ID	String	非空	标识广告(游戏自定义)
videoAdId	广告位ID	String	非空	视频广告位ID，需申请
screenOrientation	展示样式	Int	非空	1、横屏；2、竖屏
BaseMsg	共通属性	object	非空	参考接入须知
RoleInfo	角色信息	object	非空	参考接入须知
GameId	当前游戏ID	String	非空	CP游戏ID

15.监听视频广告加载成功事件
游戏调用该函数注册回调函数，当加载视频广告成功时平台会通知游戏，游戏收到该回调后，在调用展示操作。

videoAd.onLoad(func());

• 方法说明

参数	含义	类型	是否为空	备注
func	视频广告加载成功回调函数	function	非空	游戏定义回调函数

16.监听视频广告加载失败事件
游戏调用该函数注册回调函数，当加载广告失败时函数会执行。如广告加载失败，确保游戏正常继续运行

videoAd.onError(func(param));

• 方法说明

参数	含义	类型	是否为空	备注
func	视频广告加载失败回调函数	function	非空	游戏定义回调函数

• 参数说明

参数	含义	类型	是否为空	备注
param	广告加载失败	Json对象	非空	Json对象，见下文

• Param Json对象:

{
    adId,  // string 加载失败的广告Id
    errorCode//string 错误码
    //errorCode请查看本文最下方错误列表
}

17.展示视频广告（获得激励奖励）
调用广告实例的show函数展示视频广告，返回广告显示操作的结果

建议在监听到视频广告加载成功的回调函数中调用该函数。展示成功后建议销毁广告对象，重新创建新的广告对象

videoAd.show(function(){
    console.log('banner 广告显示成功')
},function(err){
    console.log('banner 广告显示失败')
})

• 方法说明：

参数	含义	类型	是否为空	备注
function()	展示广告成功回调	function	否	游戏自定义该方法
function(err)	展示广告失败回调	function	否	游戏自定义该方法

18.隐藏视频广告
调用广告实例的hide函数隐藏视频广告

videoAd.hide();

19.销毁视频广告
调用广告实例的destroy函数销毁视频广告

videoAd.destroy();

20.监听视频广告关闭按钮点击时间
关闭视频广告时该函数执行，该函数执行并不代表视频正常观看完。奖励应在展示成功回调中设置。

videoAd.onClose(func);

• 参数说明

参数	含义	类型	是否为空	备注
func	视频广告关闭时回调该函数	function	非空	游戏定义回调函数

21.游戏初始化上报
在游戏初始化时调用该函数

HGSDK.gameInitLog（BaseMsg,RoleInfo,GameId）

• 参数说明：

参数	含义	类型	是否为空	备注
BaseMsg	共通属性	object	非空	参考接入须知
RoleInfo	角色信息	object	非空	参考接入须知
GameId	当前游戏ID	String	非空	CP游戏ID

22.游戏登录上报
在游戏登录时调用该函数

HGSDK.gameLoginLog（BaseMsg,RoleInfo,GameId）

• 参数说明：

参数	含义	类型	是否为空	备注
BaseMsg	共通属性	object	非空	参考接入须知
RoleInfo	角色信息	object	非空	参考接入须知
GameId	当前游戏ID	String	非空	CP游戏ID

23.游戏加载完成上报
在游戏加载完成时调用该函数

HGSDK.gameLodLog（BaseMsg,RoleInfo,GameId）

• 参数说明：

参数	含义	类型	是否为空	备注
BaseMsg	共通属性	object	非空	参考接入须知
RoleInfo	角色信息	object	非空	参考接入须知
GameId	当前游戏ID	String	非空	CP游戏ID

24.游戏开始上报
在游戏开始时调用该函数

HGSDK.gameStartLog（BaseMsg,RoleInfo,GameId）

• 参数说明：

参数	含义	类型	是否为空	备注
BaseMsg	共通属性	object	非空	参考接入须知
RoleInfo	角色信息	object	非空	参考接入须知
GameId	当前游戏ID	String	非空	CP游戏ID