I've moved development of this project to https://github.com/ArcBees/universal-analytics. You should use that project instead of this.
A gwt wrapper for Google Universal Analytics
The code is generated directly from the api by https://github.com/rdwallis/gwt-universal-analytics-generator and then cleaned up so it should support the entire api, except for extensions like ExtendedEcommerce and tasks.
##Install
Checkout this project, and then run mvn install
Add the following to your pom
<dependency>
<groupId>com.wallissoftware</groupId>
<artifactId>gwt-universal-analytics</artifactId>
<version>1.0-SNAPSHOT</version>
</dependency>
Add the following to your gwt.xml
<inherits name="com.wallissoftware.universalanalytics.UniversalAnalytics"/>
Then in your gin module:
install(new UniversalAnalyticsModule.Builder("UA-XXXXXXXX-X").build());
##Advanced Install
By default UniversalAnalyticsModule.Builder will automatically create a tracker for you.
If you want to set up your tracker manually (eg because you want to use plugins) call:
install(new UniversalAnalyticsModule.Builder("UA-XXXXXXXX-X").autoCreate(false).build());
Then in your entry point or bootstrapper(GWTP) call the following:
analytics.create().go();
analytics.enablePlugin(AnalyticsPlugin.DISPLAY); //Provides demographics information.
##Basic Usage
Inject UniversalAnalytics into the class you want to track events from.
REMEBER TO CALL GO()
UniversalAnalytics uses a version of the builder pattern where you call the type of tracking method you want, then chain the options you need to the call followed by go().
eg:
analytics.sendPageView().go(); //track a pageview
analytics.sendPageView().DocumentPath("/foo").go(); //track a pageview for page /foo
analytics.sendEvent("button", "click").EventLabel("my label").go(); //send event with label
If you want to change the global settings call setGlobalSettings in the same way.
analytics.setGlobalSettings().AnonymizeIp(true).go(); //anonymize ips
##Server Side
install(new ServerUniversalAnalyticsModule("UA-XXXXXX-X"));
You can use universal analytics on the server exactly the same as you do on the client.
Server side calls work via the Measurement Protocol
A filter will automatically fill out the Measurement Protocol required fields for you from the _ga cookie or create the cookie if it doesn't exist.
setGlobalOptions()
and enablePlugin()
have no effect on server calls.
If you're using multiple trackers then you should call create().TrackerName("My Tracker").go()
to create your tracker before making the tracker call. All other options sent to create() on the server will be ignored.
If you're using SetCookieName() on the client then the automatic filter will not be able to keep the server and client in sync since it assumes that the cookie name is : _ga. Raise an issue on this project if you need to set the cookie name for some reason.
##Timing Events
To start a timing event call
analytics.startTimingEvent("My Category", "My Timing Variable Name");
Then to end it call.
analytics.endTimingEvent("My Category", "My Timing Variable Name").UserTimingLabel("My Label").go();
This will automatically create a timing event marking the difference between when the start and end calls are made.
The category and variable names for the start and end calls must be exactly the same, or the call will have no effect.