Flutter数据分析插件piano_analytics_plugin的使用

Flutter数据分析插件piano_analytics_plugin的使用

插件介绍

piano_analytics_plugin 是一个用于集成Piano Analytics SDK的Flutter插件。 Piano Analytics是一个经过20多年开发、由数万客户支持的产品，其用户为中心的设计和价值驱动的数据模型能够整合产品和营销分析，并解决行业面临的数据质量问题。

要阅读开发者文档，请访问 Piano Analytics。

请注意：此插件仍在开发中，部分API可能尚未可用。欢迎提供反馈和提交Pull Requests！

版本信息

不同的版本可以在 CHANGELOG.md 文件中找到。

移动端支持

• iOS: iOS插件
• Android: Android插件

使用方法

要在项目中使用此插件，请在 pubspec.yaml 文件中添加 piano_analytics_plugin 作为依赖项。

设置配置

此函数用于设置Piano Analytics配置。

Future<void> setConfiguration({required String collectDomain, required int site, String? privacyDefaultMode, String? visitorId});

有关配置的详细文档，请参阅 配置文档。

发送事件

此函数用于发送事件。

Future<void> sendEvent({required String eventName, required Map<String, dynamic> data});

示例代码

以下是使用 piano_analytics_plugin 的示例代码：

import 'package:flutter/material.dart';
import 'package:piano_analytics_plugin/piano_analytics_configuration_modes.dart';
import 'package:piano_analytics_plugin/piano_analytics_plugin.dart';

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

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

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

class _MyAppState extends State<MyApp> {
  final pianoAnalyticsPlugin = PianoAnalyticsPlugin();

  final String domaine = "YOUR_DOMAIN";
  final int site = 123456;

  final String eventName = "click.action";
  final Map<String, String> fakeData = {
    "click": "Click event",
    "status": "connected",
    "others_data": "N/A",
  };

  [@override](/user/override)
  void initState() {
    super.initState();
    pianoAnalyticsPlugin.setConfiguration(
      collectDomain: domaine,
      site: site,
      path: "fake_path",
      crashDetection: false,
      customUserAgent: "fake_agent",
      offlineEncryptionMode: OfflineEncryptionMode.force,
      ignoreLimitedAdvertisingTracking: false,
      offlineStorageMode: OfflineStorageMode.always,
      sendEventWhenOptout: false,
      sessionBackgroundDuration: 11,
      storageLifetimePrivacy: 11,
      storageLifetimeUser: 11,
      storageLifetimeVisitor: 11,
      visitorId: "fake_visitor",
      visitorIdTypeMode: VisitorIdTypeMode.advertisingId,
      visitorStorageMode: VisitorStorageMode.relative,
      privacyDefaultMode: PrivacyDefaultMode.exempt,
    );
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: const Text('Piano Analytics'),
        ),
        body: SingleChildScrollView(
          padding: const EdgeInsets.all(12),
          child: Column(
            crossAxisAlignment: CrossAxisAlignment.start,
            mainAxisAlignment: MainAxisAlignment.start,
            children: [
              Text(
                "Configuration : domaine: $domaine, site: $site",
              ),
              const Divider(),
              Text(
                "Event Name : $eventName",
              ),
              const SizedBox(height: 8),
              Text(
                "Data : ${fakeData.toString()}",
              ),
              const SizedBox(height: 11),
              const Divider(),
              Row(
                crossAxisAlignment: CrossAxisAlignment.center,
                mainAxisAlignment: MainAxisAlignment.center,
                children: [
                  MaterialButton(
                    color: Colors.lightBlueAccent,
                    child: const Text("Track event",
                        style: TextStyle(color: Colors.white)),
                    onPressed: () {
                      pianoAnalyticsPlugin
                          .sendEvent(eventName: eventName, data: fakeData)
                          .onError(
                            (error, stackTrace) =&gt; debugPrint(
                              error.toString(),
                            ),
                          );
                    },
                  ),
                ],
              )
            ],
          ),
        ),
      ),
    );
  }
}