falconAd

来自于:AC模块工作室立即使用

openBanner closeBanner hideBanner showBanner openInterstitial openSplash

概述

本模块封装了猎鹰广告SDK。

注意-iOS

使用本模块之前需要在Info.plist文件中配置白名单

  1. <key>LSApplicationQueriesSchemes</key>
  2. <array>
  3. <!-- 微信 URL Scheme ⽩白名单--> <string>wechat</string>
  4. <string>weixin</string><!-- 新浪微博 URL Scheme ⽩白名单--> <string>sinaweibohd</string>
  5. <string>sinaweibo</string>
  6. <string>sinaweibosso</string>
  7. <string>weibosdk</string>
  8. <string>weibosdk2.5</string><!-- QQ、Qzone URL Scheme ⽩白名单--> <string>mqqapi</string>
  9. <string>mqq</string>
  10. <string>mqqOpensdkSSoLogin</string>
  11. <string>mqqconnect</string>
  12. <string>mqqopensdkdataline</string>
  13. <string>mqqopensdkgrouptribeshare</string>
  14. <string>mqqopensdkfriend</string>
  15. <string>mqqopensdkapi</string>
  16. <string>mqqopensdkapiV2</string>
  17. <string>mqqopensdkapiV3</string>
  18. <string>mqzoneopensdk</string>
  19. <string>wtloginmqq</string>
  20. <string>wtloginmqq2</string>
  21. <string>mqqwpa</string>
  22. <string>mqzone</string>
  23. <string>mqzonev2</string>
  24. <string>mqzoneshare</string>
  25. <string>wtloginqzone</string>
  26. <string>mqzonewx</string>
  27. <string>mqzoneopensdkapiV2</string>
  28. <string>mqzoneopensdkapi19</string>
  29. <string>mqzoneopensdkapi</string>
  30. <string>mqzoneopensdk</string>
  31. <!-- ⽀支付宝 淘宝 URL Scheme ⽩白名单--> <string>alipay</string>
  32. <string>alipayshare</string>
  33. <string>taobao</string>
  34. <string>itaobao</string>
  35. <!-- 天猫 URL Scheme ⽩白名单--> <string>tmall</string>
  36. <string>itmall</string>
  37. <!-- 京东 Scheme ⽩白名单--> <string>openApp.jdMobile</string>
  38. <!-- ⼤大众点评 Scheme ⽩白名单--> <string>dianping</string>
  39. <!-- 聚美优品 Scheme ⽩白名单--> <string>JuMei</string>
  40. <string>jumeimall</string>
  41. <!-- 美团 Scheme ⽩白名单--> <string>meituan0000</string>
  42. <string>iMeituan</string>
  43. <!-- 苏宁 Scheme ⽩白名单--> <string>suning</string>
  44. <!-- 唯品会 Scheme ⽩白名单--> <string>vipshop</string>
  45. </array>

Info.plist配置(必须)

  1. <key>AppLovinSdkKey</key>
  2. <string>2QfqtBkZoUqpJao0MSbf6va1OodbcDhsGLkrat-Gamen4MCNRLXPTr9mTFGEQm5V17gtK6H4W-H2WXZtiVO</string>
  3. <key>GADApplicationIdentifier</key>
  4. <string>ca-app-pub-3940256094244~14802511</string>

Info.plist 文件配置方法,参考 APICloud 官方论坛帖子

注意

appID、广告ID请联系猎鹰广告后台账号申请联系人进行申请: falconAd - 图1

管理后台登录地址:猎鹰广告

使用此模块之前必须先配置 config 文件,配置方法如下:

  1. <feature name="falconAd">
  2. <param name="appId_iOS" value="" />
  3. <param name="appId_Android" value="" />
  4. </feature>
  • 字段描述:

    appId_iOS、appId_Android:appId

模块接口

openBanner

打开Banner广告页面

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

params

appId:

  • 类型:字符串类型 (仅ios支持)
  • 描述:appId

spaceId:

  • 类型:字符串类型
  • 描述:Android广告位id

spaceId_iOS:

  • 类型:字符串类型
  • 描述:iOS广告位id

rect:

  • 类型:JSON 对象
  • 描述:(可选项)模块的位置及尺寸
  • 内部字段:
  1. {
  2. x: 0, //(可选项)数字类型;模块左上角的 x 坐标(相对于所属的 Window 或 Frame);默认:0
  3. y: 0, //(可选项)数字类型;模块左上角的 y 坐标(相对于所属的 Window 或 Frame);默认:0
  4. w: 320, //(可选项)数字类型;模块的宽度;默认:所属的 Window 或 Frame 的宽度
  5. h: 220 //(可选项)数字类型;模块的高度;默认:220
  6. }

fixedOn:

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

fixed:

  • 类型:布尔
  • 描述:(可选项)模块是否随所属 window 或 frame 滚动
  • 默认值:true(不随之滚动)

callback(ret, err)

ret:

  • 类型:JSON 对象
  • 描述:注册结果
  • 内部字段:
  1. {
  2. state:'' //字符串类型;回调的事件类型,取值范围如下:
  3. //exposure:Banner广告展示
  4. //error:请求广告条数据失败,失败信息查看err
  5. //close:banner条被用户关闭
  6. //clicked:banner条被点击
  7. }

err:

  • 类型:JSON 对象
  • 描述:注册结果
  • 内部字段:
  1. {
  2. code: 1, //数字类型;错误码
  3. msg: '' //字符串类型;错误信息
  4. }

示例代码

  1. var falconAd = api.require('falconAd');
  2. falconAd.openBanner({
  3. appId:'',
  4. spaceId:'',
  5. }, function(ret, err) {
  6. if (ret) {
  7. alert(JSON.stringify(ret));
  8. } else {
  9. alert(JSON.stringify(err));
  10. }
  11. });

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

closeBanner

关闭Banner广告页面

closeBanner()

示例代码

  1. var falconAd = api.require('falconAd');
  2. falconAd.closeBanner()
  3. });

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

hideBanner

隐藏Banner广告页面

hideBanner()

示例代码

  1. var falconAd = api.require('falconAd');
  2. falconAd.hideBanner()
  3. });

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

showBanner

显示Banner广告页面

showBanner()

示例代码

  1. var falconAd = api.require('falconAd');
  2. falconAd.showBanner()
  3. });

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

openInterstitial

打开插屏广告页面

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

params

appId:

  • 类型:字符串类型 (仅ios支持)
  • 描述:appId

spaceId:

  • 类型:字符串类型
  • 描述:Android广告位id

spaceId_iOS:

  • 类型:字符串类型
  • 描述:iOS广告位id

callback(ret, err)

ret:

  • 类型:JSON 对象
  • 描述:注册结果
  • 内部字段:
  1. {
  2. state:'' //字符串类型;回调的事件类型,取值范围如下:
  3. //exposure:插屏广告视图展示成功
  4. //error:请求广告条数据失败,失败信息查看err
  5. //close:被用户关闭
  6. //clicked:被点击
  7. }

err:

  • 类型:JSON 对象
  • 描述:注册结果
  • 内部字段:
  1. {
  2. code: 1, //数字类型;错误码
  3. msg: '' //字符串类型;错误信息
  4. }

示例代码

  1. var falconAd = api.require('falconAd');
  2. falconAd.openInterstitial({
  3. appId:'',
  4. spaceId:'',
  5. }, function(ret, err) {
  6. if (ret) {
  7. alert(JSON.stringify(ret));
  8. } else {
  9. alert(JSON.stringify(err));
  10. }
  11. });

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

openSplash

打开开屏广告页面

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

params

appId:

  • 类型:字符串类型 (仅ios支持)
  • 描述:appId

spaceId:

  • 类型:字符串类型
  • 描述:Android广告位id

spaceId_iOS:

  • 类型:字符串类型
  • 描述:iOS广告位id

callback(ret, err)

ret:

  • 类型:JSON 对象
  • 描述:注册结果
  • 内部字段:
  1. {
  2. state:'' //字符串类型;回调的事件类型,取值范围如下:
  3. //success:开屏广告加载成功
  4. //exposure:开屏广告曝光回调
  5. //error:请求广告条数据失败,失败信息查看err
  6. //close:被用户关闭
  7. //clicked:被点击
  8. }

err:

  • 类型:JSON 对象
  • 描述:注册结果
  • 内部字段:
  1. {
  2. code: 1, //数字类型;错误码
  3. msg: '' //字符串类型;错误信息
  4. }

示例代码

  1. var falconAd = api.require('falconAd');
  2. falconAd.openSplash({
  3. appId:'',
  4. spaceId:''
  5. }, function(ret, err) {
  6. if (ret) {
  7. alert(JSON.stringify(ret));
  8. } else {
  9. alert(JSON.stringify(err));
  10. }
  11. });

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

SDK广告样式介绍

广告形式常规配置场景和投放建议

开屏广告

  • 展示场景:应用打开时全屏或者半屏展示的广告,例如:微博App

falconAd - 图2 falconAd - 图3

  • 效果:首屏展示,直观的触达用户,适合品牌广告价值传递,点击率高,收益高
  • APP类型:APP都可以自由接入开屏
  • 常用尺寸:1080*1920或者640*960等
  • 样式:全屏、半屏
  • 建议:
    1. APP一天内单用户开屏次数控制3次以内,低干扰,更精准的广告触达
    2. 建议半屏开屏广告,有自主APP品牌展示,效果更好

信息流广告

  • 说明:图文信息流的方式高度融合APP自有的图文内容
  • 展示场景:轮播,列表页,内容页推荐,菜单栏等可以融合图文的场景,例如:携程App

falconAd - 图4 falconAd - 图5 falconAd - 图6

  • 效果:融合APP自有的图文内容,更优美的广告展现,提升用户使用体验,使用场景多元且丰富
  • APP类型:比较适合内容输出型媒体,资讯,小说阅读类等,其他媒体也可以自由组合
  • 常用尺寸:1280*720、1200*627、800*1200等
  • 样式:上图下文,上文下图,左图右文,左文右图,双图双文,纯图,三小图等
  • 建议:
    1. 列表页可以放置一条至两条广告
    2. 上图下文,上文下图可以获得更好的点击效果

banner广告

  • 说明:通栏的广告形式
  • 展示场景:顶部或者底部固定在页面显示,例如:春播App

falconAd - 图7 falconAd - 图8

  • 效果:适用用户长期停留,空间紧凑型APP
  • APP类型:接入简单,比较适合答题类,阅读类,小游戏类等APP
  • 常用尺寸:640*100等
  • 样式:纯图,左文右图,左图右文等
  • 建议:
    1. 可以设置banner广告的轮播条数,建议设置为3条
    2. 建议置底banner广告

插屏广告

  • 说明:弹出式广告形式
  • 展示场景:游戏过关暂停时弹出,页面切换时弹出,例如:百度地图App

falconAd - 图9 falconAd - 图10 falconAd - 图11

  • 效果:类似开屏的直观显示效果,点击率高,收益高
  • APP类型:游戏,小说等交互切换场景多的APP
  • 常用尺寸:600*500等
  • 样式:横图插屏,竖图插屏
  • 建议:
    1. 一天一到两次
    2. 在不影响用户体验的场景弹出插屏

激励视频广告

  • 说明:视频播放后积分,金币激励广告形式
  • 展示场景:APP内可以设置奖励的场景

falconAd - 图12

  • 效果:极富冲击力的用户观看体验,更为直观的广告产品展示,效果好,收益更高
  • APP类型:游戏、工具类等可以奖励积分,金币,容量等的APP
  • 常用尺寸:1280*720、720*1280等
  • 样式:横屏视频,竖屏视频
  • 建议:
    1. 游戏过关或者阅读下一章节时可以提示用户观看激励视频
    2. 丰富奖励内容,链接用户真实体验