Flutter自动化控制插件mbautomation的使用

Flutter自动化控制插件mbautomation的使用

MBAutomation

MBAutomation 是一个插件库，用于从 MBurger 平台创建自动推送通知和内嵌消息。它依赖于 MBMessages 和 MBAudience。通过这个库，你还可以跟踪用户事件和视图。

• MBAutomation 依赖于以下包：
  • mburger
  • mbmessages
  • mbaudience
  • http
  • path
  • path_provider
  • shared_preferences
  • sqflite

安装

你可以通过 pub 安装 MBAudience SDK，将以下内容添加到你的 pubspec.yaml 文件中：

dependencies:
  mbautomation: ^2.0.0

然后在命令行中安装这些包：

$ flutter pub get

初始化

初始化自动化需要将 MBAutomation 作为 MBurger 插件插入。通常与 MBMessages 和 MBAudience 插件一起使用。

MBManager.shared.plugins = [
  MBAutomation(),
  ... other plugins
];

MBAutomation 可以用三个可选参数初始化：

• trackingEnabled: 如果启用了追踪功能。
• eventsTimerTime: 发送事件和视图到 MBurger 的的频率。

触发器

每个来自 MBurger 的的内嵌消息或推送通知都可以有一个触发器数组，这些触发器由 MBAutomation SDK 管理并评估，只有当定义的条件满足时才会显示消息。

触发器可以分为两种方法：

• any: 一旦其中一个触发器变为真，则向用户显示消息。
• all: 所有触发器都需要为真才能显示消息。

以下是自动化 SDK 管理的触发器列表：

• App 开启

  • MBAppOpeningTrigger: 当应用被打开 n 次（times 属性）时变为真，检查在应用启动时。

• 事件

  • MBEventTrigger: 当事件发生 n 次（times 属性）时变为真。

• 无活动用户

  • MBInactiveUserTrigger: 用户在 n 天内没有打开应用时变为真（days 参数）。

• 位置

  • MBLocationTrigger: 用户进入指定经纬度范围内的位置时变为真（latitude、longitude 和 radius）。此触发器可以在延迟 n 天后激活（afterDays 属性）。位置数据来自 MBAudience SDK。

• 标签更改

  • MBTagChangeTrigger: 当 MBAudience SDK 中的标签更改并与值相等或不相等时变为真。它具有 tag 属性（需要检查的标签）和 value 属性（需要等于或不同的值来激活触发器）。

• 视图

  • MBViewTrigger: 用户进入视图 n 次（times 属性）时变为真。如果 secondsOnView 需要用户停留秒数来激活触发器。

发送事件

你可以使用 MBAutomation 发送事件：

MBAutomation.sendEvent('EVENT_NAME');

你可以指定两个可选参数：name（名称，将在 MBurger 控制台中显示）和 metadata（额外字段的映射）。

MBAutomation.sendEvent(
  'purchase',
  name: "PURCHASE",
  metadata: {"quantity": 1},
);

事件保存在本地数据库中，并每 10 秒发送到服务器。你可以通过设置 eventsTimerTime 属性来更改频率。

视图跟踪

为了自动跟踪视图，请将一个实例的 MBAutomationNavigatorObserver 添加到 navigatorObservers 中：

[@override](/user/override)
Widget build(BuildContext context) {
  return MaterialApp(
    navigatorObservers: [MBAutomationNavigatorObserver()],
    home: ...,
  );
}

导航观察者会在每次新路由推入或弹出时将 PageRoute 的名称（route.settings.name）发送给 MBurger。

如果你不想使用导航观察者，可以手动使用此函数来跟踪视图：

MBAutomation.trackScreenView('VIEW');

就像事件一样，视图保存在本地数据库中，并每 10 秒发送到服务器。你可以通过设置 eventsTimerTime 属性来更改频率。

示例代码

下面是一个完整的示例代码，展示了如何使用 MBAutomation 进行自动化控制：

import 'package:flutter/material.dart';

import 'package:mbautomation/mbautomation.dart';
import 'package:mburger/mburger.dart';
import 'package:mbaudience/mbaudience.dart';
import 'package:mbmessages/mbmessages.dart';

void main() {
  runApp(const MyApp());
}

class MyApp extends StatefulWidget {
  const MyApp({Key? key}) : super(key: key);

  [@override](/user/override)
  State<MyApp> createState() => _MyAppState();
}

class _MyAppState extends State<MyApp> {
  [@override](/user/override)
  void initState() {
    MBManager.shared.apiToken = 'YOUR_API_TOKEN';
    MBManager.shared.plugins = [
      MBAutomation(),
      MBAudience(),
      MBMessages(
        onButtonPressed: (button) {
          debugPrint(button.toString());
        },
      ),
    ];

    _configurePushNotifications();

    super.initState();
  }

  Future<void> _configurePushNotifications() async {
    MBMessages.pushToken = 'YOUR_PUSH_API_KEY';
    MBMessages.onToken = (token) async {
      debugPrint("Token received $token");
      await MBMessages.registerDevice(token).catchError(
        (error) =&gt; debugPrint(error),
      );
      await MBMessages.registerToTopics(
        [
          await MBMessages.projectPushTopic(),
          await MBMessages.devicePushTopic(),
          const MPTopic(code: 'Topic'),
        ],
      ).catchError(
        (error) =&gt; debugPrint(error),
      );
      debugPrint('Registered');
    };

    MBMessages.configurePush(
      onNotificationArrival: (notification) {
        debugPrint("Notification arrived: $notification");
      },
      onNotificationTap: (notification) {
        debugPrint("Notification tapped: $notification");
      },
      androidNotificationsSettings: const MPAndroidNotificationsSettings(
        channelId: 'mpush_example',
        channelName: 'mpush',
        channelDescription: 'mpush',
        icon: '@mipmap/icon_notif',
      ),
    );

    MBMessages.requestToken();

    Map&lt;String, dynamic&gt;? launchNotification =
        await MBMessages.launchNotification();
    debugPrint(launchNotification?.toString());
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      navigatorObservers: [MBAutomationNavigatorObserver()],
      home: MBMessagesBuilder(
        child: Scaffold(
          appBar: AppBar(
            title: const Text('MBAutomation example app'),
          ),
          body: Center(
            child: TextButton(
              child: const Text('Send Event'),
              onPressed: () =&gt; _sendEvent(),
            ),
          ),
        ),
      ),
    );
  }

  void _sendEvent() {
    MBAutomation.sendEvent('EVENT_NAME');
  }
}