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

激励视频广告

激励视频广告接入方式参考下方内容。

激励视频广告

激励视频广告简介

激励视频广告是指将短视频融入到快应用场景中,成为快应用“任务”之一,用户观看短视频后可以得到一些应用内奖励;

权限等级:开放

适用场景:常见于游戏内的广告样式,多出现在游戏的复活、登录等位置,或者网服类快应用的一些增值服务场景。建议开发者在分析媒体属性和功能的基础上,判断是否嵌入。

分类:激励视频广告样式只有竖版样式。

全屏

主要API

广告构造方法

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

createRewardVideoAd params参数如下表所示:

字段名 类型 是否必填 默认值 说明
placementId string true - 广告位ID
muted boolean false false 视频是否静音播放;
recommendation number - 是否关闭广告个性化推荐
赋值不等于1: 开启推荐;
赋值等于1: 关闭推荐;

广告实例方法

方法名 说明
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/RewardVideoAd 文件夹拷贝至你的快应用项目中 src/YlhAds/RewardVideoAd 位置;

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

"router": {
    "pages": {
      "YlhAds/RewardVideoAd": { // 激励视频广告路由
        "component": "index"
      }
    }
  },
  "display": {
    "pages": {
      "YlhAds/RewardVideoAd": {  // 激励视频广告页面配置
        "fullScreen": true,
        "titleBar": false,
        "statusBarImmersive": true,
        "menu": false,
        "menuBarData": {
          "menuBar": false
        }
      }
    }
  }

3.实例化广告

export default {
  onLoadRewardVideoAd() {
    this.$app.$def.ylh_sdk.onYlhReady(() => {
      try {
        // 第一步:创建激励视频广告实例
        this.rewardVideoAd = this.$app.$def.ylh_sdk.createRewardVideoAd({
          placementId: this.placementId, // 广告位ID
        });
        // 第二步:设置广告实例相应的回调
        this.rewardVideoAd.onLoad(() => {
           // 广告数据加载成功回调
           // 第四步:自动展示广告
           // 注意:如果加载广告成功后,没有立即展示广告,请在调用 show 之前方法先调用 isValid 方法判断广告是否过期
           this.rewardVideoAd.show()
        });
        this.rewardVideoAd.onError((err = {}) => {
          // 广告异常回调
        });
        this.rewardVideoAd.onExpose((id) => {
          // 广告曝光回调
        });
        this.rewardVideoAd.onClick(() => {
          // 广告点击回调
        });
        this.rewardVideoAd.onClose(() => {
          // 广告关闭回调
        });
         // 第三步:load 广告数据
        this.rewardVideoAd.load();
      } catch (error) {
        console.warn('创建激励视频广告异常:', error);
      }
    })
  },
  onShowRewardVideoAd() {
    if(this.rewardVideoAd) {
      this.rewardVideoAd.show();
    }
  },
  onDestroyRewardVideoAd() {
    if(this.rewardVideoAd) {
      this.rewardVideoAd.destroy();
      this.rewardVideoAd = null;
    }
  }
}

 文档反馈

腾讯公司 版权所有