Flutter接入指引

一、安装

1. 添加依赖

在项目的pubspec.yaml文件中添加以下内容:

dependencies:
  openinstall_flutter_plugin: ^1.0.0

2. 安装插件

使用命令行获取

$ flutter pub get

或者使用开发工具的flutter pub get

3. 导入

Dart代码中使用以下代码导入:

import 'package:openinstall_flutter_plugin/openinstall_flutter_plugin.dart';

二、配置

请先从openinstall平台申请开发者账号并创建应用,获取AppKeyscheme

Android 平台配置

1. 配置appkey

/android/app/build.gradle中添加下列代码:

android: {
  ....
  defaultConfig {
    ...
    manifestPlaceholders = [
        OPENINSTALL_APPKEY : "openinstall为应用分配的appkey",
    ]
  }    
}

2. 配置 scheme

修改/android/app/src/main/AndroidMenifest.xml文件,在activity标签内添加intent-filter(一般为MainActivity)

<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为应用分配的scheme"/>
</intent-filter>

iOS 平台配置

1. 配置appkey

在Flutter工程下的ios/Runner/Info.plist文件中配置appKey键值对,如下:

<key>com.openinstall.APP_KEY</key>
<string>openinstall 分配给应用的 appkey</string>

以下为 一键拉起 功能相关配置和代码

2. universal links相关配置

  • 开启Associated Domains服务

对于iOS,为确保能正常跳转,AppID必须开启Associated Domains功能,请到苹果开发者网站,选择Certificate, Identifiers & Profiles,选择相应的AppID,开启Associated Domains。注意:当AppID重新编辑过之后,需要更新相应的mobileprovision证书。(图文配置步骤请看iOS集成指南)。

  • 配置universal links关联域名(iOS 9以后推荐使用)

关联域名(Associated Domains) 的值请在openinstall控制台获取(openinstall应用控制台->iOS集成->iOS应用配置)

该文件是给iOS平台配置的文件,在 ios/Runner 目录下创建文件名为 Runner.entitlements 的文件,Runner.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>
  • ios/Runner/AppDelegate.m中添加通用链接(Universal Link)回调方法,委托插件来处理:

在头部引入

#import <openinstall_flutter_plugin/OpeninstallFlutterPlugin.h>

添加如下方法

//添加此方法以获取拉起参数
- (BOOL)application:(UIApplication *)application continueUserActivity:(NSUserActivity *)userActivity restorationHandler:(void (^)(NSArray * _Nullable))restorationHandler{
    //判断是否通过OpenInstall Universal Link 唤起App
    if ([OpeninstallFlutterPlugin continueUserActivity:userActivity]){//如果使用了Universal link ,此方法必写
        return YES;
    }
    //其他第三方回调;
    return YES;
}
3. scheme 配置

ios/Runner/Info.plist文件中,在CFBundleURLTypes数组中添加应用对应的 scheme,或者在工程“TARGETS -> Info -> URL Types” 里快速添加,图文配置请看iOS集成指南

<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>

ios/Runner/AppDelegate.m中头部引入:

#import <openinstall_flutter_plugin/OpeninstallFlutterPlugin.h>

ios/Runner/AppDelegate.m中添加方法:

//适用目前所有iOS版本
-(BOOL)application:(UIApplication *)application openURL:(NSURL *)url sourceApplication:(NSString *)sourceApplication annotation:(id)annotation{
    //判断是否通过OpenInstall URL Scheme 唤起App
    if([OpeninstallFlutterPlugin handLinkURL:url]){//必写
        return YES;
    }
    //其他第三方回调;
    return YES;
}
//iOS9以上,会优先走这个方法
- (BOOL)application:(UIApplication *)app openURL:(NSURL *)url options:(nonnull NSDictionary *)options{
    //判断是否通过OpenInstall URL Scheme 唤起App
    if  ([OpeninstallFlutterPlugin handLinkURL:url]){//必写
        return YES;
    }
    //其他第三方回调;
    return YES;
}

三、使用指南

1. 快速下载和一键拉起

在应用启动时,注册拉起回调。这样当 App 被拉起时,会回调传入的方法,并在回调中获取拉起数据 示例:

Future wakeupHandler(Map<String, dynamic> data) async {
    setState(() {
        debugLog = "wakeup result : channel=" +
            data['channelCode'] +
            ", data=" +
            data['bindData'];
    });
}

_openinstallFlutterPlugin.init(wakeupHandler);

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

获取安装参数
在 APP 需要安装参数时(由 web 网页中传递过来的,如邀请码、游戏房间号等动态参数),调用此接口,在回调中获取参数

示例:


Future installHandler(Map<String, dynamic> data) async {
    setState(() {
        debugLog = "install result : channel=" +
            data['channelCode'] +
            ", data=" +
            data['bindData'];
    });
}

_openinstallFlutterPlugin.install(installHandler);

3. 渠道统计高级版功能

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

3.1 注册统计

如需统计每个渠道的注册量(对评估渠道质量很重要),可根据自身的业务规则,在确保用户完成 APP 注册的情况下调用此接口
示例:

_openinstallFlutterPlugin.reportRegister();

3.2 效果点统计

统计终端用户对某些特殊业务的使用效果,如充值金额,分享次数等等。调用接口前,请先进入 openinstall 管理后台 “效果点管理” 中添加效果点,第一个参数对应管理后台效果点ID

示例:

_openinstallFlutterPlugin.reportEffectPoint("effect_test", 1);