moduleQuhe

概述

moduleQuhe 模块概述

moduleQuhe 聚合了众多知名广告联盟,模块囊括了开屏、插屏、激励视频的广告样式; Android 广告模块最低支持到 5.0 版本, 若版本过低, 可能会导致部分功能无法使用; 商务或技术支持微信号:wxid6quhead

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

  • 名称:QuHeConfig
  • 参数:appId、packageName
  • 配置示例:
<feature name="QuHeConfig">
    <param name="packageName" value="com.jtb.zdgj_app.test"/>
    <param name="appId" value="5196938&amp;1200016761"/>
</feature>
  • 字段描述:

    packageName:(可选配置)APP包名

    appId:(必须配置)广告初始化ID,询问商务人员索取,商务人员微信号:wxid6quhead

模块接口

开屏广告

通过调用 tb_splash({params},callback(ret)) 加载开屏广告

params

codeId:

  • 类型:字符串
  • 描述:广告位ID,询问商务人员索取,商务人员微信号:wxid6quhead

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    tag: 1,        //数字类型;-1:请求失败||0:广告被关闭||1:请求成功||2:广告展现||3:广告被点击
    msg: "请求成功" 
}

示例代码

    //开屏
    function tb_splash(){
        var modulequhe = api.require('moduleQuhe');
        var param = {codeId:"887519130&4062219207504533"};
        modulequhe.tb_splash(param, function(ret){
            var tag = ret.tag;
            var msg = ret.msg;
            if(-1 == tag){
                //请求错误
                api.toast({msg:msg});
                tb_destroyAll();
            }else if(0 == tag){
                 //关闭
                tb_destroyAll();
            }else if(1 == tag){
                //请求成功
                api.toast({msg:msg});//单号
            }else if(2 == tag){
                //展现
            }else if(3 == tag){
                //点击
            }else if(4 == tag){
                //激励视频发送奖励(仅激励视频有此回调)
            }
        });
    }

插屏广告

通过调用 tb_interaction({params},callback(ret)) 加载插屏广告

params

codeId:

  • 类型:字符串
  • 描述:广告位ID,询问商务人员索取,商务人员微信号:wxid6quhead

orientation:

  • 类型:数字类型
  • 描述:屏幕方向;1:竖屏||2:横屏

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    tag: 1,        //数字类型;-1:请求失败||0:广告被关闭||1:请求成功||2:广告展现||3:广告被点击
    msg: "请求成功" 
}

示例代码

    //插屏
    function tb_interaction(){
        var modulequhe = api.require('moduleQuhe');
        var param = {codeId:"946409671&1032514277606567", orientation:1};
        modulequhe.tb_interaction(param, function(ret){
            var tag = ret.tag;
            var msg = ret.msg;
            if(-1 == tag){
                //请求错误
                api.toast({msg:msg});
                tb_destroyAll();
            }else if(0 == tag){
                 //关闭
                tb_destroyAll();
            }else if(1 == tag){
                //请求成功
                api.toast({msg:msg});//单号
            }else if(2 == tag){
                //展现
            }else if(3 == tag){
                //点击
            }else if(4 == tag){
                //激励视频发送奖励(仅激励视频有此回调)
            }
        });
    }

激励视频广告

通过调用 tb_loadPlayRewardVideo({params},callback(ret)) 加载激励视频广告

params

codeId:

  • 类型:字符串
  • 描述:广告位ID,询问商务人员索取,商务人员微信号:wxid6quhead

userId:

  • 类型:字符串
  • 描述:用户ID

orientation:

  • 类型:数字类型
  • 描述:屏幕方向;1:竖屏||2:横屏

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    tag: 1,        //数字类型;-1:请求失败||0:广告被关闭||1:请求成功||2:广告展现||3:广告被点击||4:奖励达成
    msg: "请求成功" 
}

示例代码

    //激励视频
    function tb_loadPlayRewardVideo(){
        var modulequhe = api.require('moduleQuhe');
        var param = {codeId:"946409672&3062115227605650", userId:"用户id", orientation:1};
        modulequhe.tb_loadPlayRewardVideo(param, function(ret){
            var tag = ret.tag;
            var msg = ret.msg;
            if(-1 == tag){
                //请求错误
                api.toast({msg:msg});
                tb_destroyAll();
            }else if(0 == tag){
                 //关闭
                tb_destroyAll();
            }else if(1 == tag){
                //请求成功
                api.toast({msg:msg});//单号
            }else if(2 == tag){
                //展现
            }else if(3 == tag){
                //点击
            }else if(4 == tag){
                //激励视频发送奖励(仅激励视频有此回调)
                api.alert({msg:"奖励达成"});
            }
        });
    }

其他方法

释放所有资源

通过调用 tb_destroyAll() 释放所有广告资源

示例代码

    //释放所有资源
    function tb_destroyAll(){
        modulequhe.tb_destroyAll();
    }