wapsAd

来自于:开发者立即使用

概述

wapsAd封装了万普世纪移动营销服务平台(以下称为“万普平台”)的 SDK, 提供了一套现成的开发 包,便于开发者在应用中方便的集成万普平台的各项功能。

本文档描述了标准版 SDK 的用途用法,并提供了示例代码。您仅需要在现有的应用中加入少 量新代码,就可以集成万普平台的各项功能,轻松获得用户量和收入的倍增。

iOS版本正在赶制中,近期将会推出,请求期待;技术支持QQ:277165921

使用万普平台基本流程说明:

1.在万普登录官网http://waps.cn 注册帐号,并创建应用,获取APP_ID

initInstance

初始化接口,该接口是所有其他接口能正常使用的基础,在每次应用启动时,必须调用该接口进行初始化操作, 才能保证获得准确的统计数据

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

params

APP_ID:

  • 类型:字符串
  • 描述:应用标识,从万普平台获取的 APP_ID。测试APP_ID:(android:0d3ad41e785f13f11726926634e18376 ios:c2aaae8743bb8d0a3ff60bd612e93078)

APP_PID:

  • 类型:字符串
  • 描述:分发渠道标识,可随意填写。

callback(ret, err)

ret:

  • 类型:JSON对象
  • 内部字段:
{
    status: true                 //布尔型;true||false
    msg:"初始化成功!"             //消息信息。
}

示例代码

var uzmoduledemo = api.require('wapsAd');
var param = { APP_ID: "0d3ad41e785f13f11726926634e18376", APP_PID: "mengfei" };
uzmoduledemo.startWork(param, function(ret, err) {
    if (ret) {
        alert(JSON.stringify(ret));
    }
});

可用性

Android系统,iOS系统暂不支持,将于近期更新

可提供的1.0.0及更高版本

getPoints

从服务器端获取用户点数/虚拟货币余额

getPoints(callback(ret, err))

callback(ret, err)

ret:

  • 类型:JSON对象
  • 内部字段:
{
    status: true                //布尔型;true||false
    msg:"操作成功!"             //消息信息。
    currencyName:"积分"         //名称:积分、金币。
    intpointTotal:"53"         //积分数。
}

示例代码

var uzmoduledemo = api.require('wapsAd');
uzmoduledemo.getPoints(function(ret, err) {
    if (ret) {
        alert(JSON.stringify(ret));
    }
});

可用性

Android系统,iOS系统暂不支持,将于近期更新

可提供的1.0.0及更高版本

spendPoints

花费(扣减)用户虚拟货币

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

params

amount:

  • 类型:整型
  • 描述:扣减虚拟货币数。

callback(ret, err)

ret:

  • 类型:JSON对象
  • 内部字段:
{
    status: true                   //布尔型;true||false
    msg:"操作成功!"                 //消息信息。
    currencyName:"积分"             //名称:积分、金币。
    intpointTotal:"53"             //积分数。
}

示例代码

var uzmoduledemo = api.require('wapsAd');
var param = { amount: "1" };
uzmoduledemo.spendPoints(param, function(ret, err) {
    if (ret) {
        alert(JSON.stringify(ret));
    }
});

可用性

Android系统,iOS系统暂不支持,将于近期更新

可提供的1.0.0及更高版本

awardPoints

奖励(增加)用户虚拟货币

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

params

amount:

  • 类型:整型
  • 描述:扣减虚拟货币数。

callback(ret, err)

ret:

  • 类型:JSON对象
  • 内部字段:
{
    status: true                //布尔型;true||false
    msg:"操作成功!"             //消息信息。
    currencyName:"积分"             //名称:积分、金币。
    intpointTotal:"53"             //积分数。
}

示例代码

var uzmoduledemo = api.require('wapsAd');
var param = { amount: "10" };
uzmoduledemo.spendPoints(param, function(ret, err) {
    if (ret) {
        alert(JSON.stringify(ret));
    }
});

可用性

Android系统,iOS系统暂不支持,将于近期更新

可提供的1.0.0及更高版本

showOffers

积分墙接口,积分墙(也称 Offer,广告墙)是万普平台提供的一种集中展示型广告。开发者可在应用中合适的位 置加入“推荐应用”、“免费赚积分”等类似字样的功能,获取更高的广告收益

showOffers(callback(ret, err))

callback(ret, err)

ret:

  • 类型:JSON对象
  • 内部字段:
{
    status: true                //布尔型;true||false
    msg:"操作成功!"             //消息信息。
}

示例代码

var uzmoduledemo = api.require('wapsAd');
uzmoduledemo.showOffers(function(ret, err) {
    if (ret) {
        alert(JSON.stringify(ret));
    }
});

可用性

Android系统,iOS系统暂不支持,将于近期更新

可提供的1.0.0及更高版本

showGameOffers

游戏积分墙接口

showGameOffers(callback(ret, err))

callback(ret, err)

ret:

  • 类型:JSON对象
  • 内部字段:
{
    status: true                //布尔型;true||false
    msg:"操作成功!"             //消息信息。
}

示例代码

var uzmoduledemo = api.require('wapsAd');
uzmoduledemo.showGameOffers(function(ret, err) {
    if (ret) {
        alert(JSON.stringify(ret));
    }
});

可用性

Android系统,iOS系统暂不支持,将于近期更新

可提供的1.0.0及更高版本

setOffersCloseListener

设置关闭积分墙的监听接口,必须在showOffers接口之前调用

setOffersCloseListener(callback(ret, err))

callback(ret, err)

ret:

  • 类型:JSON对象
  • 内部字段:
{
    status: true                 //布尔型;true||false
    msg:"积分墙关闭!"             //消息信息。
}

示例代码

var uzmoduledemo = api.require('wapsAd');
uzmoduledemo.setOffersCloseListener(function(ret, err) {
    if (ret) {
        alert(JSON.stringify(ret));
    }
});

可用性

Android系统,iOS系统暂不支持,将于近期更新

可提供的1.0.0及更高版本

showBannerAd

互动广告接口,互动广告是一个显示在应用内固定位置高度为 50 像素广告条,将自动显示万普平台提供的广告。结 合虚拟货币功能使用,可获得最佳的广告效果和用户体验

showBannerAd(callback(ret, err))

callback(ret, err)

ret:

  • 类型:JSON对象
  • 内部字段:
{
    status: false                     //布尔型;true||false
    msg:"Banner广告无数据"             //消息信息。
}

示例代码

var uzmoduledemo = api.require('wapsAd');
uzmoduledemo.showBannerAd(function(ret, err) {
    if (ret) {
        alert(JSON.stringify(ret));
    }
});

可用性

Android系统,iOS系统暂不支持,将于近期更新

可提供的1.0.0及更高版本

showPopAd

插屏广告是推出的一种新型广告形式,以全屏对话框的新式显示广告,支持透明 背景和浮层特效。和传统 Banner 广告相比,显示效果更炫,转化率更高,而且具有良好的用户体 验。不占用固定广告位,特别适用于应用启动、游戏通关等场景使用。

showPopAd(callback(ret, err))

callback(ret, err)

ret:

  • 类型:JSON对象
  • 内部字段:
{
    status: true                //布尔型;true||false
    msg:"获取成功!"             //消息信息。
}

示例代码

var uzmoduledemo = api.require('wapsAd');
uzmoduledemo.showPopAd(function(ret, err) {
    if (ret) {
        alert(JSON.stringify(ret));
    }
});

可用性

Android系统,iOS系统暂不支持,将于近期更新

可提供的1.0.0及更高版本

initAdInfo

自定义广告接口,初始化(预先加载)广告数据,必须首先调用,开发者可通过自定义广告,广告接口获取所有可用广告的元数据,自定义广告的展现方式,便于让广告内容完全和您的应用 UI 融合,可显著提升广告效果。

该接口将在首次调用时,需要预先将所有可用广告的元数据(通常 20 条左右)全部获取到手 机内存,便于程序随时快速调用。广告数据首次加载时间视网络情况决定,通常需要花几秒钟时 间,因此,如果应用内需要使用自定义广告功能,建议在程序启动后,尽早先调用 initAdInfo()方法 预先异步加载一次元数据,便于后续调用 getAdInfo()或 getAdInfoList()方法时能立即获得数据。

initAdInfo(callback(ret, err))

callback(ret, err)

ret:

  • 类型:JSON对象
  • 内部字段:
{
    status: true   //布尔型;true||false
    msg:"初始化成功!"             //消息信息。
}

示例代码

var uzmoduledemo = api.require('wapsAd');
uzmoduledemo.initAdInfo(function(ret, err) {
    if (ret) {
        alert(JSON.stringify(ret));
    }
});

可用性

Android系统,iOS系统暂不支持,将于近期更新

可提供的1.0.0及更高版本

getAdInfoList

归属自定义广告接口,获取所有可用广告的元数据,必须在初始化(initAdInfo)方法后使用

getAdInfoList(callback(ret, err))

callback(ret, err)

ret:

  • 类型:JSON对象
  • 内部字段:
{
    status: true   //布尔型;true||false
    msg:"获取成功!"             //消息信息。
    data:[{
    "adPackage": "com.medapp.man",
    "adText": "免费健康顾问,告别难言之隐",
    "filesize": "3.98",
    "adId": "04d4be719a82ac5f794f3d832c5e23e9",
    "description": "\t男性私人医生是一款针对男性生理健康及其他相关专科类病症,提供在线咨询的医疗软件。尴尬症状会因为顾虑不方便表述或工作忙碌等原因而忽略去医院。本产品集合全国各城市几百家医院的资源,提供医疗健康咨询;免去挂号难,排队久的困扰,便捷的咨询过程,省时省事,为您的健康生活提供全面的保护。",
    "adIcon": "android.graphics.Bitmap@43519830",
    "action": "注册",
    "imageUrls": "[Ljava.lang.String;@43517f18",
    "provider": "天亚科创",
    "appType": "应用",
    "adName": "男性私人医生",
    "version": "3.0.60",
    "adPoint": 50
    }]            //广告数据,json对象
}

示例代码

var uzmoduledemo = api.require('wapsAd');
uzmoduledemo.getAdInfoList(function(ret, err) {
    if (ret) {
        alert(JSON.stringify(ret));
    }
});

可用性

Android系统,iOS系统暂不支持,将于近期更新

可提供的1.0.0及更高版本

getAdInfo

归属自定义广告接口,随机获取一条广告的元数据,必须在初始化(initAdInfo)方法后使用

getAdInfo(callback(ret, err))

callback(ret, err)

ret:

  • 类型:JSON对象
  • 内部字段:
{
    status: true   //布尔型;true||false
    msg:"获取成功!"             //消息信息。
    data:{
    "adPackage": "com.medapp.man",
    "adText": "免费健康顾问,告别难言之隐",
    "filesize": "3.98",
    "adId": "04d4be719a82ac5f794f3d832c5e23e9",
    "description": "\t男性私人医生是一款针对男性生理健康及其他相关专科类病症,提供在线咨询的医疗软件。尴尬症状会因为顾虑不方便表述或工作忙碌等原因而忽略去医院。本产品集合全国各城市几百家医院的资源,提供医疗健康咨询;免去挂号难,排队久的困扰,便捷的咨询过程,省时省事,为您的健康生活提供全面的保护。",
    "adIcon": "android.graphics.Bitmap@43519830",
    "action": "注册",
    "imageUrls": "[Ljava.lang.String;@43517f18",
    "provider": "天亚科创",
    "appType": "应用",
    "adName": "男性私人医生",
    "version": "3.0.60",
    "adPoint": 50
    }             //广告数据,json对象
}

示例代码

var uzmoduledemo = api.require('wapsAd');
uzmoduledemo.getAdInfo(function(ret, err) {
    if (ret) {
        alert(JSON.stringify(ret));
    }
});

可用性

Android系统,iOS系统暂不支持,将于近期更新

可提供的1.0.0及更高版本

clickAd

归属自定义广告接口,当广告被点击时,显示广告详情

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

params

adId:

  • 类型:字符串
  • 描述:广告ID。

callback(ret, err)

ret:

  • 类型:JSON对象
  • 内部字段:
{
    status: true   //布尔型;true||false
    msg:"操作成功!"             //消息信息。
}

示例代码

var uzmoduledemo = api.require('wapsAd');
var param = {
    adId: "04d4be719a82ac5f794f3d832c5e23e9"
};
uzmoduledemo.clickAd(param, function(ret, err) {
    alert(JSON.stringify(ret));
});

可用性

Android系统,iOS系统暂不支持,将于近期更新

可提供的1.0.0及更高版本

downloadAd

当用户确认要下载广告应用时,启动下载(仅适用于应用下载类广告)

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

params

adId:

  • 类型:字符串
  • 描述:广告ID。

callback(ret, err)

ret:

  • 类型:JSON对象
  • 内部字段:
{
    status: true   //布尔型;true||false
    msg:"下载广告中"             //消息信息。
}

示例代码

var uzmoduledemo = api.require('wapsAd');
var param = {
    adId: "04d4be719a82ac5f794f3d832c5e23e9"
};
uzmoduledemo.downloadAd(param, function(ret, err) {
    alert(JSON.stringify(ret));
});

可用性

Android系统

可提供的1.0.0及更高版本