应用内广告
本 API 允许小游戏集成和管理应用内广告（奖励性视频广告），实现营收。
.createRewardedVideoAd(opts)
创建奖励性视频广告对象实例，供后续使用。
参数
- adUnitId：广告位的唯一标识符，在开发者门户中定义
示例
const rewardedVideoAd = TTMinis.game.createRewardedVideoAd({
adUnitId: 'xxx';
})rewardedVideoAd
奖励性视频广告对象。
方法 | 描述 | 上下文 |
.show() | 向用户展示已加载的奖励性视频广告。返回一个 Promise。 | 必须在游戏中用户期望获得奖励的合适间歇点调用。 |
.onClose(cb) | 监听器：注册在用户关闭广告时触发的回调函数。 | 回调会接收 result.isEnded: boolean，用于判断用户是否完整观看广告（从而获得奖励）。 |
.offClose(cb) | 取消关闭广告事件的监听器。 | 用于内存清理，防止内存泄漏或错误发放奖励。 |
.onError(cb) | 监听器：注册在广告加载或播放失败时触发的回调函数（例如由于网络问题或无可用库存时）。 | 用于优雅地处理错误，例如直接向用户发放奖励或提供其他替代操作。 |
.offError(cb) | 取消错误监听器。 | 用于清理。 |
.show()
向用户展示已加载的奖励性视频广告。返回一个 Promise。必须在游戏中用户期望获得奖励的合适间歇点调用。
参数
无
示例
const rewardedVideoAd = TTMinis.game.createRewardedVideoAd({
adUnitId: 'xxx';
});
rewardedVideoAd.show().then(() => {
console.log('Display video ad');
}).catch(() => {
console.log('Display video ad failed');
}).onClose(cb)
注册在用户关闭广告时触发的回调函数。回调会接收一个布尔值结果，用于判断用户是否完整观看广告（从而获得奖励）。
参数
- Callback：广告关闭时的回调函数
type Callback = (result: { isEnded: boolean }) => void示例
const rewardedVideoAd = TTMinis.game.createRewardedVideoAd({
adUnitId: 'xxx';
});
rewardedVideoAd.onClose(() => {
console.log('Rewarded video ad closed')
}).offClose(cb)
取消广告关闭事件的监听器。用于内存清理，防止内存泄漏或错误发放奖励。
参数
- Callback：广告关闭时的回调函数
type Callback = () => void示例
const rewardedVideoAd = TTMinis.game.createRewardedVideoAd({
adUnitId: 'xxx';
});
function listener() {
console.log('error emit')
}
rewardedVideoAd.onClose(listener);
// When not needed
rewardedVideoAd.offClose(listener);.onError(cb)
注册在广告拉取或播放失败时触发的回调函数（例如网络问题或无可用库存时）。用于优雅地处理错误，例如直接向用户发放奖励或提供其他替代操作。
参数
- Callback：广告拉取或播放失败时的回调
type Callback = () => void示例
const rewardedVideoAd = TTMinis.game.createRewardedVideoAd({
adUnitId: 'xxx';
});
function listener() {
console.log('error emit')
}
rewardedVideoAd.onError(listener);.offError(cb)
取消广告拉取或播放异常事件的监听器。用于清理。
参数
- Callback：广告拉取或播放错误的回调函数
type Callback = () => void示例
const rewardedVideoAd = TTMinis.game.createRewardedVideoAd({
adUnitId: 'xxx';
});
function listener() {
console.log('error emit')
}
rewardedVideoAd.onClose(listener);
// When not needed
rewardedVideoAd.offClose(listener);.createInterstitialAd
注意：此功能自 SDK 版本 0.3.0 起支持，低版本需进行兼容性处理。
创建插屏广告组件。
参数
adUnitId：(string) 广告位 ID
示例
const interstitialAd = TTMinis.game.createInterstitialAd({
adUnitId: 'xxx';
})interstitialAd
.show
展示插屏广告。
返回值
插屏广告展示操作的结果。
示例
const interstitialAd = TTMinis.game.createInterstitialAd({
adUnitId: 'xxx';
});
interstitialAd.show().then(() => {
console.log('Interstitial ad display');
}).catch(() => {
console.log('Interstitial ad display failed.');
}).onClose
监听插屏广告关闭事件，广告被关闭时触发。
参数
用户点击【关闭广告】按钮时的事件监听函数。
示例
const interstitialAd = TTMinis.game.createInterstitialAd({
adUnitId: 'xxx';
});
interstitialAd.onClose(() => {
console.log('The interstitial ad has been closed.)
}).offClose
移除用户点击【关闭广告】按钮时的事件监听函数。
参数
传递给 onClose 的监听函数。
示例
const interstitialAd = TTMinis.game.createInterstitialAd({
adUnitId: 'xxx';
});
function listener() {
console.log('error emit')
}
interstitialAd.onClose(listener);
// When it's not needed
interstitialAd.offClose(listener);.onError
监听插屏广告展示错误事件，插屏广告展示失败时触发。
参数
对象 res
字段 | 类型 | 描述 |
errMsg | String | 错误信息 |
errorCode | Number | 错误码 |
示例
const interstitialAd = TTMinis.game.createInterstitialAd({
adUnitId: 'xxx';
});
function listener() {
console.log('error emit')
}
interstitialAd.onError(listener);.offError
广告获取或播放出错时取消监听。
参数
传递给 onError 的监听函数。
示例
const interstitialAd = TTMinis.game.createInterstitialAd({
adUnitId: 'xxx';
});
function listener() {
console.log('error emit')
}
interstitialAd.onClose(listener);
// When it's not needed
interstitialAd.offClose(listener);错误码
创建广告 API
错误码 | 错误信息 |
11001 | 广告位 ID 为空，参数无效 |
20000 | 客户端请求后端失败 |
50000 | 系统错误 |
500 | 服务器系统内部错误 |
10001 | 广告位校验参数错误 |
20001 | 广告位不存在 |
20002 | 广告位与请求的 MinisID 不匹配 |
20003 | 广告位状态异常 |
20007 | 广告位类型错误 |
30001 | 同一广告位请求过于频繁 |
展示广告 API
错误码 | 子错误码 | 错误信息 |
10001 | -- | 传入的广告实例 ID 参数为空，属于无效参数 |
11002 | -- | 广告实例 ID 不匹配，未找到对应的广告实例 |
11003 | -- | 广告实例已被展示，无法重复使用 |
11004 | -- | 距离上次播放时间间隔不足，不允许展示插屏广告 |
11005 | -- | 已超出插屏广告播放次数限制，不允许展示插屏广告 |
30001 | -- | 用户点击退出，未完整观看（未获得奖励） |
50000 | -- | 系统错误 |
50101 | 客户端网络环境错误 | |
50102-50107 | 服务器错误 |