Flutter数据分析插件your_analytics的使用

Your Analytics - Flutter Client SDK 是一个用于使用 Your Analytics API 的 Flutter 插件。

功能特性

跟踪功能：

• trackVisit: 自动由客户端 SDK 处理。
• trackPageView
• trackEvent
• trackRevenue
• setPreferences

分析功能：

• 用户获取：每日数据、新增用户等。
• 参与度：事件细分、事件漏斗等。
• 收入：收入漏斗等。

示例代码

示例代码可以在 /example 文件夹中找到。

使用步骤

1. 安装SDK

在项目的 pubspec.yaml 文件中添加插件：

$ flutter pub add your_analytics

2. 配置Your Analytics后端

在初始化 SDK 之前，您需要配置 Your Analytics 后端的 URL：

serverUrl: 您的 Your Analytics 管理员 URL，例如：http://localhost:3000/
apiServerUrl: 您的 Your Analytics 后端 URL，例如：http://localhost:3000/api/v1

3. 初始化SDK

在 main.dart 文件中初始化 SDK：

import 'package:your_analytics/your_analytics.dart';

Future<void> main() async {
  YourAnalytics analytics = YourAnalytics.instance;
  analytics.initialize(YourAnalyticsOptions(
    appId: '', // 替换为您的应用 ID
    baseUrl: 'http://localhost:3000/api/v1', // 替换为您的 API 基础 URL
    accessToken: null, // 如果需要用户认证，设置为您的访问令牌；否则设为 null
    allowStorage: true, // 是否允许存储数据
  ));

  runApp(const MyApp());
}

使用方法

1. 跟踪页面视图

await analytics.trackPageView(screenName: 'Home');

2. 跟踪事件

await analytics.trackEvent(
  category: 'Default',
  action: 'View Product',
  label: product.name,
  value: 0,
  details: {}, // 可选的附加信息
);

3. 跟踪收入

await analytics.trackRevenue(
  category: 'Default',
  product: 'Product A',
  value: 9.9,
  details: {}, // 可选的附加信息
);

4. 设置用户偏好

await analytics.setPreferences(
  gender: 'Men',
  ageRange: '21-29',
  interests: ['Food', 'Music'],
  others: {}, // 其他可选信息
);

5. 更新存储权限

await analytics.update(
  allowStorage: true, // 是否允许存储数据
);

完整示例代码

以下是一个完整的示例代码，展示了如何在 Flutter 应用中使用 your_analytics 插件：

import 'package:flutter/material.dart';
import 'package:your_analytics/your_analytics.dart';

Future<void> main() async {
  YourAnalytics analytics = YourAnalytics.instance;
  analytics.initialize(YourAnalyticsOptions(
    appId: '', // 替换为您的应用 ID
    baseUrl: 'http://localhost:3000/api/v1', // 替换为您的 API 基础 URL
    accessToken: null, // 如果需要用户认证，设置为您的访问令牌；否则设为 null
    allowStorage: true, // 是否允许存储数据
  ));

  runApp(const MyApp());
}

class MyApp extends StatelessWidget {
  const MyApp({super.key});

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Flutter Demo',
      theme: ThemeData(
        colorScheme: ColorScheme.fromSeed(seedColor: Colors.deepPurple),
        useMaterial3: true,
      ),
      home: const MyHomePage(title: 'Your Analytics Demo page'),
    );
  }
}

class MyHomePage extends StatefulWidget {
  const MyHomePage({super.key, required this.title});

  final String title;

  [@override](/user/override)
  State<MyHomePage> createState() => _MyHomePageState();
}

class _MyHomePageState extends State<MyHomePage> {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text(widget.title),
      ),
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          crossAxisAlignment: CrossAxisAlignment.start,
          children: [
            TextButton(
              child: const Text("Track PageView", style: TextStyle(fontSize: 20)),
              onPressed: () => trackPageView(),
            ),
            TextButton(
              child: const Text("Track Event", style: TextStyle(fontSize: 20)),
              onPressed: () => trackEvent(),
            ),
            TextButton(
              child: const Text("Track Revenue", style: TextStyle(fontSize: 20)),
              onPressed: () => trackRevenue(),
            ),
            TextButton(
              child: const Text("Set Preferences", style: TextStyle(fontSize: 20)),
              onPressed: () => setPreferences(),
            ),
            TextButton(
              child: const Text("Update allowStorage", style: TextStyle(fontSize: 20)),
              onPressed: () => update(),
            ),
          ],
        ),
      ),
    );
  }

  trackPageView() async {
    YourAnalytics analytics = YourAnalytics.instance;
    await analytics.trackPageView(screenName: 'Home');
    print('Page View tracked successfully.');
  }

  trackEvent() async {
    YourAnalytics analytics = YourAnalytics.instance;
    await analytics.trackEvent(
      category: 'Default',
      action: 'View Product',
      label: 'Product A',
      value: 0,
      details: {},
    );
    print('Event tracked successfully.');
  }

  trackRevenue() async {
    YourAnalytics analytics = YourAnalytics.instance;
    await analytics.trackRevenue(
      category: 'Default',
      product: 'Product A',
      value: 9.9,
      details: {},
    );
    print('Revenue tracked successfully.');
  }

  setPreferences() async {
    YourAnalytics analytics = YourAnalytics.instance;
    await analytics.setPreferences(
      gender: 'Men',
      ageRange: '21-29',
      interests: ['Food', 'Music'],
      others: {},
    );
    print('Preferences set successfully.');
  }

  update() async {
    YourAnalytics analytics = YourAnalytics.instance;
    await analytics.update(allowStorage: true);
    print('Allow storage updated successfully.');
  }
}