iflyAd

来自于：科大讯飞立即使用

• Method

addBannerAd addInterstitialAd addNativeVideoAd addSplashVideoAd addRewardedVideoAd addPatchVideoAd removeAdView

概述

iflyAd 封装了讯飞广告sdk，通过此模块可展示讯飞下发的广告。

使用此模块之前建议先配置 config.xml 文件，配置完毕，需通过云端编译生效，配置方法如下：

Android配置meta-data

• 配置示例：

 <meta-data
    name="IFLYTEK_APPKEY_AD"
    value="" />

• 字段描述：

value：（必须配置）讯飞平台创建应用的appId

使用此模块之前 iOS 必须先配置 config 文件，配置方法如下：

• 名称：iflyAd
• 参数：appId
• 配置示例:

  <feature name="iflyAd">
    <param name="appId" value="544e2b86" />
  </feature>

• 字段描述:

  appId：讯飞平台创建应用的appId

iOS平台配置 plist 文件

<key>NSAppTransportSecurity</key> <dict> 
<key>NSAllowsArbitraryLoads</key> <true/>
</dict>

addBannerAd

添加Banner广告

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

params

adIdAndroid：

• 类型：字符串
• 描述：android广告位id，讯飞平台为每个广告位分配的广告位id 在讯飞后台申请。

adIdIOS：

• 类型：字符串
• 描述：ios广告位id，讯飞平台为每个广告位分配的广告位id 在讯飞后台申请。

rect：

• 类型：JSON对象
• 描述：广告控件位置参数
• 内部字段：

{
 x:0,                         //数字类型；左上角X轴坐标   默认值：0
 y:0,                         //数字类型；左上角Y轴坐标   默认值：0
 width:300,             //数字类型；banner的宽度  默认值：屏幕宽度
 height:200             //数字类型；banner的高度   默认值：50
}

fixedOn：

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

fixed:

• 类型：布尔
• 描述：（可选项）是否将模块视图固定到窗口上，不跟随窗口上下滚动
• 默认值：true（不随之滚动）

callback(ret, err)

ret：

• 类型：JSON 对象
• 内部字段：

{
   status: true,           //布尔型；广告请求成功/失败
   id:1,                        //数字类型；广告控件id
   action:'',               //字符串类型；取值‘recive’/成功获取广告、‘click’/广告被点击、       ‘close’/广告被关（iOS不支持）闭、‘exposure’/广告曝光（iOS不支持）、'cancle'/广告下载取消（iOS不支持）、‘submit’/广告下载确认（iOS不支持）
  }

err：

• 类型：JSON 对象
• 内部字段：

{
errorCode:0              //数字类型；错误码，详情请参考讯飞广告文档
   msg:''                       //错误信息
  }

示例代码

var iflyAd= api.require('iflyAd');
iflyAd.addBannerAd({
adId:''，
rect:{},
}，function(ret, err) {
});

可用性

Android系统，IOS系统

可提供的1.0.0及更高版本

addInterstitialAd

添加插屏广告，大开不可用removeAdView移除

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

params

adIdAndroid：

• 类型：字符串
• 描述：android广告位id，讯飞平台为每个广告位分配的位以id 在讯飞后台申请。

adIdIOS：

• 类型：字符串
• 描述：ios广告位id，讯飞平台为每个广告位分配的位以id 在讯飞后台申请。

backClose:（iOS不支持）

• 类型：布尔类型
• 描述：（可选项）back健是否可以关闭
• 默认值：true

fixedOn：（iOS不支持）

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

fixed:（iOS不支持）

• 类型：布尔
• 描述：（可选项）是否将模块视图固定到窗口上，不跟随窗口上下滚动
• 默认值：true（不随之滚动）

callback(ret, err)

ret：

• 类型：JSON 对象
• 内部字段：

{
   status: true,           //布尔型；广告请求成功/失败
   action:'',               //字符串类型；取值‘recive’/成功获取广告、‘click’/广告被点击、       ‘close’/广告被关闭（android不支持）、‘exposure’/广告曝光（iOS不支持）、'cancle'/广告下载取消（iOS不支持）、‘submit’/广告下载确认（iOS不支持）
  }

err：

• 类型：JSON 对象
• 内部字段：

{
errorCode:0              //数字类型；错误码，详情请参考讯飞广告文档
   msg:''                       //错误信息
  }

示例代码

var iflyAd= api.require('iflyAd');
iflyAd.addInterstitialAd({
adId:'',
rect:{},
}，function(ret, err) {
});

可用性

Android系统，IOS系统

可提供的1.0.0及更高版本

addNativeVideoAd

添加信息流视频广告（可暂停，可全屏，可静音，不可跳过）

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

params

adIdAndroid：

• 类型：字符串
• 描述：android广告位id，讯飞平台为每个广告位分配的位以id 在讯飞后台申请。

adIdIOS：

• 类型：字符串
• 描述：ios广告位id，讯飞平台为每个广告位分配的位以id 在讯飞后台申请。

rect：

• 类型：JSON对象
• 描述：广告控件位置参数
• 内部字段：

{
 x:0,                         //数字类型；左上角X轴坐标   默认值：0
 y:0,                         //数字类型；左上角Y轴坐标   默认值：0
 width:300,             //数字类型；banner的宽度  默认值：屏幕宽度
 height:200             //数字类型；banner的高度   默认值：100
}

backClose:（iOS不支持）

• 类型：布尔类型
• 描述：（可选项）back健是否可以关闭
• 默认值：true

playAuto:（iOS不支持）

• 类型：布尔类型
• 描述：（可选项）自动播放
• 默认值：true

fixedOn：

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

fixed:

• 类型：布尔
• 描述：（可选项）是否将模块视图固定到窗口上，不跟随窗口上下滚动
• 默认值：true（不随之滚动）

callback(ret, err)

ret：

• 类型：JSON 对象
• 内部字段：

{
   status: true,           //布尔型；广告请求成功/失败
   id:1,                        //数字类型；广告控件id
   action:'',               //字符串类型；取值‘recive’/成功获取广告、‘click’/广告被点击（iOS不支持）、'cancle'/广告下载取消（iOS不支持）、‘submit’/广告下载确认（iOS不支持）、‘startPlay’/缓冲完成开始播放、‘skip’/跳过广告（iOS不支持）、‘playError’/播放出错、'playComplete'/播放完毕、
  }

err：

• 类型：JSON 对象
• 内部字段：

{
errorCode:0              //数字类型；错误码，详情请参考讯飞广告文档
   msg:''                       //错误信息
  }

示例代码

var iflyAd= api.require('iflyAd');
iflyAd.addNativeVideoAd({
adId:'',
rect:{},
}，function(ret, err) {
});

可用性

Android系统，IOS系统

可提供的1.0.0及更高版本

addSplashVideoAd

添加开屏视频广告（不可暂停，全屏，可静音，可跳过）

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

params

adIdAndroid：

• 类型：字符串
• 描述：android广告位id，讯飞平台为每个广告位分配的位以id 在讯飞后台申请。

adIdIOS：

• 类型：字符串
• 描述：ios广告位id，讯飞平台为每个广告位分配的位以id 在讯飞后台申请。

backClose:（iOS不支持）

• 类型：布尔类型
• 描述：（可选项）back健是否可以关闭
• 默认值：true

fixedOn：

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

fixed:

• 类型：布尔
• 描述：（可选项）是否将模块视图固定到窗口上，不跟随窗口上下滚动
• 默认值：true（不随之滚动）

callback(ret, err)

ret：

• 类型：JSON 对象
• 内部字段：

{
   status: true,           //布尔型；广告请求成功/失败
   id:1,                        //数字类型；广告控件id
   action:'',               //字符串类型；取值‘recive’/成功获取广告、‘click’/广告被点击（iOS不支持）、'cancle'/广告下载取消（iOS不支持）、‘submit’/广告下载确认（iOS不支持）、‘startPlay’/缓冲完成开始播放、‘skip’/跳过广告（iOS不支持）、‘playError’/播放出错、'playComplete'/播放完毕、
  }

err：

• 类型：JSON 对象
• 内部字段：

{
errorCode:0              //数字类型；错误码，详情请参考讯飞广告文档
   msg:''                       //错误信息
  }

示例代码

var iflyAd= api.require('iflyAd');
iflyAd.addSplashVideoAd({
adId:'',
rect:{},
}，function(ret, err) {
});

可用性

Android系统，IOS系统

可提供的1.0.0及更高版本

addRewardedVideoAd

添加激励视频广告（不可暂停，全屏，可静音，不可跳过）

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

params

adIdAndroid：

• 类型：字符串
• 描述：android广告位id，讯飞平台为每个广告位分配的位以id 在讯飞后台申请。

adIdIOS：

• 类型：字符串
• 描述：ios广告位id，讯飞平台为每个广告位分配的位以id 在讯飞后台申请。

backClose:（iOS不支持）

• 类型：布尔类型
• 描述：（可选项）back健是否可以关闭
• 默认值：true

fixedOn：

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

fixed:

• 类型：布尔
• 描述：（可选项）是否将模块视图固定到窗口上，不跟随窗口上下滚动
• 默认值：true（不随之滚动）

callback(ret, err)

ret：

• 类型：JSON 对象
• 内部字段：

{
   status: true,           //布尔型；广告请求成功/失败
   id:1,                        //数字类型；广告控件id
   action:'',               //字符串类型；取值‘recive’/成功获取广告、‘click’/广告被点击（iOS不支持）、'cancle'/广告下载取消（iOS不支持）、‘submit’/广告下载确认（iOS不支持）、‘startPlay’/缓冲完成开始播放、‘skip’/跳过广告（iOS不支持）、‘playError’/播放出错、'playComplete'/播放完毕、
  }

err：

• 类型：JSON 对象
• 内部字段：

{
errorCode:0              //数字类型；错误码，详情请参考讯飞广告文档
   msg:''                       //错误信息
  }

示例代码

var iflyAd= api.require('iflyAd');
iflyAd.addRewardedVideoAd({
adId:'',
rect:{},
}，function(ret, err) {
});

可用性

Android系统，IOS系统

可提供的1.0.0及更高版本

addPatchVideoAd

添加贴片视频广告（不可暂停，全屏，可静音，可跳过）

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

params

adIdAndroid：

• 类型：字符串
• 描述：android广告位id，讯飞平台为每个广告位分配的位以id 在讯飞后台申请。

adIdIOS：

• 类型：字符串
• 描述：ios广告位id，讯飞平台为每个广告位分配的位以id 在讯飞后台申请。

backClose:

• 类型：布尔类型
• 描述：（可选项）back健是否可以关闭
• 默认值：true

fixedOn：

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

fixed:

• 类型：布尔
• 描述：（可选项）是否将模块视图固定到窗口上，不跟随窗口上下滚动
• 默认值：true（不随之滚动）

callback(ret, err)

ret：

• 类型：JSON 对象
• 内部字段：

{
   status: true,           //布尔型；广告请求成功/失败
   id:1,                        //数字类型；广告控件id
   action:'',               //字符串类型；取值‘recive’/成功获取广告、‘click’/广告被点击（iOS不支持）、'cancle'/广告下载取消、‘submit’/广告下载确认、‘startPlay’/缓冲完成开始播放、‘skip’/跳过广告、‘playError’/播放出错、'playComplete'/播放完毕、
  }

err：

• 类型：JSON 对象
• 内部字段：

{
errorCode:0              //数字类型；错误码，详情请参考讯飞广告文档
   msg:''                       //错误信息
  }

示例代码

var iflyAd= api.require('iflyAd');
iflyAd.addPatchVideoAd({
adId:'',
rect:{},
}，function(ret, err) {
});

可用性

Android系统，IOS系统

可提供的1.0.0及更高版本

removeAdView

移除广告(iOS不支持插屏广告)

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

params

id：

• 类型：数字类型
• 描述：添加广告控件时返回的id

callback(ret, err)

ret：

• 类型：JSON 对象
• 内部字段：

{
   status: true,           //布尔型；控件移除成功/失败
  }

err：

• 类型：JSON 对象
• 内部字段：

{
   msg:''                       //错误信息
  }

示例代码

var iflyAd= api.require('iflyAd');
iflyAd.removeAdView({
id:0                         
}，function(ret, err) {
});

可用性

Android系统，IOS系统

可提供的1.0.0及更高版本