Natural Preference for Minification
Ready to take your JavaScript development to the next level? Meet npm Enterprise - the ultimate in enterprise JavaScript. Learn more »

cordova-plugin-openinstall

1.2.1 • Public • Published

cordova-plugin-openinstall

openinstall 的 cordova 插件

安装插件

注册并创建应用,获取 openinstall 为应用分配的 appkey 和 scheme
(scheme的值详细获取位置:openinstall应用控制台->Android集成->Android应用配置,iOS同理)

使用下列命令安装并配置 openinstall 插件

cordova plugin add cordova-plugin-openinstall --variable OPENINSTALL_APPKEY=[appkey] --variable OPENINSTALL_SCHEME=[scheme]

调用API

1 快速下载

如果只需要快速下载功能,无需其它功能(携带参数安装、渠道统计、一键拉起),完成初始化即可(这里指安装插件)

2 一键拉起

拉起参数获取

调用以下代码注册拉起回调,应尽早调用。如在 deviceready 事件回调之时注册

window.openinstall.registerWakeUpHandler(function(data){
  console.log("openinstall.wakeup success : channel=" + data.channel + ", data=" + data.data);
}, function(msg){
  console.log("openinstall.wakeup error : " + msg)
});

注意:对于 iOS,iOS9.0以后建议使用通用链接(Universal links)实现一键唤醒,为确保能正常跳转,AppID 必须开启 Associated Domains 功能,请到苹果开发者网站,选择 Certificate, Identifiers & Profiles,选择相应的 AppID,开启 Associated Domains。注意:当 AppID 重新编辑过之后,需要更新相应的 mobileprovision 证书。(图文步骤请参考iOS集成指南)

  • 在左侧导航器中点击您的项目
  • 选择'Capabilities'标签
  • 打开'Associated Domains'开关
  • 添加openinstall官网后台中应用对应的关联域名(openinstall应用控制台->iOS集成->iOS应用配置->关联域名(Associated Domains))

3 携带参数安装 (高级版功能)

获取安装参数
window.openinstall.getInstall(function(data){
    console.log('openinstall.getInstall success: ' + data);
}, function(msg){
    console.log('openinstall.getInstall error: ' + msg);
});

也可传入一个整形数值,单位秒,指定时间未返回将超时

window.openinstall.getInstall(function(data){
    console.log('openinstall.getInstall success: ' + data);
}, function(msg){
    console.log('openinstall.getInstall error: ' + msg);
}, 10);

成功回调的data数据格式

{"channel": "渠道号", "data": {"自定义key": "自定义value"}}

4 渠道统计 (高级版功能)

SDK 会自动完成访问量、点击量、安装量、活跃量、留存率等统计工作。

4.1 注册量统计

如需统计每个渠道的注册量(对评估渠道质量很重要),可根据自身的业务规则,在确保用户完成 app 注册的情况下调用相关api

window.openinstall.reportRegister();
4.2 渠道效果统计

效果点建立在渠道基础之上,主要用来统计终端用户对某些特殊业务的使用效果,如充值金额,分享次数等等。

调用接口前,请先进入管理后台“效果点管理”中添加效果点

window.openinstall.reportEffectPoint("effect_test", 1);

第一个参数为“效果点ID”,字符串类型
第二个参数为“效果点值”,数字类型

调用接口后,可在后台查看效果点统计数据

install

npm i cordova-plugin-openinstall

Downloadsweekly downloads

23

version

1.2.1

license

MIT

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
  • avatar
  • avatar
Report a vulnerability