Clone this repo:
  1. 8a8a089 Merge pull request #115 from dart-lang/2.0_constraint by Devon Carew · 5 weeks ago master
  2. 3b24121 use the new 2.0 constraint by Devon Carew · 5 weeks ago 2.0_constraint
  3. 5d5a215 Merge pull request #114 from dart-lang/add_close_method by Devon Carew · 7 weeks ago 3.3.0
  4. 71152b4 add a close method; prep for publishing 3.3.0 by Devon Carew · 7 weeks ago add_close_method
  5. 5326e44 Update readme.md by Devon Carew · 7 weeks ago

usage

usage is a wrapper around Google Analytics for command-line, web, and Flutter apps.

pub package Build Status Coverage Status

For web apps

To use this library as a web app, import the usage_html.dart library and instantiate the AnalyticsHtml class.

When you are creating a new property at google analytics make sure to select the mobile app option, not the website option.

For Flutter apps

Flutter applications can use the AnalyticsIO version of this library. They will need to specify the documents directory in the constructor in order to tell the library where to save the analytics preferences:

import 'package:flutter/services.dart';
import 'package:usage/usage_io.dart';

void main() {
  final String UA = ...;

  Analytics ga = new AnalyticsIO(UA, 'ga_test', '3.0',
    documentsDirectory: PathProvider.getApplicationDocumentsDirectory());
  ...
}

For command-line apps

To use this library as a command-line app, import the usage_io.dart library and instantiate the AnalyticsIO class.

Note, for CLI apps, the usage library will send analytics pings asynchronously. This is useful it that it doesn‘t block the app generally. It does have one side-effect, in that outstanding asynchronous requests will block termination of the VM until that request finishes. So, for short-lived CLI tools, pinging Google Analytics can cause the tool to pause for several seconds before it terminates. This is often undesired - gathering analytics information shouldn’t negatively effect the tool's UX.

One solution to this is to use the waitForLastPing({Duration timeout}) method on the analytics object. This will wait until all outstanding analytics requests have completed, or until the specified duration has elapsed. So, CLI apps can do something like:

await analytics.waitForLastPing(timeout: new Duration(milliseconds: 200));
analytics.close();

or:

await analytics.waitForLastPing(timeout: new Duration(milliseconds: 200));
exit(0);

Using the API

Import the package (in this example we use the dart:io version):

import 'package:usage/usage_io.dart';

And call some analytics code:

final String UA = ...;

Analytics ga = new AnalyticsIO(UA, 'ga_test', '3.0');
ga.optIn = true;

ga.sendScreenView('home');
ga.sendException('foo exception');

ga.sendScreenView('files');
ga.sendTiming('writeTime', 100);
ga.sendTiming('readTime', 20);

When do we send analytics data?

You can use this library in an opt-in manner or an opt-out one. It defaults to opt-out - data will be sent to Google Analytics unless the user explicitly opts-out. The mode can be adjusted by changing the value of the Analytics.analyticsOpt field.

Opt-out In opt-out mode, if the user does not explicitly opt-out of collecting analytics (Analytics.enabled = false), the usage library will send usage data.

Opt-in In opt-in mode, no data will be sent until the user explicitly opt-in to collection (Analytics.enabled = true). This includes screen views, events, timing information, and exceptions.

Other info

For both classes, you need to provide a Google Analytics tracking ID, the application name, and the application version.

Your application should provide an opt-in option for the user. If they opt-in, set the optIn field to true. This setting will persist across sessions automatically.

Note: This library is intended for use with the Google Analytics application / mobile app style tracking IDs (as opposed to the web site style tracking IDs).

For more information, please see the Google Analytics Measurement Protocol Policy.

Contributing

Tests can be run using pub run test.

Issues and bugs

Please file reports on the GitHub Issue Tracker.

License

You can view our license here.