描述

本模块将各小游戏平台的插屏接口进行封装，方便游戏层调用统一的接口展示插屏。

事件名	是否支持	上报时机
insert_all	是	游戏内调用插屏展示接口或者触发了前台插屏时会上报
insert_select	是	调用插屏后插屏加载成功后会上报
insert_show	是	插屏成功展示时上报

接入说明

本模块主要提供两个功能

• 插屏展示接口GameHelper.AdsFunc.showInsert

• 切换到前台插屏的监听接口GameHelper.AdsFunc.onHomeInsert：调用后，当游戏内发生切换前台行为时将会触发插屏展示逻辑

研发自测

微信 字节

微信、字节平台可筛选关键字“---广告配置---”或者“插屏”；

若没有上面的这些日志，请联系发布方检查是否配置了插屏推广位；

若以上日志正常打印，筛选关键字“[---广告ID的Log---]”

调用展示插屏接口后若创建失败可以在该字段后显示创建失败返回的具体信息

快手

先检查初始化阶段是否有“插屏广告初始化失败，请检查gameConfig.json文件内是否配置insertId，若无请联系发布方提供”的日志，若有日志请按照提示排查。

插屏创建失败时会有“[插屏] 触发插屏错误监听”的日志，可以找到平台返回的创建失败的错误信息；

接口索引

方法

说明

调用后会立即请求展示插屏

参数	类型	默认值	是否必填	说明
opt	insertParams	/	否	插屏调用回调

insertParams

参数	类型	默认值	是否必填	说明
show	(res) => {}	/	否	插屏展示时执行，会返回当前使用的广告ID
error	function	/	否	插屏获取失败时执行的回调
close	function	/	否	插屏被关闭时执行

示例

GameHelper.AdsFunc.showInsert({
    show: (res) => {
        console.log("插屏成功展示", res.id);
    },
    error: () => {
        console.log("插屏展示失败回调");
    },
    close: () => {
        console.log("插屏的关闭回调");
    }
})

说明

注册插屏监听，调用后SDK会监听用户切换前台行为，并在用户触发切换前台时调用插屏展示接口

参数

无

示例

GameHelper.AdsFunc.onHomeInsert();

说明

设置插屏是否可展示，当传入false时，会将插屏设置为不可展示状态，此时切换切换前台插屏将失效，游戏内调用GameHelper.AdsFunc.showInsert接口都会无效；设置为true后，插屏恢复展示

参数

Boolean值

示例

// 设置插屏不可展示
GameHelper.AdsFunc.setInsertAdVisible(false);

// 设置插屏可展示
GameHelper.AdsFunc.setInsertAdVisible(true);