baiduMobAds

init showBanner showInterstitialAd showPatchVideo

社区示例

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

概述

baiduMobAds 模块概述

本模块封装了百度百青藤的移动广告sdk，集成了闪屏广告，横幅广告，插屏广告，贴片广告，激励视频广告；其他功能会陆续上线。

模块使用攻略

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

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

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

  • 字段描述:

    appId：（必须配置）从百度百青藤获取到的应用id

init

初始化

init(callback(ret, err))

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
  2.     eventType: init      //如果ret不为空，eventType为init，表示初始化成功
  3. }

err：

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

示例代码

  1. var BaiduMobAds = api.require('baiduMobAds');
  2. BaiduMobAds.init(function(ret, err) {
  3.      if(ret){
  4.          console.log("初始化成功");
  5.      }else if(err){
  6.          console.log("err:"+JSON.stringify(err));
  7.      }
  8. });

可用性

Android系统

可提供的1.0.0及更高版本

showSplash

显示闪屏广告

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

params

adId:

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

rect ：

  • 类型： JSON 对象

  • 描述：位置及尺寸

  • 内部字段

    1. {
    2.     x: 0,    //（可选项）数字类型；模块左上角的 x 坐标（相对于所属的 Window 或 Frame）；默认值：0
    3.     y: 0,    //（可选项）数字类型；模块左上角的 y 坐标（相对于所属的 Window 或 Frame）；默认值：0
    4.     w: 300,  //（可选项）数字类型；模块的宽度；页面从x位置开始自动充满所属的 Window 或 Frame 的宽度；默认：300
    5.     h: 300    //（可选项）数字类型；模块的高度；默认：300
    6. }

fixedOn：

  • 类型：字符串
  • 描述：（可选项）模块添加到指定 frame 的名字（只指 frame，传 window 无效）
  • 默认值： 模块依附于当前 window

fixed ：

  • 类型：字符串
  • 描述： （可选项）模块是否随所属 window 或 frame 滚动
  • 默认值：true（不随之滚动）

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     eventType: onLpClosed   //字符串型；
  3.                             //onLpClosed:广告落地页关闭或点击返回键
  4.                             //onAdDismissed:广告关闭
  5.                             //onAdPresent：广告成功显示
  6. }

err：

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

示例代码

  1. var BaiduMobAds = api.require('baiduMobAds');
  2. var param = {rect:{x:0,y:100,w:0,h:400},adId:'1',fixedOn:'index_frm'};
  3. BaiduMobAds.showSplash(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系统

showBanner

显示横幅广告

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

params

adId:

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

rect ：

  • 类型： JSON 对象

  • 描述：位置及尺寸

  • 内部字段

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     eventType: onAdSwitch   //字符串型；
  3.                             //onAdSwitch:广告内容自动刷新回调
  5.                             //onAdReady：广告加载成功，表示广告可以显示
  6.                             //onAdClick：广告点击
  7.                             //onAdClose：广告关闭
  8. }

err：

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

示例代码

  1. var BaiduMobAds = api.require('baiduMobAds');
  2. var param = {rect:{x:0,y:0,w:0,h:80},adId:'1'};
  3. BaiduMobAds.showBanner(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系统

可提供的1.0.0及更高版本

closeBanner

关闭已打开的横幅广告

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

params

无

callback(ret, err)

ret：

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

示例代码

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

可用性

Android系统

可提供的1.0.0及更高版本

showInterstitialAd

分享网络视频资源

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

params

adId:

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

rect ：

  • 类型： JSON 对象

  • 描述： （可选项） 位置及尺寸,type为非other时，需要传参

  • 内部字段

    1. {
    2.     x: 0,    //（可选项）数字类型；模块左上角的 x 坐标（相对于所属的 Window 或 Frame）；默认值：0
    3.     y: 0,    //（可选项）数字类型；模块左上角的 y 坐标（相对于所属的 Window 或 Frame）；默认值：0
    4.     w: 300,  //（可选项）数字类型；模块的宽度；页面从x位置开始自动充满所属的 Window 或 Frame 的宽度；默认：300
    5.     h: 300    //（可选项）数字类型；模块的高度；默认：300
    6. }

fixedOn：

  • 类型：字符串
  • 描述：（可选项）模块添加到指定 frame 的名字（只指 frame，传 window 无效）
  • 默认值： 模块依附于当前 window

fixed ：

  • 类型：字符串
  • 描述： （可选项）模块是否随所属 window 或 frame 滚动
  • 默认值：true（不随之滚动）

type：

  • 描述： （可选项） 广告类型，默认other

  • 取值范围：

    ‘beforeVideo’（前贴插屏）

    ‘pauseVideo’（暂停插屏）

    ‘other’（全屏插屏）

callback(ret, err)

ret：

  • 类型：JSON 对象
  1. {
  2.     eventType: onAdSwitch   //字符串型；
  3.                             //onAdSwitch:广告内容自动刷新回调
  4.                             //onAdPresent:广告显示成功
  5.                             //onAdReady：广告加载成功，表示广告可以显示
  6.                             //onAdClick：广告点击
  7.                             //onAdDismissed：广告关闭
  8. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. var BaiduMobAds = api.require('baiduMobAds');
  2. var param = {rect:{x:0,y:100,w:600,h:900},adId:'1',fixedOn:'index_frm',type:'pauseVideo'};
  3. BaiduMobAds.showInterstitialAd(param,function(ret,err){
  4.     if(ret){
  5.         console.log("ret:"+JSON.stringify(ret));
  7.         console.log("err:"+JSON.stringify(err));
  8.     }
  9. });

可用性

Android系统

可提供的1.0.0及更高版本

showRewardVideo

显示激励广告

params

adId:

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

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     eventType: onAdSwitch   //字符串型；
  3.                             //playCompletion:广告视频播放完毕
  4.                             //onAdShow:广告显示成功
  5.                             //onVideoDownloadSuccess：广告视频缓存成功
  6.                             //onAdClick：广告点击
  7.                             //onAdClose：广告关闭
  8. }

err：

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

示例代码

  1. var BaiduMobAds = api.require('baiduMobAds');
  2. var param = {adId:'1'};
  3. BaiduMobAds.showRewardVideo(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系统

可提供的1.0.0及更高版本

showPatchVideo

显示贴片广告

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

params

adId:

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

rect ：

  • 类型： JSON 对象

  • 描述：位置及尺寸

  • 内部字段

    1. {
    2.     x: 0,    //（可选项）数字类型；模块左上角的 x 坐标（相对于所属的 Window 或 Frame）；默认值：0
    3.     y: 0,    //（可选项）数字类型；模块左上角的 y 坐标（相对于所属的 Window 或 Frame）；默认值：0
    4.     w: 300,  //（可选项）数字类型；模块的宽度；页面从x位置开始自动充满所属的 Window 或 Frame 的宽度；默认：300
    5.     h: 300    //（可选项）数字类型；模块的高度；默认：300
    6. }

fixedOn：

  • 类型：字符串
  • 描述：（可选项）模块添加到指定 frame 的名字（只指 frame，传 window 无效）
  • 默认值： 模块依附于当前 window

fixed ：

  • 类型：字符串
  • 描述： （可选项）模块是否随所属 window 或 frame 滚动
  • 默认值：true（不随之滚动）

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.      eventType: onAdSwitch   //字符串型；
  3.                             //onAdLoad:广告加载成功
  4.                             //playCompletion:广告播放完毕
  5.                             //onAdShow：广告显示成功
  6.                             //onAdClick：广告点击
  7.                             //onAdClose：广告关闭
  8. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.    code: 1     //数字类型；
  3.                 //错误码：
  4.                 //1（adId为空）
  5.                 //2（rect为空）
  6.                 //3（广告请求失败）
  7.                 //4（广告视频播放失败）
  8. }

示例代码

Android系统