fnad

来自于：北京赋能广告有限公司立即使用

getVersion getSDKVersion init loadSplashAd loadRewardAd loadBannerAd destroyBannerAd loadFullVideoAd loadInterstitialAd loadContentVlog loadPageVlog

概述

本模块封装了赋能广告原生 SDK，目前包含开屏、激励视频、Banner 、插屏、全屏视频等广告类型。

模块使用攻略

使用之前须联系赋能广告商务，获取 appid 和 appkey,

平台接入流程参考赋能广告接入文档

模块接口

getVersion

获取插件版本

getVersion(callback(ret, err))

callback(ret, err)

ret：

类型: JSON
内部字段：

{
    version: '1.0.0'      //String，插件版本
}

示例代码

var fnad = api.require('fnad');
fnad.getVersion(function(ret) {
    alter('插件版本:'+ret.version);
});

可用性

Android系统

可提供的1.0.0及更高版本

getSDKVersion

获取插件版本

getSDKVersion(callback(ret, err))

callback(ret, err)

ret：

类型: JSON
内部字段：

{
    version: '1.0.0'      //String，插件版本
}

示例代码

var fnad = api.require('fnad');
fnad.getVersion(function(ret) {
    alter('插件版本:'+ret.version);
});

可用性

Android系统

可提供的1.0.0及更高版本

init

初始化广告SDK

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

params

appId：

类型: String
默认值：无
必须: 是
描述: AppId,向商务索取

apiKey：

类型: String
默认值：无
必须: 是
描述: AppKey,向商务索取

callback(ret, err)

ret：

类型: JSON
内部字段：

{
    callback: "initSuccess" //String 回调,初始化是否成功
                            //initSuccess  初始化成功
                            //initError    初始化失败
    code: null,//int,错误代码,非错误不返回
    msg: null//int,错误消息,非错误不返回
}

示例代码

var fnad = api.require('fnad');
fnad.init({appId: "a5f4a25e35daa3", appKey: "52009c8cc00bf67d328d68ecb7c76adf"}，function(ret){
    console.log(JSON.stringify(ret));
});

可用性

Android系统

可提供的1.0.0及更高版本

loadSplashAd

加载开屏广告.

开屏广告宽高默认为100%,注意开屏广告的height>=75%屏幕高，否则会影响计费

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

params

positionId：

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

position：

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

{
    x: 0,//int,广告x坐标(可选)
    y: 0,//int,广告y坐标(可选)
    width: -1,//int,广告宽度,-1表示自适应并居中(可选)
    height: -1//int,广告高度,-1表示自适应并居中(可选)
}

callback(ret, err)

ret：

类型: JSON
内部字段：

{
    callback: "onLoadSuccess",  //String,回调方法
                                //onLoadSuccess  广告加载成功
                                //onLoadError    广告加载失败
                                //onLoadTimeout  广告加载超时
                                //onAdShow       广告显示
                                //onAdClicked    广告被点击
    code: null,//int,错误代码,非错误不返回
    msg: null//int,错误消息,非错误不返回
}

示例代码

var param = {positionId: "b5f4a25f971cd3", position: {height: parseInt(api.winHeight * 0.85)}};
fnad.loadSplashAd(param, function (ret, err) {
    var callback = ret.callback;
    if (callback === 'onLoadError') {
        api.toast({
            msg: ret.callback + '@' + ret.code + ':' + ret.msg
        });
    }
    api.toast({
        msg: '触发回调' + callback
    });
});

可用性

Android系统

可提供的1.0.0及更高版本

loadRewardAd

加载并显示激励视频

本插件为接入方提供激励视频广告，该广告的效果为观看完毕视频广告，发放奖励给用户。使用场景包括但不限于：

游戏等应用内观看视频广告获得游戏内金币等；
积分类应用接入。

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

params

positionId

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

callback(ret, err)

ret：

类型: JSON
内部字段：

{
    callback: "onLoadSuccess",  //String,回调方法
                                //onAdShow           广告显示
                                //onAdBarClick       广告被点击
                                //onAdClose          广告关闭
                                //onVideoComplete    广告播放完毕
                                //onVideoError       广告播放错误
                                //onSkippedVideo     广告跳过
                                //onLoadError        广告加载错误
                                //onLoadSuccess      广告加载成功
                                //onVideoCached      广告被缓存
    code: null,//int,错误代码,非错误不返回
    msg: null//int,错误消息,非错误不返回
}

示例代码

var param = {positionId: "b5f4a261182671"};
fnad.loadRewardAd(param, function (ret, error) {
    var callback = ret.callback;
    if (callback === 'onLoadSuccess' || callback === 'onLoadError' || callback === 'onVideoError') {
        api.hideProgress();
    }
});

可用性

Android系统

可提供的1.0.0及更高版本

loadBannerAd

加载并显示Banner

注意： BANNER 使用完毕后请务必调用destroyBannerAd销毁,否则会造成内存泄漏,导致应用崩溃

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

目前广告位尺寸包含:

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

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

params

positionId:

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

id:

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

fixed:

类型: boolean
默认值：true(不随之滚动)
必须: 否
描述: 模块是否不随所属 frame 滚动

fixedOn：

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

position:

类型: JSON
默认值: 无
必须: 是
描述:广告坐标及尺寸
内部字段:

{
    x: 0,//int,广告x坐标,默认0(可选)
    y: 0,//int,广告y坐标,默认0(可选)
    width: -1,//int,广告宽度,-1表示自适应并居中,默认-1(可选)
    height: -1//int,广告高度,-1表示自适应并居中,默认-1(可选)
}

callback(ret, err)

ret：

类型: JSON
内部字段：

{
    callback: "onLoadSuccess",  //String,回调方法
                                //onLoadError 广告加载错误
                                //onLoadSuccess 广告加载成功
                                //onAdClicked 点击关闭按钮
                                //onCancel 广告被关闭
    code: null, //int,错误代码,非错误不返回
    msg: null //int,错误消息,非错误不返回
}

示例代码

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));
});

可用性

Android系统

可提供的1.0.0及更高版本

destroyBannerAd

销毁Banner

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

params

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

callback(ret, err)

ret：

类型: JSON
内部字段：

{
    callback: "onDestroyed", //String,回调方法
                             //onDestroyed 销毁成功
                             //onDestroyError 销毁失败
    code: null, //int,错误代码,非错误不返回
    msg: null //int,错误消息,非错误不返回
}

示例代码

var param = {id:"_DEFAULT"}
fnad.desctroyBannerAd(param, function (ret) {
    console.log(JSON.stringify(ret));
});

可用性

Android系统

可提供的1.0.2及更高版本

loadFullVideoAd

加载并显示全屏视频

注意:

本 SDK 为接入方提供个性化模板全屏视频，开发者不用自行对广告样式进行编辑和渲染.

全屏视频样式激励视频一致,唯一不同点就是全屏视频5~10秒可以选择跳过,用户体验相对更好.

loadFullVideoAd(params, callback(ret, err))

params

positionId

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

callback(ret, err)

ret：

类型: JSON
内部字段：

{
    callback: "onLoadSuccess",  //String,回调方法
                                //onLoadSuccess    广告加载成功
                                //onLoadError      广告加载错误
                                //onAdClicked      广告被点击 
                                //onAdShow         广告显示  
                                //onAdClose        广告关闭  
                                //onVideoError     广告播放错误
                                //onVideoComplete  广告播放完毕
    code: null,//int,错误代码,非错误不返回
    msg: null//int,错误消息,非错误不返回
}

示例代码

var param = {positionId: "b5f8d5e2274d4d"};
fnad.loadFullVideoAd(param, function (ret, error) {
    var callback = ret.callback;
    if (callback === 'onLoadSuccess' || callback === 'onLoadError' || callback === 'onVideoError') {
        api.hideProgress();
    }
});

可用性

Android系统

可提供的1.0.0及更高版本

loadInterstitialAd(params, callback(ret, err))

params

positionId:

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

callback(ret, err)

ret：

类型: JSON
内部字段：

{
    callback: "onLoadSuccess", //String,回调方法
                                //onLoadSuccess    广告加载成功
                                //onLoadError      广告加载错误
                                //onAdClicked      广告被点击 
                                //onAdShow         广告显示  
                                //onAdClose        广告关闭  
                                //onVideoError     广告播放错误
                                //onVideoComplete  广告播放完毕
    code: null,//int,错误代码,非错误不返回
    msg: null//int,错误消息,非错误不返回
}

示例代码

var param = {positionId: "b5f8d5e0815c1e"};
fnad.loadInterstitialAd(param, function (ret, error) {
    var callback = ret.callback;
    if (callback === 'onLoadSuccess' || callback === 'onLoadError' || callback === 'onVideoError') {
        api.hideProgress();
    }
});

可用性

Android系统

可提供的1.0.0及更高版本

loadContentVlog(params)

params

positionId:

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

示例代码

var params = {positionId: "15f99fn55d6dad"};
fnad.loadContentVlog(params);

可用性

Android系统

可提供的1.1.0及更高版本

loadPageVlog(params)

params

positionId:

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

示例代码

var params = {positionId: "15f99fnee6b2842"};
fnad.loadPageVlog(params);

可用性

Android系统

可提供的1.1.0及更高版本

APICloud

模块开发

端API

设备访问

功能扩展

界面布局

导航菜单

开放SDK

云服务对接

AVM多端模块

H5模块

前端框架

云API

技术专题

开发工具

下载

微信公众号适配

七天培训课教程

其他

Faq

开放平台接入指南

自定义加速域名

云主机

入门教程

部署与管理

常见FAQ

fnad

概述

实例widget下载地址

模块接口

getVersion

callback(ret, err)

示例代码

可用性

getSDKVersion

callback(ret, err)

示例代码

可用性

init

params

callback(ret, err)

示例代码

可用性

loadSplashAd

params

callback(ret, err)

示例代码

可用性

loadRewardAd

params

callback(ret, err)

示例代码

可用性

loadBannerAd

params

callback(ret, err)

示例代码

可用性

destroyBannerAd

params

callback(ret, err)

示例代码

可用性

loadFullVideoAd

loadFullVideoAd(params, callback(ret, err))

params

callback(ret, err)

示例代码

可用性

loadInterstitialAd(params, callback(ret, err))

params

callback(ret, err)

示例代码

可用性

loadContentVlog(params)

params

示例代码

可用性

loadPageVlog(params)

params