baiduAd
showAd closeAd showPrerollAd showSplashAd removeSplashAd showInterstitialAd showNativeAd closeNativeAd showCpuInfoAd closeCpuInfoAd showRewardVideo
概述
baiduAd 封装了百度公司的MSSP移动广告sdk。该平台支持横幅,视频贴片,开屏,插屏,信息流等广告展现形式。使用本模块需要到百度MSSP平台去生成应用,并获取应用id,代码位id等参数。如下图:
使用此模块之前需先配置 config.xml 文件,配置完毕,需通过云端编译生效,配置方法如下:
- 名称:baiduAd
- 参数:appId(应用的Id)
- 配置示例:
<!-- Android 配置方法 -->
<meta-data name="BaiduMobAd_APP_ID" value="6536447"/>
<!-- iOS 配置方法 -->
<feature name="baiduAd">
<param name="ios_appId" value="ccb60059"/>
</feature>
showAd
显示横幅广告
showAd({params}, callback(ret))
params
rect:
- 类型:JSON 对象
- 描述:(可选项)模块的位置及尺寸
- 内部字段:
{
x: 0, //(可选项)数字类型;模块左上角的 x 坐标(相对于所属的 Window 或 Frame);默认值:0
y: 0, //(可选项)数字类型;模块左上角的 y 坐标(相对于所属的 Window 或 Frame);默认值:0
w: 300, //(可选项)数字类型;模块的宽度;页面从x位置开始自动充满所属的 Window 或 Frame 的宽度;默认:300
h: 300 //(可选项)数字类型;模块的高度;默认:300
}
adId:
- 类型: 字符串
- 描述:广告代码位id
fixedOn:
- 类型:字符串类型
- 描述:(可选项)模块添加到指定 frame 的名字(只指 frame,传 window 无效)
- 默认:模块依附于当前 window
fixed:
- 类型:布尔
- 描述:(可选项)模块是否随所属 window 或 frame 滚动
- 默认值:true(不随之滚动)
callback(ret)
ret:
- 类型:JSON对象
- 描述:返回值
{
code: 1 //数字类型;取值范围0,1,2,3,4
0代表:广告将要展示
1代表:广告展示成功
2代表:广告展示失败
3代表:用户点击了广告
4代表:用户点击了关闭按钮
}
示例代码
var baiduAd = api.require('baiduAd');
baiduAd.showAd({
rect: {
x: 0,
y: 0,
w: 300,
h: 300
},
adId: '2015347',
fixedOn: api.frameName,
fixed: true
},function(ret){
alert(JSON.stringify(ret));
});
可用性
iOS系统,Android系统
可提供的1.0.0及更高版本
closeAd
关闭横幅广告
closeAd()
示例代码
var baiduAd = api.require('baiduAd');
baiduAd.closeAd();
可用性
iOS系统,Android系统
可提供的1.0.0及更高版本
showPrerollAd
显示视频贴片广告(仅iOS支持)
showPrerollAd({params}, callback(ret))
params
rect:
- 类型:JSON 对象
- 描述:(可选项)模块的位置及尺寸
- 内部字段:
{
x: 0, //(可选项)数字类型;模块左上角的 x 坐标(相对于所属的 Window 或 Frame);默认值:0
y: 0, //(可选项)数字类型;模块左上角的 y 坐标(相对于所属的 Window 或 Frame);默认值:0
w: 320, //(可选项)数字类型;模块的宽度;默认:320
h: 240 //(可选项)数字类型;模块的高度;默认:240
}
adId:
- 类型: 字符串
- 描述:广告代码位id
fixedOn:
- 类型:字符串类型
- 描述:(可选项)模块添加到指定 frame 的名字(只指 frame,传 window 无效)
- 默认:模块依附于当前 window
fixed:
- 类型:布尔
- 描述:(可选项)模块是否随所属 window 或 frame 滚动
- 默认值:true(不随之滚动)
callback(ret)
ret:
- 类型:JSON对象
- 描述:返回值
{
code: 1 //数字类型;取值范围0,1,2,3,4
0代表:广告准备播放
1代表:广告展示成功
2代表:广告展示失败
3代表:用户点击了广告
4代表:广告展示完毕
}
示例代码
var baiduAd = api.require('baiduAd');
baiduAd.showPrerollAd({
rect: {
x: 0,
y: 0,
w: 320,
h: 240
},
adId: '2058633',
fixedOn: api.frameName,
fixed: true
},function(ret){
alert(JSON.stringify(ret));
});
可用性
iOS系统
可提供的1.0.0及更高版本
showSplashAd
显示开屏广告
showSplashAd({params}, callback(ret))
params
rect:
- 类型:JSON 对象
- 描述:(可选项)模块的位置及尺寸
- 内部字段:
{
x: 0, //(可选项)数字类型;模块左上角的 x 坐标(相对于所属的 Window 或 Frame);默认值:0
y: 0, //(可选项)数字类型;模块左上角的 y 坐标(相对于所属的 Window 或 Frame);默认值:0
w: 375, //(可选项)数字类型;模块的宽度;页面从x位置开始自动充满所属的 Window 或 Frame 的宽度;默认:300
h: 670 //(可选项)数字类型;模块的高度;页面从x位置开始自动充满所属的 Window 或 Frame 的高度;默认:300
}
adId:
- 类型: 字符串
- 描述:广告代码位id
canClick:
- 类型:布尔类型
- 描述:是否允许点击,默认true
fixedOn:
- 类型:字符串类型
- 描述:(可选项)模块添加到指定 frame 的名字(只指 frame,传 window 无效)
- 默认:模块依附于当前 window
fixed:
- 类型:布尔
- 描述:(可选项)模块是否随所属 window 或 frame 滚动
- 默认值:true(不随之滚动)
callback(ret)
ret:
- 类型:JSON对象
- 描述:返回值
{
code: 1 //数字类型;取值范围1,2,3,4
1代表:广告展示成功
2代表:广告展示失败
3代表:用户点击了广告
4代表:广告展示完毕
}
示例代码
var baiduAd = api.require('baiduAd');
baiduAd.showSplashAd({
rect: {
x: 0,
y: 0,
w: 300,
h: 300
},
adId: '2058633',
canClick: true,
fixedOn: api.frameName,
fixed: true
},function(ret){
alert(JSON.stringify(ret));
});
可用性
iOS系统,Android系统
可提供的1.0.0及更高版本
removeSplashAd
关闭开屏广告
removeSplashAd({params}, callback(ret))
示例代码
var baiduAd = api.require('baiduAd');
baiduAd.removeSplashAd({
},function(ret){
alert(JSON.stringify(ret));
});
可用性
iOS系统,Android系统
可提供的1.0.0及更高版本
showInterstitialAd
显示插屏广告
showInterstitialAd({params}, callback(ret))
params
rect:
- 类型:JSON 对象
- 描述:(可选项)模块的位置及尺寸(仅iOS支持)
- 内部字段:
{
x: 0, //(可选项)数字类型;模块左上角的 x 坐标(相对于所属的 Window 或 Frame);默认值:0
y: 0, //(可选项)数字类型;模块左上角的 y 坐标(相对于所属的 Window 或 Frame);默认值:0
w: 250, //(可选项)数字类型;模块的宽度;默认:250
h: 200 //(可选项)数字类型;模块的高度;默认:200
}
adId:
- 类型: 字符串
- 描述:广告代码位id
type:
- 类型:字符串
- 描述:广告类型,默认pauseVideo
- 取值范围:
- ‘pauseVideo’
- ‘beforeVideo’
- ‘other’ (默认为全屏,此类型下,rect参数无效)
fixedOn:
- 类型:字符串类型
- 描述:(可选项)模块添加到指定 frame 的名字(只指 frame,传 window 无效)(仅iOS支持)
- 默认:模块依附于当前 window
fixed:
- 类型:布尔
- 描述:(可选项)模块是否随所属 window 或 frame 滚动(仅iOS支持)
- 默认值:true(不随之滚动)
callback(ret)
ret:
- 类型:JSON对象
- 描述:返回值
{
code: 1 //数字类型;取值范围0,1,2,3,4,5,6
0代表:广告预加载成功
1代表:广告预加载失败
2代表:广告即将展示
3代表:广告展示成功
4代表:广告展示失败
5代表:广告被用户点击
6代表:广告展示结束
}
示例代码
var baiduAd = api.require('baiduAd');
baiduAd.showInterstitialAd({
rect: {
x: 0,
y: 0,
w: 300,
h: 300
},
adId: '2058633',
type: 'beforeVideo',
fixedOn: api.frameName,
fixed: true
},function(ret){
alert(JSON.stringify(ret));
});
可用性
iOS系统,Android系统
可提供的1.0.0及更高版本
showNativeAd
显示信息流广告
showNativeAd({params}, callback(ret))
params
rect:
- 类型:JSON 对象
- 描述:(可选项)模块的位置及尺寸
- 内部字段:
{
x: 0, //(可选项)数字类型;模块左上角的 x 坐标(相对于所属的 Window 或 Frame);默认值:0
y: 0, //(可选项)数字类型;模块左上角的 y 坐标(相对于所属的 Window 或 Frame);默认值:0
w: 250, //(可选项)数字类型;模块的宽度;默认:250
h: 200 //(可选项)数字类型;模块的高度;默认:200
}
adId:
- 类型: 字符串
- 描述:广告代码位id
type:
- 类型:字符串
- 描述:类型
- 取值范围:
- ‘normal’
- ‘video’
- ‘html’
fixedOn:
- 类型:字符串类型
- 描述:(可选项)模块添加到指定 frame 的名字(只指 frame,传 window 无效)
- 默认:模块依附于当前 window
fixed:
- 类型:布尔
- 描述:(可选项)模块是否随所属 window 或 frame 滚动
- 默认值:true(不随之滚动)
callback(ret)
ret:
- 类型:JSON对象
- 描述:返回值
{
code: 1 //数字类型;取值范围 0,1,2,3
0代表:广告请求成功
1代表:广告请求失败
2代表:用户点击了广告
3代表:用户点击了广告的视频区域
}
示例代码
var baiduAd = api.require('baiduAd');
baiduAd.showNativeAd({
rect: {
x: 0,
y: 0,
w: 300,
h: 300
},
adId: '2058621',
type: 'normal',
fixedOn: api.frameName,
fixed: true
},function(ret){
alert(JSON.stringify(ret));
});
可用性
iOS系统,Android系统
可提供的1.0.0及更高版本
closeNativeAd
关闭信息流广告
closeNativeAd()
示例代码
var baiduAd = api.require('baiduAd');
baiduAd.closeNativeAd();
可用性
iOS系统,Android系统
可提供的1.0.0及更高版本
showCpuInfoAd
显示内容联盟广告
showCpuInfoAd({params}, callback(ret))
params
rect:
- 类型:JSON 对象
- 描述:(可选项)模块的位置及尺寸
- 内部字段:
{
x: 0, //(可选项)数字类型;模块左上角的 x 坐标(相对于所属的 Window 或 Frame);默认值:0
y: 0, //(可选项)数字类型;模块左上角的 y 坐标(相对于所属的 Window 或 Frame);默认值:0
w: 375, //(可选项)数字类型;模块的宽度;页面从x位置开始自动充满所属的 Window 或 Frame 的宽度;默认:300
h: 670 //(可选项)数字类型;模块的高度;页面从x位置开始自动充满所属的 Window 或 Frame 的高度;默认:300
}
appId:
- 类型: 字符串
- 描述:应用id
adId:
- 类型: 字符串
- 描述:广告代码位id
channelId:
- 类型: 字符串
- 描述:频道id
fixedOn:
- 类型:字符串类型
- 描述:(可选项)模块添加到指定 frame 的名字(只指 frame,传 window 无效)
- 默认:模块依附于当前 window
fixed:
- 类型:布尔
- 描述:(可选项)模块是否随所属 window 或 frame 滚动
- 默认值:true(不随之滚动)
callback(ret)
ret:
- 类型:JSON对象
- 描述:返回值
{
code: 1 //数字类型;取值范围0,1,2,3
0代表:将要开始加载 //已废弃
1代表:已经开始加载
2代表:加载完成
3代表:加载失败
}
示例代码
var baiduAd = api.require('baiduAd');
baiduAd.showCpuInfoAd({
rect: {
x: 0,
y: 0,
w: 'auto',
h: 'auto'
},
appId: 'd77e414',
channelId: '1001',
fixedOn: api.frameName,
fixed: true
},function(ret){
alert(JSON.stringify(ret));
});
可用性
iOS系统,Android系统
可提供的1.0.0及更高版本
closeCpuInfoAd
关闭内容联盟广告
closeCpuInfoAd()
示例代码
var baiduAd = api.require('baiduAd');
baiduAd.closeCpuInfoAd();
可用性
iOS系统,Android系统
可提供的1.0.0及更高版本
showRewardVideo
显示激励视频广告
showRewardVideo({params}, callback(ret))
params
adId:
- 类型: 字符串
- 描述:广告代码位id
callback(ret)
ret:
- 类型:JSON对象
- 描述:返回值
{
code: 1 //数字类型;取值范围0,1,2,3,4,5
0代表:缓存成功
1代表:开始播放
2代表:缓存失败
3代表:播放完成
4代表:广告点击
5代表:关闭了广告
6代表:广告展示失败
7代表:激励广告请求成功
8代表:激励广告请求失败
}
示例代码
var baiduAd = api.require('baiduAd');
baiduAd.showRewardVideo({
adId: '2015347',
},function(ret){
alert(JSON.stringify(ret));
});
可用性
iOS系统,Android系统
可提供的1.0.0及更高版本