Cordova plugin for Firebase Analytics

Index

• Supported platforms
• Installation
• Methods

Supported platforms

• iOS
• Android

Installation

$ cordova plugin add cordova-plugin-firebase-analytics-v5

If you get an error about CocoaPods being unable to find compatible versions, run

$ pod repo update

Use variables ANDROID_FIREBASE_ANALYTICS_VERSION or IOS_FIREBASE_ANALYTICS_VERSION to override dependency versions for Firebase SDKs.

NOTE: on iOS in order to collect demographic, age, gender data etc. you should additionally include AdSupport.framework into your project.

Disabling analytics data collection

In some cases, you may wish to temporarily or permanently disable collection of Analytics data. You can set the value of variable ANALYTICS_COLLECTION_ENABLED to false to prevent collecting any user data:

$ cordova plugin add cordova-plugin-firebase-analytics-v5 --variable ANALYTICS_COLLECTION_ENABLED=false

Later you can re-enable analytics data collection (for instance after getting end-user consent) using method setEnabled.

Disabling automatic screen collection

In order to disable automatic collection of screen view events set the value of variable AUTOMATIC_SCREEN_REPORTING_ENABLED to false:

$ cordova plugin add cordova-plugin-firebase-analytics-v5 --variable AUTOMATIC_SCREEN_REPORTING_ENABLED=false

Adding required configuration files

Cordova supports resource-file tag for easy copying resources files. Firebase SDK requires google-services.json on Android and GoogleService-Info.plist on iOS platforms.

1. Put google-services.json and/or GoogleService-Info.plist into the root directory of your Cordova project
2. Add new tag for Android platform

<platform name="android">
    ...
    <resource-file src="google-services.json" target="app/google-services.json" />
</platform>
...
<platform name="ios">
    ...
    <resource-file src="GoogleService-Info.plist" />
</platform>

This way config files will be copied on cordova prepare step.

Methods

Every method returns a promise that fulfills when a call was successful.

logEvent(name, params)

Logs an app event.

cordova.plugins.firebase.analytics.logEvent("my_event", {param1: "value1"});

Be aware of automatically collected events.

setUserId(id)

Sets the user ID property.

cordova.plugins.firebase.analytics.setUserId("12345");

This feature must be used in accordance with Google's Privacy Policy.

setUserProperty(name, value)

Sets a user property to a given value.

cordova.plugins.firebase.analytics.setUserProperty("name1", "value1");

Be aware of automatically collected user properties.

setCurrentScreen(name)

Sets the current screen name, which specifies the current visual context in your app. This helps identify the areas in your app where users spend their time and how they interact with your app.

cordova.plugins.firebase.analytics.setCurrentScreen("User profile");

setEnabled(enabled)

Sets whether analytics collection is enabled for this app on this device.

cordova.plugins.firebase.analytics.setEnabled(false);

resetAnalyticsData()

Clears all analytics data for this instance from the device and resets the app instance ID.

cordova.plugins.firebase.analytics.resetAnalyticsData();

setDefaultEventParameters(params)

Adds parameters that will be set on every event logged from the SDK, including automatic ones.

cordova.plugins.firebase.analytics.setDefaultEventParameters({foo: "bar"});