README.md

cordova-plugin-firebase-analytics

Cordova plugin for Firebase Analytics

Installation

cordova plugin add cordova-plugin-firebase-analytics --save

If you need to set a specific dependency version on Android then use variable FIREBASE_VERSION.

Plugin depends on cordova-support-google-services for setting up google services properly. Please read the README carefully in order to avoid common issues with a project configuration.

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

Supported Platforms

• iOS
• Android

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);