1. 描述

本模块将个小游戏平台的banner接口进行封装，方便游戏内调用统一接口展示banner广告

请注意

抖音平台（或称作字节）不允许游戏界面展示banner，如果游戏界面展示了banner会有审核被拒的风险，所以建议抖音平台仅在弹窗界面、结束界面等不直接影响用户游戏操作的页面展示banner。

展示位置

banner默认在屏幕底部并铺满屏幕宽展示；

另外SDK在showBanner接口提供了一个可选属性position.y控制banner的展示位置，主要有两个作用：

1. 微信小游戏可以动态调整banner可展示的最高点；调用接口后，banner将以该位置作为banner顶部进行展示；

2. （微信小游戏、抖音小游戏、快手小游戏均支持）banner是否可展示判断，当传入的位置在不同设备上计算出来的高度不满足banner可展示的最小高度时，SDK将不展示banner；

3. oppo、vivo小游戏 会根据传入的位置计算与屏幕底部的距离（即SDK日志输出的"转换之后的高度是xxx"），展示对应大小的banner:

   当转换后的高度 < 250, 展示最低banner；

   当 250 < 转换高度 < 503 时，展示中等高度banner；

   当转换高度 >= 503 时，展示高banner；

   注意：不同高度banner对应不同类型的广告id，只有配置了该类型id时才会做以上判断

   

banner刷新

SDK支持banner每间隔一定时间自动刷新，可通过广告后台参数自定义修改

2. 接入说明

2.1 展示banner

在需要展示banner的页面调用GameHelper.AdsFunc.showBanner()；

2.2 隐藏banner

当某个页面不需要banner时，调用GameHelper.AdsFunc.hideBanner()；

2.3 调整banner展示的位置或设置banner可展示的最高点

如果需要banner以游戏页面某个固定高度作为banner最高点时，可以在showBanner接口传入position.y，banner将紧贴该位置进行展示；

传入y坐标值时请注意以Canvas坐标系为锚点（即画面中心）；

如下图，传入第二条红色的line2的y坐标值（-450），banner将紧贴line2位置进行展示；

同时，在小屏设备上若line2离屏幕底部距离不足banner可展示的最小高度，banner将自动隐藏。

3. 接口索引

方法

GameHelper.AdsFunc.initBannerTop(y:number)

该接口的功能由GameHelper.AdsFunc.showBanner的position.y取代，游戏侧调用时可以直接调用showBanner接口传入y坐标，无需再调用本接口

说明

设置banner可展示的最高处的y坐标 （微信小游戏将以该坐标作为banner的顶部进行展示）

参数

参数	类型	默认值	是否必填	说明
y	number	/	是	banner可展示的最高点的y坐标（Canvas坐标系下）

示例

GameHelper.AdsFunc.initBannerTop(-450);

GameHelper.AdsFunc.showBanner(opts)

说明

展示banner，不传入position参数时banner将默认展示在屏幕底部

参数

参数	类型	默认值	是否必填	说明
position		/	否	banner可展示的最高点的y坐标（Canvas坐标系下）
verticalAlign	string	/	否	仅app端生效, 可传入 :'top' | 'bottom'
clickCallback	() =>void	/	否	仅app端生效的参数，广告点击回调

示例

GameHelper.AdsFunc.showBanner();  // banner默认展示在屏幕底部

GameHelper.AdsFunc.showBanner({
    position: {
        y: -500,
    }
});

GameHelper.AdsFunc.hideBanner()

说明

隐藏banner

参数

无

示例

GameHelper.AdsFunc.hideBanner();