tencentAd

概述

本插件封装了腾讯广点通的移动广告sdk,集成了开屏广告,横幅广告,插屏广告,激励视频广告;其他功能会陆续上线。

插件使用攻略

使用之前须从腾讯-优量汇申请开发者账号并创建应用,创建的应用必须是已在应用商店上架过的app,不然腾讯官方会拒绝申请,申请成功后获取应用id,然后再申请对应类型的代码位,并获取代码位id。

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

  • 名称:tencentAd
  • 参数:appId
  • 配置示例:
  <feature name="tencentAd">
      <param name="appId" value="1101152570" />
  </feature>
  • 字段描述:

    appId:(必须配置)从腾讯优量汇获取到的应用id

插件接口

showSplashAd

显示开屏广告

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

params

adId:

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

callback(ret, err)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    eventType: onLpClosed   //字符串型;
                            //onADExposure:广告曝光
                            //onADDismissed:广告关闭
                            //onADPresent:广告成功显示
                            //onADClicked:广告点击
}

err:

  • 类型:JSON 对象
  • 内部字段:
{
    code: 1     //数字类型;
                //错误码:
                //1(appId为空)
                //2(adId为空)
                //其他(广告显示失败,具体原因见message字段)
    message:adId为空
}

示例代码

var tencentAd = api.require('tencentAd');
var param = {adId:'8863364436303842593'};
tencentAd.showSplashAd(param,function(ret,err){
    if(ret){
        console.log("ret:"+JSON.stringify(ret));
    }else if(err){
        console.log("err:"+JSON.stringify(err));
    }
});

可用性

Android系统

可提供的1.0.0及更高版本

showBannerAd

显示横幅广告

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

params

adId:

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

rect :

  • 类型: JSON 对象

  • 描述:位置及尺寸

  • 内部字段

    {
        x: 0,    //(可选项)数字类型;插件左上角的 x 坐标(相对于所属的 Window 或 Frame);默认值:0
        y: 0,    //(可选项)数字类型;插件左上角的 y 坐标(相对于所属的 Window 或 Frame);默认值:0
        w: api.frameWidth,  //(可选项)数字类型;插件的宽度;页面从x位置开始自动充满所属的 Window 或 Frame 的宽度;默认:0,横幅高度会根据(宽/高=6.4/1)计算出来
    }
    

callback(ret, err)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    eventType: onAdSwitch   //字符串型;
                            //onADReceive:广告加载成功
                            //onADExposure:广告曝光
                            //onADClicked:广告点击时
                            //onADClosed:广告关闭
                            //onADLeftApplication:由于广告点击离开 APP 时调用
                            //onADOpenOverlay:当广告打开浮层时调用,如打开内置浏览器、内容展示浮												   层,一般发生在点击之后
                            //onADCloseOverlay:浮层关闭时调用
}

err:

  • 类型:JSON 对象
  • 内部字段:
{
    code: 1     //数字类型;
                //错误码:
                //1(appId为空)
                //2(adId为空)
                //其他(广告显示失败,具体原因见message字段)
    message:adId为空
}

示例代码

var tencentAd = api.require('tencentAd');
var param = {rect:{x:0,y:0,w:api.frameWidth},adId:'4080052898050840'};
tencentAd.showBannerAd(param,function(ret,err){
    if(ret){
        console.log("ret:"+JSON.stringify(ret));
    }else if(err){
        console.log("err:"+JSON.stringify(err));
    }
});

可用性

Android系统

可提供的1.0.0及更高版本

closeBannerAd

关闭已打开的横幅广告

closeBannerAd(callback(ret, err))

params

callback(ret, err)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    eventType: closeBannerAd  
}

示例代码

var tencentAd = api.require('tencentAd');
tencentAd.closeBannerAd(function(ret){
    if(ret){
        console.log("ret:"+JSON.stringify(ret));
    }
});

可用性

Android系统

可提供的1.0.0及更高版本

showInsertAd

显示插屏广告

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

params

adId:

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

callback(ret, err)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    eventType: onAdSwitch   //字符串型;
                            //onADReceive:广告加载完毕
                            //onADOpened:广告展开时
                            //onADExposure:广告曝光时
                            //onADClicked:广告点击
                            //onADClosed:广告关闭
                            //onADLeftApplication:广告点击离开应用时
                            //onVideoInit:视频播放 View 初始化完成
                            //onVideoLoading:视频下载中
                            //onVideoCached:视频下载完成
                            //onVideoReady:视频播放器初始化完成
                            //onVideoStart:视频开始播放
                            //onVideoPause:视频暂停
                            //onVideoComplete:视频播放结束
                            //onVideoPageOpen:进入视频落地页
                            //onVideoPageClose:退出视频落地页
}

err:

  • 类型:JSON 对象
  • 内部字段:
{
     code: 1     //数字类型;
                //错误码:
               //1(appId为空)
                //2(adId为空)
                //其他(广告显示失败,具体原因见message字段)
    message:adId为空
}

示例代码

var tencentAd = api.require('tencentAd');
var param = {adId:'4080298282218338'};
tencentAd.showInsertAd(param,function(ret,err){
    if(ret){
        console.log("ret:"+JSON.stringify(ret));
    }else if(err){
        console.log("err:"+JSON.stringify(err));
    }
});

可用性

Android系统

可提供的1.0.0及更高版本

closeInsertAd

关闭插屏广告

closeInsertAd(callback(ret, err))

params

callback(ret, err)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    eventType: closeInsertAd  
}

示例代码

var tencentAd = api.require('tencentAd');
tencentAd.closeInsertAd(function(ret){
    if(ret){
        console.log("ret:"+JSON.stringify(ret));
    }
});

可用性

Android系统

可提供的1.0.0及更高版本

showRewardVideoAd

显示激励视频

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

params

adId:

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

callback(ret, err)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
     eventType: onAdSwitch   //字符串型;
                            //onADLoad:广告加载成功
                            //onVideoCached:视频素材缓存成功
                            //onADShow:广告显示成功
                            //onADExpose:广告曝光
                            //onReward:广告激励发放
                             //onADClick:广告被点击
                             //onVideoComplete:广告视频素材播放完毕
                             //onADClose:广告被关闭
}

err:

  • 类型:JSON 对象
  • 内部字段:
{
   code: 1     //数字类型;
                //错误码:
               //1(appId为空)
                //2(adId为空)
                //其他(广告显示失败,具体原因见message字段)
    message:adId为空
}

示例代码

var tencentAd = api.require('tencentAd');
var param = {adId:'5040942242835423'};
tencentAd.showRewardVideoAd(param,function(ret,err){
    if(ret){
        console.log("ret:"+JSON.stringify(ret));
    }else if(err){
        console.log("err:"+JSON.stringify(err));
    }
});

可用性

Android系统

可提供的1.0.0及更高版本

是否仍需要帮助? 请保持联络!
最后更新于 2024/11/18