下载文档

uexIFlytekAd
更新时间:2015-09-23

1、简介

科大讯飞广告插件

1.1、 业务限制资源规格限制说明

科大讯飞广告插件是基于讯飞广告API封装集成到AppCan平台的第三方api模块, 开发者可以使用本插件实现基本的广告推送和展示服务。目前本插件仅支持旗帜广告、插屏广告和全屏广告的推送展示服务。

温馨提示:
(1)、uexIFlytekAd插件分别封装IFLYBannerAd、IFLYInterstitialAd、 IFLYFullScreenAd个类,因此插件调用的时候需要区分这3个类别名,注意每个方法的正确写法。
(2)、旗帜广告没有关闭按钮触发事件,可与uexButton插件配合使用

1.2、UI展示

1.3、申请开通

申请开通立即使用

自定义插件使用,需要提前申请

1.4 、术语表

常见的错误码,在接入插件接口时发生报错信息,可对应查找对应的原因。见附录表

2、API概览

2.1、方法

IFLYBannerAd 旗帜广告

createBannerAd 创建旗帜广告对象

IFLYBannerAd.createBannerAd(String param);
说明:
初始化旗帜广告对象,设置广告对象的广告位号。申请开通后获取并传入参数。
旗帜广告没有关闭按钮触发事件,可与uexButton插件配合使用
参数:

  1. params: (String类型) 必选 广告位号

平台支持:
Android2.2+

版本支持:
3.0.0+
示例:

  1. IFLYBannerAd.createBannerAd(String param);

 createInterstitialAd 创建插屏广告对象

IFLYInterstitialAd.createInterstitialAd(String param);
说明:
初始化插屏广告对象,设置广告对象的广告位号。申请开通后获取并传入参数。
参数:

  1. params: (String类型) 必选 广告位号

平台支持:
Android2.2+

版本支持:
3.0.0+
示例:

  1. IFLYInterstitialAd.createInterstitialAd(String param);

createFullscreenAd 创建全屏广告对象 

IFLYFullscreenAd.createFullscreenAd(String param);
说明:
初始化全屏广告对象,设置广告对象的广告位号。申请开通后获取并传入参数。
参数:

  1. params: (String类型) 必选 广告位号

平台支持:
Android2.2+

版本支持:
3.0.0+
示例:

  1. IFLYFullscreenAd.createFullscreenAd(String param);

setParameter 设置广告参数

IFLYFullScreenAd.setParameter(String key, String value);
说明:
设置广告对象的相关参数(旗帜、插屏、全屏广告均含有该方法)。采用键值对的方法传入数据,请在启动广告加载和展示之前传入。
参数:

  1. key: (String类型) 必选 所要设置的参数 
  2. value: (String类型) 必选 设置值

详细参数字段对照下表:

参数(key) 说明 value 适用范围
appid 广告应用 ID 必填 申请开通后获取并传入参数。 旗帜、插屏、全屏
debug_mode 设置是否调试模式, 调试 模式下可查看log, 默认调试模式 true和false 旗帜、插屏、全屏
back_key_enable 点击手机后退键是否 销毁插屏广告, 默 认销毁广告 true和false 插屏
show_time_fullscreen 全屏广告展示时间; 如果设为-1,则使用 叉号方式退出全屏广告 范围 5000~10000, 默认 5000 全屏
download_alert 弹出下载广告提示框,  默认不弹提示框 true和false 旗帜、插屏、全屏

平台支持:
Android2.2+

版本支持:
3.0.0+
示例:

  1. IFLYBannerAd.setParameter("appid", "55f8dade");
  2. IFLYBannerAd.setParameter("debug_mode", "true");

 IFLYBannerAd.loadAd 加载旗帜广告

IFLYBannerAd.loadAd(int x,int y,int w)
说明:
加载旗帜广告
参数:

  1. x: (Number类型) 必选 广告位置的X坐标 
  2. y: (Number类型) 必选 广告位置的Y坐标
  3. w:(Number类型) 必选 广告的宽度。

平台支持:
Android2.2+

版本支持:
3.0.0+
示例:

  1. IFLYBannerAd.loadAd(int x,int y,int w)

IFLYInterstitialAd.loadAd 加载插屏广告

IFLYFullscreenAd.loadAd 加载全屏广告

说明:
加载插屏 、全屏广告
参数:

平台支持:
Android2.2+

版本支持:
3.0.0+
示例:

  1. IFLYInterstitialAd.loadAd();
  2. IFLYFullScreenAd.loadAd();

showAd 展示广告

说明:
展示加载完成的广告(旗帜、插屏、全屏广告均含有该方法)
参数:

平台支持:
Android2.2+

版本支持:
3.0.0+
示例:

  1. IFLYBannerAd.showAd();
  2. IFLYFullScreenAd.showAd();
  3. IFLYInterstitialAd.showAd();

destroy 销毁广告

说明:
销毁广告(旗帜、插屏、全屏广告均含有该方法)。
参数:

平台支持:
Android2.2+

版本支持:
3.0.0+
示例:

  1. IFLYBannerAd.destroy();

2.2、 识别监听回调方法

onAdInit 广告对象初始化回调

IFLYBannerAd .onAdInit(opCode, dataType, data)
说明:
广告对象初始化回调(旗帜、插屏、全屏广告均含有该方法)注意:此接口需在使用创建广告对象接口之前传入,否则广告接口无法正常调用。
参数:

  1. opId: (Number类型) 必选 操作ID,此函数中不起作用,可忽略。
  2. dataType: (Number类型) 必选 数据类型
  3. data: (String类型) 必选 初始化信息

平台支持:
Android2.2+

版本支持:
3.0.0+
示例:

  1. IFLYFullScreenAd .onAdInit(opCode, dataType, data);
  2. IFLYInterstitialAd.onAdInit = onInterstitialAdInit;
  3. function onInterstitialAdInit(opCode, dataType, data){
  4. if(0 == dataType){
  5. // 初始化广告失败
  6. document.getElementById('msg').value = "初始化插屏广告对象失败";
  7. } else {
  8. document.getElementById('msg').value = "初始化插屏广告对象成功";
  9. }
  10. }

onAdReceive 广告加载成功回调

IFLYFullScreenAd.onAdReceive(opCode, dataType, data)
说明:
广告加载成功回调(旗帜、插屏、全屏广告均含有该方法)
参数:

  1. opId: (Number类型) 必选 操作ID,此函数中不起作用,可忽略。
  2. dataType: (Number类型) 必选 数据类型
  3. data: (String类型) 必选 初始化信息

平台支持:
Android2.2+

版本支持:
3.0.0+
示例:

  1. IFLYBannerAd .onAdReceive(opCode, dataType, data);
  2. IFLYInterstitialAd.onAdReceive = onInterstitialAdReceive;
  3. function onInterstitialAdReceive(opCode, dataType, data){
  4. //显示广告
  5. IFLYInterstitialAd.showAd();
  6. document.getElementById('msg').value = "请求插屏广告成功";
  7. }

onAdFailed 广告加载失败回调

IFLYFullScreenAd.onAdFailed(opCode, dataType, data)
说明:
广告加载失败回调(旗帜、插屏、全屏广告均含有该方法)
参数:

  1. opId: (Number类型) 必选 操作ID,此函数中不起作用,可忽略。
  2. dataType: (Number类型) 必选 数据类型
  3. data: (String类型) 必选 初始化信息

平台支持:
Android2.2+

版本支持:
3.0.0+
示例:

  1. IFLYBannerAd .onAdFailed(opCode, dataType, data);
  2. IFLYInterstitialAd.onAdFailed = onInterstitialAdFailed;
  3. function onInterstitialAdFailed(opCode, dataType, data){
  4. document.getElementById('msg').value = "请求插屏广告失败";
  5. }

onAdClick 广告被点击回调

IFLYFullScreenAd.onAdClick(opCode, dataType, data)
说明:
广告被点击回调(旗帜、插屏、全屏广告均含有该方法)
参数:

  1. opId: (Number类型) 必选 操作ID,此函数中不起作用,可忽略。
  2. dataType: (Number类型) 必选 数据类型
  3. data: (String类型) 必选 初始化信息

平台支持:
Android2.2+

版本支持:
3.0.0+
示例:

  1. IFLYBannerAd .onAdClick(opCode, dataType, data);
  2. IFLYInterstitialAd.onAdClick = onInterstitialAdClick;
  3. function onInterstitialAdClick(opCode, dataType, data){
  4. document.getElementById('msg').value = "插屏广告被点击";
  5. }

onAdClose 广告关闭回调

IFLYFullScreenAd.onAdClose(opCode, dataType, data)
说明:
广告关闭回调(旗帜、插屏、全屏广告均含有该方法)
参数:

  1. opId: (Number类型) 必选 操作ID,此函数中不起作用,可忽略。
  2. dataType: (Number类型) 必选 数据类型
  3. data: (String类型) 必选 初始化信息

平台支持:
Android2.2+

版本支持:
3.0.0+
示例:

  1. IFLYBannerAd .onAdClose(opCode, dataType, data);
  2. IFLYInterstitialAd.onAdClose = onInterstitialAdClose;
  3. function onInterstitialAdClose(opCode, dataType, data){
  4. document.getElementById('msg').value = "插屏广告被关闭";
  5. }

附录

错误码 描述
70200 广告请求成功
70204 请求成功,但是无广告内容
70400 无效的广告位 ID  
70403 当日广告请求次数达到上限
70500 服务错误  
71001 未知错误  
71002 无效的广告请求,比如:请求频率过快  
71003 网络错误  
71004 Permission 未设置  
71005 Appid 为空 
71006 无效的 Appid  
71007 广告位 ID 为空 
71008 广告页面加载超时  
71009 广告页面加载异常  
71010 手机无浏览器