hotsspAds

概述

HotsspAds 封装了优量汇，快手，穿山甲等多家知名联盟，实现了横幅、插屏、开屏，原生，激励视频等主流样式。使用之前请填写以下表单联系我们开通开发者账号，创建应用，获取应用MediaId 和对应的广告位PosId。

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

名称：hotsspAds
参数：MediaId Hotssp 官网申请ID
配置示例:

  <permission name="readPhoneState"/><!--上述非必须权限，开发者视情况自行添加-->
  <permission name="location" /><!--上述非必须权限，开发者视情况自行添加-->

字段描述:

MediaId：（必须配置）用于模块获取当前应用在 Hotssp 官网申请的广告

模块接口

初始化模块

startAd({params},callback(succ,err))

params

mediaId：

类型：字符串
描述：从Hotssp开放平台获取的媒体ID

callback(succ, err)

succ：

类型：JSON 对象
内部字段：

{
    status:onInitSuccess
}

err：

类型：JSON 对象
内部字段：

{
    errorCode: 0 //数字类型
    errorMsg:  "错误信息"
}

示例代码

var hotsspAds = api.require('hotsspAds');
    var param = {
        mediaId:"7d01e45f"
    };
    hotlib.startAd(param,function(succ,err){
        var result = succ || err;
        var resJsonStr = JSON.stringify(result);
        console.log("<h3>初始化SDK</h3>"+ "<br />");
        console.log(resJsonStr);
    });

获取Banner 类型广告
showBanner({params},callback(succ,err))

params

adPosId：

类型：字符串
描述：从Hotssp开放平台获取的广告位ID

slideTime：

类型：数字类型
描述：（可选项）
默认值：30(秒)
取值范围：
- slideTime（30~120）

refresh：

类型：布尔
描述：(可选项) 描述是否开启自刷新true 表示开启，默认不开启

x：

类型：数字类型
描述：模块左上角的 x 坐标（相对于所属的 Window 或 Frame）

y：

类型：数字类型
描述：模块左上角的 y 坐标（相对于所属的 Window 或 Frame）

w：

类型：数字类型
描述：模块的宽度，页面从x位置开始自动充满所属的 Window 或 Frame 的宽度

h：

类型：数字类型
描述：模块的高度；页面从y位置开始自动充满所属的 Window 或 Frame 的高度

fixedOn：

类型：字符串类型
描述：（可选项）模块添加到指定window或frame
默认：模块依附于当前 window

fixed：

类型：布尔
描述：（可选项）模块是否随所属 window 或 frame 滚动
默认值：true（不随之滚动）

callback(succ, err)

succ：

类型：JSON 对象
内部字段：

{
    status:
           onAdShowed/
           onAdClicked/
           onAdClosed,
    traceId: "175b67cdcfe34da89307a41f7ea4f873" 
}

err：

类型：JSON 对象
内部字段：

{
    errorCode: 0 //数字类型
    errorMsg:  "错误信息"
}

示例代码

var hotsspAds = api.require('hotsspAds');
function loadBanner(){
        var param = {
          adPosId: api.systemType=='ios'?"2a1c3aec":"2a1c3aev",// 代码位
          slideTime:5, // (可选项) 自刷新时间 单位秒
          refresh:true, // (可选项) 是否开启 自刷新 true 开启， false 关闭
          //显示位置 宽高比例建议 6.4：1
          rect:{
            x:10,
            y:80,
            w:api.winWidth,
            h:(api.winWidth)/6.4
          },
          fixedOn:"api.frameName,
          // 是否跟随页面滚动
          fixed:true
        };
        hotlib.showBanner(param, function(succ, err){
            var result = succ || err;
            try {
                var resJsonStr = JSON.stringify(result);
                console.log("JS LOG resJsonStr: ", resJsonStr);
            } catch(err) {
                console.log("JS LOG Error： ", err);
            }
        });
    }

关闭Banner 类型广告
closeBanner(callback(succ,err))

示例代码

var hotsspAds = api.require('hotsspAds');
function closeBanner(){
        var param = {
          traceId:"2a1c3aec" //代码位
        };
        hotlib.closeBanner(param, function(succ, err){
            var result = succ || err;
            try {
                var resJsonStr = JSON.stringify(result);
                console.log("JS LOG resJsonStr: ", resJsonStr);
            } catch(err) {
                console.log("JS LOG Error： ", err);
            }
        });
    }

可用性

iOS系统，Android系统

可提供的1.0.0版本

Splash模块

获取开屏类型广告
loadSplashAd({params},callback(succ,err))

params

adPosId：

类型：字符串
描述：从Hotssp开放平台获取的广告位ID

splashLogo：

类型：字符串类型
描述：（可选项）开屏广告下方的logo图片，暂仅支持widget路径
默认值：无（不传则不显示）
备注：安卓设备在拉取广告过程中显示logo

splashLoadingImg：

类型：字符串类型
描述：（可选项）开屏广告的占位图片，暂仅支持widget路径
默认值：无（不传则显示透明背景）

callback(succ, err)

succ：

类型：JSON 对象
内部字段：

{
    status: 
        onAdSuccess/
        onAdShowed/
        onAdClicked/
        onAdTick/
        onAdClosed
}

err：

类型：JSON 对象
内部字段：

{
    errorCode: 0 //数字类型
    errorMsg:  "错误信息"
}

示例代码

var hotsspAds = api.require('hotsspAds');
function loadSplash(){
        var param = {
        adPosId:api.systemType=='ios'?"d576f36d":"d576f36f",
        splashLogo:"widget://image/logo.jpg", //（可选项）字符串类型，开屏广告下方的logo图片，传入后广告会自动适配屏幕大小；不传则不显示，暂只支持widget路经 禁止高度超过屏幕 1/4。
        splashLoadingImg:"widget://image/loadimg.png" //（可选项）字符串类型，开屏广告的占位图片，要求高度，否则广告将无法展示；不传显示为透明背景。暂只支持widget路经
        };
        hotlib.loadSplashAd(param, function(succ, err){
            var result = succ || err;
            try {
                var resJsonStr = JSON.stringify(result);
                console.log("JS LOG resJsonStr: ", resJsonStr);
            } catch(err) {
                console.log("JS LOG Error： ", err);
            }
        });
    }

可用性

iOS系统，Android系统

可提供的1.0.0版本

Native 模块

获取Native类型广告
showNative({params},callback(succ,err))

params

adPosId：

类型：字符串
描述：从Hotssp开放平台获取的广告位ID

x：

类型：数字类型
描述：模块左上角的 x 坐标（相对于所属的 Window 或 Frame）

y：

类型：数字类型
描述：模块左上角的 y 坐标（相对于所属的 Window 或 Frame）

w：

类型：数字类型
描述：模块的宽度，页面从x位置开始自动充满所属的 Window 或 Frame 的宽度

h：

类型：数字类型
描述：模块的高度；页面从y位置开始自动充满所属的 Window 或 Frame 的高度

fixedOn：

类型：字符串类型
描述：（可选项）模块添加到指定window或frame
默认：模块依附于当前 window

fixed：

类型：布尔
描述：（可选项）模块是否随所属 window 或 frame 滚动
默认值：true（不随之滚动）

callback(succ, err)

succ：

类型：JSON 对象
内部字段：

{
    status:
           onAdSuccess/
           onAdShowed/
           onAdClicked
    traceId: "175b67cdcfe34da89307a41f7ea4f873"    
}

err：

类型：JSON 对象
内部字段：

{
    errorCode: 0 //数字类型
    errorMsg:  "错误信息"
}

示例代码

var hotsspAds = api.require('hotsspAds');
function loadNative(){
        var param = {
        adPosId:api.systemType=='ios'?"aa352b2d":"aa352b2f",
        rect:{ // 位置 宽高 定义
            x:0,
            y:100,
            w:api.winWidth,
            h:250
        },
        // 绑定frame 名称
        fixedOn:api.frameName,
        fixed:false
        };
        hotlib.showNative(param, function(succ, err){
        var result = succ || err;
            try {
                var resJsonStr = JSON.stringify(result);
                closeTraceId = JSON.parse(resJsonStr).traceId
                console.log("JS LOG resJsonStr: ", resJsonStr);
            } catch(err) {
                console.log("JS LOG Error： ", err);
            }
        });
    }

关闭Native 类型广告
closeNative({params},callback(succ,err))

params

traceId：

类型：字符串
描述：(可选项)showNative 时返回当前广告ID，关闭时传入指定ID 关闭指定广告, 不传值将关闭所有

callback(succ, err)

ret：

类型：JSON 对象
内部字段：

{
    status:
           onAdClosed
}

err：

类型：JSON 对象
内部字段：

{
    errorCode: 0 //数字类型
    errorMsg:  "错误信息"
}

示例代码

var hotsspAds = api.require('hotsspAds');
function closeNative(){
        var param = {
        traceId:closeTraceId
        };
        hotlib.closeNative(param, function(ret, err){
            var result = succ || err;
            try {
                var resJsonStr = JSON.stringify(result);
                console.log("JS LOG resJsonStr: ", resJsonStr);
            } catch(err) {
                console.log("JS LOG Error： ", err);
            }
        });
    }

可用性

iOS系统，Android系统

可提供的1.0.0版本

InterAct 模块

获取插屏类型广告
showInterAct({params}，callback(succ,err))

params

adPosId：

类型：字符串
描述：从Hotssp开放平台获取的广告位ID

callback(succ, err)

succ：

类型：JSON 对象
内部字段：

{
    status:
           onAdShowed/
           onAdClicked/
           onAdClosed
}

err：

类型：JSON 对象
内部字段：

{
    errorCode: 0 //数字类型
    errorMsg:  "错误信息"
}

示例代码

var hotsspAds = api.require('hotsspAds');
function loadInterAct(){
        var param = {
            adPosId:api.systemType=='ios'?"aa352b2d":"2a1c3aec"
            };
        hotlib.showInterAct(param, function(succ, err){
            var result = succ || err;
            try {
                var resJsonStr = JSON.stringify(result);
                console.log("JS LOG resJsonStr: ", resJsonStr);
            } catch(err) {
                console.log("JS LOG Error： ", err);
            }
        });
    }

关闭InterAct 类型广告
closeInterAct(callback(succ,err))

示例代码

var hotsspAds = api.require('hotsspAds');
function closeInterAct(){
        hotlib.closeInterAct(function(succ, err){
            var result = succ || err;
            try {
                var resJsonStr = JSON.stringify(result);
                console.log("JS LOG resJsonStr: ", resJsonStr);
            } catch(err) {
                console.log("JS LOG Error： ", err);
            }
        });
    }

可用性

iOS系统，Android系统

可提供的1.0.0版本

RewardAD 模块

获取激励视频类型广告

loadReward({params}，callback(succ,err))

params

adPosId：

类型：字符串
描述：从Hotssp开放平台获取的广告位ID

callback(succ, err)

succ：

类型：JSON 对象
内部字段：

{
    status:
           onAdCached
}

err：

类型：JSON 对象
内部字段：

{
    errorCode: 0 //数字类型
    errorMsg:  "错误信息"
}

示例代码

var hotsspAds = api.require('hotsspAds');
function loadReward(){
        var param = {
            adPosId:api.systemType=='ios'?"aa352b2d":"33a5726"
        };
        hotlib.loadReward(param, function(succ, err){
            var result = succ || err;
            try {
                var resJsonStr = JSON.stringify(result);
                console.log("JS LOG resJsonStr: ", resJsonStr);
            } catch(err) {
                console.log("JS LOG Error： ", err);
            }
        });
    }

展示 Reward 类型广告
showReward({params}, callback(succ,err))

params

adPosId：

类型：字符串
描述：从Hotssp开放平台获取的广告位ID

callback(succ, err)

succ：

类型：JSON 对象
内部字段：

{
    status:
           onAdShowed/
           onAdClicked/
           onAdComplete/
           onAdVerify/
           onAdClosed
}

err：

类型：JSON 对象
内部字段：

{
    errorCode: 0 //数字类型
    errorMsg:  "错误信息"
}

示例代码

var hotsspAds = api.require('hotsspAds');
function showReward(){
        var param = {
            adPosId:api.systemType=='ios'?"aa352b2d":"33a5726"
        };
        hotlib.showReward(param, function(succ, err){
            var result = succ || err;
            try {
                var resJsonStr = JSON.stringify(result);
                console.log("JS LOG resJsonStr: ", resJsonStr);
            } catch(err) {
                console.log("JS LOG Error： ", err);
            }
        });
    }

可用性

备注：请再预加载广告返回onAdCached，在调用此接口，否则无响应

iOS系统，Android系统

可提供的1.0.0版本

FullScreenAD

获取全屏视频类型广告

loadFullScreen({params},callback(succ,err))

params

adPosId：

类型：字符串
描述：从Hotssp开放平台获取的广告位ID

callback(succ, err)

succ：

类型：JSON 对象
内部字段：

{
    status:
           onAdCached
}

err：

类型：JSON 对象
内部字段：

{
    errorCode: 0 //数字类型
    errorMsg:  "错误信息"
}

示例代码

var hotsspAds = api.require('hotsspAds');
function loadFullScreen(){
        var param = {
            adPosId:api.systemType=='ios'?"aa352b2d":"deea196b"
        };
        hotlib.loadFullScreen(param, function(succ, err){
            var result = succ || err;
            try {
                var resJsonStr = JSON.stringify(result);
                console.log("JS LOG resJsonStr: ", resJsonStr);
            } catch(err) {
                console.log("JS LOG Error： ", err);
            }
        });
    }

展示 FullScreen 类型广告
showFullScreen({params}，callback(succ,err))

params

adPosId：

类型：字符串
描述：从Hotssp开放平台获取的广告位ID

callback(succ, err)

succ：

类型：JSON 对象
内部字段：

{
    status:
           onAdShowed/
           onAdClicked/
           onAdComplete/
           onAdSkipped/
           onAdClosed
}

err：

类型：JSON 对象
内部字段：

{
    errorCode: 0 //数字类型
    errorMsg:  "错误信息"
}

示例代码

var hotsspAds = api.require('hotsspAds');
function showFullScreen(){
        var param = {
            adPosId:api.systemType=='ios'?"aa352b2d":"deea196b"
        };
        hotlib.showFullScreen(param, function(succ, err){
            var result = succ || err;
            try {
                var resJsonStr = JSON.stringify(result);
                console.log("JS LOG resJsonStr: ", resJsonStr);
            } catch(err) {
                console.log("JS LOG Error： ", err);
            }
        });
    }

可用性

备注：请再预加载广告返回onAdCached，在调用此接口，否则无响应

iOS系统，Android系统

可提供的1.0.0版本

APICloud

模块开发

端API

设备访问

功能扩展

界面布局

导航菜单

开放SDK

云服务对接

AVM多端模块

H5模块

前端框架

云API

技术专题

开发工具

下载

微信公众号适配

七天培训课教程

其他

Faq

开放平台接入指南

自定义加速域名

云主机

入门教程

部署与管理

常见FAQ

hotsspAds

概述

模块接口

初始化模块

params

callback(succ, err)

示例代码

Banner模块

params

callback(succ, err)

示例代码

示例代码

可用性

Splash模块

params

callback(succ, err)

示例代码

可用性

Native 模块

params

callback(succ, err)

示例代码

params

callback(succ, err)

示例代码

可用性

InterAct 模块

params

callback(succ, err)

示例代码

示例代码

可用性

RewardAD 模块

params

callback(succ, err)

示例代码

params

callback(succ, err)

示例代码

可用性

FullScreenAD

params

callback(succ, err)

示例代码

params

callback(succ, err)

示例代码

可用性