开发
分发
推广与变现
联系我们
搜索
文档
管理中心
通知
开发指南更新时间：2025-08-07 16:15:01

温馨提示：此指南主要面向针对小米进行快游戏的开发者，开发者如果是面向快游戏联盟（小米、oppo、vivo、荣耀）平台进行开发，可以跳转联盟链接查看相关内容。小米和微信主要在GAME逻辑上有区别，开发者可以针对小米小游戏的Adapter层和API进行适配。

1.开发指南

  • 目录结构：

工程目录 | 小米澎湃OS开发者平台
manifest说明 | 小米澎湃OS开发者平台

2.游戏引擎

cocos&egret&laya
Unity引擎支持 | 小米澎湃OS开发者平台

3.开放能力

  • 广告变现
    • 分广告类型接入方法

快游戏开发者需仔细参照广告接入文档的“广告API文档”部分内容，根据方法说明和代码示例，在快游戏包体中添加、调用对应的api，以接入所需的广告类型。快游戏广告API接入文档 | 小米澎湃OS开发者平台
注意：米盟SDK已经集成在快游戏框架之中，用于支持快游戏开发者广告变现。因此，快游戏接入米盟广告变现，无需额外集成广告SDK，可直接调用广告接入文档中提供的API，即可接入广告变现能力。
下面列举不同广告类型的主要api和接入要点，详尽的信息请查阅广告接入文档。每种广告类型对应若干具体的广告样式及素材类型，例如插屏广告分为全屏插屏样式、半屏插屏样式，素材分为图文、视频；具体样式和素材类型可以在米盟SSP平台创建广告位时根据需要进行选择。

广告类型主要api、回调接入要点
横幅广告/banner广告1、创建横幅广告组件
bannerAd qg.createBannerAd(Object object)

2、展示横幅广告
bannerAd.show()

3、隐藏横幅广告
bannerAd.hide()

4、销毁横幅广告
bannerAd.destroy()

5、横幅广告错误事件回调 bannerAd.onError(function callback)

6、横幅广告加载事件回调 bannerAd.onLoad(function callback)

7、横幅广告关闭事件回调 bannerAd.onClose(function callback)

8、横幅广告组件被缩放回调 bannerAd.onResize(function callback)

9、取消广告组件被缩放回调 bannerAd.offResize(function callback)

10、横幅广告点击事件回调 bannerAd.onClick(function callback)

11、移除横幅广告点击回调 bannerAd.offClick(function callback) 		- adUnitId：即开发者在SSP平台创建的广告位，必须传入的关键参数。

- 广告组件被创建时会根据传入的adUnitId自动请求广告。

- 广告展示：
1、广告组件即容纳广告内容、素材的容器，广告组件的宽高尺寸通过style属性进行设置。
2、广告内容为了保证展示效果有推荐的宽高比。开发者应该通过调试设置合理的广告组件宽高值，以正确容纳广告内容，保障广告展示效果。
3、在不同分辨率的机型上，广告展示会有差异，开发者设置广告组件尺寸时，需注意分辨率、px/dp等单位差异。
4、展示失败在onError中回调
插屏广告1、创建插屏广告组件
interstitialAd qg.createInterstitialAd(Object object)

2、展示插屏广告
interstitialAd.show()

3、销毁插屏广告
interstitialAd.destroy()

4、插屏广告错误事件回调 interstitialAd.onError(function callback)

5、插屏广告加载事件回调 interstitialAd.onLoad(function callback)

6、插屏广告关闭事件回调 interstitialAd.onClose(function callback)

7、插屏广告点击事件回调 interstitialAd.onClick(function callback)

8、移除插屏广告点击回调 interstitialAd.offClick(function callback)		- 广告组件被创建时会根据传入的adUnitId自动请求广告。

- 插屏广告仅需传入adUnitId，无需设置广告组件的宽高尺寸。

- 展示失败在onError中回调
激励视频广告1、创建激励视频广告组件
rewardedVideoAd qg.createRewardedVideoAd(Object object)

2、加载激励视频广告
rewardedVideoAd.load()

3、展示激励视频广告
rewardedVideoAd.show()

4、激励视频广告加载事件回调 rewardedVideoAd.onLoad(function callback)

5、激励视频广告关闭事件回调 rewardedVideoAd.onClose(function callback)

6、激励视频广告错误事件回调 rewardedVideoAd.onError(function callback)

7、激励视频广告点击事件回调 rewardedVideoAd.onClick(function callback)

8、移除激励视频广告点击回调 rewardedVideoAd.offClick(function callback)		- 激励视频广告组件展示层级最高，不能跨页面使用。

- 激励视频广告需通过load方法加载广告。

- 展示失败在onError中回调
激励广告1、创建激励广告组件
rewardedVideoAd qg.createRewardedVideoAd(Object object)

2、加载激励广告
rewardedVideoAd.load()

3、展示激励广告
rewardedVideoAd.show()

4、激励广告加载事件回调 rewardedVideoAd.onLoad(function callback)

5、激励广告关闭事件回调 rewardedVideoAd.onClose(function callback)

6、激励广告错误事件回调 rewardedVideoAd.onError(function callback)

7、激励广告点击事件回调 rewardedVideoAd.onClick(function callback)

8、移除激励广告点击回调 rewardedVideoAd.offClick(function callback)		- 激励广告api和激励视频广告api基本一致，但使用激励广告样式，需要在SSP后台重新创建对应的upid，无法直接复用激励视频广告的upid

- 激励广告样式仅在快框架1307及以上版本支持，开发者需进行适配，低于1307版本，使用激励视频样式，1307版本及以上，可以使用激励广告样式
原生模板广告1、创建原生模板广告组件
customAd qg.createCustomAd(Object object)

2、展示原生模板广告
customAd.show()

3、隐藏原生模板广告
customAd.hide()

4、销毁原生模板广告
customAd.destroy()

5、原生模板广告展示事件回调 customAd.onShow(function callback)

6、移除原生模板广告展示回调 customAd.offShow(function callback)

7、原生模板广告错误事件回调 customAd.onError(function callback)

8、移除原生模板广告错误回调 customAd.offError(function callback)

9、原生模板广告加载事件回调 customAd.onLoad(function callback)

10、移除原生模板广告加载回调 customAd.offLoad(function callback)

11、原生模板广告关闭事件回调 customAd.onClose(function callback)

12、移除原生模板广告关闭回调 customAd.offClose(function callback)

13、原生模板广告点击事件回调 customAd.onClick(Function callback)

14、移除原生模板广告点击回调 customAd.offClick(Function callback)		- 广告组件被创建时会根据传入的adUnitId自动请求广告

- 广告展示：
1、原生模板广告需要通过style属性设置广告组件的宽高尺寸。
2、建议充分调试广告组件的宽高值，特别是在不同分辨率机型上的取值，以尽可能保障上线后的广告展示效果，确保用户体验的同时提升变现效率。
3、展示失败在onShow中回调
开屏广告目前支持系统开屏广告，无需开发者主动调用- 在米盟SSP平台创建系统开屏广告位后，选择“启用”即可，无需api调用或其他配置，系统开屏广告会自动请求、展示

  • 数据管理

快游戏数据服务使用说明 | 小米澎湃OS开发者平台
米盟离线数据报表API接入说明 | 小米澎湃OS开发者平台
米盟分小时数据报表API接入说明 | 小米澎湃OS开发者平台

文档内容是否有帮助？
有帮助
无帮助