zyHuaweiAd

来自于:开发者立即使用


其它接口


模块接口

论坛示例

为帮助用户更好更快的使用模块,论坛维护了一个示例,示例中包含示例代码供您参考。

概述

模块简介

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

信息流广告解决划动时会触摸误点的问题。

Android云编译最低版本为4.0.3。 使用设备为:华为手机、华为平板

使用模块前请先到华为开发者后台注册帐号、新建应用、添加代码位使用。模块中默认测试代码位可直接测试使用。

点击进入华为开发者联盟

模块接口

getVersions

获取当前集成的sdk版本号

getVersions(callback(ret))

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
  status:true, //调用成功
  result:"13.4.45.302",//结果
}

示例代码

var zyHuaweiAd = api.require('zyHuaweiAd');
zyHuaweiAd.getVersions(function(ret){
  alert("zyHuaweiAd:"+JSON.stringify(ret));
});

可用性

Android系统

可提供的1.0.0及更高版本

init

初始化模块(使用前必须)

init({params}, callback(ret))

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
  status:true,
  result:"初始化完成"
}

示例代码

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

可用性

Android系统

可提供的1.0.0及更高版本

showSplashAd

展示开屏广告

showSplashAd({params}, callback(ret))

params

setCodeId:

  • 类型:字符串
  • 描述:(必选项)代码位id
  • 默认值:testq6zq98hecj

rect:

  • 类型:对象
  • 描述:(可选项)打开开屏区域 全为0或不写 则打开全屏
  • 内部字段:
{
    x:0,
    y:0,
    w:0,
    h:0
}

fixedOn:

  • 类型:字符串类型
  • 描述:(可选项)模块视图添加到指定 frame 的名字(只指 frame,传 window 无效)
  • 默认值:模块依附于当前 window

fixed:

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

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
  status:true, //true的结果如下   false结果则显示对应错误提示
  result:"开屏加载中"
         "view已添加"
         "开屏展示"
         "开屏倒计时结束"
         "开屏点击"
         "开屏已关闭"
}

示例代码

var zyHuaweiAd = api.require('zyHuaweiAd');
var param = {
  setCodeId:"testd7c5cewoj6",//默认测试代码位
  rect:{//开屏位置 默认0即为全屏 也可自定义
        x:0,
        y:0,
        w:0,
        h:0
    },
    fixedOn:"",
    fixed:true,
};
zyHuaweiAd.showSplashAd(param,function(ret){
    console.log("zyHuaweiAd:"+JSON.stringify(ret));
});

可用性

Android系统

可提供的1.0.0及更高版本

closeSplashAd

手动关闭开屏广告

closeSplashAd(callback(ret))

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
  status:true,
  result:"开屏已关闭"
}

示例代码

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

可用性

Android系统

可提供的1.0.0及更高版本

showBannerAd

展示Banner广告

showBannerAd({params}, callback(ret))

params

tag:

  • 类型:字符串
  • 描述:(可选项)打开此banner的标识 需要打开多个banner可设置不同的tag 手动close时传入对应tag即可关闭对应banner
  • 默认值:_default

setCodeId:

  • 类型:字符串
  • 描述:(必选项)代码位id
  • 默认值:testw6vs28auh3

rect:

  • 类型:对象
  • 描述:(可选项)打开开屏区域 全为0或不写 则打开全屏
  • 内部字段:
{
    x:0,
    y:0,
    w:0,
    h:0
}

fixedOn:

  • 类型:字符串类型
  • 描述:(可选项)模块视图添加到指定 frame 的名字(只指 frame,传 window 无效)
  • 默认值:模块依附于当前 window

fixed:

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

bannerRefresh:

  • 类型:数字
  • 描述:(可选项)刷新频率 取值范围:[30, 120]
  • 默认值:30

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
  status:true, //true的结果如下   false结果则显示对应错误提示
  result:"banner加载中"
         "banner加载成功"
         "view已添加"
         "banner展示"
         "banner曝光"
         "banner点击"
         "banner打开三方页面"
         "banner离开应用"
         "banner已关闭"
}

示例代码

var param = {
    setCodeId:"testw6vs28auh3",//默认测试代码位
    rect:{//显示位置
        x:20,
        y:100,
        w:api.winWidth-40,
        h:(api.winWidth-40)*144/360
    },
    fixedOn:api.frameName,
    fixed:false
};
zyHuaweiAd.showBannerAd(param,function(ret){
    console.log("zyHuaweiAd:"+JSON.stringify(ret));
});

可用性

Android系统

可提供的1.0.0及更高版本

closeBannerAd

手动关闭Banner广告

closeBannerAd({params}, callback(ret))

params

tag:

  • 类型:字符串
  • 描述:(可选项)打开此banner的标识 需要打开多个banner可设置不同的tag 手动close时传入对应tag即可关闭对应banner
  • 默认值:_default

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
  status:true,
  result:"bannerAd已关闭"
}

示例代码

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

可用性

Android系统

可提供的1.0.0及更高版本

showInteractionAd

展示插屏广告

showInteractionAd({params}, callback(ret))

params

setCodeId:

  • 类型:字符串
  • 描述:(必选项)代码位id
  • 默认值:testb4znbuh3n2

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
  status:true, //true的结果如下   false结果则显示对应错误提示
  result:"插屏加载中"
         "插屏加载成功"
         "view已添加"
         "插屏展示"
         "插屏打开三方页面"
         "插屏点击"
         "插屏离开应用"
         "插屏已关闭"
}

示例代码

var zyHuaweiAd = api.require('zyHuaweiAd');
var param = {
    setCodeId:"testb4znbuh3n2",//默认测试代码位
};
zyHuaweiAd.showInteractionAd(param,function(ret){
    console.log("zyHuaweiAd:"+JSON.stringify(ret));
});

可用性

Android系统

可提供的1.0.0及更高版本

loadRewardVideoAd

加载激励视频广告

loadRewardVideoAd({params}, callback(ret))

params

setCodeId:

  • 类型:字符串
  • 描述:(必选项)代码位id
  • 默认值:testx9dtjwj8hp

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
  status:true, //true的结果如下   false结果则显示对应错误提示
  result:"激励视频加载中"
         "激励视频缓存完成"
         "激励视频展示"
         "激励视频奖励发送:?,?"
         "激励视频关闭"
}

示例代码

var zyHuaweiAd = api.require('zyHuaweiAd');
var param = {
    setCodeId:"testx9dtjwj8hp",//默认测试代码位
};
zyHuaweiAd.loadRewardVideoAd(param,function(ret){
    console.log("zyHuaweiAd:"+JSON.stringify(ret));
});

可用性

Android系统

可提供的1.0.0及更高版本

showRewardVideoAd

展示激励视频

showRewardVideoAd(callback(ret))

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
  status:true|false,
  result:"展示广告|请先加载激励视频|激励视频正在加载,请稍候"
}

示例代码

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

可用性

Android系统

可提供的1.0.0及更高版本

showNativeExpressAd

展示信息流广告

showNativeExpressAd({params}, callback(ret))

params

tag:

  • 类型:字符串
  • 描述:(可选项)唯一广告标识
  • 默认值:_default

setCodeId:

  • 类型:字符串
  • 描述:(必选项)代码位id
  • 默认值:testy63txaom86

rect:

  • 类型:对象
  • 描述:(可选项)打开展示区域
  • 内部字段:
{
    x:0,
    y:0,
    w:0,
    h:600
}

fixedOn:

  • 类型:字符串类型
  • 描述:(可选项)模块视图添加到指定 frame 的名字(只指 frame,传 window 无效)
  • 默认值:模块依附于当前 window

fixed:

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

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
  status:true, //true的结果如下   false结果则显示对应错误提示
  result:"信息流加载中" 
         "信息流加载成功"
         "view已添加"
         "信息流曝光"
         "信息流点击"
         "信息流打开三方页面"
         "信息流离开应用"
         "信息流已关闭"
}

示例代码

var zyHuaweiAd = api.require('zyHuaweiAd');
var param = {
    tag:"123",
    setCodeId:"testy63txaom86",//代码位
    rect:{
        x:0,
        y:0,
        w:360,
        h:300
    },
    fixedOn:api.frameName,
    fixed:false
};
zyHuaweiAd.showNativeExpressAd(param,function(ret){
    console.log("zyHuaweiAd:"+JSON.stringify(ret));
});

可用性

Android系统

可提供的1.0.0及更高版本

closeNativeExpressAd

关闭信息流 传入tag 默认关闭_default 传 all清除所有 closeNativeExpressAd({params}, callback(ret))

params

tag:

  • 类型:字符串
  • 描述:(可选项)打开信息流的标识 需要打开多个信息流可设置不同的tag 手动close时传入对应tag即可关闭对应banner
  • 默认值:_default

示例代码

var zyHuaweiAd = api.require('zyHuaweiAd');
zyHuaweiAd.closeNativeExpressAd({tag:"all"});

可用性

Android系统

可提供的1.0.0及更高版本

showVideoPatchAd

展示贴片广告

showVideoPatchAd({params}, callback(ret))

params

setCodeId:

  • 类型:字符串
  • 描述:(必选项)代码位id
  • 默认值:testy3cglm3pj0

rect:

  • 类型:对象
  • 描述:(可选项)打开展示区域
  • 内部字段:
{
    x:0,
    y:0,
    w:api.winWidth,
    h:220
}

fixedOn:

  • 类型:字符串类型
  • 描述:(可选项)模块视图添加到指定 frame 的名字(只指 frame,传 window 无效)
  • 默认值:模块依附于当前 window

fixed:

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

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
  status:true, //true的结果如下   false结果则显示对应错误提示
  result:"贴片广告加载中" 
         "view已添加"
         "广告媒体切换"
         "已播放时长:?"
         "开始播放"
         "贴片广告已关闭"
}

示例代码

var zyHuaweiAd = api.require('zyHuaweiAd');
var param = {
    setCodeId:"testy3cglm3pj0",//代码位
    rect:{
        x:0,
        y:0,
        w:api.winWidth,
        h:220
    },
    fixedOn:api.frameName,
    fixed:false
};
zyHuaweiAd.showVideoPatchAd(param,function(ret){
    console.log("zyHuaweiAd:"+JSON.stringify(ret));
});

可用性

Android系统

可提供的1.0.0及更高版本

closeVideoPatchAd

关闭贴片广告

closeVideoPatchAd(callback(ret))

示例代码

var zyHuaweiAd = api.require('zyHuaweiAd');
zyHuaweiAd.closeVideoPatchAd();

可用性

Android系统

可提供的1.0.0及更高版本

setAttr

重设广告的显示区域

setAttr({params}, callback(ret))

params

type:

  • 类型:字符串
  • 描述:(必填项)banner、nativeExpress 分别为banner、信息流

tag:

  • 类型:字符串
  • 描述:(必填项)唯一广告标识

rect:

  • 类型:对象
  • 描述:(必填项)重设展示区域
  • 内部字段:
{
    x:0,
    y:0,
    w:0,
    h:0
}

示例代码

var zyHuaweiAd = api.require('zyHuaweiAd');
setTimeout(function(){
    for(var i = 0; i < openAds.length; i++){
        var divOff = $api.offset($api.byId("myAddPage" + openAds[i].id));
        zyHuaweiAd.setAttr({
            type:openAds[i].type,
            tag:openAds[i].tag,
            rect:{//重新显示位置
                x:divOff.l,
                y:divOff.t,
                w:divOff.w,
                h:divOff.h
            },
        });
    }
},0);

可用性

Android系统

可提供的1.0.0及更高版本