tencentAds

来自于:开发者立即使用

概述

tencentAds 封装了腾讯广告联盟的SDK,实现了横幅、插屏、开屏等主流样式。使用之前须从腾讯广告联盟申请开发者账号并创建应用,获取 APPID 和 对应的广告位id。

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

  • 名称:tencentAds
  • 参数:APPID、BannerPosID、InterteristalPosID、SplashPosID、APPID_ios、BannerPosID_ios、InterteristalPosID_ios、SplashPosID_ios
  • 配置示例:
  <feature name="tencentAds">
    <param name="APPID" value="1105912126"/>
    <param name="BannerPosID" value="2020316827574286"/>
    <param name="InterteristalPosID" value="5020617897074277"/>
    <param name="SplashPosID" value="1050617807750621"/>
    <param name="APPID_ios" value="1105344611"/>  
    <param name="BannerPosID_ios" value="4090812164690039"/>  
    <param name="InterteristalPosID_ios" value="2030814134092814"/>  
    <param name="SplashPosID_ios" value="9040714184494018"/> 
  </feature>
  • 字段描述:

    APPID: 在腾讯广告联盟中注册的安卓应用id。

    BannerPosID: 安卓应用对应的横幅(banner)广告位id。

    InterteristalPosID:安卓应用对应的插屏广告位id。

    SplashPosID:安卓应用对应的开屏广告位id。

    APPID_ios:在腾讯广告联盟中注册的IOS应用id。

    BannerPosID_ios:IOS应用对应的横幅(banner)广告位id。。

    InterteristalPosID_ios IOS应用对应的插屏广告位id

    SplashPosID_ios:IOS应用对应的开屏广告位id。

showBanner

打开横幅广告

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

params

  • x: 0, //(可选项)数字类型;模块左上角的 x 坐标(相对于所属的 Window 或 Frame);默认值:0
  • y: 0, //(可选项)数字类型;模块左上角的 y 坐标(相对于所属的 Window 或 Frame);默认值:0
  • w: 0, //(可选项)数字类型;模块的宽度;页面从x位置开始自动充满所属的 Window 或 Frame 的宽度;默认:自适应。宽度值不能小于300,否则曝光不成功,导致无法计费。
  • h: 0 //(不可选)数字类型;模块的高度;默认:50;ipad(仅苹果平板)默认高度90

refresh:

  • 类型:字符串类型
  • 描述:(可选项)横幅刷新时间
  • 默认值:30
  • 取值范围:0或30-120(0表示不刷新)

fixedOn:

  • 类型:字符串类型
  • 描述:(可选项)模块添加到指定window或frame
  • 默认:模块依附于当前 window

fixed:

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

isGpsOn:

  • 类型:布尔
  • 描述:(可选项)模块是否允许GPS定位功能
  • 默认值:true(允许使用GPS)
  • 此参数仅IOS有效

callback(ret,err)

ret:

  • 类型:JSON对象
  • 内部字段:
{
    status:true/false/onclick/close
}

err:

  • 类型:JSON对象
  • 内部字段:
{
    NSLocalizedDescription: "相关错误信息"   //错误信息
}

示例代码

var tencentAds = api.require('tencentAds');
tencentAds.showBanner({
       x: 0,
       y: 0,
       refresh: 30,
       fixedOn: api.frameName,
       fixed: true
},function(ret,err){
      alert("ret: " + JSON.stringify(ret) + "\nerr: " + JSON.stringify(err));
});

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

refreshBanner

刷新横幅广告,仅支持安卓,IOS此方法无效

refreshBanner()

示例代码

var tencentAds = api.require('tencentAds');
tencentAds.refreshBanner();

可用性

Android系统

可提供的1.0.0及更高版本

closeBanner

closeBanner()

关闭横幅广告

示例代码

var tencentAds = api.require('tencentAds');
tencentAds.closeBanner();

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

showInterstitialAD

展示插屏广告,有/无遮罩(可选)

params

PopupWindow:

  • 类型:boolean对象
  • 内部字段:true/false,默认true(有遮罩)
  • 备注:此参数仅支持安卓,IOS传入无效,IOS默认有遮罩

isGpsOn:

类型:布尔 描述:(可选项)模块是否允许GPS定位功能 默认值:true(允许使用GPS) 此参数仅IOS有效

showInterstitialAD(callback(ret,err))

callback(ret, err)

ret:

  • 类型:JSON对象
  • 内部字段:
{
      status:true/false/onclick/close
}

err:

  • 类型:JSON对象
  • 内部字段:
{
     NSLocalizedDescription: "相关错误信息"   //错误信息:
}

示例代码

var tencentAds = api.require('tencentAds');
tencentAds.showInterstitialAD(
    PopupWindow:false
    function(ret,err){
       alert("ret: " + JSON.stringify(ret) + "\nerr: " + JSON.stringify(err));
});

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

showSplash

showSplash({params},callback(ret))

params

splashlogo

  • 类型:字符串类型
  • 描述:(可选项)开屏广告下方的logo图片,暂仅支持widget路径
  • 默认值:无(不传则不显示)
  • 备注:安卓设备在拉取广告过程中显示logo,ios则在广告拉取成功后才会显示logo

splashholderimg:'widget//res/splashholder.png'

  • 类型:字符串类型
  • 描述:(可选项)开屏广告的占位图片,暂仅支持widget路径
  • 默认值:无(不传则显示白色背景)

callback(ret,err)

ret:

  • 类型:JSON对象
  • 内部字段:
{
  status: true/false,       //布尔型;true||false 此处便于开发者使用只传入开屏结束时的状态,鉴于不影响apicloud程序,建议当开屏广告结束时在执行apicloud相关函数。
}

err:

  • 类型:JSON对象
  • 内部字段:
{
   NSLocalizedDescription: "相关错误信息"   //错误信息      
}

示例代码

var tencentAds = api.require('tencentAds');
tencentAds.showSplash(
{
    splashlogo : 'widget://res/logo.jpg',//(可选项)字符串类型;开屏广告下方的logo图片,传入后广告会自动适配屏幕大小;不传则不显示,,暂只支持widget路经。
    splashholderimg : 'widget://image/splash.png'//(可选项)字符串类型;开屏广告的占位图片,要求高度不小于400,否则广告将无法展示;不传显示为空白。暂只支持widget路经。
},
    function(ret,err){
       alert("ret: " + JSON.stringify(ret) + "\nerr: " + JSON.stringify(err));
});

可用性

iOS系统,Android系统

备注:ipad设备不支持开平广告接口,调用此接口会返回status:false,错误信息“设备不支持”

可提供的1.0.0及更高版本

SDK错误码

  1. 3XX 初始化错误
  2. 403/404/405/406/4XX 网络错误
  3. 500 广告位错误:建议检查广告位是否正确
  4. 501 无广告返回:建议重新请求广告