Hms Ads

/ Title: hmsAds Description: 华为广告联盟 /

来自于：770104707@qq.com立即使用

initSdk showSplashAD showBannerAD closeBannerAD showInterstitialAD showRewardVideoAD showNativeExpressAD closeNativeExpressAD showVideoPatchAD closeVideoPatchAD

概述

华为广告联盟简介

广告服务（Ads Kit）依托华为终端平台与数据能力为您提供流量变现服务，帮助您解决流量变现的难题；同时为广告主提供广告服务，配合华为终端平台向用户提供个性化的营销活动或商业广告。

hmsAds 模块概述

本模块封装了华为广告联盟的原生 SDK，集成了开屏、Banner、插屏、激励视频、信息流、贴片广告；可用于实现app流量变现。

模块使用攻略

使用之前须从华为广告联盟平台申请开发者账号并创建应用，开通广告服务。

华为广告联盟申请地址华为广告联盟

模块接口

initSdk

sdk 初始化

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

params

wxappId:

  • 类型：字符串
  • 描述：（可选项）微信小程序appId。

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
{
    status: true, //初始化状态
    code: 0, //状态码
    type: 'onInit', //事件类型 
    msg: "onInitSdk",//描述
    result:{ //其他结果数据
        version:"3.8.0" //sdk 版本号
    }
}

示例代码

var hmsAds = api.require('hmsAds');
hmsAds.initSdk({

},function(ret, err) {
    if (ret.status) {
        alert("sdk 初始化成功");
    } else {
        alert('sdk 初始化失败');
    }
});

可用性

Android系统

可提供的1.0.0及更高版本

showSplashAD

开屏

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

params

posId：

  • 类型：字符串
  • 描述：（必填）广告位ID。

logo：

  • 类型：字符串
  • 描述：（可选项）开屏广告底部logo （widget://image/logo-bottom.png）[必须是widget://地址]
  • 默认值：空

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
{
    status: true, //初始化状态
    code: 0, //状态码
    type: 'onLoad', //事件类型 onLoad onShow onClicked onClosed
    msg: "描述",//描述
    result:{ //其他结果数据

    }
}

示例代码

var hmsAds = api.require('hmsAds');
hmsAds.showSplashAD({
    posId:"testq6zq98hecj",
    logo:"widget://image/logo-bottom.png"
}, function(ret, err) {
    if (ret.status) {
        if(ret.type == "onShow"){ //展示

        }

        if(ret.type == "onClosed"){ //关闭

        }
    } else {
        alert(err.code);
    }
});

可用性

Android系统

可提供的1.0.0及更高版本

showBannerAD

横幅

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

params

posId：

  • 类型：字符串
  • 描述：（必填）广告位ID。

rect

  • 类型：对象
  • 描述：（可选项）位置偏移量参数 {
      x:0,
  y:0,
  w:0,
  h:0,
    }

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
{
    status: true, //初始化状态
    code: 0, //状态码
    type: 'onLoad', //事件类型 onLoad onShow onClicked onClosed
    msg: "描述",//描述
    result:{ //其他结果数据

    }
}

示例代码

var hmsAds = api.require('hmsAds');
hmsAds.showBannerAD({
    posId:"testw6vs28auh3",
    rect:{
        x:0,
        y:api.frameHeight - (api.frameWidth/(20/3)),
        w:api.frameWidth,
        h:api.frameWidth/(20/3),
    }
}, function(ret, err) {
    if (ret.status) {
        if(ret.type == "onShow"){ //展示

        }

        if(ret.type == "onClosed"){ //关闭

        }
    } else {
        alert(err.code);
    }
});

可用性

Android系统

可提供的1.0.0及更高版本

closeBannerAD

关闭横幅

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

params

无

callback(ret, err)

无

示例代码

var hmsAds = api.require('hmsAds');
hmsAds.closeBannerAD({
}, function(ret, err) {

});

可用性

Android系统

可提供的1.0.0及更高版本

showInterstitialAD

插屏

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

params

posId：

  • 类型：字符串
  • 描述：（必填）广告位ID。

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
{
    status: true, //初始化状态
    code: 0, //状态码
    type: 'onLoad', //事件类型 onLoad onShow onClicked onClosed
    msg: "描述",//描述
    result:{ //其他结果数据

    }
}

示例代码

var hmsAds = api.require('hmsAds');
hmsAds.showInterstitialAD({
    posId:"testb4znbuh3n2",
    frameName:api.frameName
}, function(ret, err) {
    if (ret.status) {
        if(ret.type == "onShow"){ //展示

        }

        if(ret.type == "onClosed"){ //关闭

        }
    } else {
        alert(err.code);
    }
});

可用性

Android系统

可提供的1.0.0及更高版本

showRewardVideoAD

激励视频

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

params

posId：

  • 类型：字符串
  • 描述：（必填）广告位ID。

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
{
    status: true, //初始化状态
    code: 0, //状态码
    type: 'onLoad', //事件类型 onLoad onShow  onClicked onReward onCompleted onClosed
    msg: "描述",//描述
    result:{ //其他结果数据

    }
}

示例代码

var hmsAds = api.require('hmsAds');
hmsAds.showRewardVideoAD({
    posId:"testx9dtjwj8hp",
    userId:1
}, function(ret, err) {
    if (ret.status) {
        if(ret.type == "onShow"){ //展示

        }

        if(ret.type == "onClosed"){ //关闭

        }
    } else {
        alert(err.code);
    }
});

可用性

Android系统

可提供的1.0.0及更高版本

showNativeExpressAD

信息流

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

params

posId：

  • 类型：字符串
  • 描述：（必填）广告位ID。

frameName

  • 类型：字符串
  • 描述：（可选项）模块视图添加到指定 frame 的名字（只指 frame，传 window 无效）

fixed

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

scroll

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

rect

  • 类型：对象
  • 描述：（可选项）位置偏移量参数 {
      x:0,
  y:0,
  w:0,
  h:0,
    }

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
{
    status: true, //初始化状态
    code: 0, //状态码
    type: 'onLoad', //事件类型 onLoad onShow onClicked onCompleted onClosed onClicked
    msg: "描述",//描述
    result:{ //其他结果数据

    }
}

示例代码

var hmsAds = api.require('hmsAds');
hmsAds.showNativeExpressAD({
    posId : "testu7m3hc4gvm",
    //大图文:testu7m3hc4gvm
    //三小图文:testr6w14o0hqz
    //小图文:testb65czjivt9
    //视频文:testy63txaom86
    frameName:api.frameName,
    fixed:false,
    scroll:true,
    rect:{
        x:0,
        y:0,
        w:0,
        h:0,
    }
}, function(ret, err){
    console.log(JSON.stringify(ret));
});

可用性

Android系统

可提供的1.0.0及更高版本

closeNativeExpressAD

关闭信息流

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

params

无

callback(ret, err)

无

示例代码

var hmsAds = api.require('hmsAds');
hmsAds.closeNativeExpressAD({
}, function(ret, err){

});

可用性

Android系统

可提供的1.0.0及更高版本

showVideoPatchAD

贴片广告

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

params

posId：

  • 类型：字符串
  • 描述：（必填）广告位ID。

frameName

  • 类型：字符串
  • 描述：（可选项）模块视图添加到指定 frame 的名字（只指 frame，传 window 无效）

fixed

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

scroll

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

rect

  • 类型：对象
  • 描述：（可选项）位置偏移量参数 {
      x:0,
  y:0,
  w:0,
  h:0,
    }

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
{
    status: true, //初始化状态
    code: 0, //状态码
    type: 'onLoad', //事件类型 onLoad onShow onCompleted onError
    msg: "描述",//描述
    result:{ //其他结果数据

    }
}

示例代码

var hmsAds = api.require('hmsAds');
hmsAds.showVideoPatchAD({
    posId : "testy3cglm3pj0",
    frameName:api.frameName,
    fixed:false,
    scroll:true,
    rect:{
        x:0,
        y:0,
        w:0,
        h:0,
    }
}, function(ret, err){
    console.log(JSON.stringify(ret));
});

可用性

Android系统

可提供的1.0.0及更高版本

closeVideoPatchAD

关闭贴片广告

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

params

无

callback(ret, err)

无

示例代码

var hmsAds = api.require('hmsAds');
hmsAds.closeVideoPatchAD({
}, function(ret, err){

});

可用性

Android系统

可提供的1.0.0及更高版本