adnetAds
概述
优量汇广告联盟简介
广点通移动联盟系统(优量汇)致力于为广告主与应用开发者搭建高效的移动广告技术服务平台，支持丰富的广告产品形态及多样化的资源接入方式，整合腾讯内外数千家广告主及流量资源，提供多维度的精准定向方式及透明清晰的统计报告，助力开发者及广告主实现收益最大化。
adnetAds 插件概述
本插件封装了优量汇广告联盟的原生 SDK，集成了开屏、Banner、插屏、全屏视频、激励视频、信息流；可用于实现app流量变现。
插件使用攻略
使用之前须从优量汇广告联盟平台申请开发者账号并创建应用，获取 appid。
优量汇广告联盟申请地址优量汇广告联盟
使用此插件之前建议先配置 config.xml 文件，配置完毕，需通过云端编译生效，配置方法如下：
- 名称：adnetAds
- 参数：android_appId、ios_appId
- 配置示例:
<feature name="adnetAds">
<param name="android_appId" value="5001121" />
<param name="ios_appId" value="5001121" />
</feature>
字段描述:
android_appId：安卓平台应用appid。
ios_appId：苹果平台应用appid。
android 配置：
<!-- //部分第三方sdk 不支持 armeabi -->
<preference name="android_abi" value="arm64-v8a"/>
<!-- //admob 广告配置appId 替换成自己的实际appId-->
<meta-data name="com.google.android.gms.ads.APPLICATION_ID" value="ca-app-pub-3940256099942544~3347511713" />
ios 配置：
<!-- res/Info.plst -->
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
<!-- http 访问 -->
<key>NSAppTransportSecurity</key>
<dict>
<key>NSAllowsArbitraryLoads</key>
<true/>
</dict>
<!-- IDFA -->
<key>NSUserTrackingUsageDescription</key>
<string>该标识符将用于向您投放个性化广告</string>
<!-- 网关 -->
<key>SKAdNetworkItems</key>
<array>
<!-- 优量汇广告应用网络 -->
<dict>
<key>SKAdNetworkIdentifier</key>
<string>f7s53z58qe.skadnetwork</string>
</dict>
</array>
</dict>
</plist>
插件接口
initSdk
sdk 初始化
initSdk({params},callback(ret, err))
params
userId:
- 类型：字符串
- 描述：（可选项）用户标识。
callback(ret, err)
ret：
- 类型：JSON 对象
- 内部字段：
{
status: true, //初始化状态
code: 0, //状态码
type: 'onInit', //事件类型
msg: "onInitSdk",//描述
result:{ //其他结果数据
version:"3.8.0" //sdk 版本号
}
}
示例代码
var adnetAds = api.require('adnetAds');
adnetAds.initSdk({
userId:"1",
},function(ret, err) {
if (ret.status) {
alert("sdk 初始化成功");
} else {
alert('sdk 初始化失败');
}
});
可用性
iOS系统，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 adnetAds = api.require('adnetAds');
adnetAds.showSplashAD({
posId:"4090599490374470",
// posId:"9040714184494018",ios
logo:"widget://image/logo-bottom.png"
}, function(ret, err) {
if (ret.status) {
if(ret.type == "onShow"){ //展示
}
if(ret.type == "onClosed"){ //关闭
}
} else {
alert(err.code);
}
});
可用性
iOS系统，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 adnetAds = api.require('adnetAds');
adnetAds.showBannerAD({
posId:"4080052898050840",
// posId:"1080958885885321",ios
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);
}
});
可用性
iOS系统，Android系统
可提供的1.0.0及更高版本
closeBannerAD
关闭横幅
closeBannerAD({params}, callback(ret, err))
params
无
callback(ret, err)
无
示例代码
var adnetAds = api.require('adnetAds');
adnetAds.closeBannerAD({
}, function(ret, err) {
});
可用性
iOS系统，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 adnetAds = api.require('adnetAds');
adnetAds.showInterstitialAD({
posId:"4090791272610625",
// posId:"6050298509489032",ios
}, function(ret, err) {
if (ret.status) {
if(ret.type == "onShow"){ //展示
}
if(ret.type == "onClosed"){ //关闭
}
} else {
alert(err.code);
}
});
可用性
iOS系统，Android系统
可提供的1.0.0及更高版本
showFullScreenVideoAD
全屏视频 (插屏全屏)
showFullScreenVideoAD({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 adnetAds = api.require('adnetAds');
adnetAds.showFullScreenVideoAD({
posId:"9051949928507973",
// posId:"4031449988975443",ios
}, function(ret, err) {
if (ret.status) {
if(ret.type == "onShow"){ //展示
}
if(ret.type == "onClosed"){ //关闭
}
} else {
alert(err.code);
}
});
可用性
iOS系统，Android系统
可提供的1.0.0及更高版本
showRewardVideoAD
激励视频
showRewardVideoAD({params}, callback(ret, err))
params
posId：
- 类型：字符串
- 描述：（必填）广告位ID。
customData：
- 类型：字符串
- 描述：（选填）自定义数据。
callback(ret, err)
ret：
- 类型：JSON 对象
- 内部字段：
{
status: true, //初始化状态
code: 0, //状态码
type: 'onLoad', //事件类型 onLoad onShow onClicked onReward onCompleted onClosed
msg: "描述",//描述
result:{ //其他结果数据
}
}
示例代码
var adnetAds = api.require('adnetAds');
adnetAds.showRewardVideoAD({
posId:"2090845242931421",
// posId:"8020744212936426",ios
customData: '{"userId":"1","channel":"app"}'
}, function(ret, err) {
if (ret.status) {
if(ret.type == "onShow"){ //展示
}
if(ret.type == "onClosed"){ //关闭
}
} else {
alert(err.code);
}
});
可用性
iOS系统，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 adnetAds = api.require('adnetAds');
adnetAds.showNativeExpressAD({
posId : "6090892202222287",
//posId : 1070493363284797 ,ios
frameName:api.frameName,
fixed:false,
scroll:true,
rect:{
x:0,
y:0,
w:0,
h:0,
}
}, function(ret, err){
console.log(JSON.stringify(ret));
});
可用性
iOS系统，Android系统
可提供的1.0.0及更高版本
closeNativeExpressAD
关闭信息流
closeNativeExpressAD({params}, callback(ret, err))
params
无
callback(ret, err)
无
示例代码
var adnetAds = api.require('adnetAds');
adnetAds.closeNativeExpressAD({
}, function(ret, err){
});
可用性
iOS系统，Android系统
可提供的1.0.0及更高版本