Skip to content

Latest commit

 

History

History
468 lines (346 loc) · 15.5 KB

README.md

File metadata and controls

468 lines (346 loc) · 15.5 KB
Raw

GoogleAnalyticsBridge npm version Build Status

Google Analytics Bridge is built to provide an easy interface to the native Google Analytics libraries on both iOS and Android.

Why a native bridge? Why not use just JavaScript?

The key difference with the native bridge is that you get a lot of the metadata handled automatically by the Google Analytics native library. This will include the device UUID, device model, viewport size, OS version etc.

You will only have to send in a few parameteres when tracking, e.g:

import { GoogleAnalyticsTracker } from 'react-native-google-analytics-bridge';
let tracker = new GoogleAnalyticsTracker('UA-12345-1');

tracker.trackScreenView('Home');
tracker.trackEvent('testcategory', 'testaction');

Content

Installation and linking libraries

Install with npm: npm install --save react-native-google-analytics-bridge.

Or, install with yarn: yarn add react-native-google-analytics-bridge.

Either way, then link with react-native link react-native-google-analytics-bridge.

For iOS you must also link a few more SDK packages in Xcode, which are required by GA:

  • CoreData.framework
  • SystemConfiguration.framework
  • libz.tbd
  • libsqlite3.0.tbd

For Android, make sure you have the following SDK packages installed in the Android SDK Manager:

  • Google Repository
  • Google Play services
  • Google APIs (Atom) system image

For more details about the native SDKs, consult the manual installation guide.

Usage

// You have access to three classes in this module:
import { 
  GoogleAnalyticsTracker, 
  GoogleTagManager, 
  GoogleAnalyticsSettings 
} from 'react-native-google-analytics-bridge';

// The tracker must be constructed, and you can have multiple:
let tracker1 = new GoogleAnalyticsTracker('UA-12345-1');
let tracker2 = new GoogleAnalyticsTracker('UA-12345-2');

tracker1.trackScreenView('Home');
tracker1.trackEvent('Customer', 'New');

// The GoogleAnalyticsSettings is static, and settings are applied across all trackers:
GoogleAnalyticsSettings.setDispatchInterval(30);
GoogleAnalyticsSettings.setDryRun(true);

// GoogleTagManager is also static, and works only with one container. All functions here are Promises:
GoogleTagManager.openContainerWithId("GT-NZT48")
  .then(() => {
    return GoogleTagManager.stringForKey("pack");
  })
  .then((pack) => {
    console.log("Pack: ", pack);
  })
  .catch((err) => {
    console.log(err);
  });

JavaScript API

GoogleAnalyticsTracker API

new GoogleAnalyticsTracker(trackerId, customDimensionsFieldsIndexMap = {})

  • trackerId (required): String, your tracker id, something like: UA-12345-1
  • customDimensionsFieldsIndexMap (optional): {{fieldName: fieldIndex}} Custom dimensions field/index pairs
import { GoogleAnalyticsTracker } from 'react-native-google-analytics-bridge';
let tracker = new GoogleAnalyticsTracker('UA-12345-1');

Google Analytics expects dimensions to be tracked by indices, and not field names. To simplify this, you can construct a tracker with a customDimensionsFieldsIndexMap. With this, you can map field names to indices, e.g:

let tracker2 = new GoogleAnalyticsTracker('UA-12345-3', { test: 1 });
tracker2.trackScreenViewWithCustomDimensionValues('Home', { test: 'Beta' });

Here the underlying logic will transform the custom dimension, so what ends up being sent to GA is { 1: 'Beta' }. This should make it easier to use custom dimensions. If you do not provide a customDimensionsFieldsIndexMap, the custom dimensions are passed through untouched.

trackScreenView(screenName)

  • screenName (required): String, name of current screen

Important: Calling this will also set the "current view" for other calls. So events tracked will be tagged as having occured on the current view, Home in this example. This means it is important to track navigation, especially if events can fire on different views.

See the Google Analytics docs for more info

tracker.trackScreenView('Home')

trackEvent(category, action, optionalValues)

  • category (required): String, category of event
  • action (required): String, name of action
  • optionalValues: Object
    • label: String
    • value: Number

See the Google Analytics docs for more info.

tracker.trackEvent('testcategory', 'testaction');
// or
tracker.trackEvent('testcategory', 'testaction', {label: 'v1.0.3', value: 22});

trackTiming(category, value, optionalValues)

  • category (required): String, category of the timed event
  • value (required): Number, the timing measurement in milliseconds
  • optionalValues: Object
    • name (required): String, the name of the timed event
    • label: String, the label of the timed event

See the Google Analytics docs for more info.

tracker.trackTiming('testcategory', 13000, {name: 'LoadList'}); // name option is required
// or
tracker.trackTiming('testcategory', 13000, {name: 'loadList', label: 'v1.0.3'});

trackPurchaseEvent(product, transaction, eventCategory, eventAction)

  • product (required): Object
    • id: String
    • name: String
    • category: String
    • brand: String
    • variant: String
    • price: Number
    • quantity: Number
    • couponCode: String
  • transaction (required): Object
    • id: String
    • affiliation: String, an entity with which the transaction should be affiliated (e.g. a particular store)
    • revenue: Number
    • tax: Number
    • shipping: Number
    • couponCode: String
  • eventCategory (required): String, defaults to "Ecommerce"
  • eventAction (required): String, defaults to "Purchase"

See the Google Analytics docs for more info.

tracker.trackPurchaseEvent({
  id: 'P12345',
  name: 'Android Warhol T-Shirt',
  category: 'Apparel/T-Shirts',
  brand: 'Google',
  variant: 'Black',
  price: 29.20,
  quantity: 1,
  couponCode: 'APPARELSALE'
}, {
  id: 'T12345',
  affiliation: 'Google Store - Online',
  revenue: 37.39,
  tax: 2.85,
  shipping: 5.34,
  couponCode: 'SUMMER2013'
}, 'Ecommerce', 'Purchase');

trackMultiProductsPurchaseEvent(products, transaction, eventCategory, eventAction)

same as trackPurchaseEvent but instead of one product you can provide an Array of products

trackMultiProductsPurchaseEventWithCustomDimensionValues(products, transaction, eventCategory, eventAction, dimensionIndexValueDict)

  • products (required): Array, array of products
  • transaction (required): Object, transaction object
  • eventCategory (required): String, defaults to "Ecommerce"
  • eventAction (required): String, defaults to "Purchase"
  • dimensionIndexValueDict (required): Dict of dimension index / values.
tracker.trackMultiProductsPurchaseEventWithCustomDimensionValues([
{
  id: 'P12345',
  name: 'Android Warhol T-Shirt',
  category: 'Apparel/T-Shirts',
  brand: 'Google',
  variant: 'Black',
  price: 29.20,
  quantity: 1,
  couponCode: 'APPARELSALE'
},
{
  id: 'P54321',
  name: 'IOS T-Shirt',
  category: 'Apparel/T-Shirts',
  brand: 'Apple',
  variant: 'Black',
  price: 10.10,
  quantity: 1,
  couponCode: 'APPARELSALE'
}],
{
  id: 'T12345',
  affiliation: 'Store - Online',
  revenue: 52.5,
  tax: 7.86,
  shipping: 5.34,
  couponCode: 'SUMMER2013'
}, 
'Ecommerce',
'Purchase',
{'1':'premium', '5':'foo'}
);

trackException(error, fatal)

  • error: String, a description of the exception (up to 100 characters), accepts nil
  • fatal (required): Boolean, indicates whether the exception was fatal, defaults to false

See the Google Analytics docs for more info.

try {
  ...
} catch(error) {
  tracker.trackException(error.message, false);
}

trackSocialInteraction(network, action, targetUrl)

  • network (required): String, name of social network (e.g. 'Facebook', 'Twitter', 'Google+')
  • action (required): String, social action (e.g. 'Like', 'Share', '+1')
  • targetUrl: String, url of content being shared

See the Google Analytics docs for more info.

tracker.trackSocialInteraction('Twitter', 'Post');

trackScreenViewWithCustomDimensionValues(screenName, dimensionIndexValueDict)

  • screenName (required): String, name of current screen
  • dimensionIndexValueDict (required): Dict of dimension index / values.

Tracks a screen view with one or more customDimensionValues. See the Google Analytics docs for more info.

tracker.trackScreenViewWithCustomDimensionValues('Home', {'1':'premium', '5':'foo'});

trackEventWithCustomDimensionValues(category, action, optionalValues, dimensionIndexValueDict)

  • category (required): String, category of event
  • action (required): String, name of action
  • optionalValues: Object
    • label: String
    • value: Number
  • dimensionIndexValueDict (required): Dict of dimension index / values.

Tracks an event with one or more customDimensionValues. See the Google Analytics docs for more info.

tracker.trackEventWithCustomDimensionValues('testcategory', 'testaction', {label: 'v1.0.3', value: 22}, {'1':'premium', '5':'foo'});

setUser(userId)

  • userId (required): String, an anonymous identifier that complies with Google Analytic's user ID policy

See the Google Analytics for more info.

tracker.setUser('12345678');

allowIDFA(enabled)

  • enabled (required): Boolean, true to allow IDFA collection, defaults to true.

Also called advertising identifier collection, and is used for advertising features.

Important: For iOS you can only use this method if you have done the optional step 6 from the installation guide. Only enable this (and link the appropriate libraries) if you plan to use advertising features in your app, or else your app may get rejected from the AppStore.

See the Google Analytics for more info.

tracker.allowIDFA(true);

setTrackUncaughtExceptions(enabled)

  • enabled (required): Boolean

Sets if uncaught exceptions should be tracked. This is enabled by default.

tracker.setTrackUncaughtExceptions(true);

setAnonymizeIp(enabled)

  • enabled (required): Boolean

Sets if AnonymizeIp is enabled. This is disabled by default. If enabled the last octet of the IP address will be removed.

tracker.setAnonymizeIp(true);

setAppName(appName)

  • appName (required): String

Overrides the app name logged in Google Analytics. The Bundle name is used by default. Note: This has to be set each time the App starts.

tracker.setAppName('someAppName');

setSamplingRate(ratio)

  • ratio (required): Number Percentage 0 - 100

Sets tracker sampling rate.

tracker.setSamplingRate(50);

GoogleAnalyticsSettings API

Settings are applied across all trackers.

setDryRun(enabled)

  • enabled (required): Boolean, indicating if the dryRun flag should be enabled or not.

When enabled the native library prevents any data from being sent to Google Analytics. This allows you to test or debug the implementation, without your test data appearing in your Google Analytics reports.

GoogleAnalyticsSettings.setDryRun(true);

setDispatchInterval(intervalInSeconds)

  • intervalInSeconds (required): Number, indicating how often dispatches should be sent

Events, screen views, etc, are sent in batches to your tracker. This function allows you to configure how often (in seconds) the batches are sent to your tracker. Recommended to keep this around 20-120 seconds to preserve battery and network traffic. This is set to 20 seconds by default.

GoogleAnalyticsSettings.setDispatchInterval(30);

setOptOut(enabled)

  • enabled (required): Boolean

Sets if OptOut is active and disables Google Analytics. This is disabled by default. Note: This has to be set each time the App starts.

GoogleAnalyticsSettings.setOptOut(true);

GoogleTagManager API

import { GoogleTagManager } from 'react-native-google-analytics-bridge';
GoogleTagManager.openContainerWithId('GT-NZT48')
.then(() => GoogleTagManager.stringForKey('pack'))
.then((str) => console.log('Pack: ', str));

Can only be used with one container. All methods returns a Promise.

openContainerWithId(containerId)

  • containerId (required): String, your container id.

Important: Call once to open the container for all subsequent static calls.

GoogleTagManager.openContainerWithId('GT-NZT48')
.then((..) => ..)

stringForKey(key)

Parameter(s)
  • key (required): String
Returns:
  • value: String

Retrieves a string with the given key from the opened container.

GoogleTagManager.stringForKey('key').then((val) => console.log(val));

boolForKey(key)

Parameter(s)
  • key (required): String
Returns:
  • value: Boolean

Retrieves a boolean value with the given key from the opened container.

GoogleTagManager.boolForKey('key').then((val) => console.log(val));

doubleForKey(key)

Parameter(s)
  • key (required): String
Returns:
  • value: Number

Retrieves a number with the given key from the opened container.

GoogleTagManager.doubleForKey('key').then((val) => console.log(val));

pushDataLayerEvent(dictionary = {})

Parameter(s)
  • dictionary (required): dictionary An Map<String, Object> containing key and value pairs.
Returns:
  • value: Boolean

Push a DataLayer event for Google Analytics through Google Tag Manager.

GoogleTagManager.pushDataLayerEvent({event: "eventName", pageId: "/home"})
.then((success) => console.log(success));