Skip to content

Latest commit

 

History

History
253 lines (211 loc) · 9.54 KB

README.md

File metadata and controls

253 lines (211 loc) · 9.54 KB
Raw

=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-

⚠️ ⚠️ We are no longer mantaining this library. Feel free to fork it and work on your own branch. ⚠️ ⚠️

=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-

Segment plugin

Pub Version style: lint

This library was created by our friends at claimsforce-gmbh to whom we are deeply grateful for letting us contribute. From now this project will be maintained from this repository.

Flutter plugin to support iOS, Android and Web sources at https://segment.com.

Future development

We want to prepare flutter-segment for the future! Please have a look at this issue and let us know what you think.

Usage

To use this plugin, add flutter_segment as a dependency in your pubspec.yaml file.

Important note for iOS usage

Since version 3.5.0 we are forcing all users to use use_frameworks! within the Podfile due to import issues of some 3rd party dependencies.

Supported methods

Method Android iOS Web MacOS Windows Linux
identify X X X
track X X X
screen X X X
group X X X
alias X X X
getAnonymousId X X X
reset X X X
disable X X
enable X X
flush X X
debug X* X X
setContext X X

* Debugging must be set as a configuration parameter in AndroidManifest.xml (see below). The official segment library does not offer the debug method for Android.

Example

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

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

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    Segment.screen(
      screenName: 'Example Screen',
    );
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: Text('Segment example app'),
        ),
        body: Center(
          child: FlatButton(
            child: Text('TRACK ACTION WITH SEGMENT'),
            onPressed: () {
              Segment.track(
                eventName: 'ButtonClicked',
                properties: {
                  'foo': 'bar',
                  'number': 1337,
                  'clicked': true,
                },
              );
            },
          ),
        ),
      ),
      navigatorObservers: [
        SegmentObserver(),
      ],
    );
  }
}

Migration from v2.x to v3.x

In v3.x we removed branch io integration as the package is in the the maintenance mode and uses outdated dependencies. If you don't use ENABLE_BRANCH_IO_INTEGRATION you are good to go. If you want to continue using ENABLE_BRANCH_IO_INTEGRATION then use v2.x of this package.

Installation

Setup your Android, iOS and/or web sources as described at Segment.com and generate your write keys.

Set your Segment write key and change the automatic event tracking (only for Android and iOS) on if you wish the library to take care of it for you. Remember that the application lifecycle events won't have any special context set for you by the time it is initialized.

Via Dart Code

void main() {
  /// Wait until the platform channel is properly initialized so we can call
  /// `setContext` during the app initialization.
  WidgetsFlutterBinding.ensureInitialized();
  
  String writeKey;
  if(Platform.isAndroid){
    writeKey = "ANDROID_WRITE_KEY";
  } else{ //iOS
      writeKey = "IOS_WRITE_KEY";
  }

  Segment.config(
    options: SegmentConfig(
      writeKey: 'YOUR_WRITE_KEY_GOES_HERE',
      trackApplicationLifecycleEvents: false,
      amplitudeIntegrationEnabled: false,
      debug: false,
    ),
  );
}

Android (Deprecated*)

<manifest xmlns:android="http://schemas.android.com/apk/res/android" package="com.example.flutter_segment_example">
    <application>
        <activity>
            [...]
        </activity>
        <meta-data android:name="com.claimsforce.segment.WRITE_KEY" android:value="YOUR_WRITE_KEY_GOES_HERE" />
        <meta-data android:name="com.claimsforce.segment.TRACK_APPLICATION_LIFECYCLE_EVENTS" android:value="false" />
        <meta-data android:name="com.claimsforce.segment.ENABLE_AMPLITUDE_INTEGRATION" android:value="false" />
        <meta-data android:name="com.claimsforce.segment.DEBUG" android:value="false" />
    </application>
</manifest>

iOS (Deprecated*)

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
  [...]
  <key>com.claimsforce.segment.WRITE_KEY</key>
  <string>YOUR_WRITE_KEY_GOES_HERE</string>
  <key>com.claimsforce.segment.TRACK_APPLICATION_LIFECYCLE_EVENTS</key>
  <false/>
  <key>com.claimsforce.segment.ENABLE_AMPLITUDE_INTEGRATION</key>
  <false/>
  [...]
</dict>
</plist>

Web

<!DOCTYPE html>
<html>
<head>
  [...]
</head>
<body>
<script>
  !function(){ ...;
    analytics.load("YOUR_WRITE_KEY_GOES_HERE");
    analytics.page();
  }}();
</script>
  <script src="main.dart.js" type="application/javascript"></script>
</body>
</html>

For more informations please check: https://segment.com/docs/connections/sources/catalog/libraries/website/javascript/quickstart/

Sending device tokens strings for push notifications

Segment integrates with 3rd parties that allow sending push notifications. In order to do that you will need to provide it with the device token string - which can be obtained using one of the several Flutter libraries.

As soon as you obtain the device token string, you need to add it to Segment's context by calling setContext and then emit a tracking event named Application Opened or Application Installed. The tracking event is needed because it is the only moment when Segment propagates it to 3rd parties.

Both calls (setContext and track) can be done sequentially at startup time, given that the token exists. Nonetheless, if you don't want to delay the token propagation and don't mind having an extra Application Opened event in the middle of your app's events, it can be done right away when the token is acquired.

await Segment.setContext({
  'device': {
    'token': yourTokenString
  },
});

// the token is only propagated when one of two events are called:
// - Application Installed
// - Application Opened
await Segment.track(eventName: 'Application Opened');

A few important points:

  • The token is propagated as-is to Segment through the context field, without any manipulation or intermediate calls to Segment's libraries. Strucutred data - such as APNs - need to be properly converted to its string representation beforehand
  • On iOS, once the device.token is set, calling setContext({}) will not clean up its value. This occurs due to the existence of another method from segment's library that sets the device token for Apple Push Notification service (APNs )
  • setContext always overrides any previous values that were set in a previous call to setContext
  • setContext is not persisted after the application is closed

Setting integration options

If you intend to use any specific integrations with third parties, such as custom Session IDs for Amplitude, you'll need to set it using options for each call, or globally when the application was started.

Setting the options in every call

The methods below support options as parameters:

  • identify({@required userId, Map<String, dynamic> traits, Map<String, dynamic> options})
  • track({@required String eventName, Map<String, dynamic> properties, Map<String, dynamic> options})
  • screen({@required String screenName, Map<String, dynamic> properties, Map<String, dynamic> options})
  • group({@required String groupId, Map<String, dynamic> traits, Map<String, dynamic> options})
  • alias({@required String alias, Map<String, dynamic> options})

An example of a screen being tracked as part of a session, which will be communicated to Amplitude:

Segment.screen(
  screenName: screenName,
  properties: {},
  options: {
    'integrations': {
      'Amplitude': {'session_id': '1578083527'}
    }
  },
)

Setting the options globally

You can also set the default options to be used in every method call, if the call omits the options parameter. Just set SegmentDefaultOptions.instance.options. For example:

SegmentDefaultOptions.instance.options = {
  'integrations': {
    'Amplitude': {
      'session_id': '1578083527'
    }
  }
}

Issues

Please file any issues, bugs, or feature requests in the GitHub repo.

Contributing

If you wish to contribute a change to this repo, please send a pull request.

*This installation method will be removed, please use the Installation via Dart Code instructions.