baiduMobAds

立即使用

社区示例

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

概述

baiduMobAds 模块概述

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

模块使用攻略

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

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

  • 名称:baiduMobAds
  • 参数:appId
  • 配置示例:
  <feature name="BaiduMobAds">
      <param name="appId" value="1" />
  </feature>
  • 字段描述:

    appId:(必须配置)从百度百青藤获取到的应用id

模块接口

init

初始化

init(callback(ret, err))

callback(ret, err)

ret:

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

err:

  • 类型:JSON 对象
  • 内部字段:
{
    code: 1,//错误码 
            //错误码:
                //1(appId为空)
    message: appId为空
}

示例代码

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

可用性

Android系统

可提供的1.0.0及更高版本

showSplash

显示闪屏广告

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

params

adId:

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

rect :

  • 类型: JSON 对象

  • 描述:位置及尺寸

  • 内部字段

    {
        x: 0,    //(可选项)数字类型;模块左上角的 x 坐标(相对于所属的 Window 或 Frame);默认值:0
        y: 0,    //(可选项)数字类型;模块左上角的 y 坐标(相对于所属的 Window 或 Frame);默认值:0
        w: 300,  //(可选项)数字类型;模块的宽度;页面从x位置开始自动充满所属的 Window 或 Frame 的宽度;默认:300
        h: 300    //(可选项)数字类型;模块的高度;默认:300
    }
    

fixedOn:

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

fixed :

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

callback(ret, err)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    eventType: onLpClosed   //字符串型;
                            //onLpClosed:广告落地页关闭或点击返回键
                            //onAdDismissed:广告关闭
                            //onAdPresent:广告成功显示
                            //onAdClick:广告点击
}

err:

  • 类型:JSON 对象
  • 内部字段:
{
    code: 1     //数字类型;
                //错误码:
                //1(adId为空)
                //2(rect为空)
                //3(广告显示失败,具体原因见message字段)
    message:adId为空
}

示例代码

var BaiduMobAds = api.require('baiduMobAds');
var param = {rect:{x:0,y:100,w:0,h:400},adId:'1',fixedOn:'index_frm'};
BaiduMobAds.showSplash(param,function(ret,err){
    if(ret){
        console.log("ret:"+JSON.stringify(ret));
    }else if(err){
        console.log("err:"+JSON.stringify(err));
    }
});

可用性

Android系统

可提供的1.0.0及更高版本

showBanner

显示横幅广告

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

params

adId:

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

rect :

  • 类型: JSON 对象

  • 描述:位置及尺寸

  • 内部字段

    {
        x: 0,    //(可选项)数字类型;模块左上角的 x 坐标(相对于所属的 Window 或 Frame);默认值:0
        y: 0,    //(可选项)数字类型;模块左上角的 y 坐标(相对于所属的 Window 或 Frame);默认值:0
        w: 300,  //(可选项)数字类型;模块的宽度;页面从x位置开始自动充满所属的 Window 或 Frame 的宽度;默认:300
        h: 300    //(可选项)数字类型;模块的高度;默认:300
    }
    

callback(ret, err)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    eventType: onAdSwitch   //字符串型;
                            //onAdSwitch:广告内容自动刷新回调
                            //onAdShow:广告显示成功
                            //onAdReady:广告加载成功,表示广告可以显示
                            //onAdClick:广告点击
                            //onAdClose:广告关闭
}

err:

  • 类型:JSON 对象
  • 内部字段:
{
    code: 1     //数字类型;
                //错误码:
                //1(adId为空)
                //2(rect为空)
                //3(广告显示失败,具体原因见message字段)
    message:adId为空
}

示例代码

var BaiduMobAds = api.require('baiduMobAds');
var param = {rect:{x:0,y:0,w:0,h:80},adId:'1'};
BaiduMobAds.showBanner(param,function(ret,err){
    if(ret){
        console.log("ret:"+JSON.stringify(ret));
    }else if(err){
        console.log("err:"+JSON.stringify(err));
    }
});

可用性

Android系统

可提供的1.0.0及更高版本

closeBanner

关闭已打开的横幅广告

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

params

callback(ret, err)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    eventType: closeBanner  
}

示例代码

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

可用性

Android系统

可提供的1.0.0及更高版本

showInterstitialAd

分享网络视频资源

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

params

adId:

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

rect :

  • 类型: JSON 对象

  • 描述: (可选项) 位置及尺寸,type为非other时,需要传参

  • 内部字段

    {
        x: 0,    //(可选项)数字类型;模块左上角的 x 坐标(相对于所属的 Window 或 Frame);默认值:0
        y: 0,    //(可选项)数字类型;模块左上角的 y 坐标(相对于所属的 Window 或 Frame);默认值:0
        w: 300,  //(可选项)数字类型;模块的宽度;页面从x位置开始自动充满所属的 Window 或 Frame 的宽度;默认:300
        h: 300    //(可选项)数字类型;模块的高度;默认:300
    }
    

fixedOn:

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

fixed :

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

type:

  • 类型:字符串

  • 描述: (可选项) 广告类型,默认other

  • 取值范围:

    'beforeVideo'(前贴插屏)

    'pauseVideo'(暂停插屏)

    'other'(全屏插屏)

callback(ret, err)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    eventType: onAdSwitch   //字符串型;
                            //onAdSwitch:广告内容自动刷新回调
                            //onAdPresent:广告显示成功
                            //onAdReady:广告加载成功,表示广告可以显示
                            //onAdClick:广告点击
                            //onAdDismissed:广告关闭
}

err:

  • 类型:JSON 对象
  • 内部字段:
{
     code: 1     //数字类型;
                //错误码:
                //1(adId为空)
                //2(rect为空)
                //3(广告显示失败,具体原因见message字段)
    message:adId为空
}

示例代码

var BaiduMobAds = api.require('baiduMobAds');
var param = {rect:{x:0,y:100,w:600,h:900},adId:'1',fixedOn:'index_frm',type:'pauseVideo'};
BaiduMobAds.showInterstitialAd(param,function(ret,err){
    if(ret){
        console.log("ret:"+JSON.stringify(ret));
    }else if(err){
        console.log("err:"+JSON.stringify(err));
    }
});

可用性

Android系统

可提供的1.0.0及更高版本

showRewardVideo

显示激励广告

params

adId:

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

callback(ret, err)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    eventType: onAdSwitch   //字符串型;
                            //playCompletion:广告视频播放完毕
                            //onAdShow:广告显示成功
                            //onVideoDownloadSuccess:广告视频缓存成功
                            //onAdClick:广告点击
                            //onAdClose:广告关闭
}

err:

  • 类型:JSON 对象
  • 内部字段:
{
     code: 1     //数字类型;
                //错误码:
                //1(adId为空)
                //2(广告显示失败,具体原因见message字段)
                //3(视频缓存失败)
    message:adId为空
}

示例代码

var BaiduMobAds = api.require('baiduMobAds');
var param = {adId:'1'};
BaiduMobAds.showRewardVideo(param,function(ret,err){
    if(ret){
        console.log("ret:"+JSON.stringify(ret));
    }else if(err){
        console.log("err:"+JSON.stringify(err));
    }
});

可用性

Android系统

可提供的1.0.0及更高版本

showPatchVideo

显示贴片广告

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

params

adId:

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

rect :

  • 类型: JSON 对象

  • 描述:位置及尺寸

  • 内部字段

    {
        x: 0,    //(可选项)数字类型;模块左上角的 x 坐标(相对于所属的 Window 或 Frame);默认值:0
        y: 0,    //(可选项)数字类型;模块左上角的 y 坐标(相对于所属的 Window 或 Frame);默认值:0
        w: 300,  //(可选项)数字类型;模块的宽度;页面从x位置开始自动充满所属的 Window 或 Frame 的宽度;默认:300
        h: 300    //(可选项)数字类型;模块的高度;默认:300
    }
    

fixedOn:

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

fixed :

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

callback(ret, err)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
     eventType: onAdSwitch   //字符串型;
                            //onAdLoad:广告加载成功
                            //playCompletion:广告播放完毕
                            //onAdShow:广告显示成功
                            //onAdClick:广告点击
                            //onAdClose:广告关闭
}

err:

  • 类型:JSON 对象
  • 内部字段:
{
   code: 1     //数字类型;
                //错误码:
                //1(adId为空)
                //2(rect为空)
                //3(广告请求失败)
                //4(广告视频播放失败)
    message:adId为空
}

示例代码

var BaiduMobAds = api.require('baiduMobAds');
var param = {rect:{x:0,y:100,w:0,h:400},adId:'1',fixedOn:'index_frm'};
BaiduMobAds.showPatchVideo(param,function(ret,err){
    if(ret){
        console.log("ret:"+JSON.stringify(ret));
    }else if(err){
        console.log("err:"+JSON.stringify(err));
    }
});

可用性

Android系统

可提供的1.0.0及更高版本