github.com/idehub/react-native-google-analytics-bridge
On November 13th 2018 Google issued the following statement:
We want to let you know that in October 2019 we will begin to sunset our Google Analytics for mobile apps reporting and the Google Analytics Services SDK.
Data collection and processing for such properties will stop on October 31, 2019.
The message is quite clear, and therefore I am officially deprecating this library. If you want to continue using Google's solutions for analytics, I recommend you move to Google Analytics for Firebase instead.
For React Native, there is a great library called react-native-firebase which implements Analytics (and other Firebase solutions).
I will continue to support this library for minor fixes, but no major changes will occur. The repository itself will be archived sometime in 2019.
Thanks to everyone who have used or contributed to this library!
- Christian (@cbrevik)
Google Analytics Bridge is built to provide an easy interface to the native Google Analytics libraries on both iOS and Android.
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");
If you are upgrading to version 6 from an older version, read this wiki post for important details.
The newest version of this library has a new API surface. The API changes are in most cases backwards-compatible.
0.40 use version 5.0.0 (and up) of this module.0.40 use version 4.0.3.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
If it doesn't work immediately after this, consult the manual installation guide. Both Android and iOS has a couple of prerequisite SDKs linked and installed.
Important: Does this library work with Expo? We have to sort of invert the question a bit, because it should be: does Expo work with other libraries? And the answer is no:
The most limiting thing about Expo is that you can’t add in your own native modules without
detaching and using ExpoKit.
This includes using create-react-native-app which also makes use of Expo.
// 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);
// Setting `dryRun` to `true` lets you test tracking without sending data to GA
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);
});
// You can also register Function Call tag handlers when the container is open.
GoogleTagManager.registerFunctionCallTagHandler(
"some_function", // Must be equal to Function Name field when the tag was configured.
(functionName, tagArguments) => {
// functionName is passed for convenience. In this example it will be equal to "some_function".
// tagArguments is an object and is populated based on Tag configuration in TagManager interface.
console.log("Handling Function Call tag:", functionName);
}
)
Settings which are applied across all trackers.
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.
enabled booleanGoogleAnalyticsSettings.setOptOut(true);
Sets the trackers dispatch interval. 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.
intervalInSeconds numberGoogleAnalyticsSettings.setDispatchInterval(30);
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.
enabled booleanGoogleAnalyticsSettings.setDryRun(true);
// Constructing a tracker is simple:
import { GoogleAnalyticsTracker } from "react-native-google-analytics-bridge";
const tracker = new GoogleAnalyticsTracker("UA-12345-1");
tracker.trackScreenView("Home");
// You can have multiple trackers if you have several tracking ids
const tracker2 = new GoogleAnalyticsTracker("UA-12345-2");
// One optional feature as well is constructing a tracker with a CustomDimensionsFieldIndexMap, to map custom dimension field names to index keys:
const fieldIndexMap = { customerType: 1 };
const tracker3 = new GoogleAnalyticsTracker("UA-12345-3", fieldIndexMap);
// This is because the Google Analytics API expects custom dimensions to be tracked by index keys, and not field names.
// Here the underlying logic will transform the custom dimension, so what ends up being sent to GA is { 1: 'Premium' }:
tracker3.trackScreenView("Home", { customDimensions: { customerType: "Premium" } });
// If you do not use a CustomDimensionsFieldIndexMap, you will have to use index as keys instead for custom dimensions:
tracker.trackScreenView("Home", { customDimensions: { 1: "Premium" } });
Track the current screen/view. 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.
screenName string (Required) The name of the current screenpayload HitPayload (Optional) An object containing the hit payload (optional, default null)tracker.trackScreenView('Home');
// With payload:
const payload = { impressionList: "Sale", impressionProducts: [ { id: "PW928", name: "Premium bundle" } ] };
tracker.trackScreenView("SplashModal", payload);
Track an event that has occured
category string (Required) The event categoryaction string (Required) The event actioneventMetadata EventMetadata (Optional) An object containing event metadatapayload HitPayload (Optional) An object containing the hit payload (optional, default null)tracker.trackEvent("DetailsButton", "Click");
// Track event with label and value
tracker.trackEvent("AppVersionButton", "Click", { label: "v1.0.3", value: 22 });
// Track with a payload (ecommerce in this case):
const product = {
id: "P12345",
name: "Android Warhol T-Shirt",
category: "Apparel/T-Shirts",
brand: "Google",
variant: "Black",
price: 29.2,
quantity: 1,
couponCode: "APPARELSALE"
};
const transaction = {
id: "T12345",
affiliation: "Google Store - Online",
revenue: 37.39,
tax: 2.85,
shipping: 5.34,
couponCode: "SUMMER2013"
};
const productAction = {
transaction,
action: 7 // Purchase action, see ProductActionEnum
}
const payload = { products: [ product ], productAction: productAction }
tracker.trackEvent("FinalizeOrderButton", "Click", null, payload);
Track a timing measurement
category string (Required) The event categoryinterval number (Required) The timing measurement in millisecondstimingMetadata TimingMetadata (Required) An object containing timing metadatapayload HitPayload (Optional) An object containing the hit payload (optional, default null)tracker.trackTiming("testcategory", 2000, { name: "LoadList" }); // name metadata is required
// With optional label:
tracker.trackTiming("testcategory", 2000, { name: "LoadList", label: "v1.0.3" });
Track an exception
error string (Required) The description of the errorfatal boolean (Optional) A value indiciating if the error was fatal, defaults to false (optional, default false)payload HitPayload (Optional) An object containing the hit payload (optional, default null)try {
...
} catch(error) {
tracker.trackException(error.message, false);
}
Track a social interaction, Facebook, Twitter, etc.
network stringaction stringtargetUrl stringpayload HitPayload (Optional) An object containing the hit payloadtracker.trackSocialInteraction("Twitter", "Post");
Sets the current userId for tracking.
userId string An anonymous identifier that complies with Google Analytic's user ID policytracker.setUser("12345678");
Sets the current clientId for tracking.
clientId string A anonymous identifier that complies with Google Analytic's client ID policytracker.setClient("35009a79-1a05-49d7-b876-2b884d0f825b");
Get the client id to be used for purpose of logging etc.
tracker.getClientId().then(clientId => console.log("Client id is: ", clientId));
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.
enabled boolean (Optional) Defaults to true (optional, default true)tracker.allowIDFA(true);
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.
appName string (Required)tracker.setAppName("YourAwesomeApp");
Sets the trackers appVersion
appVersion string (Required)tracker.setAppVersion("1.3.2");
Sets if AnonymizeIp is enabled If enabled the last octet of the IP address will be removed
enabled boolean (Required)tracker.setAnonymizeIp(true);
Sets tracker sampling rate.
sampleRatio number (Required) Percentage 0 - 100tracker.setSamplingRate(50);
Sets the currency for tracking.
currencyCode string (Required) The currency ISO 4217 codetracker.setCurrency("EUR");
Sets if uncaught exceptions should be tracked Important to note: On iOS this option is set on all trackers. On Android it is set per tracker. If you are using multiple trackers on iOS, this will enable & disable on all trackers.
enabled booleanThis function lets you manually dispatch all hits which are queued. Use this function sparingly, as it will normally happen automatically as a batch. This function will also dispatch for all trackers.
tracker.dispatch().then(done => console.log("Dispatch is done: ", done));
Returns Promise<boolean> Returns when done
The same as dispatch, but also gives you the ability to time out
the Promise in case dispatch takes too long.
timeout number The timeout. Default value is 15 sec. (optional, default -1)tracker
.dispatchWithTimeout(10000)
.then(done => console.log("Dispatch is done: ", done));
Returns Promise<boolean> Returns when done or timed out
Can only be used with one container. All functions returns a Promise.
import { GoogleTagManager } from "react-native-google-analytics-bridge";
GoogleTagManager.openContainerWithId("GT-NZT48")
.then(() => GoogleTagManager.stringForKey("pack"))
.then(str => console.log("Pack: ", str));
Call once to open the container for all subsequent static calls.
containerId stringGoogleTagManager.openContainerWithId('GT-NZT48').then((..) => ..)
Refreshes the GTM container. According to Tag Manager documentations for Android can be called once every 15 minutes. No such limitations has been mentioned for iOS containers, though.
GoogleTagManager.refreshContainer().then((..) => ..)
Retrieves a boolean value with the given key from the opened container.
key stringGoogleTagManager.boolForKey("key").then(val => console.log(val));
Retrieves a string with the given key from the opened container.
key stringGoogleTagManager.stringForKey("key").then(val => console.log(val));
Retrieves a number with the given key from the opened container.
key stringGoogleTagManager.doubleForKey("key").then(val => console.log(val));
Push a datalayer event for Google Analytics through Google Tag Manager. The event must have at least one key "event" with event name.
event DataLayerEvent An Map<String, Object> containing key and value pairs. It must have at least one key "event" with event nameGoogleTagManager.pushDataLayerEvent({
event: "eventName",
pageId: "/home"
}).then(success => console.log(success));
Register Function Call tag handler
Sets logger to verbose, default is warning
enabled booleanUsed when tracking time measurements
const timingMetadata = { name: "LoadList" } // name is a required value when tracking timing
tracker.trackTiming("testcategory", 13000, timingMetadata);
Used when tracking event
const eventMetadata = { label: "v1.0.3", value: 22 }
tracker.trackEvent("FinalizeOrderButton", "Click", eventMetadata);
The HitPayload object and possible values
Used by the different tracking methods for adding metadata to the hit.
products Array<Product> (Optional) Used for ecommerceimpressionProducts Array<Product> (Optional) Used for ecommerceimpressionList string (Optional) Used for ecommerceimpressionSource string (Optional) Used for ecommerceproductAction ProductAction (Optional) Used for ecommercecustomDimensions (CustomDimensionsByIndex | CustomDimensionsByField) (Optional)customMetrics CustomMetrics (Optional)utmCampaignUrl string (Optional) Used for campaignssession string (Optional) Only two possible values, "start" or "end". This will either start or end a session.// If you want to do send a purchase payload with an event:
const product = {
id: "P12345",
name: "Android Warhol T-Shirt",
category: "Apparel/T-Shirts",
brand: "Google",
variant: "Black",
price: 29.2,
quantity: 1,
couponCode: "APPARELSALE"
};
const transaction = {
id: "T12345",
affiliation: "Google Store - Online",
revenue: 37.39,
tax: 2.85,
shipping: 5.34,
couponCode: "SUMMER2013"
};
const productAction = {
transaction,
action: 7 // Purchase action, see ProductActionEnum
}
const payload = { products: [ product ], productAction: productAction }
tracker.trackEvent("FinalizeOrderButton", "Click", null, payload);
// If you want to send custom dimensions with a screen view:
const customDimensions = {
1: "Beta",
3: "Premium"
};
const payload = { customDimensions };
tracker.trackScreenView("SaleScreen", payload);
A dictionary with custom dimensions values and their (mapped) field name keys.
In order to use this and send in custom dimensions by field name, you must have
provided a CustomDimensionsFieldIndexMap when constructing the tracker.
const customDimensions = { customerType: "Premium", appType: "Beta", credit: 1200 }
tracker.trackScreenView("Home", { customDimensions });
A dictionary with custom dimensions values and their index keys.
const customDimensions = { 1: "Premium", 3: "Beta", 5: 1200 }
tracker.trackScreenView("Home", { customDimensions });
A dictionary describing mapping of field names to indices for custom dimensions. This is an optional object used by the tracker.
// Create something like:
const fieldIndexMap = { customerType: 1 };
// Construct tracker with it:
const tracker = new GoogleAnalyticsTracker("UA-12345-3", fieldIndexMap);
// This allows you to send in customDimensions in the`HitPayload by field name instead of index:
tracker.trackScreenView("Home", { customDimensions: { customerType: "Premium" } });
// If you do not provide a map, you instead have to send in by index:
tracker.trackScreenView("Home", { customDimensions: { 1: "Premium" } });
A dictionary with custom metric values and their index keys.
const customMetrics = { 1: 2389, 4: 15000 }
tracker.trackScreenView("Home", { customMetrics });
The Google Tag Manager DataLayerEvent dictionary.
Populate this event-object with values to push to the DataLayer. The only required property is event.
event stringconst dataLayerEvent = {
event: "eventName",
pageId: "/home"
};
GoogleTagManager.pushDataLayerEvent(dataLayerEvent);
Enhanced Ecommerce ProductActionEnum
Used by ProductAction when describing the type of product action. The possible values (numbers) are:
Enhanced Ecommerce Product
Used by HitPayload when populating product actions or impressions
id stringname stringcategory string (Optional)brand string (Optional)variant string (Optional)price number (Optional)couponCode string (Optional)quantity number (Optional)const product = {
id: "P12345",
name: "Android Warhol T-Shirt",
category: "Apparel/T-Shirts",
brand: "Google",
variant: "Black",
price: 29.2,
quantity: 1,
couponCode: "APPARELSALE"
};
Enhanced Ecommerce Product Action
Used by HitPayload when describing a product action
action ProductActionEnumtransaction Transaction (Optional)checkoutStep number (Optional)checkoutOption string (Optional)productActionList string (Optional)productListSource string (Optional)const productAction = {
transaction,
action: 7 // Purchase action, see ProductActionEnum
}
const productAction = {
action: 3 // Add action, see ProductActionEnum
}
Enhanced Ecommerce Transaction
Used by ProductAction when populating describing a purchase/transaction
id stringaffiliation string (Optional)revenue number (Optional - but not really)tax number (Optional)shipping number (Optional)couponCode string (Optional)const transaction = {
id: "T12345",
affiliation: "Google Store - Online",
revenue: 37.39,
tax: 2.85,
shipping: 5.34,
couponCode: "SUMMER2013"
};
FAQs
Unknown package
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
In this segment of the Risky Business podcast, Feross Aboukhadijeh and Patrick Gray discuss the challenges of tracking malware discovered in open source softare.
Research
Security News
A threat actor's playbook for exploiting the npm ecosystem was exposed on the dark web, detailing how to build a blockchain-powered botnet.
Security News
NVD’s backlog surpasses 20,000 CVEs as analysis slows and NIST announces new system updates to address ongoing delays.