cordova-plugin-xinstall

Xinstall 为了方便Cordova开发同学接入SDK的封装SDK

前期准备

在Xinstall官网注册自己的账号
创建应用，获得需要使用的appKey 和 scheme

【注】scheme 只有android 使用到，iOS使用的是universal link

安装插件

执行下列命令安装并配置xinstall插件

cordova plugin add cordova-plugin-xinstall --variable XINSTALL_APPKEY={AppKey} --variable XINSTALL_SCHEME={Scheme}

客户端配置

1. Android

Android 不需要任何配置

2. iOS

在xxx-Info.plist 文件中需要添加

<key>com.xinstall.APP_KEY</key>
<string>{appKey}</string>

调用API

1.快速下载

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

2. 一键拉起

拉起参数获取

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

window.xinstall.registerWakeUpHandler(function(data) {
       // 对data进行处理
}, function(msg){
       console.log("xinstall.wakeup error : " + msg)
});

Xinstall 通过 Scheme(iOS < 9) 和 universal link（iOS≥9） ,在app已安装的情况下，从各种浏览器（包括微信、QQ、新浪微博、钉钉等主流社交软件的内置浏览器）拉起app并传递动态参数，避免重复安装。

2.1 通用链接集成（Universal Link)

首先，我们需要到苹果开发者网站，为当前的 App ID 开启关联域名 (Associated Domains) 服务：

为刚才开发关联域名功能的 App ID 创建新的（或更新现有的）描述文件，下载并导入到Xcode中(通过xcode自动生成的描述文件，可跳过这一步)：

在Xcode中配置Xinstall为当前应用生成的关联域名 (Associated Domains) ：applinks:xxxx.xinstall.top 和 applinks:xxxx.xinstall.net

具体的关联域名可在 Xinstall管理后台 - 对应的应用控制台 - iOS下载配置页面中找到

2.2 集成Scheme

此方法为XinstallSDK 1.2.2最新添加的方法，如果使用报错，请先更新SDK 更多问题见iOS常见问题

2.2.1 在Xcode选中Target -> Info -> URL Types,配置Xinstall 为当前应用生成的 Scheme,如图所示：

图中4中的值为实例值，具体为xi+appkey格式，如xi4z9yxu8，您也可以在iOS集成-功能集成-一键拉起的文档中找到您对应的Scheme值

3. 携带参数安装

window.xinstall.getInstallParams(function(data) {
        //对安装data进行处理
}, function(msg){
        console.log('xinstall.getInstall error: ' + msg);
}, 15);

【注】过期时间只有androidSDK 提供，后期肯能会去除。

成功回调的data数据为

{"channelCode":"渠道号","timeSpan":"获取数据间隔时间","data":{"uo":"{\"testkey\":\"1111\"}","co":""}}
// uo 为页面参事
// co 为点击参数

4. 渠道统计相关

4.1 注册量统计

window.xinstall.reportRegister();

4.2 渠道效果统计

window.xinstall.reportEffectEvent(eventId, eventVal);

【注】事件需要在Xinstall 后台添加

导出apk/ipa包并上传

参考官网文档

iOS集成-导出ipa包并上传

Android-集成

如何测试功能

参考官方文档测试集成效果

Cordova