Cordova 接入指引

如何在 capacity 中使用

一、安装插件

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

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

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

注：使用openinstall第三方插件文档集成时，如何快速获取AppKey、Associated Domains和scheme，下图为iOS相关配置信息（Android同理）：

二、相关配置

iOS配置Universal Links（适用于iOS9.0以后）

1）到苹果开发者网站，为当前的 AppID 开启关联域名（Associated Domains）服务：

associatedDev

2）在 Xcode 中配置 openinstall 为当前应用生成的关联域名（Associated Domains）（openinstall应用控制台 -> iOS集成 -> iOS应用配置 -> 关联域名（Associated Domains））：

三、调用API

1. 快速下载

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

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)
});

3. App传参安装高级版功能

获取安装参数

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": "自定义数据"}

4. 渠道统计高级版功能

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

4.1 注册量统计

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

window.openinstall.reportRegister();

4.2 渠道效果统计

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

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

效果点管理

调用接口时，请保证代码中的效果点ID与后台创建的效果点ID一致

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

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

四、导出apk/ipa包并上传

  • 代码集成完毕后，需要导出安装包上传openinstall后台，openinstall会自动完成所有的应用配置工作。
  • 上传完成后即可开始在线模拟测试，体验完整的App安装/拉起流程；待测试无误后，再完善下载配置信息。

下面是apk包的上传界面（后台截图）：

上传安装包

如何在 capacitor 中使用

1.安装插件

npm install cordova-plugin-openinstall

2.同步到原生平台

npx cap sync

3.手动修改：

3.1 Android平台

1）修改 capacitor-cordova-android-plugins module 下的 AndroidManifest.xml 文件，将

<meta-data
   android:name="com.openinstall.APP_KEY"
   android:value="$OPENINSTALL_APPKEY"/>

中的$OPENINSTALL_APPKEY修改为 openinstall 为应用分配的 appkey

2）修改 app module 下的AndroidManifest.xml文件，将

<intent-filter>
   <action android:name="android.intent.action.VIEW" />
   <category android:name="android.intent.category.DEFAULT" />
   <category android:name="android.intent.category.BROWSABLE" />
   <data android:scheme="@string/custom_url_scheme" />
</intent-filter>

的@string/custom_url_scheme修改为 openinstall 为应用分配的 scheme 或者新增配置

<intent-filter>
   <action android:name="android.intent.action.VIEW" />
   <category android:name="android.intent.category.DEFAULT" />
   <category android:name="android.intent.category.BROWSABLE" />
   <data android:scheme="openinstall为应用分配的appkey" />
</intent-filter>

3.2 iOS平台

1）找到Info.plist文件，添加appkey

    <key>com.openinstall.APP_KEY</key>
    <string>“从openinstall官网后台获取应用的appkey”</string>

2）找到Info.plist文件，添加scheme

    <key>CFBundleURLTypes</key>
    <array>
        <dict>
        <key>CFBundleTypeRole</key>
        <string>Editor</string>
        <key>CFBundleURLName</key>
        <string>openinstall</string>
        <key>CFBundleURLSchemes</key>
        <array>
            <string>"从openinstall官网后台获取应用的scheme"</string>
        </array>
        </dict>
    </array>