APICloud 接入指引
一、概述
为方便用户集成, openinstall 已在 APICloud 的模块Store
中上架了官方模块。此模块封装了openinstall平台的SDK,集成了携参安装,渠道统计,快速下载和一键跳转功能;可用于实现移动广告效果统计,免填邀请码,安装后自动加好友,一键加入游戏房间,用户分享统计,微信中快速下载/一键跳转等功能,根据需求可实现更多场景。
二、初始化配置
1. 使用之前须从openinstall平台申请开发者账号并创建应用,获取AppKey,使用此模块之前建议先配置config.xml 文件,配置完毕,需通过云端编译生效,配置方法如下:
<permission name="internet" />
<preference name="urlScheme" value="openinstall官方自动分配的scheme" />
//android下
<meta-data name="com.openinstall.APP_KEY" value="openinstall官方自动分配的appKey" />
//iOS下
<feature name="openinstall">
<param name="com.openinstall.APP_KEY" value="openinstall官方自动分配的appKey" />
</feature>
- 字段描述:
internet:添加网络权限;
urlScheme:使用一键跳转功能必须配置
com.openinstall.APP_KEY:从openinstall平台获取的 AppKey。
注:使用openinstall第三方插件文档集成时,如何快速获取AppKey、Associated Domains和scheme,下图为iOS相关配置信息(Android同理):
2. Universal Links相关配置(iOS9.0以上)
1)到苹果开发者网站,为当前的 AppID 开启关联域名(Associated Domains)服务:
注意:当AppID重新编辑过之后,需要更新相应的mobileprovision证书。更新mobileprovision证书步骤请查看云编译mobileprovision证书制作中的 “云编译mobileprovision发布证书制作”或“云编译mobileprovision测试证书制作”。
2)创建新的(或更新现有的)描述文件,下载并导入到APICloud开发控制台 -> iOS证书;
3)配置关联域名(Associated Domains),方法如下:
在widget\res下创建文件名为UZApp.entitlements的文件,UZApp.entitlements内容如下:
<?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>
<key>com.apple.developer.associated-domains</key><!--固定key值-->
<array>
<!--这里换成你在openinstall后台的关联域名(Associated Domains)-->
<string>applinks:xxxxxx.openinstall.io</string>
</array>
</dict>
</plist>
openinstall完全兼容微信openSDK1.8.6以上版本的通用链接跳转功能,注意在使用 微信模块wxPlus或wxpayPlus 时,微信要求配置的config.xml,请传入正确格式的universal link链接:(链接中yourAppkey请从openinstall后台获取)
微信开放平台后台Universal links配置,要和上面代码中的保持一致
- 微信SDK更新参考微信开放平台更新文档
三、调用API
1. 快速下载
如果只需要快速下载功能,无需其它功能(携带参数安装、渠道统计、一键跳转),完成初始化即可。
2. 一键跳转
获取跳转参数
getWakeup
getWakeup({uri:ret},callback(ret, err))
callback(ret, err)
ret:
- 类型:JSON对象
- 内部字段:
{
channelCode: '渠道编号',//渠道编号
data: '唤醒携带的参数' //有携带参数,则返回数据,没有则为空
}
示例代码
var openinstall = api.require('openinstall');
api.addEventListener({
name: 'appintent'
}, function(ret, err) {
openinstall.getWakeup({
"uri": ret
}, function(ret, err) {
alert(JSON.stringify(ret));
});
});
补充说明
此接口用于获取动态唤醒参数,通过动态参数,在跳转APP时,获取由web网页中传递过来的,如邀请码、游戏房间号等自定义参数,跳转指定页面
监听appintent事件,调用以上代码,获取web端传过来的自定义参数,并回调给getWakeup方法调用;
可用性
Android系统,iOS系统
可提供的1.0.0及更高版本
3. 携带参数安装高级版功能
getInstall
getInstall({params},callback(ret, err))
params
timeout:
类型:数字类型
描述:超时时长,单位秒(s),默认为10秒
callback(ret, err)
ret:
- 类型:JSON对象
- 内部字段:
{
channelCode: '渠道编号',//渠道编号
data: '个性化安装携带的参数'
}
示例代码
var openinstall = api.require('openinstall');
openinstall.getInstall({
timeout:10
},function(ret, err){
alert(JSON.stringify(ret));
});
补充说明
此接口用于获取动态安装参数(可重复获取),测试时候建议卸载再安装正确获取参数,在APP需要个性化安装参数时(由web网页中传递过来的,如邀请码、游戏房间号等自定义参数),在回调中获取参数,可实现跳转指定页面、统计渠道数据等
可用性
Android系统,iOS系统
可提供的1.0.0及更高版本
4. 渠道统计高级版功能
SDK 会自动完成访问量、点击量、安装量、活跃量、留存率等统计工作。
4.1 reportRegister
上报注册量
reportRegister()
示例代码
var openinstall = api.require('openinstall');
openinstall.reportRegister();
补充说明
openinstall 会自动完成安装量、留存率、活跃量、在线时长等渠道统计数据的上报工作,如需统计每个渠道的注册量(对评估渠道质量很重要),可根据自身的业务规则,在确保用户完成app注册的情况下,调用reportRegister()上报注册量。
在openinstall平台即可看到注册量。
可用性
Android系统,iOS系统
可提供的1.0.0及更高版本
4.2reportEffectPoint**
效果点统计
reportEffectPoint({params})
params
effectId:
类型:字符串
描述:效果点ID
effectValue:
类型:数字类型
描述:效果点值,货币以分为单位
示例代码
var openinstall = api.require('openinstall');
openinstall.reportEffectPoint({
effectId:'effect_test',
effectValue:1
});
补充说明
openinstall 调用reportEffectPoint({params})统计自定义效果点。
effectID与effectValue对应的值与openinstall平台的效果点管理的效果点名称与效果点ID必须一一对应。在openinstall平台即可看到渠道管理的渠道效果点。
四、导出apk/ipa包并上传
- 代码集成完毕后,需要导出安装包上传openinstall后台,openinstall会自动完成所有的应用配置工作。
- 上传完成后即可开始在线模拟测试,体验完整的App安装/跳转流程;待测试无误后,再完善下载配置信息。
下面是apk包的上传界面(后台截图):