google-analytics-plugin

google-analytics-plugin

Cordova (PhoneGap) 3.0+ Plugin to connect to Google's native Universal Analytics SDK

Prerequisites:

• A Cordova 3.0+ project for iOS, Android, browser (PWA), Windows Phone 8 and/or Windows 10 (UWP)
• A Mobile App property through the Google Analytics Admin Console
• (Android) Google Play Services SDK installed via Android SDK Manager

Installing

This plugin follows the Cordova 3.0+ plugin spec, so it can be installed through the Cordova CLI in your existing Cordova project:

cordova plugin add https://github.com/danwilson/google-analytics-plugin.git

This plugin is also available on npm if you are using Cordova 5.0+:

cordova plugin add cordova-plugin-google-analytics

... OR the Cordova Plugin Registry if you are using a version of Cordova before 5.0 (while it remains open, as it is planning to shut down soon due to the move to npm):

cordova plugin add com.danielcwilson.plugins.googleanalytics

Important Note If the latest versions (0.8.0+) of this plugin are not working for you with Android on Cordova 5.0+, please try the suggestions in Issues 123. Google Play Services has been very confusing to integrate, but in recent months it has been simplified. This plugin uses the new simpler way (including it as a framework instead of bundling it which can conflict with other plugins bundling it), but if you previously installed this plugin some old files might still be lingering.

The plugin.xml file will add the Google Analytics SDK files for Android, iOS, browser (PWA), Windows Phone 8 and/or Windows 10 (UWP). Follow Google's steps if you need to update these later. Also make sure to review the Google Analytics terms and SDK Policy

If you are not using the CLI, follow the steps in the section Installing Without the CLI

Windows Phone users have to manually add the Google Analytics SDK for Windows 8 and Windows Phone to your solution. To do this, just open your Cordova solution in Visual Studio, and add the GoogleAnalyticsSDK package via NuGet. This plugin requires v1.3.0 or higher.

Windows 10 (UWP) users have to manually add the Windows SDK for Google Analytics to your solution. To do this, just open your Cordova solution in Visual Studio, and add the UWP.SDKforGoogleAnalytics.Native package via NuGet. This plugin requires v1.5.2 or higher.

Configuring play-services Version

Many other plugins require Google Play Services and/or Firebase libraries. This is a common source of Android build-failures, since the play-services library version must be aligned to the same version for all plugins. For example, when one plugin imports version 11.0.1 and another one imports 11.2.0, a gradle build failure will occur. Use the GMS_VERSION to align the required play-services version with other plugins.

cordova plugin add cordova-plugin-google-analytics --variable GMS_VERSION=11.0.1

Release note

v1.0.0 -- api change from window.analytics to window.ga, 'analytics' is deprecated since 1.0.0 and you should use the new api 'ga', because in the next release we are removing the analytics.

v1.7.x -- since this version there are new parameters in some of the old methods like startTrackerWithId('UA-XXXX-YY', 30) and this is causing errors for those who are using the ionic 2(ionic-native) or ionic 1 (ngCordova); these wrapper interfaces don't have the new parameters at the time we did the changes; so please update you ionic framework to the lastest version.

v1.7.11 -- since this version there is back compatibility with the new and old parameters in the method startTrackerWithId('UA-XXXX-YY', 30) to avoid loading issues reported.

v1.8.4 -- fix conflicting versions of google play services due to multiple implementations.

v1.9.0 -- since this version the windows platform is supported, also use Cocoa pods instead of static Framework for iOS.

v1.9.1 -- fix use Cocoa pods instead of static Framework for iOS; it will add the dependenciesto the config.xml ....

v1.9.2 -- remove CampaignTrackingReceiver (deprecated on SDK31+), update analytics dependency to support SDK31+

v1.9.3 -- Added exported property on android: android:exported="true"

JavaScript Usage

All the following methods accept optional success and error callbacks after all other available parameters.

…

Example use ionic (Ionic Native)

npm i --save @ionic-native/google-analytics

…

Working with multiple trackers in Ionic mobile app (Android & iOS)

    this.ga.startTrackerWithId('YOUR_TRACKER_ID_1')
      .then(() => {
          // Send a screen view to the first property.
          this.ga.trackView('First Tracker');
      })
      .catch(e => console.log('Error starting GoogleAnalytics', e));
    this.ga2.startTrackerWithId('YOUR_TRACKER_ID_2')
      .then(() => {
          // Send another screen view to the second property.
          this.ga2.trackView('Second Tracker');
      })
      .catch(e => console.log('Error starting GoogleAnalytics', e));

Issue for using trackMetric in Ionic: currently @ionic-native/google-analytics defines the typescript signature with trackMetric(key: string, value?: any). So be aware to pass the metric index as a string formatted integer and a non empty string as a value, like window.ga.trackMetric('1', 'Value', success, error)!

Installing Without the CLI

Copy the files manually into your project and add the following to your config.xml files:

You also will need to manually add the Google Analytics SDK files:

• Download the Google Analytics SDK 3.0 for iOS and/or Android
• For iOS, add the downloaded Google Analytics SDK header files and libraries according to the Getting Started documentation
• For Android, add libGoogleAnalyticsServices.jar to your Cordova Android project's /libs directory and build path
• For Windows Phone, add the GoogleAnalyticsSDK package via NuGet
• For Windows 10 (UWP), add the UWP.SDKforGoogleAnalytics.Native package via NuGet

Integrating with Lavaca

The lavaca directory includes a component that can be added to a Lavaca project. It offers a way to use the web analytics.js when the app is running in the browser and not packaged as Cordova.

• Copy AnalyticsService.js to your Lavaca project (I create a directory under js/app called data).
• In your config files (local.json, staging.json, production.js) create properties called google_analytics_id (for the Mobile App UA property) and google_analytics_web_id (for the Web UA property) and set the appropriate IDs or leave blank as needed.
• In any file you want to track screen views or events, require AnalyticsService and use the methods provided.

var analyticsService = require('app/data/AnalyticsService');

analyticsService.trackView('Home');

Browser (PWA)

For browser (PWA), people who want to use the plugin in a website that has already integrated google analytics needs to make sure that they remove the google analytics snippet from the head section of the page and change the global ga object name to something else. The plugin uses nativeGa instead. This can be changed by the following code.

// insert this in your head

The plugin will pick up the new name.

Windows 10 (UWP)

The following plugin methods are (currently) not supported by the UWP.SDKforGoogleAnalytics.Native package:

• setAllowIDFACollection()
• addTransaction()
• addTransactionItem()

Unexpected behaviour may occur on the following methods:

• trackView(): campaign details are currently not supported and therefore not tracked.
• trackMetric(): there is currently a bug in version 1.5.2 of the UWP.SDKforGoogleAnalytics.Native package via NuGet, that the wrong data specifier cd is taken for metrics, whereas cm should be the correct specifier. So as long as this bug is not fixed, trackMetrics will overwrite previous addCustomDimension with same index!!