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平台申请开发者账号并创建应用,获取AppKey、scheme和Associated Domains

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

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相关配置(支持iOS9.0以后)

  • 开启关联域名(Associated Domains)服务并配置Xcode

1)到苹果开发者网站,为当前的 AppID 开启关联域名(Associated Domains)服务:

2)创建新的(或更新现有的)描述文件,下载并导入到Xcode中(通过Xcode自动生成的描述文件,可跳过这一步):

3)在 Xcode 中配置 openinstall 为当前应用生成的关联域名(Associated Domains)(openinstall应用控制台->iOS集成->iOS应用配置->关联域名(Associated Domains)):

  • 通用链接相关代码
    注意:插件版本>=1.3.1开始,iOS通用链接原生代码已在插件内部完成,如遇到跳转问题,详细可参考文档github flutter文档
3. scheme 配置

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

注意:插件版本>=1.3.1开始,scheme原生代码已在插件内部完成,如遇到跳转问题,可参考文档github flutter文档

三、使用指南

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

四、导出apk/ipa包并上传

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

下面是apk包的上传界面(后台截图):

上传安装包

五、广告平台接入补充文档

Android平台

广告平台配置

针对广告平台接入,新增配置接口,在调用init之前调用。参考广告平台对接Android集成指引

    /**
    * adEnabled 为 true 表示 openinstall 需要获取广告追踪相关参数,默认为 false
    * oaid 为 null 时,表示交由 openinstall 获取 oaid, 默认为 null
    * gaid 为 null 时,表示交由 openinstall 获取 gaid, 默认为 null
    */
    _openinstallFlutterPlugin.config(true, "通过移动安全联盟获取到的 oaid", "通过 google api 获取到的 advertisingId");

例如: 开发者自己获取到了 oaid,但是需要 openinstall 获取 gaid,则调用代码为

    // f32a09dc-3312-d43e-6583-62fac13f33ae 是通过移动安全联盟获取到的 oaid
    _openinstallFlutterPlugin.config(true, "f32a09dc-3312-d43e-6583-62fac13f33ae", null);

设备唯一标识码获取

针对广告平台,为了精准地匹配到渠道,需要获取设备唯一标识码(IMEI),因此需要做额外的权限申请。
1、声明权限
AndroidMainfest.xml配置文件中添加了需要申请的权限<uses-permission android:name="android.permission.READ_PHONE_STATE"/>

2、申请权限并初始化
可使用插件提供的 api 进行权限申请,调用初始化 api,第二个参数permission=true表示插件进行权限申请

_openinstallFlutterPlugin.init(wakeupHandler, true);

也可在Flutter自行进行权限申请,只需要确保在初始化之前申请权限,例如

// 使用 permission_handler
if (await Permission.phone.request().isGranted) {
  // 获取到了权限
}
_openinstallFlutterPlugin.init(wakeupHandler);

iOS平台

1、将ios/Classes/OpeninstallFlutterPlugin.m文件替换为example/ad-track/OpeninstallFlutterPlugin.m文件

2、需要在Info.plist文件中配置权限

<key>NSUserTrackingUsageDescription</key>
<string>请允许,以获取和使用您的IDFA</string>

备注:2021年iOS14.5苹果公司将正式启用idfa新隐私政策,详情可参考:广告平台对接iOS集成指引