TencentAd

showSplashAd closeBannerAd closeInsertAd

社区示例

为帮助用户更好更快的使用模块，论坛维护了一个示例，示例中包含示例代码、知识点讲解、注意事项等，供您参考。

概述

tencentAds 模块概述

本模块封装了腾讯广点通的移动广告sdk，集成了开屏广告，横幅广告，插屏广告，激励视频广告；其他功能会陆续上线。

模块使用攻略

使用之前须从申请开发者账号并创建应用，创建的应用必须是已在应用商店上架过的app，不然腾讯官方会拒绝申请，申请成功后获取应用id，然后再申请对应类型的代码位，并获取代码位id。

使用此模块之前建议先配置 config.xml 文件，配置完毕，需通过云端编译生效，配置方法如下：

  • 名称：tencentAd
  • 参数：appId
  • 配置示例:

  • 字段描述:

    appId：（必须配置）从腾讯优量汇获取到的应用id

showSplashAd

显示开屏广告

showSplashAd({params}, callback(ret, err))

params

adId:

  • 类型： 字符串
  • 描述：广告代码位id

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
  2.     eventType: onLpClosed   //字符串型；
  3.                             //onADExposure:广告曝光
  4.                             //onADDismissed:广告关闭
  5.                             //onADPresent：广告成功显示
  6.                             //onADClicked：广告点击
  7. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     code: 1     //数字类型；
  3.                 //错误码：
  4.                 //1（appId为空）
  5.                 //2（adId为空）
  6.                 //其他（广告显示失败，具体原因见message字段）
  7.     message:adId为空
  8. }

示例代码

  1. var tencentAd = api.require('tencentAd');
  2. var param = {adId:'8863364436303842593'};
  3. tencentAd.showSplashAd(param,function(ret,err){
  4.     if(ret){
  5.     }else if(err){
  6.         console.log("err:"+JSON.stringify(err));
  7.     }
  8. });

可用性

Android系统，iOS系统

可提供的1.0.0及更高版本

showBannerAd

显示横幅广告

params

adId:

  • 类型： 字符串
  • 描述：广告代码位id

rect ：

  • 类型： JSON 对象

  • 描述：位置及尺寸

  • 内部字段

    1. {
    2.     x: 0,    //（可选项）数字类型；模块左上角的 x 坐标（相对于所属的 Window 或 Frame）；默认值：0
    3.     y: 0,    //（可选项）数字类型；模块左上角的 y 坐标（相对于所属的 Window 或 Frame）；默认值：0
    4.     w: api.frameWidth,  //（可选项）数字类型；模块的宽度；页面从x位置开始自动充满所属的 Window 或 Frame 的宽度；默认：0,横幅高度会根据（宽/高=6.4/1）计算出来
    5. }

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     eventType: onAdSwitch   //字符串型；
  3.                             //onADReceive:广告加载成功
  4.                             //onADExposure:广告曝光
  5.                             //onADClicked：广告点击时
  6.                             //onADClosed：广告关闭
  7.                             //onADLeftApplication：由于广告点击离开 APP 时调用
  8.                             //onADOpenOverlay：当广告打开浮层时调用，如打开内置浏览器、内容展示浮                                                   层，一般发生在点击之后
  9.                             //onADCloseOverlay：浮层关闭时调用
  10. }

err：

  • 类型：JSON 对象
  • 内部字段：

示例代码

  1. var tencentAd = api.require('tencentAd');
  3. tencentAd.showBannerAd(param,function(ret,err){
  4.     if(ret){
  5.         console.log("ret:"+JSON.stringify(ret));
  6.     }else if(err){
  7.         console.log("err:"+JSON.stringify(err));
  8.     }
  9. });

Android系统，iOS系统

可提供的1.0.0及更高版本

closeBannerAd

关闭已打开的横幅广告

closeBannerAd(callback(ret, err))

params

无

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     eventType: closeBannerAd  
  3. }

示例代码

  1. var tencentAd = api.require('tencentAd');
  2. tencentAd.closeBannerAd(function(ret){
  3.     if(ret){
  4.         console.log("ret:"+JSON.stringify(ret));
  5.     }
  6. });

可用性

Android系统，iOS系统

可提供的1.0.0及更高版本

showInsertAd

显示插屏广告

showInsertAd({params}, callback(ret, err))

params

  • 类型： 字符串
  • 描述：广告代码位id

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     eventType: onAdSwitch   //字符串型；
  3.                             //onADReceive:广告加载完毕
  4.                             //onADOpened:广告展开时
  5.                             //onADExposure：广告曝光时
  6.                             //onADClicked：广告点击
  7.                             //onADClosed：广告关闭
  8.                             //onADLeftApplication：广告点击离开应用时
  9.                             //onVideoInit：视频播放 View 初始化完成
  10.                             //onVideoLoading：视频下载中
  11.                             //onVideoReady：视频播放器初始化完成
  12.                             //onVideoStart：视频开始播放
  13.                             //onVideoPause：视频暂停
  14.                             //onVideoComplete：视频播放结束
  15.                             //onVideoPageOpen：进入视频落地页
  16.                             //onVideoPageClose：退出视频落地页
  17. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.      code: 1     //数字类型；
  3.                 //错误码：
  4.                //1（appId为空）
  5.                 //2（adId为空）
  7.     message:adId为空
  8. }

示例代码

Android系统，iOS系统

可提供的1.0.0及更高版本

closeInsertAd

关闭插屏广告

closeInsertAd(callback(ret, err))

params

无

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     eventType: closeInsertAd  
  3. }

示例代码

  1. var tencentAd = api.require('tencentAd');
  2. tencentAd.closeInsertAd(function(ret){
  3.     if(ret){
  4.         console.log("ret:"+JSON.stringify(ret));
  5.     }
  6. });

可用性

Android系统，iOS系统

可提供的1.0.0及更高版本

showRewardVideoAd

显示激励视频

showRewardVideoAd({params}, callback(ret, err))

params

adId:

  • 类型： 字符串
  • 描述：广告代码位id

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.      eventType: onAdSwitch   //字符串型；
  3.                             //onADLoad:广告加载成功
  4.                             //onVideoCached:视频素材缓存成功
  5.                             //onADShow：广告显示成功
  6.                             //onADExpose：广告曝光
  7.                             //onReward：广告激励发放
  8.                              //onADClick：广告被点击
  9.                              //onVideoComplete：广告视频素材播放完毕
  10.                              //onADClose：广告被关闭
  11. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.    code: 1     //数字类型；
  3.                 //错误码：
  4.                //1（appId为空）
  5.                 //2（adId为空）
  6.                 //其他（广告显示失败，具体原因见message字段）
  7.     message:adId为空
  8. }

示例代码

  1. var tencentAd = api.require('tencentAd');
  2. var param = {adId:'5040942242835423'};
  3. tencentAd.showRewardVideoAd(param,function(ret,err){
  4.     if(ret){
  5.         console.log("ret:"+JSON.stringify(ret));
  6.     }else if(err){
  7.         console.log("err:"+JSON.stringify(err));
  8.     }
  9. });

Android系统，iOS系统

可提供的1.0.0及更高版本