Cordova plugin for Firebase Analytics
Clone or download
Latest commit 710f08a Dec 5, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
src cleanup imports Dec 5, 2018
www implement resetAnalyticsData May 29, 2018
.gitignore fix typo Oct 9, 2016
LICENSE Initial commit Oct 8, 2016
README.md implement resetAnalyticsData May 29, 2018
package.json 1.0.1 Sep 25, 2018
plugin.xml 1.0.1 Sep 25, 2018

README.md

cordova-plugin-firebase-analytics
NPM version NPM downloads

Cordova plugin for Firebase Analytics

Installation

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

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.

Use variable FIREBASE_CORE_VERSION to override dependency version on Android.

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

resetAnalyticsData()

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

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