fa-expo-analytics v1.0.0

Fa Expo Analytics

Library forked from https://github.com/ryanvanderpol/expo-analytics, with minor modifications, all credits to Ryan Vanderpol

Google Analytics integration for use with React Native apps built on Expo with support to hit dupplication. Most of the other Google Analytics libraries I've found require linking, which is not supported with Expo. This library does not require linking.

Please create issues for any bugs you find or features you would like added.

Installation

npm install fa-expo-analytics --save

Usage

Your React Native app's screen resolution, app name, app ID, app version and multiple other parameters will be automatically resolved and sent with each hit or event.

Hits

Sending page hits or screen hits is done by constructing a new PageHit or ScreenHit instance and passing it to the hit function of an Analytics instance.

import { Analytics, PageHit } from 'expo-analytics';

const analytics = new Analytics('UA-XXXXXX-Y', 'https://duplication_url...');
analytics.hit(new PageHit('Home'))
  .then(() => console.log("success"))
  .catch(e => console.log(e.message));

Events

You can also send custom events by constructing a new Event instance and passing it to the event function. Events have four parameters.

• Event Category
• Event Action
• Event Label (optional, but recommended)
• Event Value (optional, integer)

These parameters are passed to the Event constructor in that order.

import { Analytics, Event } from 'expo-analytics';

const analytics = new Analytics('UA-XXXXXX-Y');
analytics.event(new Event('Video', 'Play', 'The Big Lebowski', 123))
  .then(() => console.log("success"))
  .catch(e => console.log(e.message));

Learn more about custom events.

Custom Dimensions

Custom Dimensions are also supported. Any custom dimensions set will be sent with each request.

import { Analytics, Event } from 'expo-analytics';

const analytics = new Analytics('UA-XXXXXX-Y');
analytics.addCustomDimension(1, 'TrialAccount');
analytics.addCustomDimension(2, 'Comedy');
analytics.event(new Event('Video', 'Play', 'The Big Lebowski', 123))
  .then(() => console.log("success"))
  .catch(e => console.log(e.message));

You can remove custom dimensions as needed.

analytics.removeCustomDimension(1);

Additional Parameters

You can also optionally include any additional supported parameters you would like.

import { Analytics } from 'expo-analytics';

// pass in the user ID (uid), referrer (dr) and campaign name (cn) 
const analytics = new Analytics('UA-XXXXXX-Y', { uid: '999', dr: 'github.com', cn: 'get_more_views' });

Debugging

The Google Analytics API is a bit particular. If you're not seeing Real Time hits in your Analytics console you can turn on debug mode for this package and the exact URL request being sent will be printed to the console.

import { Analytics, PageHit } from 'expo-analytics';

const analytics = new Analytics('UA-XXXXXX-Y', null, { debug: true });
analytics.hit(new PageHit('IsItWorking'))
  .then(() => console.log("success"))
  .catch(e => console.log(e.message));

Release History

• 1.0.7 Promisification. Thanks, @dylancompanjen!

• 1.0.6 Fix for ScreenHit parameter name (thanks @davisml!). Support for custom dimensions.

• 1.0.5 Fixing issue with duplicate dependencies causing installation problems.

• 1.0.4 Automatically pull screen resolution from React Native dimensions. Resolve app name, app ID, app version from Expo manifest. App name is now required. Added debug option.

• 1.0.3 Added support for app ID and version

• 1.0.2 Added support for custom events

• 1.0.1 Initial release