@capgo/capacitor-firebase-analytics

Overview

Capacitor plugin for Firebase Analytics.

Core Capabilities

• getAppInstanceId - Retrieves the app instance id.
• getSessionId - Retrieves the current session id (ga_session_id).
• setConsent - Sets the user’s consent mode.
• setUserId - Sets the user ID property.

Public API

Method	Description
getAppInstanceId	Retrieves the app instance id.
getSessionId	Retrieves the current session id (ga_session_id).
setConsent	Sets the user’s consent mode.
setUserId	Sets the user ID property.
setUserProperty	Sets a custom user property to a given value.
setCurrentScreen	Sets the current screen name.
logEvent	Logs an app event.
setSessionTimeoutDuration	Sets the duration of inactivity that terminates the current session.
setEnabled	Enables/disables automatic data collection. The value does not apply until the next run of the app.
isEnabled	Returns whether or not automatic data collection is enabled.
resetAnalyticsData	Clears all analytics data for this app from the device. Resets the app instance id.
initiateOnDeviceConversionMeasurementWithEmailAddress	Initiates on-device conversion measurement with an email address.
initiateOnDeviceConversionMeasurementWithPhoneNumber	Initiates on-device conversion measurement with a phone number.
initiateOnDeviceConversionMeasurementWithHashedEmailAddress	Initiates on-device conversion measurement with a hashed email address.
initiateOnDeviceConversionMeasurementWithHashedPhoneNumber	Initiates on-device conversion measurement with a hashed phone number.
getPluginVersion	Get the version of this plugin.

Source Of Truth

This reference is synced from src/definitions.ts in capacitor-firebase.