gromoreAds
概述
穿山甲聚合广告联盟简介
穿山甲是全球开发者成长平台，为开发者提供APP流量变现、用户增长、LTV提升等全生命周期成长服务，目前已帮助超过10万个app在平台内飞速成长，也为超过10.5万广告主提供广告投放解决方案。
gromoreAds 插件概述
本插件封装了穿山甲聚合广告联盟的原生 SDK，集成了开屏、Banner、插屏、全屏视频、激励视频、信息流；可用于实现app流量变现。
聚合平台：穿山甲、优量汇、快手、百度、mintegral、sigmob、admob、unity
插件使用攻略
使用之前须从穿山甲聚合广告联盟平台申请开发者账号并创建应用，获取 appid。
穿山甲聚合广告联盟申请地址穿山甲聚合广告联盟
使用此插件之前建议先配置 config.xml 文件，配置完毕，需通过云端编译生效，配置方法如下：
- 名称：gromoreAds
- 参数：android_appId、ios_appId
- 配置示例:
<feature name="gromoreAds">
<param name="android_appId" value="5001121" />
<param name="ios_appId" value="5000546" />
</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>238da6jt44.skadnetwork</string>
</dict>
<dict>
<key>SKAdNetworkIdentifier</key>
<string>22mmun2rn5.skadnetwork</string>
</dict>
<dict>
<key>SKAdNetworkIdentifier</key>
<string>x2jnk7ly8j.skadnetwork</string>
</dict>
<!-- Admob -->
<dict>
<key>SKAdNetworkIdentifier</key>
<string>cstr6suwn9.skadnetwork</string>
</dict>
<!-- UnityAds -->
<dict>
<key>SKAdNetworkIdentifier</key>
<string>4dzt52r2t5.skadnetwork</string>
</dict>
<dict>
<key>SKAdNetworkIdentifier</key>
<string>bvpn9ufa9b.skadnetwork</string>
</dict>
<!-- Sigmob -->
<dict>
<key>SKAdNetworkIdentifier</key>
<string>58922NB4GD.skadnetwork</string>
</dict>
<!-- GDT -->
<dict>
<key>SKAdNetworkIdentifier</key>
<string>f7s53z58qe.skadnetwork</string>
</dict>
<!-- Mintegral -->
<dict>
<key>SKAdNetworkIdentifier</key>
<string>kbd757ywx3.skadnetwork</string>
</dict>
</array>
<!-- admob 配置appid -->
<key>GADApplicationIdentifier</key>
<!-- 替换成自己的实际appId -->
<string>ca-app-pub-3940256099942544~1458002511</string>
<!-- 如果不启用 admob 必须配置 否则ios 闪退 -->
<key>GADIsAdManagerApp</key>
<true/>
</dict>
</plist>
插件接口
initSdk
sdk 初始化
initSdk({params},callback(ret, err))
params
appName:
- 类型：字符串
- 描述：（可选项）app 名称。
userId:
- 类型：字符串
- 描述：（可选项）自定义用户标识
deviceId:
- 类型：字符串
- 描述：（可选项）自定义用户设备标识
callback(ret, err)
ret：
- 类型：JSON 对象
- 内部字段：
{
status: true, //初始化状态
code: 0, //状态码
type: 'onInit', //事件类型
msg: "onInitSdk",//描述
result:{ //其他结果数据
version:"3.8.0" //sdk 版本号
}
}
示例代码
var gromoreAds = api.require('gromoreAds');
gromoreAds.initSdk({
appName:api.appName, //app 名称
userId:"", //用户标识
deviceId:"", //自定义用户设备标识
},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 onSkipped onClicked onClosed
msg: "描述",//描述
result:{ //其他结果数据
}
}
示例代码
var gromoreAds = api.require('gromoreAds');
gromoreAds.showSplashAD({
posId: "887382965",
// posId: "887418500", 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 gromoreAds = api.require('gromoreAds');
gromoreAds.showBannerAD({
posId: "945493677",
// posId: "945494753", 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 gromoreAds = api.require('gromoreAds');
gromoreAds.closeBannerAD({
}, function(ret, err) {
});
可用性
iOS系统，Android系统
可提供的1.0.0及更高版本
showInterstitialAD
插屏(原插屏)
showInterstitialAD({params}, callback(ret, err))
params
isPro：
- 类型：布尔
- 描述：（选填）新否为新插屏（半屏）。 默认：false
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 gromoreAds = api.require('gromoreAds');
gromoreAds.showInterstitialAD({
isPro:false,//新否为新插屏（半屏）。 默认：false
posId: "945493679",
// posId: "945494755", ios
rect:{
x:0,
y:0,
w: api.frameWidth * 0.9,
h: (api.frameWidth * 0.9) / (2/3)
}
}, 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
isPro：
- 类型：布尔
- 描述：（选填）新否为新插屏（全屏）。 默认：false
posId：
- 类型：字符串
- 描述：（必填）广告位ID。
callback(ret, err)
ret：
- 类型：JSON 对象
- 内部字段：
{
status: true, //初始化状态
code: 0, //状态码
type: 'onLoad', //事件类型 onLoad onShow onSkipped onClicked onCompleted onClosed
msg: "描述",//描述
result:{ //其他结果数据
}
}
示例代码
var gromoreAds = api.require('gromoreAds');
gromoreAds.showFullScreenVideoAD({
isPro:false,//新否为新插屏（全屏）。 默认：false
posId: "945493674",
// posId: "945494752",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。
callback(ret, err)
ret：
- 类型：JSON 对象
- 内部字段：
{
status: true, //初始化状态
code: 0, //状态码
type: 'onLoad', //事件类型 onLoad onShow onSkipped onClicked onReward onCompleted onClosed
msg: "描述",//描述
result:{ //其他结果数据
}
}
示例代码
var gromoreAds = api.require('gromoreAds');
gromoreAds.showRewardVideoAD({
posId: "945700410",
// posId: "945490586",ios
}, 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 onCompleted onClicked onClosed
msg: "描述",//描述
result:{ //其他结果数据
}
}
示例代码
var gromoreAds = api.require('gromoreAds');
gromoreAds.showNativeExpressAD({
posId: "945493687",
// posId: "945494759",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 gromoreAds = api.require('gromoreAds');
gromoreAds.closeNativeExpressAD({
}, function(ret, err){
});
可用性
iOS系统，Android系统
可提供的1.0.0及更高版本