uni-app 接入指引

插件介绍

此插件是 openinstall 为了方便 uni-app 集成使用 openinstall 功能而开发的,实现了携带参数安装,渠道统计,一键拉起全部功能。

openinstall可帮助 Android/iOS 开发者精确的获取 App 每一次安装来源;在 App 安装或拉起后,直达指定场景,大大提高用户转化率和留存率。同时,openinstall 在精准的 app 安装来源跟踪的技术上,开发了免打包,跨平台的渠道统计功能,轻松创建与管理成千上万的渠道,实现线上线下全渠道覆盖。openinstall 统计数据完全独立于第三方平台,提供多维度的统计报表,实时客观地反映渠道效果。

使用前准备

前往openinstall 官网,注册账户,登录管理控制台,创建应用后,跳过 "集成指引",在 "应用集成" 的对应平台的 "应用配置" 中获取appkeyscheme以及 iOS 的关联域名。

一、配置

1. 配置appkey

在 mainfest.json 的App原生插件配置的 openinstall 插件配置框内配置openinstall分配给应用的AppKey

2. 配置scheme

在 mainfest.json 的App常用其它配置中配置openinstall分配给应用的scheme

3. 配置universal links(iOS平台)

1)HBuilderX2.3.0开始云端打包支持配置XCode中的Capabilities参考文档
在HBuilderX中的manifest.json中配置域名:
在"plus" -> "distribute" -> "apple" -> "capabilities" -> "entitlements"节点(uni-app项目在"app-plus" -> "distribute" -> "ios" -> "capabilities" -> "entitlements")下添加"com.apple.developer.associated-domains"字段,字段值为字符串数组,每个字符串为要关联的域名

    "capabilities": {  
        "entitlements": {  
            "com.apple.developer.associated-domains": [  
                "openinstall分配给应用的关联域名"  
            ]  
        }  
    }

2)HBuilderX2.3.0之前,需将插件下载到本地修改package.json中内容

"entitlements": {
    "com.apple.developer.associated-domains": [
        "openinstall为应用生成的关联域名"
    ]
}

然后再提交云端打包
参考本地uni-app原生插件提交云端打包

二、使用教程

1. 快速下载

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

以下功能需引用 openinstall-plugin 插件

const openinstall = uni.requireNativePlugin('openinstall-plugin');

2. 一键拉起

获取拉起数据

registerWakeUp(callback)

  • callback: 数据回调函数

示例:
App.vueonLaunch方法中注册拉起回调

openinstall.registerWakeUp(function(result){
    console.log('getWakeup : channel=' + result.channelCode + ', data=' + result.bindData);
});

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

获取安装数据
getInstall(seconds, callback)

  • seconds: 回调超时时间
  • callback: 数据回调函数

示例:

openinstall.getInstall(
    8,
    function(result) {
        console.log('getInstall : channel=' + result.channelCode + ', data=' + result.bindData);
    }
);

4. 渠道统计高级版功能

SDK 会自动完成访问量、点击量、安装量、活跃量、留存率等统计工作。其它业务相关统计由开发人员使用 api 上报

4.1 注册统计
示例:

openinstall.reportRegister();

4.2 效果点统计
reportEffectPoint(effectPointId, effectPointValue)

  • effectPointId: 效果点ID
  • effectPointValue: 效果点值,数值类型

示例:

openinstall.reportEffectPoint("effect_test", 1);