赋能广告接入文档

# Banner(横幅)广告

本SDK为接入方提供个性化模板Banner广告，开发者不用自行对广告样式进行编辑和渲染，广告样式模板以及微调后期支持开发者编辑。

目前广告位尺寸包含:

600×90 、 600×100 、 600×150 、 600×200 、 600×300 、 600×400 、 600×500 、 600×500 、 600×260 、 690×388

如需定制上述尺寸,请沟通商务.

使用完毕后,请“务必”调用destroyBannerAd方法销毁广告,以免造成 内存泄漏 从而导致App崩溃.

# 使用

加载并显示Banner

var fnad = api.require('fnad');
var param = {positionId: "b5f4a262254c6e", position: {x: 20, y: 400, width: api.winWidth - 40, height: 120}};
// 加载并显示Banner,如果改Banner Id存在则会销毁并重新加载
fnad.loadBannerAd(param, function (ret, error) {
    console.log(JSON.stringify(ret));
});
1
2
3
4
5
6

# 参数说明

参数示例:

var param = {
    positionId: "b5f4a262254c6e", //广告位Id(必填)
    id: "_DEFAULT",//String,定义一个ID,方便关闭,默认为"_DEFAULT"(可选)
    fixed: true,//模块是否不随所属 frame 滚动,默认true不随frame滚动(可选)
    fixedOn: null,//String,模块视图添加到指定 frame 的名字 只指 frame，传 window 无效(可选)
    position: {//广告位置尺寸(可选)
        x: 0,//int,广告x坐标(可选)
        y: 0,//int,广告y坐标(可选)
        width: -1,//int,广告宽度,-1表示自适应并居中(可选)
        height: -1//int,广告高度,-1表示自适应并居中(可选)
    }
}
1
2
3
4
5
6
7
8
9
10
11
12

# positionId

  • 类型: String
  • 默认: 无
  • 必须: 是
  • 描述: 广告位ID

# id

  • 类型: String
  • 默认: _DEFAULT
  • 必须: 否
  • 描述: 设置一个bannerId 方便管理和销毁Banner

# fixed

  • 类型: boolean
  • 默认值: true（不随之滚动）
  • 描述: （可选项）模块是否不随所属 frame 滚动

# fixedOn

  • 类型: String
  • 默认值: 模块依附于当前 window
  • 必须: 否
  • 描述: （可选项）模块视图添加到指定 frame 的名字（只指 frame，传 window 无效）

# position

  • 类型: JSON
  • 默认值: 无
  • 必须: 否
  • 描述: 广告坐标及尺寸

# 加载回调

# callback(ret,error)

ret参数

ret = {
    callback: "onLoadSuccess",  //String,回调方法
                                //onLoadError   广告加载错误
                                //onLoadSuccess 广告加载成功
                                //onAdClicked   点击关闭按钮
                                //onCancel      广告被关闭
    code: null, //int,错误代码,非错误不返回
    msg: null //int,错误消息,非错误不返回
}
1
2
3
4
5
6
7
8
9

callback:

回调方法 描述
onLoadError 广告加载错误
onLoadSuccess 广告加载成功
onAdClicked 点击关闭按钮
onCancel 广告被关闭

# 销毁Banner

var param = {}
fnad.desctroyBannerAd(param, function (ret) {
    console.log(JSON.stringify(ret));
});
1
2
3
4

# 参数说明

示例:

var param = {
    id: "banner01" //String,需要销毁的广告位ID,默认为"_DEFAULT"(可选)
};
1
2
3

# id

  • 类型: String
  • 默认: _DEFAULT
  • 必须: 否
  • 描述: 设置一个bannerId 方便管理和销毁Banner

# 回调

ret参数

ret = {
    callback: "onDestroyed", //String,回调方法
                             //onDestroyed    销毁成功
                             //onDestroyError 销毁失败
    code: null, //int,错误代码,非错误不返回
    msg: null //int,错误消息,非错误不返回
}
1
2
3
4
5
6
7

← 全屏视频 →