Partner Ads

/ Title: partnerAds Description: 穿山甲广告联盟 /

来自于:开发者立即使用

概述

穿山甲广告联盟简介

穿山甲是全球开发者成长平台,为开发者提供APP流量变现、用户增长、LTV提升等全生命周期成长服务,目前已帮助超过10万个app在平台内飞速成长,也为超过10.5万广告主提供广告投放解决方案。

partnerAds 模块概述

本模块封装了穿山甲广告联盟的原生 SDK,集成了开屏、Banner、插屏、全屏视频、激励视频、Darw流、信息流;可用于实现app流量变现。

模块使用攻略

使用之前须从穿山甲广告联盟平台申请开发者账号并创建应用,获取 appid。

穿山甲广告联盟申请地址穿山甲广告联盟

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

  • 名称:partnerAds
  • 参数:android_appId、ios_appId
  • 配置示例:
  <feature name="partnerAds">
    <param name="android_appId" value="5001121" />
    <param name="ios_appId" value="5000546" />
  </feature>
  • 字段描述:

    android_appId:安卓平台应用appid。

    ios_appId:苹果平台应用appid。

    模块接口

initSdk

sdk 初始化

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

params

appName:

  • 类型:字符串
  • 描述:(可选项)app 名称。

imei:

  • 类型:字符串
  • 描述:(可选项)手机 imei [仅限Android]。

oaId:

  • 类型:字符串
  • 描述:(可选项)手机 oaId [仅限Android]。

idfa:

  • 类型:字符串
  • 描述:(可选项)手机 idfa [仅限IOS]。

callback(ret, err)

ret:

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

示例代码

var partnerAds = api.require('partnerAds');
partnerAds.initSdk({
    appName:api.appName, //选填
    imei:"",
    oaId:"",
    idfa:"",
},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 partnerAds = api.require('partnerAds');
partnerAds.showSplashAD({
    posId:"801121648",
    // posId:"800546851",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 partnerAds = api.require('partnerAds');
partnerAds.showBannerAD({
    posId:"901121246",
    // posId:"900546269",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 partnerAds = api.require('partnerAds');
partnerAds.closeBannerAD({
}, function(ret, err) {

});

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

showInterstitialAD

插屏(原插屏)

showInterstitialAD({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 partnerAds = api.require('partnerAds');
partnerAds.showInterstitialAD({
    posId:"945509833",
    // posId:"945113155",ios
    rect:{
        x:0,
        y:0,
        w:450,
        h:300
    }
}, 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 onSkipped onClicked onCompleted onClosed
    msg: "描述",//描述
    result:{ //其他结果数据

    }
}

示例代码

var partnerAds = api.require('partnerAds');
partnerAds.showFullScreenVideoAD({
    posId:"901121375",
    // posId:"945113164",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 partnerAds = api.require('partnerAds');
partnerAds.showRewardVideoAD({
    posId:"901121430",
    // posId:"945113162",ios
    userId:1
}, 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 partnerAds = api.require('partnerAds');
partnerAds.showNativeExpressAD({
    posId : "901121134",
    //posId : 945113159 ,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 partnerAds = api.require('partnerAds');
partnerAds.closeNativeExpressAD({
}, function(ret, err){

});

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

showDrawExpressAD

Draw流

showDrawExpressAD({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 onClicked
    msg: "描述",//描述
    result:{ //其他结果数据

    }
}

示例代码

var partnerAds = api.require('partnerAds');
partnerAds.showDrawExpressAD({
    posId : "901121041",
    //posId : 900546881 ,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及更高版本

closeDrawExpressAD

关闭Draw流

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

params

callback(ret, err)

示例代码

var partnerAds = api.require('partnerAds');
partnerAds.closeDrawExpressAD({
}, function(ret, err){

});

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本