zyBaiduAd

来自于：勇可可立即使用

其它接口

getVersions requestPermissionIfNecessary

模块接口

init showSplashAd closeSplashAd showBannerAd closeBannerAd showInteractionAd loadRewardVideoAd showRewardVideoAd loadFullScreenVideoAd showFullScreenVideoAd showNativeExpressAd closeNativeExpressAd showVideoPatchAd closeVideoPatchAd setAttr

论坛示例

为帮助用户更好更快的使用模块，论坛维护了一个示例，示例中包含示例代码供您参考。

概述

模块简介

zyBaiduAd封装百度百青藤 Android、Ios广告sdk，包含Banner、插屏、开屏、激励视频、全屏视频、贴片、信息流广告等功能，信息流模块，解决划动时会触摸误点的问题。

IOS 云编译最低版本为9.0，Android云编译最低版本为4.0.3。

使用模块前请先到百度百青藤后台注册帐号、新建应用、添加代码位使用。模块中默认测试代码位可直接测试使用。

点击进入百青藤控制台

模块接口

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及更高版本

APICloud

模块开发

端API

设备访问

功能扩展

界面布局

导航菜单

开放SDK

云服务对接

AVM多端模块

H5模块

前端框架

云API

技术专题

开发工具

下载

微信公众号适配

七天培训课教程

其他

Faq

开放平台接入指南

自定义加速域名

云主机

入门教程

部署与管理

常见FAQ

MTL.js

zyBaiduAd

论坛示例

概述

模块接口

getVersions

callback(ret)

示例代码

可用性

requestPermissionIfNecessary

示例代码

可用性

init

params

callback(ret)

示例代码

可用性

showSplashAd

params

callback(ret)

示例代码

可用性

closeSplashAd

callback(ret)

示例代码

可用性

showBannerAd

params

callback(ret)

示例代码

可用性

closeBannerAd

params

callback(ret)

示例代码

可用性

showInteractionAd

params

callback(ret)

示例代码

可用性

loadRewardVideoAd

params

callback(ret)

示例代码

可用性

showRewardVideoAd

callback(ret)

示例代码

可用性

loadFullScreenVideoAd

params

callback(ret)

示例代码