Bidding Android iOS 快应用 SDK H5 SDK Media API 常见问题

开屏广告

开屏广告接入方式参考下方内容。

开屏广告

开屏广告简介

开屏广告以快应用启动作为曝光时机,提供5s的可感知广告展示。用户可以点击广告跳转到目标页面;或者点击右上角的“跳过”按钮,跳转到指定页面。

权限等级:开放

适用场景:开屏广告会在您的应用开启时加载,拥有固定展示时间(一般为5秒),展示完毕后自动关闭并进入您的指定的页面。

分类:开屏只有全屏样式,为你带来更加沉浸的广告播放体验和更佳的变现效果。

全屏

主要API

广告构造方法

方法名 方法介绍
createSplashAd(params:object) 广告构造方法,调用该方法,传入 params 参数,创建 SplashAd 实例

createSplashAd params参数如下表所示:

字段名 类型 是否必填 默认值 说明
placementId string true - 广告位ID
recommendation number - 是否关闭广告个性化推荐
赋值不等于1: 开启推荐;
赋值等于1: 关闭推荐;
entry string false - 广告结束后的跳转路由(uri):
如果设置了该参数,则在开屏广告结束后,则跳转至该地址页面;
如果未设置该参数,则开屏广告结束后,从广告播放页返回到上一个页面(当前页:广告请求页);

广告实例方法

方法名 说明
load() 加载广告
show() 广告加载成功后展示广告
isValid() 获取广告ecpm,单位:分
getECPM() 展示广告前判断广告是否有效
destroy() 销毁广告实例,释放内存

广告回调方法

方法名 说明
onLoad(function callback) 监听广告加载
offLoad(function callback) 取消广告加载监听
onError(function callback) 监听广告异常
offError(function callback) 取消广告异常监听
onExpose(function callback) 监听广告曝光成功
offExpose(function callback) 取消广告曝光监听
onClick(function callback) 监听广告点击
offClick(function callback) 取消广告点击监听
onClose(function callback) 监听广告关闭
offClose(function callback) 取消广告关闭监听

注意事项

接入代码示例

1.拷贝SDKDemo中的开屏广告页面至项目中

打开 SDKDemo,将 src/YlhAds/SplashAd 文件夹拷贝至你的快应用项目中 src/YlhAds/SplashAd 位置;

2s.配置 manifest.json 中页面的 router 和 display 信息

"router": {
    "pages": {
      "YlhAds/SplashAd": { // 开屏广告路由
        "component": "index"
      }
    }
  },
  "display": {
    "pages": {
      "YlhAds/SplashAd": {// 开屏广告页面配置
        "fullScreen": true,
        "titleBar": false,
        "statusBarImmersive": true,
        "menu": false,
        "menuBarData": {
          "menuBar": false
        }
      }
    }
  }

3.实例化广告

export default {
  onLoadSplashAd() {
    this.$app.$def.ylh_sdk.onYlhReady(() => {
      try {
        // 第一步:创建开屏广告实例
        this.splashAd = this.$app.$def.ylh_sdk.createSplashAd({
          placementId: this.placementId, // 广告位ID
          // 1、若设置了该参数,则在开屏广告结束后跳转则跳转至该地址页面;
          // 2、如果未设置该参数,则开屏广告结束后,从广告播放页返回到当前页;开发者可在onClose中自行处理跳转逻辑
          entry: '/pages/Home'
        });
        // 第二步:设置广告实例相应的回调
        this.splashAd.onLoad(() => {
           // 广告数据加载成功回调
           // 第四步:自动展示广告
           // 注意:如果加载广告成功后,没有立即展示广告,请在调用 show 之前方法先调用 isValid 方法判断广告是否过期
           this.splashAd.show()
        });
        this.splashAd.onError((err = {}) => {
          // 广告异常回调
        });
        this.splashAd.onExpose((id) => {
          // 广告曝光回调
        });
        this.splashAd.onClick(() => {
          // 广告点击回调
        });
        this.splashAd.onClose(() => {
          // 广告关闭回调
        });
        // 第三步:load 广告数据
        this.splashAd.load();
      } catch (error) {
        console.warn('创建开屏异常:', error);
      }
    })
  },
  onShowSplashAd() {
    if(this.splashAd) {
      this.splashAd.show();
    }
  },
  onDestroySplashAd() {
    if(this.splashAd) {
      this.splashAd.destroy();
      this.splashAd = null;
    }
  }
}

 文档反馈

腾讯公司 版权所有