Flutter Firebase分段分析插件segment_analytics_plugin_firebase的使用

DestinationPlugin 用于 Firebase。它封装了 firebase_analytics。

安装

手动将此软件包添加到您的 pubspec.yaml 文件中。

dependencies:
  segment_analytics_plugin_firebase:
    git:
      url: https://github.com/segmentio/analytics_flutter
      ref: main
      path: packages/plugins/plugin_firebase

然后，您需要根据核心 Firebase 文档配置 Firebase 设置，通过运行以下命令：

flutterfire configure

这将在您的 lib 文件夹下创建一个 firebase_options.dart 文件。

使用

在主 Analytics 客户端中添加插件时，请遵循说明：

在初始化 Analytics 客户端的代码中，调用 .add(plugin) 方法并传入一个 FirebaseDestination 实例。

import 'firebase_options.dart';
import 'package:segment_analytics/client.dart';
import 'package:segment_analytics_plugin_firebase/plugin_firebase.dart' show FirebaseDestination;

const writeKey = 'SEGMENT_API_KEY';

class _MyAppState extends State<MyApp> {
  final analytics = createClient(Configuration(writeKey));

  [@override](/user/override)
  void initState() {
    // 初始化 Analytics 客户端
    super.initState();

    // 添加 Firebase 插件
    analytics.addPlugin(FirebaseDestination(DefaultFirebaseOptions.currentPlatform));
  }
}

支持

请使用 Github issues、Pull Requests 或随时联系我们的支持团队。

与 Segment 集成

有兴趣将您的服务与我们集成吗？请查看我们的合作伙伴页面以获取更多详细信息。

许可证

MIT License

Copyright (c) 2023 Segment

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

### 完整示例 Demo

以下是一个完整的 Flutter 应用程序示例，演示如何使用 `segment_analytics_plugin_firebase` 插件。

```dart
import 'package:flutter/material.dart';
import 'firebase_options.dart';
import 'package:segment_analytics/client.dart';
import 'package:segment_analytics_plugin_firebase/plugin_firebase.dart' show FirebaseDestination;

void main() => runApp(MyApp());

class MyApp extends StatefulWidget {
  [@override](/user/override)
  _MyAppState createState() => _MyAppState();
}

class _MyAppState extends State<MyApp> {
  final analytics = createClient(Configuration('SEGMENT_API_KEY'));

  [@override](/user/override)
  void initState() {
    super.initState();

    // 添加 Firebase 插件
    analytics.addPlugin(FirebaseDestination(DefaultFirebaseOptions.currentPlatform));
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: Text('Flutter Firebase 分析'),
        ),
        body: Center(
          child: ElevatedButton(
            onPressed: () {
              // 发送事件到 Firebase
              analytics.track('Button Clicked', properties: {'button': 'elevated'});
            },
            child: Text('点击发送事件'),
          ),
        ),
      ),
    );
  }
}

在这个示例中，当用户点击按钮时，会触发一个名为 Button Clicked 的事件，并附带一些属性（例如按钮类型）。这样，您就可以使用 Firebase 来跟踪这些事件。