一、广告开发者接入准备

1、小游戏开发者站创建小游戏

• 小游戏开发者站使用说明：https://dev.mi.com/xiaomihyperos/documentation/detail?pId=1454

2、米盟SSP后台创建广告位

• 登录米盟SSP后台(ssp.xiaomi.com)，注意：登录SSP后台的小米账号，需要与上面小游戏开发者站使用的账号一致，否则会无法找到对应小游戏
• 找到对应的小游戏并点击“启用”，注意：不启用应用不可创建广告位

• 在“我的广告位”中点击“新的广告位”开始创建广告位

• 在“所属应用”中选择需要创建广告位的小游戏

• 选择要创建的广告位并点击“保存”

• 保存后点击“启用”，启用广告位后，广告位才可正常下发广告，注意：此处的广告位ID为后续接入中用到的adUnitId

3、米盟SSP后台应用状态说明

当您创建小游戏后，米盟应用列表即会显示该小游戏的信息，应用状态包括：
未启用：该应用未启用流量变现功能，您可点击“立即启用”。
未通过审核：该应用没有通过应用商店的审核或者在审核中，米盟不会向该应用返回真实广告（点击广告不计费），开发者可以点击“应用详情”先创建广告位并接入调试，待审核通过后登陆米盟再开启广告位即可拉取到正式计费的广告。
运行中：该应用已经通过应用商店的审核，可以正常接收米盟广告。

4、广告调试

请参见：https://dev.mi.com/xiaomihyperos/documentation/detail?pId=1757

5、广告结算相关

整体结算流程同APK游戏，详见指引文档中“分成结算”相关内容

二、广告API文档

1、横幅广告

• bannerAd qg.createBannerAd(Object object)

创建横幅广告组件

参数Object object：

代码示例：

let bannerAd =qg.createBannerAd({

    adUnitId: 'xxx',

    style:{

        left:0,

        top: 800,

        width:1080

    }

})

• style的结构

返回值：bannerAd（横幅广告组件）

• bannerAd.style

横幅广告组件的尺寸会根据开发者设置的宽度，即 style.width 进行等比缩放，缩放的范围是designWidth * 50%到屏幕宽度。开发者在创建 BannerAd 时设置宽高，也可以在创建后设置，

如：

 bannerAd.style.width = 1000

当 style.width 小于 designWidth * 50% 时，会取作 designWidth * 50%。

当 style.width 大于屏幕宽度时，会取作屏幕宽度。 在组件内部会以此值为基准，根据 Banner 广告的标准尺寸，进行缩放。

每当缩放发生且缩放后的尺寸不同时，通过 BannerAd.onResize() 注册的回调函数就会执行。回调函数的参数是一个包含 BannerAd 缩放后的宽和高的对象。BannerAd 的 style.realWidth 和style.realHeight 到经过缩放后的宽和高。

bannerAd.onResize(res => {

    console.log(res.width, res.height)

    console.log(bannerAd.style.realWidth, bannerAd.style.realHeight)

})

横幅广告不设置位置，默认在屏幕底部。

• bannerAd.show()

展示横幅广告，出错的时候回调 onError，分为加载和展示两个阶段，加载成功回调onLoad

• bannerAd.hide()

隐藏横幅广告

• bannerAd.destroy()

销毁横幅广告

• bannerAd.onError(function callback)

监听横幅广告错误事件

代码示例：

bannerAd.onError((err)=>{

    console.log(err)

})

err:Object错误参数，其他广告类型相同

• bannerAd.onLoad(function callback)

监听横幅广告加载事件，callback无返回值

• bannerAd.onClose(function callback)

监听横幅广告关闭事件

• bannerAd.onResize(function callback)

监听横幅广告尺寸变化事件

Banner广告尺寸会根据开发者设置的宽度进行等比缩放，缩放的范围是 300 到 屏幕宽度，

事件的返回参数中包含真实的宽、高，若宽高不符合需求，可以动态的通过style.width设置改变广告的大小。

注意：如果在 onResize 的回调函数中重设 width 且总是与上一次缩放后的 width 不同，那么可能会导致 onResize 的回调函数一直触发，卡死在 onResize 的回调函数中。

参数：function callback（横幅广告尺寸变化事件的回调函数）

回调参数 Object res：

• bannerAd.offResize(function callback)

取消监听banner广告尺寸变化事件，callback同onResize的callback一致

• bannerAd.onClick(function callback) 1300+

监听横幅广告点击事件

• bannerAd.offClick(function callback) 1300+

移除横幅广告点击回调

2、插屏广告

interstitialAd qg.createInterstitialAd(Object object)

创建插屏广告组件，同一个 adUnitId，如果已经创建，并且未 destroy，会复用之前的对象，创建后会加载广告素材，素材创建后会自动拉取

参数 Object object：

代码示例：

let interstitialAd =qg.createInterstitialAd({

  adUnitId: 'xxx'

})

返回值：interstitialAd插屏广告组件

• interstitialAd.show()

展示插屏广告，插屏广告组件默认是隐藏的，调用 show 方法展示广告

• interstitialAd.destroy()

销毁插屏广告组件

• interstitialAd.onLoad(function callback)

监听视频广告加载事件，callback无返回值

代码示例：

interstitialAd.onLoad(()=> {

  console.log("插屏广告加载成功");

  interstitialAd.show();

})

• interstitialAd.onClose(function callback)

监听插屏广告关闭事件，callback无返回值

• interstitialAd.onError(function callback)

监听插屏广告错误事件

代码示例：

interstitialAd.onError((err)=> {

  console.log(err);

})

• callback回调函数的参数 Object res

• interstitialAd.onClick(function callback) 1300+

监听插屏广告点击事件

• interstitialAd.offClick(function callback) 1300+

移除插屏广告点击回调

3、激励视频广告

激励视频广告组件是由客户端原生的图片、文本、视频控件组成的，层级最高，会覆盖在普通组件上，该方法返回的是一个单例，该实例仅对当前页面有效，不允许跨页面使用。

• rewardedVideoAd qg.createRewardedVideoAd(Object object)

参数Object object：

代码示例：

let rewardedVideoAd = ad.createRewardedVideoAd({

    adUnitId: 'xxx'

})

返回值:rewardedVideoAd（激励视频广告组件）

• rewardedVideoAd.load()

加载激励视频广告

• rewardedVideoAd.show()

展示激励视频广告，激励视频广告将从屏幕下方推入（请勿在onLoad回调中调用show()）

• rewardedVideoAd.onLoad(function callback)

监听激励视频广告加载事件，callback无返回值

• rewardedVideoAd.onClose(function callback)

监听用户点击“关闭按钮”按钮的事件

参数：function callback

• rewardedVideoAd.onError(function callback)

监听激励视频错误事件

参数：function callback（激励视频错误事件的回调函数）

• callback回调函数的参数 Object res

• rewardedVideoAd.onClick(function callback) 1300+

监听激励视频广告点击事件

• rewardedVideoAd.offClick(function callback) 1300+

移除激励视频广告点击回调

4、原生模板（最小支持引擎版本1110+）

versionCode >= 11100001

• customAd qg.createCustomAd(Object object)

创建模板广告组件
参数Object object：

代码示例：

let customAd =qg.createCustomAd({
    adUnitId: 'xxx',
    style:{
        left:0,
        top: 800,
        width:1080
    }
})

• style的结构：

返回值：CustomAd（模板广告组件）

• customAd.style

模板广告组件的尺寸会根据开发者设置的宽度和高度进行展示。开发者在创建 CustomAd时设置宽高，也可以在创建后设置，
如：

 customAd.style.width = 1000

当 style.width 大于屏幕宽度时，会取作屏幕宽度。
模板广告不设置位置，默认在屏幕底部。

• customAd.show()

展示模板广告，出错的时候回调 onError，分为加载和展示两个阶段，加载成功回调onLoad

• customAd.hide()

模板横幅广告

• customAd.destroy()

销毁模板广告

• customAd.onShow(function callback) | offShow 解除监听

监听模板广告展示事件

• customAd.onError(function callback) | offError 解除监听

监听模板广告错误事件
代码示例：

customAd.onError((err)=>{
    console.log(err)
})

err:Object错误参数，其他广告类型相同

• customAd.onLoad(function callback) | offLoad 解除监听

监听模板广告加载事件，callback无返回值

• customAd.onClose(function callback) | offClose解除监听

监听模板广告关闭事件

• customAd.onClick(Function callback) | offClick 解除监听 1300+

监听模版广告点击事件

5、开屏广告

直接启用系统开屏即可

6、互推盒子广告

详见接入文档

7、常见错误码

错误码是通过onError获取到的错误信息，errCode返回值如下表：

注：以下说明中仅包含客户端错误码说明及对应调优建议，请您前往米盟后台-填充率诊断模块查看服务端错误码说明及对应调优建议（https://dev.mi.com/xiaomihyperos/documentation/detail?pId=2012）。

更多错误码详见：https://dev.mi.com/xiaomihyperos/documentation/detail?pId=1472

三、广告变现指南

https://dev.mi.com/xiaomihyperos/documentation/detail?pId=1459

四、广告接入规范

互推盒子广告规范：https://dev.mi.com/xiaomihyperos/documentation/detail?pId=1119

其他广告规范：https://dev.mi.com/xiaomihyperos/documentation/detail?pId=1460