zyBaiduAd
2.x+接口
adInit adShowSplash adShowBanner adCloseBanner adShowInteraction adLoadRewardVideo adShowRewardVideo adLoadFullScreenVideo adShowFullScreenVideo adShowFeed adCloseFeed adSetAttr adShowFeed2 adCloseFeed2 adShowVideoPatch adCloseVideoPatch
1.x+接口
init showSplashAd closeSplashAd showBannerAd closeBannerAd showInteractionAd loadRewardVideoAd showRewardVideoAd loadFullScreenVideoAd showFullScreenVideoAd showNativeExpressAd closeNativeExpressAd showVideoPatchAd closeVideoPatchAd setAttr showExpressFeedAd closeExpressFeedAd
论坛示例
为帮助用户更好更快的使用插件，请访问示例说明页面
概述
插件简介
zyBaiduAd封装百度百青藤 Android、Ios广告sdk，包含开屏、Banner、插屏、激励视频、全屏视频、贴片、信息流广告等功能 ，信息流插件，解决划动时会触摸误点的问题。
IOS 云编译最低版本为11.0，Android云编译最低版本为4.0.3。
使用插件前请先到百度百青藤后台注册帐号、新建应用、添加代码位使用。插件中默认测试代码位可直接测试使用。
插件接口
adGetVersions
获取当前集成的sdk版本号
adGetVersions(callback(ret))
callback(ret)
ret：
- 类型：JSON 对象
- 内部字段：
{
status:true, //调用成功
result:"1.0",//结果
}
示例代码
var zyBaiduAd = api.require('zyBaiduAd');
zyBaiduAd.adGetVersions(function(ret){
alert("zyBaiduAd："+JSON.stringify(ret));
});
可用性
Android系统，ios系统
可提供的2.0.0及更高版本
adRequestPermission
设置插件所需权限可提高收益(请在必要时申请) 安卓：获取权限 苹果为：ios14以上才有的获取idfa权限(低版本自动有)
adRequestPermission(callback(ret))
callback(ret)
ret：
- 类型：JSON 对象
- 内部字段：
{
status:true, //安卓不返回 苹果返回idfa值
result:"XXXX",//结果
}
示例代码
var zyBaiduAd = api.require('zyBaiduAd');
zyBaiduAd.adRequestPermission({},function(ret){
alert("zyBaiduAd："+JSON.stringify(ret));
});
可用性
Android系统，ios系统
可提供的2.0.0及更高版本
adInit
初始化插件（使用前必须）
adInit({params}, callback(ret))
params
appId:
- 类型：字符串
- 描述：（必选项）应用id
- 默认值：无
appName:
- 类型：字符串
- 描述：（可选项）应用名字
- 默认值：demo
callback(ret)
ret：
- 类型：JSON 对象
- 内部字段：
{
status:true,
result:"初始化成功"
}
示例代码
var zyBaiduAd = api.require('zyBaiduAd');
var param = {
appId:api.systemType=='ios'?"ccb60059":"e866cfb0",
appName:"demo",
};
zyBaiduAd.adInit(param,function(ret){
console.log("zyBaiduAd："+JSON.stringify(ret));
api.removeLaunchView();
api.toast({ msg:ret.result })
});
可用性
Android系统，ios系统
可提供的2.0.0及更高版本
adShowSplash
展示开屏广告
adShowSplash({params}, callback(ret))
params
codeId：
- 类型：字符串
- 描述：（必选项）代码位id
- 默认值：无
rect：
- 类型：对象
- 描述：（可选项）打开区域 全为0或不写 则打开全屏
- 内部字段：
{
x:0,
y:0,
w:0,
h:0
}
fixedOn：
- 类型：字符串类型
- 描述：（可选项）插件视图添加到指定 frame 的名字（只指 frame，传 window 无效）
- 默认值：插件依附于当前 window
fixed:
- 类型：布尔
- 描述：（可选项）插件是否不随所属 window 或 frame 滚动
- 默认值：true（不随之滚动）
callback(ret)
ret：
- 类型：JSON 对象
- 内部字段：
{
status: true的结果如下 false结果则显示对应错误提示
result: 加载中 具体错误码或原因说明
加载成功 缓存失败
ECPM:0
缓存中
缓存成功
view添加
展示
点击
跳过
关闭
}
示例代码
var zyBaiduAd = api.require('zyBaiduAd');
var param = {
codeId:api.systemType=='ios'?"2058492":"2058622",//默认测试代码位
rect:{//开屏位置 默认0即为全屏 也可自定义
x:0,
y:0,
w:0,
h:0
},
fixedOn:"",
fixed:true
};
zyBaiduAd.adShowSplash(param,function(ret){
console.log("zyBaiduAd："+JSON.stringify(ret));
if(ret.status){
if(ret.result == "展示"){
api.setFullScreen({fullScreen: true,animation:"slide"});
}
if(ret.result == "关闭"){
api.setFullScreen({fullScreen: false,animation:"slide"});
}
}else{
api.toast({ msg:ret.result })
}
});
可用性
Android系统，ios系统
可提供的2.0.0及更高版本
adShowBanner
展示Banner横幅广告
adShowBanner({params}, callback(ret))
params
tag：
- 类型：字符串
- 描述：（可选项）打开此banner的标识 需要打开多个banner可设置不同的tag 手动close时传入对应tag即可关闭对应banner
- 默认值：_default
codeId：
- 类型：字符串
- 描述：（必选项）代码位id
- 默认值：无
rect：
- 类型：对象
- 描述：（可选项）打开区域
- 内部字段：
{
x:0,
y:0,
w:0,
h:0
}
fixedOn：
- 类型：字符串类型
- 描述：（可选项）插件视图添加到指定 frame 的名字（只指 frame，传 window 无效）
- 默认值：插件依附于当前 window
fixed:
- 类型：布尔
- 描述：（可选项）插件是否不随所属 window 或 frame 滚动
- 默认值：true（不随之滚动）
callback(ret)
ret：
- 类型：JSON 对象
- 内部字段：
{
status true false
result 加载中 具体错误码加原因说明
加载成功 加载失败
ECPM:0
view添加
展示
点击
关闭
}
示例代码
var param = {
tag:"banner",
codeId:api.systemType=='ios'?"3722589":"2015351",//代码位
rect:{//显示位置
x:20,
y:50 + (_addMsg-1)*180,
w:api.winWidth-40,
h:(api.winWidth-40)*3/20
},
fixedOn:"",
fixed:true,
};
zyBaiduAd.adShowBanner(param,function(ret){
console.log("zyBaiduAd："+JSON.stringify(ret));
if(!ret.status){
api.toast({ msg:ret.result })
}
});
可用性
Android系统，ios系统
可提供的2.0.0及更高版本
adCloseBanner
手动关闭Banner广告
adCloseBanner({params}, callback(ret))
params
tag：
- 类型：字符串
- 描述：（可选项）打开此banner的标识
- 默认值：_default
callback(ret)
ret：
- 类型：JSON 对象
- 内部字段：
{
status:false,
result:"无此tag"
}
示例代码
var zyBaiduAd = api.require('zyBaiduAd');
zyBaiduAd.adCloseBanner({tag:""+_addMsg},function(ret){
console.log(_addMsg+"-zyBaiduAd："+JSON.stringify(ret));
if(!ret.status){
api.toast({ msg:ret.result })
}
});
可用性
Android系统，ios系统
可提供的2.0.0及更高版本
adShowInteraction
展示插屏广告
adShowInteraction({params}, callback(ret))
params
codeId：
- 类型：字符串
- 描述：（必选项）代码位id
- 默认值：无
callback(ret)
ret：
- 类型：JSON 对象
- 内部字段：
{
status true false
result 加载中 具体错误码或原因说明
加载成功 缓存失败
ECPM:0
缓存中
缓存成功
view添加
展示
点击
关闭
}
示例代码
var zyBaiduAd = api.require('zyBaiduAd');
var param = {
codeId:api.systemType=='ios'?"2058554":"2403633",//代码位
};
zyBaiduAd.adShowInteraction(param,function(ret){
console.log("zyBaiduAd："+JSON.stringify(ret));
if(!ret.status){
api.toast({ msg:ret.result })
}
});
可用性
Android系统，ios系统
可提供的2.0.0及更高版本
adLoadRewardVideo
加载激励视频广告
adLoadRewardVideo({params}, callback(ret))
params
codeId：
- 类型：字符串
- 描述：（必选项）代码位id
- 默认值：无
userId:
- 类型：字符串
- 描述：（可选项）当前用户id 用于服务器验证
- 默认值：空
extraData:
- 类型：字符串
- 描述：（可选项）附加消息 用于服务器验证
- 默认值：空
callback(ret)
ret：
- 类型：JSON 对象
- 内部字段：
{
status true false
result 加载中 具体错误码或原因说明
加载成功 缓存失败
ECPM:0
缓存中
缓存成功
展示
点击
奖励:true
跳过
关闭
}
示例代码
var zyBaiduAd = api.require('zyBaiduAd');
var param = {
codeId:api.systemType=='ios'?"5889473":"5925490",//代码位
userId:"",//用户id
extraData:"",//自定义参数
};
api.showProgress({});
zyBaiduAd.adLoadRewardVideo(param,function(ret){
console.log("zyBaiduAd："+JSON.stringify(ret));
if(ret.status){
if(ret.result == "缓存成功"){
api.hideProgress();
//缓存成功后可以展示广告
//moduleClick('adShowRewardVideo');
//api.setFullScreen({fullScreen: true,animation:"slide"});
}
if(ret.result == "关闭"){
api.setFullScreen({fullScreen: false,animation:"slide"});
}
}else{
api.hideProgress();
api.toast({ msg:ret.result })
}
});
可用性
Android系统，ios系统
可提供的2.0.0及更高版本
adShowRewardVideo
展示激励视频
adShowRewardVideo(callback(ret))
callback(ret)
ret：
- 类型：JSON 对象
- 内部字段：
{
status:false,
result: 请先加载广告
广告过期
}
示例代码
var zyBaiduAd = api.require('zyBaiduAd');
zyBaiduAd.adShowRewardVideo(function(ret){
console.log("zyBaiduAd："+JSON.stringify(ret));
if(!ret.status){
api.toast({ msg:ret.result })
}
});
可用性
Android系统，ios系统
可提供的2.0.0及更高版本
adLoadFullScreenVideo
加载全屏视频广告
adLoadFullScreenVideo({params}, callback(ret))
params
codeId：
- 类型：字符串
- 描述：（必选项）代码位id
- 默认值：无
callback(ret)
ret：
- 类型：JSON 对象
- 内部字段：
{
status true false
result 加载中 具体错误码或原因说明
加载成功 缓存失败
ECPM:0
缓存中
缓存成功
展示
点击
跳过
关闭
}
示例代码
var param = {
codeId:api.systemType=='ios'?"5889473":"7339862",//代码位
};
api.showProgress({});
zyBaiduAd.adLoadFullScreenVideo(param,function(ret){
console.log("zyBaiduAd："+JSON.stringify(ret));
if(ret.status){
if(ret.result == "缓存成功"){
api.hideProgress();
//缓存成功后可以展示广告
//moduleClick('adShowFullScreenVideo');
//api.setFullScreen({fullScreen: true,animation:"slide"});
}
if(ret.result == "关闭"){
api.setFullScreen({fullScreen: false,animation:"slide"});
}
}else{
api.hideProgress();
api.toast({ msg:ret.result })
}
});
可用性
Android系统，ios系统
可提供的2.0.0及更高版本
adShowFullScreenVideo
展示全屏视频
adShowFullScreenVideo(callback(ret))
callback(ret)
ret：
- 类型：JSON 对象
- 内部字段：
{
status false
result 请先加载广告
广告过期
}
示例代码
var zyBaiduAd = api.require('zyBaiduAd');
zyBaiduAd.adShowFullScreenVideo(function(ret){
console.log("zyBaiduAd："+JSON.stringify(ret));
if(!ret.status){
api.toast({ msg:ret.result })
}
});
可用性
Android系统，ios系统
可提供的2.0.0及更高版本
adShowFeed
展示信息流广告(注意插件打开之后会返回插件高度请参考demo重新设置广告区域)
adShowFeed({params}, callback(ret))
params
tag：
- 类型：字符串
- 描述：（可选项）唯一广告标识
- 默认值：_default
codeId：
- 类型：字符串
- 描述：（必选项）代码位id
- 默认值：无
rect：
- 类型：对象
- 描述：（可选项）打开区域
- 内部字段：
{
x:0,
y:0,
w:0,
h:600
}
fixedOn：
- 类型：字符串类型
- 描述：（可选项）插件视图添加到指定 frame 的名字（只指 frame，传 window 无效）
- 默认值：插件依附于当前 window
fixed:
- 类型：布尔
- 描述：（可选项）插件是否不随所属 window 或 frame 滚动
- 默认值：true（不随之滚动）
callback(ret)
ret：
- 类型：JSON 对象
- 内部字段：
{
status true false
result 加载中 具体错误码加原因说明
加载成功 加载失败
ECPM:0
view添加
展示
点击
不喜欢
关闭
}
示例代码
var zyBaiduAd = api.require('zyBaiduAd');
var param = {
tag:"_default",
codeId:api.systemType=='ios'?"6481011":"6481012",//代码位
rect:{
x:0,
y:0,
w:360,
h:300
},
fixedOn:api.frameName,
fixed:false
};
zyBaiduAd.adShowFeed(param,function(ret){
console.log("zyBaiduAd："+JSON.stringify(ret));
});
可用性
Android系统，ios系统
可提供的2.0.0及更高版本
adCloseFeed
关闭信息流 传入tag 默认关闭_default 传 all清除所有
adCloseFeed(callback(ret))
示例代码
var zyBaiduAd = api.require('zyBaiduAd');
zyBaiduAd.adCloseFeed({tag:"all"});
可用性
Android系统，ios系统
可提供的2.0.0及更高版本
adSetAttr
重设广告的显示区域
adSetAttr({params}, callback(ret))
params
type：
- 类型：字符串
- 描述：（必填项）banner、feed、feed2分别为banner、信息流、优选模板信息流三种类型
tag：
- 类型：字符串
- 描述：（必填项）唯一广告标识
rect：
- 类型：对象
- 描述：（必填项）重设展示区域
- 内部字段：
{
x:0,
y:0,
w:0,
h:0
}
示例代码
var zyBaiduAd = api.require('zyBaiduAd');
setTimeout(function(){
for(var i = 0; i < openAds.length; i++){
var divOff = $api.offset($api.byId("myAddPage" + openAds[i].id));
zyBaiduAd.adSetAttr({
type:openAds[i].type,
tag:openAds[i].tag,
rect:{//显示位置
x:divOff.l,
y:divOff.t,
w:divOff.w,
h:divOff.h
},
});
}
},0);
可用性
Android系统，ios系统
可提供的2.0.0及更高版本
adShowFeed2
展示优选模板信息流广告(注意插件打开之后会返回插件高度请参考demo重新设置广告区域)
adShowFeed2({params}, callback(ret))
params
tag：
- 类型：字符串
- 描述：（可选项）唯一广告标识
- 默认值：_default
codeId：
- 类型：字符串
- 描述：（必选项）代码位id
- 默认值：无
rect：
- 类型：对象
- 描述：（可选项）打开区域
- 内部字段：
{
x:0,
y:0,
w:0,
h:600
}
fixedOn：
- 类型：字符串类型
- 描述：（可选项）插件视图添加到指定 frame 的名字（只指 frame，传 window 无效）
- 默认值：插件依附于当前 window
fixed:
- 类型：布尔
- 描述：（可选项）插件是否不随所属 window 或 frame 滚动
- 默认值：true（不随之滚动）
callback(ret)
ret：
- 类型：JSON 对象
- 内部字段：
{
status true false
result 加载中 具体错误码加原因说明
加载成功 加载失败
ECPM:0
view添加
展示
点击
不喜欢
关闭
}
示例代码
var zyBaiduAd = api.require('zyBaiduAd');
var param = {
tag:"_default",
codeId:api.systemType=='ios'?"8035136":"8035132",//代码位
rect:{
x:0,
y:0,
w:360,
h:300
},
fixedOn:api.frameName,
fixed:false
};
zyBaiduAd.adShowFeed2(param,function(ret){
console.log("zyBaiduAd："+JSON.stringify(ret));
});
可用性
Android系统，ios系统
可提供的2.0.0及更高版本
adCloseFeed2
关闭优选模板信息流 传入tag 默认关闭_default 传 all清除所有
adCloseFeed2(callback(ret))
示例代码
var zyBaiduAd = api.require('zyBaiduAd');
zyBaiduAd.adCloseFeed2({tag:"all"});
可用性
Android系统，ios系统
可提供的2.0.0及更高版本
adShowVideoPatch
打开贴片广告
adShowVideoPatch({params}, callback(ret))
params
codeId：
- 类型：字符串
- 描述：（必选项）代码位id
- 默认值：无
rect：
- 类型：对象
- 描述：（可选项）打开区域
- 内部字段：
{
x:0,
y:0,
w:0,
h:0
}
fixedOn：
- 类型：字符串类型
- 描述：（可选项）插件视图添加到指定 frame 的名字（只指 frame，传 window 无效）
- 默认值：插件依附于当前 window
fixed:
- 类型：布尔
- 描述：（可选项）插件是否不随所属 window 或 frame 滚动
- 默认值：true（不随之滚动）
callback(ret)
ret：
- 类型：JSON 对象
- 内部字段：
{
status true false
result 加载中 具体错误码或原因说明
加载成功 缓存失败
ECPM:0
展示
点击
关闭
}
示例代码
var zyBaiduAd = api.require('zyBaiduAd');
var param = {
codeId:api.systemType=='ios'?"14492389":"2058634",//代码位
rect:{//显示位置
x:0,
y:60,
w:api.winWidth,
h:220
},
fixedOn:"",
fixed:true,
};
zyBaiduAd.adShowVideoPatch(param,function(ret){
console.log("zyBaiduAd："+JSON.stringify(ret));
if(!ret.status){
api.toast({ msg:ret.result })
}
});
可用性
Android系统，ios系统
可提供的2.0.0及更高版本
adCloseVideoPatch
关闭贴片广告
adCloseVideoPatch(callback(ret))
callback(ret)
ret：
- 类型：JSON 对象
- 内部字段：
{
status:true,
result:"关闭"
}
示例代码
var zyBaiduAd = api.require('zyBaiduAd');
zyBaiduAd.adCloseVideoPatch(function(ret){
console.log("zyBaiduAd："+JSON.stringify(ret));
if(!ret.status){
api.toast({ msg:ret.result })
}
});
可用性
Android系统，ios系统
可提供的2.0.0及更高版本
getVersions
获取当前集成的sdk版本号
getVersions(callback(ret))
callback(ret)
ret：
- 类型：JSON 对象
- 内部字段：
{
status:true, //调用成功
result:"4.75",//结果
}
示例代码
var zyBaiduAd = api.require('zyBaiduAd');
zyBaiduAd.getVersions(function(ret){
alert("zyBaiduAd："+JSON.stringify(ret));
});
可用性
Android系统，ios系统
可提供的1.0.0及更高版本
requestPermissionIfNecessary
建议在广告初始化之前，添加如下设置，可有效提升ecpm，全局生效
requestPermissionIfNecessary()
示例代码
var zyBaiduAd = api.require('zyBaiduAd');
zyBaiduAd.requestPermissionIfNecessary();
可用性
Android系统，ios系统
可提供的1.0.0及更高版本
init
初始化插件（使用前必须）
init({params}, callback(ret))
params
appId:
- 类型：字符串
- 描述：（必选项）应用id
- 默认值：api.systemType=='ios'?"ccb60059":"e866cfb0"
callback(ret)
ret：
- 类型：JSON 对象
- 内部字段：
{
status:true,
result:"初始化完成"
}
示例代码
var zyBaiduAd = api.require('zyBaiduAd');
var param = {
appId:api.systemType=='ios'?"ccb60059":"e866cfb0"
};
zyBaiduAd.init(param,function(ret){
console.log("zyBaiduAd："+JSON.stringify(ret));
});
可用性
Android系统，ios系统
可提供的1.0.0及更高版本
showSplashAd
展示开屏广告
showSplashAd({params}, callback(ret))
params
setCodeId：
- 类型：字符串
- 描述：（必选项）代码位id
- 默认值：api.systemType=='ios'?"2058492":"2058622"
rect：
- 类型：对象
- 描述：（可选项）打开开屏区域 全为0或不写 则打开全屏
- 内部字段：
{
x:0,
y:0,
w:0,
h:0
}
fixedOn：
- 类型：字符串类型
- 描述：（可选项）插件视图添加到指定 frame 的名字（只指 frame，传 window 无效）
- 默认值：插件依附于当前 window
fixed:
- 类型：布尔
- 描述：（可选项）插件是否不随所属 window 或 frame 滚动
- 默认值：true（不随之滚动）
callback(ret)
ret：
- 类型：JSON 对象
- 内部字段：
{
status:true, //true的结果如下 false结果则显示对应错误提示
result:"开屏广告加载中"
"view已添加"
"开屏广告展示"
"开屏广告点击"
"开屏广告跳过"
"开屏广告关闭"
}
示例代码
var zyBaiduAd = api.require('zyBaiduAd');
var param = {
setCodeId:api.systemType=='ios'?"2058492":"2058622",//默认测试代码位
rect:{//开屏位置 默认0即为全屏 也可自定义
x:0,
y:0,
w:0,
h:0
},
fixedOn:"",
fixed:true
};
zyBaiduAd.showSplashAd(param,function(ret){
console.log("zyBaiduAd："+JSON.stringify(ret));
});
可用性
Android系统，ios系统
可提供的1.0.0及更高版本
closeSplashAd
关闭开屏广告
closeSplashAd(callback(ret))
callback(ret)
ret：
- 类型：JSON 对象
- 内部字段：
{
status:true,
result:"splashAd已关闭"
}
示例代码
var zyBaiduAd = api.require('zyBaiduAd');
zyBaiduAd.closeSplashAd(function(ret){
console.log("zyBaiduAd："+JSON.stringify(ret));
});
可用性
Android系统，ios系统
可提供的1.0.0及更高版本
showBannerAd
展示Banner广告
showBannerAd({params}, callback(ret))
params
tag：
- 类型：字符串
- 描述：（可选项）打开此banner的标识 需要打开多个banner可设置不同的tag 手动close时传入对应tag即可关闭对应banner
- 默认值：_default
setCodeId：
- 类型：字符串
- 描述：（必选项）代码位id
- 默认值：api.systemType=='ios'?"3722589":"2015351"
rect：
- 类型：对象
- 描述：（可选项）打开开屏区域 全为0或不写 则打开全屏
- 内部字段：
{
x:0,
y:0,
w:0,
h:0
}
fixedOn：
- 类型：字符串类型
- 描述：（可选项）插件视图添加到指定 frame 的名字（只指 frame，传 window 无效）
- 默认值：插件依附于当前 window
fixed:
- 类型：布尔
- 描述：（可选项）插件是否不随所属 window 或 frame 滚动
- 默认值：true（不随之滚动）
callback(ret)
ret：
- 类型：JSON 对象
- 内部字段：
{
status:true, //true的结果如下 false结果则显示对应错误提示
result:"banner加载中"
"banner展示"
"banner点击"
"bannerAd已关闭"
}
示例代码
var param = {
tag:"_default",
setCodeId:api.systemType=='ios'?"3722589":"2015351",//默认测试代码位
rect:{//显示位置
x:20,
y:100,
w:api.winWidth-40,
h:70
},
fixedOn:api.frameName,
fixed:false,
};
zyBaiduAd.showBannerAd(param,function(ret){
console.log("zyBaiduAd："+JSON.stringify(ret));
});
可用性
Android系统，ios系统
可提供的1.0.0及更高版本
closeBannerAd
手动关闭Banner广告
closeBannerAd({params}, callback(ret))
params
tag：
- 类型：字符串
- 描述：（可选项）打开此banner的标识
- 默认值：_default
callback(ret)
ret：
- 类型：JSON 对象
- 内部字段：
{
status:true,
result:"bannerAd已关闭"
}
示例代码
var zyBaiduAd = api.require('zyBaiduAd');
zyBaiduAd.closeBannerAd({tag:"_default"},function(ret){
console.log("zyBaiduAd："+JSON.stringify(ret));
});
可用性
Android系统，ios系统
可提供的1.0.0及更高版本
showInteractionAd
展示插屏广告
showInteractionAd({params}, callback(ret))
params
setCodeId：
- 类型：字符串
- 描述：（必选项）代码位id
- 默认值：api.systemType=='ios'?"2403633":"2403633"
callback(ret)
ret：
- 类型：JSON 对象
- 内部字段：
{
status:true, //true的结果如下 false结果则显示对应错误提示
result:"插屏广告加载中"
"view已添加"
"插屏广告展示"
"插屏广告点击"
"插屏广告消失"
}
示例代码
var zyBaiduAd = api.require('zyBaiduAd');
var param = {
setCodeId:api.systemType=='ios'?"2403633":"2403633",//默认测试代码位
};
zyBaiduAd.showInteractionAd(param,function(ret){
console.log("zyBaiduAd："+JSON.stringify(ret));
});
可用性
Android系统，ios系统
可提供的1.0.0及更高版本
loadRewardVideoAd
加载激励视频广告
loadRewardVideoAd({params}, callback(ret))
params
setCodeId：
- 类型：字符串
- 描述：（必选项）代码位id
- 默认值：api.systemType=='ios'?"5889473":"5925490"
setUserID:
- 类型：字符串
- 描述：（可选项）当前用户id 用于服务器验证
- 默认值：空
setMediaExtra:
- 类型：字符串
- 描述：（可选项）附加消息 用于服务器验证
- 默认值：空
setShowDialogOnSkip:
- 类型：布尔型
- 描述：（可选项）设置点击跳过时是否展示提示弹框
- 默认值：true
setUseRewardCountdown:
- 类型：布尔型
- 描述：（可选项）设置是否展示奖励领取倒计时提示
- 默认值：true
callback(ret)
ret：
- 类型：JSON 对象
- 内部字段：
{
status:true, //true的结果如下 false结果则显示对应错误提示
result:"激励视频加载中"
"激励视频缓存完成"
"激励视频展示"
"激励视频点击"
"激励视频播放完"
"激励视频关闭"
}
示例代码
var zyBaiduAd = api.require('zyBaiduAd');
var param = {
setCodeId:api.systemType=='ios'?"5889473":"5925490",//默认测试代码位
};
zyBaiduAd.loadRewardVideoAd(param,function(ret){
console.log("zyBaiduAd："+JSON.stringify(ret));
});
可用性
Android系统，ios系统
可提供的1.0.0及更高版本
showRewardVideoAd
展示激励视频
showRewardVideoAd(callback(ret))
callback(ret)
ret：
- 类型：JSON 对象
- 内部字段：
{
status:true|false,
result:"展示广告|广告已过期|请先加载广告"
}
示例代码
var zyBaiduAd = api.require('zyBaiduAd');
zyBaiduAd.showRewardVideoAd(function(ret){
console.log("zyBaiduAd："+JSON.stringify(ret));
});
可用性
Android系统，ios系统
可提供的1.0.0及更高版本
loadFullScreenVideoAd
加载全屏视频广告
loadFullScreenVideoAd({params}, callback(ret))
params
setCodeId：
- 类型：字符串
- 描述：（必选项）代码位id
- 默认值：api.systemType=='ios'?"5889473":"7339862"
callback(ret)
ret：
- 类型：JSON 对象
- 内部字段：
{
status:true, //true的结果如下 false结果则显示对应错误提示
result:"全屏视频加载中"
"全屏视频缓存完成"
"全屏视频展示"
"全屏视频点击"
"全屏视频播放完"
"全屏视频关闭"
"全屏视频跳过"
}
示例代码
var zyBaiduAd = api.require('zyBaiduAd');
var param = {
setCodeId:api.systemType=='ios'?"5889473":"7339862",//默认测试代码位
};
zyBaiduAd.loadFullScreenVideoAd(param,function(ret){
console.log("zyBaiduAd："+JSON.stringify(ret));
});
可用性
Android系统，ios系统
可提供的1.0.0及更高版本
showFullScreenVideoAd
展示全屏视频
showFullScreenVideoAd(callback(ret))
callback(ret)
ret：
- 类型：JSON 对象
- 内部字段：
{
status:true|false,
result:"展示广告|广告已过期|请先加载广告"
}
示例代码
var zyBaiduAd = api.require('zyBaiduAd');
zyBaiduAd.showFullScreenVideoAd(function(ret){
console.log("zyBaiduAd："+JSON.stringify(ret));
});
可用性
Android系统，ios系统
可提供的1.0.0及更高版本
showNativeExpressAd
展示信息流广告(注意插件打开之后会返回插件高度请参考demo重新设置广告区域)
showNativeExpressAd({params}, callback(ret))
params
tag：
- 类型：字符串
- 描述：（可选项）唯一广告标识
- 默认值：_default
setCodeId：
- 类型：字符串
- 描述：（必选项）代码位id
- 默认值：api.systemType=='ios'?"6481011":"6481012"
rect：
- 类型：对象
- 描述：（可选项）打开展示区域
- 内部字段：
{
x:0,
y:0,
w:0,
h:600
}
fixedOn：
- 类型：字符串类型
- 描述：（可选项）插件视图添加到指定 frame 的名字（只指 frame，传 window 无效）
- 默认值：插件依附于当前 window
fixed:
- 类型：布尔
- 描述：（可选项）插件是否不随所属 window 或 frame 滚动
- 默认值：true（不随之滚动）
callback(ret)
ret：
- 类型：JSON 对象
- 内部字段：
{
status:true, //true的结果如下 false结果则显示对应错误提示
result:"信息流广告加载中"
"view已添加"
"信息流广告曝光时"
"信息流广告点击"
"信息流已关闭"
}
示例代码
var zyBaiduAd = api.require('zyBaiduAd');
var param = {
tag:"_default",
setCodeId:api.systemType=='ios'?"6481011":"6481012",//代码位
rect:{
x:0,
y:0,
w:360,
h:300
},
fixedOn:api.frameName,
fixed:false
};
zyBaiduAd.showNativeExpressAd(param,function(ret){
console.log("zyBaiduAd："+JSON.stringify(ret));
});
可用性
Android系统，ios系统
可提供的1.0.0及更高版本
closeNativeExpressAd
关闭信息流 传入tag 默认关闭_default 传 all清除所有
closeNativeExpressAd(callback(ret))
示例代码
var zyBaiduAd = api.require('zyBaiduAd');
zyBaiduAd.closeNativeExpressAd({tag:"all"});
可用性
Android系统，ios系统
可提供的1.0.0及更高版本
showVideoPatchAd
打开贴片广告
showVideoPatchAd({params}, callback(ret))
params
setCodeId：
- 类型：字符串
- 描述：（必选项）代码位id
- 默认值：api.systemType=='ios'?"2058633":"2058634"
rect：
- 类型：对象
- 描述：（可选项）打开开屏区域 全为0或不写 则打开全屏
- 内部字段：
{
x:0,
y:0,
w:0,
h:0
}
fixedOn：
- 类型：字符串类型
- 描述：（可选项）插件视图添加到指定 frame 的名字（只指 frame，传 window 无效）
- 默认值：插件依附于当前 window
fixed:
- 类型：布尔
- 描述：（可选项）插件是否不随所属 window 或 frame 滚动
- 默认值：true（不随之滚动）
callback(ret)
ret：
- 类型：JSON 对象
- 内部字段：
{
status:true, //true的结果如下 false结果则显示对应错误提示
result:"贴片广告加载中"
"贴片广告加载成功"
"贴片广告展示"
"贴片广告点击"
"贴片广告已关闭"
}
示例代码
var zyBaiduAd = api.require('zyBaiduAd');
var param = {
setCodeId:api.systemType=='ios'?"2058633":"2058634",//代码位
rect:{//显示位置
x:0,
y:60,
w:api.winWidth,
h:220
},
fixedOn:"",
fixed:true,
};
zyBaiduAd.showVideoPatchAd(param,function(ret){
console.log("zyBaiduAd："+JSON.stringify(ret));
});
可用性
Android系统，ios系统
可提供的1.0.0及更高版本
closeVideoPatchAd
关闭贴片广告
closeVideoPatchAd(callback(ret))
callback(ret)
ret：
- 类型：JSON 对象
- 内部字段：
{
status:true,
result:"贴片广告已关闭"
}
示例代码
var zyBaiduAd = api.require('zyBaiduAd');
zyBaiduAd.closeVideoPatchAd(function(ret){
console.log("zyBaiduAd："+JSON.stringify(ret));
});
可用性
Android系统，ios系统
可提供的1.0.0及更高版本
setAttr
重设广告的显示区域
setAttr({params}, callback(ret))
params
type：
- 类型：字符串
- 描述：（必填项）banner、nativeExpress、nativeExpress2 分别为banner、信息流、信息流2.0三种类型
tag：
- 类型：字符串
- 描述：（必填项）唯一广告标识
rect：
- 类型：对象
- 描述：（必填项）重设展示区域
- 内部字段：
{
x:0,
y:0,
w:0,
h:0
}
示例代码
var zyBaiduAd = api.require('zyBaiduAd');
setTimeout(function(){
for(var i = 0; i < openAds.length; i++){
var divOff = $api.offset($api.byId("myAddPage" + openAds[i].id));
zyBaiduAd.setAttr({
type:openAds[i].type,
tag:openAds[i].tag,
rect:{//重新显示位置
x:divOff.l,
y:divOff.t,
w:divOff.w,
h:divOff.h
},
});
}
},0);
可用性
Android系统，ios系统
可提供的1.0.0及更高版本
showExpressFeedAd
打开优选模板信息流广告(注意插件打开之后会返回插件高度请参考demo重新设置广告区域)
showExpressFeedAd({params}, callback(ret))
params
tag：
- 类型：字符串
- 描述：（可选项）唯一广告标识
- 默认值：_default
setCodeId：
- 类型：字符串
- 描述：（必选项）代码位id
- 默认值：api.systemType=='ios'?"8035136":"8035132"
rect：
- 类型：对象
- 描述：（可选项）打开展示区域
- 内部字段：
{
x:0,
y:0,
w:0,
h:600
}
fixedOn：
- 类型：字符串类型
- 描述：（可选项）插件视图添加到指定 frame 的名字（只指 frame，传 window 无效）
- 默认值：插件依附于当前 window
fixed:
- 类型：布尔
- 描述：（可选项）插件是否不随所属 window 或 frame 滚动
- 默认值：true（不随之滚动）
callback(ret)
ret：
- 类型：JSON 对象
- 内部字段：
{
status:true, //true的结果如下 false结果则显示对应错误提示
result:"信息流广告加载中"
"view已添加"
"信息流广告曝光时"
"信息流广告点击"
"信息流已关闭"
}
示例代码
var zyBaiduAd = api.require('zyBaiduAd');
var param = {
tag:"_default",
setCodeId:api.systemType=='ios'?"8035136":"8035132",//代码位
rect:{
x:0,
y:0,
w:360,
h:300
},
fixedOn:api.frameName,
fixed:false
};
zyBaiduAd.showExpressFeedAd(param,function(ret){
console.log("zyBaiduAd："+JSON.stringify(ret));
});
可用性
Android系统，ios系统
可提供的1.1.1及更高版本
closeExpressFeedAd
关闭优选模板信息流 传入tag 默认关闭_default 传 all清除所有
closeExpressFeedAd(callback(ret))
示例代码
var zyBaiduAd = api.require('zyBaiduAd');
zyBaiduAd.closeExpressFeedAd({tag:"all"});
可用性
Android系统，ios系统
可提供的1.1.1及更高版本