--- description: Unofficial Capacitor plugin for Firebase Analytics SDK to track user interactions and events in your app. title: Capacitor Firebase Analytics Plugin - Capawesome image: https://capawesome.io/docs/assets/images/social/sdks/capacitor/firebase/analytics.png --- [ Skip to content](#capacitor-firebaseanalytics) [ πŸ” Introducing the **Capacitor Vault** plugin β€” store secrets behind biometrics or a device passcode.](/blog/announcing-the-capacitor-vault-plugin/) * [ SDKs ](/docs/sdks/) * [ iOS ](#ios) * [ Configuration ](#configuration) * [ Demo ](#demo) * [ Usage ](#usage) * [ API ](#api) * [ Enums ](#enums) * [ Test your implementation ](#test-your-implementation) * [ Changelog ](#changelog) * [ License ](#license) * [ App ](/docs/sdks/capacitor/firebase/app/) * [ App Check ](/docs/sdks/capacitor/firebase/app-check/) * [ Authentication ](/docs/sdks/capacitor/firebase/authentication/) * [ Crashlytics ](/docs/sdks/capacitor/firebase/crashlytics/) * [ Cloud Firestore ](/docs/sdks/capacitor/firebase/cloud-firestore/) * [ Cloud Functions ](/docs/sdks/capacitor/firebase/cloud-functions/) * [ Cloud Messaging ](/docs/sdks/capacitor/firebase/cloud-messaging/) * [ Cloud Storage ](/docs/sdks/capacitor/firebase/cloud-storage/) * [ Performance Monitoring ](/docs/sdks/capacitor/firebase/performance-monitoring/) * [ Remote Config ](/docs/sdks/capacitor/firebase/remote-config/) * [ Formbricks ](/docs/sdks/capacitor/formbricks/) * [ Geocoder ](/docs/sdks/capacitor/geocoder/) * [ Google Sign-In ](/docs/sdks/capacitor/google-sign-in/) * [ Grafana Faro ](/docs/sdks/capacitor/grafana-faro/) * [ libSQL ](/docs/sdks/capacitor/libsql/) * [ Live Update ](/docs/sdks/capacitor/live-update/) * [ Managed Configurations ](/docs/sdks/capacitor/managed-configurations/) * [ Media Session ](/docs/sdks/capacitor/media-session/) * [ ML Kit ](/docs/sdks/capacitor/mlkit/) * [ Navigation Bar ](/docs/sdks/capacitor/navigation-bar/) * [ NFC ](/docs/sdks/capacitor/nfc/) * [ OAuth ](/docs/sdks/capacitor/oauth/) * [ Pedometer ](/docs/sdks/capacitor/pedometer/) * [ Photo Editor ](/docs/sdks/capacitor/photo-editor/) * [ PostHog ](/docs/sdks/capacitor/posthog/) * [ Printer ](/docs/sdks/capacitor/printer/) * [ Purchases ](/docs/sdks/capacitor/purchases/) * [ RealtimeKit ](/docs/sdks/capacitor/realtimekit/) * [ Screen Orientation ](/docs/sdks/capacitor/screen-orientation/) * [ Screenshot ](/docs/sdks/capacitor/screenshot/) * [ Secure Preferences ](/docs/sdks/capacitor/secure-preferences/) * [ Speech Recognition ](/docs/sdks/capacitor/speech-recognition/) * [ Speech Synthesis ](/docs/sdks/capacitor/speech-synthesis/) * [ Share Target ](/docs/sdks/capacitor/share-target/) * [ Square Mobile Payments ](/docs/sdks/capacitor/square-mobile-payments/) * [ SQLite ](/docs/sdks/capacitor/sqlite/) * [ Superwall ](/docs/sdks/capacitor/superwall/) * [ Torch ](/docs/sdks/capacitor/torch/) * [ Vault ](/docs/sdks/capacitor/vault/) * [ Wifi ](/docs/sdks/capacitor/wifi/) * [ Zip ](/docs/sdks/capacitor/zip/) * [ Cordova ](/docs/sdks/cordova/) * [ Cloud ](/docs/cloud/) * [ Integrations ](/docs/cloud/live-updates/integrations/) * Concepts * Reference * [ Troubleshooting ](/docs/cloud/live-updates/troubleshooting/) * [ FAQ ](/docs/cloud/live-updates/faq/) * [ Native Builds ](/docs/cloud/native-builds/) * [ Set Up Environments ](/docs/cloud/native-builds/environments/) * [ Overwrite Native Configurations ](/docs/cloud/native-builds/native-configurations/) * [ Auto-Increment Build Numbers ](/docs/cloud/native-builds/auto-incrementing-build-numbers/) * [ Configure the Web Build Script ](/docs/cloud/native-builds/web-build-script/) * [ Build from a Monorepo ](/docs/cloud/native-builds/monorepo/) * [ Use pnpm or Yarn ](/docs/cloud/native-builds/package-managers/) * [ Install Private npm Packages ](/docs/cloud/native-builds/npm-private-registry/) * [ Override the Java Version ](/docs/cloud/native-builds/override-java-version/) * [ Custom iOS Provisioning Profiles ](/docs/cloud/native-builds/custom-ios-provisioning-profiles/) * [ Build without Git ](/docs/cloud/native-builds/build-without-git/) * [ Access Git Behind a Firewall ](/docs/cloud/native-builds/firewall-access/) * [ Integrations ](/docs/cloud/native-builds/integrations/) * Reference * [ Troubleshooting ](/docs/cloud/native-builds/troubleshooting/) * [ FAQ ](/docs/cloud/native-builds/faq/) * [ App Store Publishing ](/docs/cloud/app-store-publishing/) * [ Submit a Build ](/docs/cloud/app-store-publishing/submit-a-build/) * [ Submit Automatically After a Build ](/docs/cloud/app-store-publishing/submit-automatically/) * [ Troubleshooting ](/docs/cloud/app-store-publishing/troubleshooting/) * [ FAQ ](/docs/cloud/app-store-publishing/faq/) * [ Automations ](/docs/cloud/automations/) * [ Reference ](/docs/cloud/automations/reference/) * [ Troubleshooting ](/docs/cloud/automations/troubleshooting/) * [ FAQ ](/docs/cloud/automations/faq/) * [ Assist ](/docs/cloud/assist/) * [ CLI ](/docs/cloud/cli/) * APIs and SDKs * [ Webhooks ](/docs/cloud/webhooks/) * [ Integrations ](/docs/cloud/integrations/) * Account * [ Organization ](/docs/cloud/organizations/) * [ Two-Factor Enforcement ](/docs/cloud/organizations/two-factor-authentication/) * [ Audit Logs ](/docs/cloud/organizations/audit-logs/) * [ Billing ](/docs/cloud/organizations/billing/) * [ License Keys ](/docs/cloud/license-keys/) * [ AI ](/docs/ai/) * [ Insiders ](/docs/insiders/) * [ Billing & Plans ](/docs/insiders/billing-and-plans/) * [ FAQ ](/docs/insiders/faq/) * [ License ](https://capawesome.io/legal/eula/) * [ Support ](/docs/support/) * [ Contributing ](/docs/contributing/) * Contributing code * [ Code of Conduct ](/docs/contributing/code-of-conduct/) * [ Questions ](https://docs.github.com/en/discussions/collaborating-with-your-community-using-discussions/participating-in-a-discussion#creating-a-discussion) * [ Blog ](/blog/) * Categories * [ iOS ](#ios) * [ Configuration ](#configuration) * [ Demo ](#demo) * [ Usage ](#usage) * [ API ](#api) * [ Enums ](#enums) * [ Test your implementation ](#test-your-implementation) * [ Changelog ](#changelog) * [ License ](#license) # @capacitor-firebase/analytics[ΒΆ](#capacitor-firebaseanalytics "Permanent link") Unofficial Capacitor plugin for [Firebase Analytics](https://firebase.google.com/docs/analytics).[1](#fn:1) [ ![Deliver Live Updates to your Capacitor app with Capawesome Cloud](../../../../assets/external/cloud.capawesome.io/assets/banners/cloud-build-and-deploy-capacitor-apps.69628c3f.png) ](https://cloud.capawesome.io/) ## Newsletter[ΒΆ](#newsletter "Permanent link") Stay up to date with the latest news and updates about the Capawesome, Capacitor, and Ionic ecosystem by subscribing to our [Capawesome Newsletter](https://cloud.capawesome.io/newsletter/). ## Compatibility[ΒΆ](#compatibility "Permanent link") | Plugin Version | Capacitor Version | Status | | -------------- | ----------------- | -------------- | | 8.x.x | \>=8.x.x | Active support | | 7.x.x | 7.x.x | Deprecated | | 6.x.x | 6.x.x | Deprecated | | 5.x.x | 5.x.x | Deprecated | | 1.x.x | 4.x.x | Deprecated | ## Installation[ΒΆ](#installation "Permanent link") You can use our **AI-Assisted Setup** to install the plugin. Add the [Capawesome Skills](https://github.com/capawesome-team/skills) to your AI tool using the following command: `[](#%5F%5Fcodelineno-0-1)npx skills add capawesome-team/skills --skill capacitor-plugins ` Then use the following prompt: `` [](#%5F%5Fcodelineno-1-1)Use the `capacitor-plugins` skill from `capawesome-team/skills` to install the `@capacitor-firebase/analytics` plugin in my project. `` If you prefer **Manual Setup**, install the plugin by running the following commands and follow the platform-specific instructions below: `[](#%5F%5Fcodelineno-2-1)npm install @capacitor-firebase/analytics firebase [](#%5F%5Fcodelineno-2-2)npx cap sync ` Add Firebase to your project if you haven't already ([Android](https://github.com/capawesome-team/capacitor-firebase/blob/main/docs/firebase-setup.md#android) / [iOS](https://github.com/capawesome-team/capacitor-firebase/blob/main/docs/firebase-setup.md#ios) / [Web](https://github.com/capawesome-team/capacitor-firebase/blob/main/docs/firebase-setup.md#web)). ### Android[ΒΆ](#android "Permanent link") #### Disable Analytics data collection[ΒΆ](#disable-analytics-data-collection "Permanent link") See [Disable Analytics data collection](https://firebase.google.com/docs/analytics/configure-data-collection?platform=android#disable%5Fdata%5Fcollection) if you want to disable Analytics data collection. #### Disable Advertising ID collection[ΒΆ](#disable-advertising-id-collection "Permanent link") See [Disable Advertising ID collection](https://firebase.google.com/docs/analytics/configure-data-collection?platform=android#disable%5Fadvertising%5Fid%5Fcollection) if you want to disable Advertising ID collection. #### Variables[ΒΆ](#variables "Permanent link") If needed, you can define the following project variable in your app’s `variables.gradle` file to change the default version of the dependency: * `$firebaseAnalyticsVersion` version of `com.google.firebase:firebase-analytics` (default: `23.0.0`) This can be useful if you encounter dependency conflicts with other plugins in your project. ### iOS[ΒΆ](#ios "Permanent link") #### Swift Package Manager[ΒΆ](#swift-package-manager "Permanent link") Add the following to your `capacitor.config.json` (or `capacitor.config.ts`) to avoid a [SwiftPM package identity collision](https://github.com/capawesome-team/capacitor-firebase/issues/959): `[](#%5F%5Fcodelineno-3-1){ [](#%5F%5Fcodelineno-3-2) "experimental": { [](#%5F%5Fcodelineno-3-3) "ios": { [](#%5F%5Fcodelineno-3-4) "spm": { [](#%5F%5Fcodelineno-3-5) "packageOptions": { [](#%5F%5Fcodelineno-3-6) "@capacitor-firebase/analytics": { [](#%5F%5Fcodelineno-3-7) "symlink": true [](#%5F%5Fcodelineno-3-8) } [](#%5F%5Fcodelineno-3-9) } [](#%5F%5Fcodelineno-3-10) } [](#%5F%5Fcodelineno-3-11) } [](#%5F%5Fcodelineno-3-12) } [](#%5F%5Fcodelineno-3-13)} ` **Attention**: SPM `packageOptions` support requires Capacitor CLI **8.4.0+**. If you are using **CocoaPods** for your iOS project, you need to add the `CapacitorFirebaseAnalytics/Analytics` pod to your `Podfile` (usually `ios/App/Podfile`): `[](#%5F%5Fcodelineno-4-1)target 'App' do [](#%5F%5Fcodelineno-4-2)capacitor_pods [](#%5F%5Fcodelineno-4-3)# Add your Pods here [](#%5F%5Fcodelineno-4-4)+ pod 'CapacitorFirebaseAnalytics/Analytics', :path => '../../node_modules/@capacitor-firebase/analytics' [](#%5F%5Fcodelineno-4-5)end ` **Attention**: Do not add the pod in the section `def capacitor_pods`, but under the comment `# Add your Pods here` ([example](https://github.com/robingenz/capacitor-firebase-plugin-demo/blob/e1684a0af6871442ed0a87dceeeba6fd9ce0185d/ios/App/Podfile#L30)). #### Disable Analytics data collection[ΒΆ](#disable-analytics-data-collection%5F1 "Permanent link") See [Disable Analytics data collection](https://firebase.google.com/docs/analytics/configure-data-collection?platform=ios#disable%5Fdata%5Fcollection) if you want to disable Analytics data collection. #### Disable IDFA collection[ΒΆ](#disable-idfa-collection "Permanent link") If you are using **CocoaPods** for your iOS project and you want to disable IDFA collection, you can use the `CapacitorFirebaseAnalytics/AnalyticsWithoutAdIdSupport` pod instead of the `CapacitorFirebaseAnalytics/Analytics` pod: `[](#%5F%5Fcodelineno-5-1)target 'App' do [](#%5F%5Fcodelineno-5-2)capacitor_pods [](#%5F%5Fcodelineno-5-3)# Add your Pods here [](#%5F%5Fcodelineno-5-4)- pod 'CapacitorFirebaseAnalytics/Analytics', :path => '../../node_modules/@capacitor-firebase/analytics' [](#%5F%5Fcodelineno-5-5)+ pod 'CapacitorFirebaseAnalytics/AnalyticsWithoutAdIdSupport', :path => '../../node_modules/@capacitor-firebase/analytics' [](#%5F%5Fcodelineno-5-6)end ` If you are using **Swift Package Manager** for your iOS project and you want to disable IDFA collection, you can enable the `AnalyticsWithoutAdIdSupport` trait in your `capacitor.config.json` (or `capacitor.config.ts`): `[](#%5F%5Fcodelineno-6-1){ [](#%5F%5Fcodelineno-6-2) "experimental": { [](#%5F%5Fcodelineno-6-3) "ios": { [](#%5F%5Fcodelineno-6-4) "spm": { [](#%5F%5Fcodelineno-6-5) "swiftToolsVersion": "6.1", [](#%5F%5Fcodelineno-6-6) "packageTraits": { [](#%5F%5Fcodelineno-6-7) "@capacitor-firebase/analytics": ["AnalyticsWithoutAdIdSupport"] [](#%5F%5Fcodelineno-6-8) } [](#%5F%5Fcodelineno-6-9) } [](#%5F%5Fcodelineno-6-10) } [](#%5F%5Fcodelineno-6-11) } [](#%5F%5Fcodelineno-6-12)} ` **Note**: SPM trait support requires Capacitor CLI **8.3.0+** and Xcode **16.3+** (Swift 6.1+). ## Configuration[ΒΆ](#configuration "Permanent link") No configuration required for this plugin. ## Demo[ΒΆ](#demo "Permanent link") A working example can be found here: [robingenz/capacitor-firebase-plugin-demo](https://github.com/robingenz/capacitor-firebase-plugin-demo) ## Usage[ΒΆ](#usage "Permanent link") `[](#%5F%5Fcodelineno-7-1)import { FirebaseAnalytics } from '@capacitor-firebase/analytics'; [](#%5F%5Fcodelineno-7-2) [](#%5F%5Fcodelineno-7-3)const setUserId = async () => { [](#%5F%5Fcodelineno-7-4) await FirebaseAnalytics.setUserId({ [](#%5F%5Fcodelineno-7-5) userId: '123', [](#%5F%5Fcodelineno-7-6) }); [](#%5F%5Fcodelineno-7-7)}; [](#%5F%5Fcodelineno-7-8) [](#%5F%5Fcodelineno-7-9)const setUserProperty = async () => { [](#%5F%5Fcodelineno-7-10) await FirebaseAnalytics.setUserProperty({ [](#%5F%5Fcodelineno-7-11) key: 'language', [](#%5F%5Fcodelineno-7-12) value: 'en', [](#%5F%5Fcodelineno-7-13) }); [](#%5F%5Fcodelineno-7-14)}; [](#%5F%5Fcodelineno-7-15) [](#%5F%5Fcodelineno-7-16)const setCurrentScreen = async () => { [](#%5F%5Fcodelineno-7-17) await FirebaseAnalytics.setCurrentScreen({ [](#%5F%5Fcodelineno-7-18) screenName: 'Login', [](#%5F%5Fcodelineno-7-19) screenClassOverride: 'LoginPage', [](#%5F%5Fcodelineno-7-20) }); [](#%5F%5Fcodelineno-7-21)}; [](#%5F%5Fcodelineno-7-22) [](#%5F%5Fcodelineno-7-23)const logEvent = async () => { [](#%5F%5Fcodelineno-7-24) await FirebaseAnalytics.logEvent({ [](#%5F%5Fcodelineno-7-25) name: 'sign_up', [](#%5F%5Fcodelineno-7-26) params: { method: 'password' }, [](#%5F%5Fcodelineno-7-27) }); [](#%5F%5Fcodelineno-7-28)}; [](#%5F%5Fcodelineno-7-29) [](#%5F%5Fcodelineno-7-30)const setSessionTimeoutDuration = async () => { [](#%5F%5Fcodelineno-7-31) await FirebaseAnalytics.setSessionTimeoutDuration({ [](#%5F%5Fcodelineno-7-32) duration: '120', [](#%5F%5Fcodelineno-7-33) }); [](#%5F%5Fcodelineno-7-34)}; [](#%5F%5Fcodelineno-7-35) [](#%5F%5Fcodelineno-7-36)const setEnabled = async () => { [](#%5F%5Fcodelineno-7-37) await FirebaseAnalytics.setEnabled({ [](#%5F%5Fcodelineno-7-38) enabled: true, [](#%5F%5Fcodelineno-7-39) }); [](#%5F%5Fcodelineno-7-40)}; [](#%5F%5Fcodelineno-7-41) [](#%5F%5Fcodelineno-7-42)const isEnabled = async () => { [](#%5F%5Fcodelineno-7-43) const { enabled } = await FirebaseAnalytics.isEnabled(); [](#%5F%5Fcodelineno-7-44) return enabled; [](#%5F%5Fcodelineno-7-45)}; [](#%5F%5Fcodelineno-7-46) [](#%5F%5Fcodelineno-7-47)const resetAnalyticsData = async () => { [](#%5F%5Fcodelineno-7-48) await FirebaseAnalytics.resetAnalyticsData(); [](#%5F%5Fcodelineno-7-49)}; [](#%5F%5Fcodelineno-7-50) [](#%5F%5Fcodelineno-7-51)const initiateOnDeviceConversionMeasurementWithEmailAddress = async () => { [](#%5F%5Fcodelineno-7-52) await FirebaseAnalytics.initiateOnDeviceConversionMeasurementWithEmailAddress({ [](#%5F%5Fcodelineno-7-53) emailAddress: 'mail@example.com', [](#%5F%5Fcodelineno-7-54) }); [](#%5F%5Fcodelineno-7-55)}; [](#%5F%5Fcodelineno-7-56) [](#%5F%5Fcodelineno-7-57)const initiateOnDeviceConversionMeasurementWithPhoneNumber = async () => { [](#%5F%5Fcodelineno-7-58) await FirebaseAnalytics.initiateOnDeviceConversionMeasurementWithPhoneNumber({ [](#%5F%5Fcodelineno-7-59) phoneNumber: '+49123456789', [](#%5F%5Fcodelineno-7-60) }); [](#%5F%5Fcodelineno-7-61)}; [](#%5F%5Fcodelineno-7-62) [](#%5F%5Fcodelineno-7-63)const initiateOnDeviceConversionMeasurementWithHashedEmailAddress = async () => { [](#%5F%5Fcodelineno-7-64) await FirebaseAnalytics.initiateOnDeviceConversionMeasurementWithHashedEmailAddress({ [](#%5F%5Fcodelineno-7-65) emailAddressToHash: 'mail@example.com', [](#%5F%5Fcodelineno-7-66) }); [](#%5F%5Fcodelineno-7-67)}; [](#%5F%5Fcodelineno-7-68) [](#%5F%5Fcodelineno-7-69)const initiateOnDeviceConversionMeasurementWithHashedPhoneNumber = async () => { [](#%5F%5Fcodelineno-7-70) await FirebaseAnalytics.initiateOnDeviceConversionMeasurementWithHashedPhoneNumber({ [](#%5F%5Fcodelineno-7-71) phoneNumberToHash: '+49123456789', [](#%5F%5Fcodelineno-7-72) }); [](#%5F%5Fcodelineno-7-73)}; ` ## API[ΒΆ](#api "Permanent link") * [getAppInstanceId()](#getappinstanceid) * [setConsent(...)](#setconsent) * [setUserId(...)](#setuserid) * [setUserProperty(...)](#setuserproperty) * [setCurrentScreen(...)](#setcurrentscreen) * [logEvent(...)](#logevent) * [setSessionTimeoutDuration(...)](#setsessiontimeoutduration) * [setEnabled(...)](#setenabled) * [isEnabled()](#isenabled) * [resetAnalyticsData()](#resetanalyticsdata) * [logTransaction(...)](#logtransaction) * [initiateOnDeviceConversionMeasurementWithEmailAddress(...)](#initiateondeviceconversionmeasurementwithemailaddress) * [initiateOnDeviceConversionMeasurementWithPhoneNumber(...)](#initiateondeviceconversionmeasurementwithphonenumber) * [initiateOnDeviceConversionMeasurementWithHashedEmailAddress(...)](#initiateondeviceconversionmeasurementwithhashedemailaddress) * [initiateOnDeviceConversionMeasurementWithHashedPhoneNumber(...)](#initiateondeviceconversionmeasurementwithhashedphonenumber) * [Interfaces](#interfaces) * [Enums](#enums) ### getAppInstanceId()[ΒΆ](#getappinstanceid "Permanent link") `[](#%5F%5Fcodelineno-8-1)getAppInstanceId() => Promise ` Retrieves the app instance id. Only available for Android and iOS. **Returns:** `Promise<[GetAppInstanceIdResult](#getappinstanceidresult)>` **Since:** 1.4.0 --- ### setConsent(...)[ΒΆ](#setconsent "Permanent link") `[](#%5F%5Fcodelineno-9-1)setConsent(options: SetConsentOptions) => Promise ` Sets the user's consent mode. | Param | Type | | ----------- | --------------------------------------- | | **options** | [SetConsentOptions](#setconsentoptions) | **Since:** 6.0.0 --- ### setUserId(...)[ΒΆ](#setuserid "Permanent link") `[](#%5F%5Fcodelineno-10-1)setUserId(options: SetUserIdOptions) => Promise ` Sets the user ID property. | Param | Type | | ----------- | ------------------------------------- | | **options** | [SetUserIdOptions](#setuseridoptions) | **Since:** 0.1.0 --- ### setUserProperty(...)[ΒΆ](#setuserproperty "Permanent link") `[](#%5F%5Fcodelineno-11-1)setUserProperty(options: SetUserPropertyOptions) => Promise ` Sets a custom user property to a given value. | Param | Type | | ----------- | ------------------------------------------------- | | **options** | [SetUserPropertyOptions](#setuserpropertyoptions) | **Since:** 0.1.0 --- ### setCurrentScreen(...)[ΒΆ](#setcurrentscreen "Permanent link") `[](#%5F%5Fcodelineno-12-1)setCurrentScreen(options: SetCurrentScreenOptions) => Promise ` Sets the current screen name. | Param | Type | | ----------- | --------------------------------------------------- | | **options** | [SetCurrentScreenOptions](#setcurrentscreenoptions) | **Since:** 0.1.0 --- ### logEvent(...)[ΒΆ](#logevent "Permanent link") `[](#%5F%5Fcodelineno-13-1)logEvent(options: LogEventOptions) => Promise ` Logs an app event. | Param | Type | | ----------- | ----------------------------------- | | **options** | [LogEventOptions](#logeventoptions) | **Since:** 0.1.0 --- ### setSessionTimeoutDuration(...)[ΒΆ](#setsessiontimeoutduration "Permanent link") `[](#%5F%5Fcodelineno-14-1)setSessionTimeoutDuration(options: SetSessionTimeoutDurationOptions) => Promise ` Sets the duration of inactivity that terminates the current session. Only available for Android and iOS. | Param | Type | | ----------- | --------------------------------------------------------------------- | | **options** | [SetSessionTimeoutDurationOptions](#setsessiontimeoutdurationoptions) | **Since:** 0.1.0 --- ### setEnabled(...)[ΒΆ](#setenabled "Permanent link") `[](#%5F%5Fcodelineno-15-1)setEnabled(options: SetEnabledOptions) => Promise ` Enables/disables automatic data collection. The value does not apply until the next run of the app. | Param | Type | | ----------- | --------------------------------------- | | **options** | [SetEnabledOptions](#setenabledoptions) | **Since:** 0.1.0 --- ### isEnabled()[ΒΆ](#isenabled "Permanent link") `[](#%5F%5Fcodelineno-16-1)isEnabled() => Promise ` Returns whether or not automatic data collection is enabled. Only available for Web. **Returns:** `Promise<[IsEnabledResult](#isenabledresult)>` **Since:** 0.1.0 --- ### resetAnalyticsData()[ΒΆ](#resetanalyticsdata "Permanent link") `[](#%5F%5Fcodelineno-17-1)resetAnalyticsData() => Promise ` Clears all analytics data for this app from the device. Resets the app instance id. Only available for Android and iOS. **Since:** 0.1.0 --- ### logTransaction(...)[ΒΆ](#logtransaction "Permanent link") `[](#%5F%5Fcodelineno-18-1)logTransaction(options: LogTransactionOptions) => Promise ` Logs a StoreKit 2 transaction. Only available for iOS (15.0+). | Param | Type | | ----------- | ----------------------------------------------- | | **options** | [LogTransactionOptions](#logtransactionoptions) | **Since:** 8.2.0 --- ### initiateOnDeviceConversionMeasurementWithEmailAddress(...)[ΒΆ](#initiateondeviceconversionmeasurementwithemailaddress "Permanent link") `[](#%5F%5Fcodelineno-19-1)initiateOnDeviceConversionMeasurementWithEmailAddress(options: InitiateOnDeviceConversionMeasurementWithEmailAddressOptions) => Promise ` Initiates on-device conversion measurement with an email address. Only available for iOS. | Param | Type | | ----------- | ----------------------------------------------------------------------------------------------------------------------------- | | **options** | [InitiateOnDeviceConversionMeasurementWithEmailAddressOptions](#initiateondeviceconversionmeasurementwithemailaddressoptions) | **Since:** 7.2.0 --- ### initiateOnDeviceConversionMeasurementWithPhoneNumber(...)[ΒΆ](#initiateondeviceconversionmeasurementwithphonenumber "Permanent link") `[](#%5F%5Fcodelineno-20-1)initiateOnDeviceConversionMeasurementWithPhoneNumber(options: InitiateOnDeviceConversionMeasurementWithPhoneNumberOptions) => Promise ` Initiates on-device conversion measurement with a phone number. Only available for iOS. | Param | Type | | ----------- | --------------------------------------------------------------------------------------------------------------------------- | | **options** | [InitiateOnDeviceConversionMeasurementWithPhoneNumberOptions](#initiateondeviceconversionmeasurementwithphonenumberoptions) | **Since:** 7.2.0 --- ### initiateOnDeviceConversionMeasurementWithHashedEmailAddress(...)[ΒΆ](#initiateondeviceconversionmeasurementwithhashedemailaddress "Permanent link") `[](#%5F%5Fcodelineno-21-1)initiateOnDeviceConversionMeasurementWithHashedEmailAddress(options: InitiateOnDeviceConversionMeasurementWithHashedEmailAddressOptions) => Promise ` Initiates on-device conversion measurement with a hashed email address. Only available for iOS. | Param | Type | | ----------- | ----------------------------------------------------------------------------------------------------------------------------------------- | | **options** | [InitiateOnDeviceConversionMeasurementWithHashedEmailAddressOptions](#initiateondeviceconversionmeasurementwithhashedemailaddressoptions) | **Since:** 7.2.0 --- ### initiateOnDeviceConversionMeasurementWithHashedPhoneNumber(...)[ΒΆ](#initiateondeviceconversionmeasurementwithhashedphonenumber "Permanent link") `[](#%5F%5Fcodelineno-22-1)initiateOnDeviceConversionMeasurementWithHashedPhoneNumber(options: InitiateOnDeviceConversionMeasurementWithHashedPhoneNumberOptions) => Promise ` Initiates on-device conversion measurement with a hashed phone number. Only available for iOS. | Param | Type | | ----------- | --------------------------------------------------------------------------------------------------------------------------------------- | | **options** | [InitiateOnDeviceConversionMeasurementWithHashedPhoneNumberOptions](#initiateondeviceconversionmeasurementwithhashedphonenumberoptions) | **Since:** 7.2.0 --- ### Interfaces[ΒΆ](#interfaces "Permanent link") #### GetAppInstanceIdResult[ΒΆ](#getappinstanceidresult "Permanent link") | Prop | Type | Description | Since | | ----------------- | ------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----- | | **appInstanceId** | string | The app instance id. Not defined if FirebaseAnalytics.ConsentType.ANALYTICS\_STORAGE has been set to FirebaseAnalytics.ConsentStatus.DENIED. | 1.4.0 | #### SetConsentOptions[ΒΆ](#setconsentoptions "Permanent link") | Prop | Type | Description | Since | | ---------- | ------------------------------- | ------------------- | ----- | | **type** | [ConsentType](#consenttype) | The consent type. | 6.0.0 | | **status** | [ConsentStatus](#consentstatus) | The consent status. | 6.0.0 | #### SetUserIdOptions[ΒΆ](#setuseridoptions "Permanent link") | Prop | Type | Since | | ---------- | -------------- | ----- | | **userId** | string \| null | 0.1.0 | #### SetUserPropertyOptions[ΒΆ](#setuserpropertyoptions "Permanent link") | Prop | Type | Since | | --------- | -------------- | ----- | | **key** | string | 0.1.0 | | **value** | string \| null | 0.1.0 | #### SetCurrentScreenOptions[ΒΆ](#setcurrentscreenoptions "Permanent link") | Prop | Type | Description | Default | Since | | ----------------------- | -------------- | ----------------------------------- | ------- | ----- | | **screenName** | string \| null | 0.1.0 | | | | **screenClassOverride** | string \| null | Only available for Android and iOS. | null | 0.1.0 | #### LogEventOptions[ΒΆ](#logeventoptions "Permanent link") | Prop | Type | Description | Since | | ---------- | ------------------------- | -------------------------- | ----- | | **name** | string | The event name. | 0.1.0 | | **params** | { \[key: string\]: any; } | The optional event params. | 0.1.0 | #### SetSessionTimeoutDurationOptions[ΒΆ](#setsessiontimeoutdurationoptions "Permanent link") | Prop | Type | Description | Default | Since | | ------------ | ------ | -------------------- | ------- | ----- | | **duration** | number | Duration in seconds. | 1800 | 0.1.0 | #### SetEnabledOptions[ΒΆ](#setenabledoptions "Permanent link") | Prop | Type | Since | | ----------- | ------- | ----- | | **enabled** | boolean | 0.1.0 | #### IsEnabledResult[ΒΆ](#isenabledresult "Permanent link") | Prop | Type | Since | | ----------- | ------- | ----- | | **enabled** | boolean | 0.1.0 | #### LogTransactionOptions[ΒΆ](#logtransactionoptions "Permanent link") | Prop | Type | Description | Since | | ----------------- | ------ | -------------------------------------------------------- | ----- | | **transactionId** | string | The StoreKit 2 Transaction.id value as a numeric string. | 8.2.0 | #### InitiateOnDeviceConversionMeasurementWithEmailAddressOptions[ΒΆ](#initiateondeviceconversionmeasurementwithemailaddressoptions "Permanent link") | Prop | Type | Description | Since | | ---------------- | ------ | -------------------------------------------------------------------- | ----- | | **emailAddress** | string | The email address to initiate on-device conversion measurement with. | 7.2.0 | #### InitiateOnDeviceConversionMeasurementWithPhoneNumberOptions[ΒΆ](#initiateondeviceconversionmeasurementwithphonenumberoptions "Permanent link") | Prop | Type | Description | Since | | --------------- | ------ | ------------------------------------------------------------------- | ----- | | **phoneNumber** | string | The phone number to initiate on-device conversion measurement with. | 7.2.0 | #### InitiateOnDeviceConversionMeasurementWithHashedEmailAddressOptions[ΒΆ](#initiateondeviceconversionmeasurementwithhashedemailaddressoptions "Permanent link") | Prop | Type | Description | Since | | ---------------------- | ------ | -------------------------------------------------------------------- | ----- | | **emailAddressToHash** | string | The email address to initiate on-device conversion measurement with. | 7.2.0 | #### InitiateOnDeviceConversionMeasurementWithHashedPhoneNumberOptions[ΒΆ](#initiateondeviceconversionmeasurementwithhashedphonenumberoptions "Permanent link") | Prop | Type | Description | Since | | --------------------- | ------ | ------------------------------------------------------------------- | ----- | | **phoneNumberToHash** | string | The phone number to initiate on-device conversion measurement with. | 7.2.0 | ### Enums[ΒΆ](#enums "Permanent link") #### ConsentType[ΒΆ](#consenttype "Permanent link") | Members | Value | Since | | -------------------------- | -------------------------- | ----- | | **AdPersonalization** | 'AD\_PERSONALIZATION' | 6.0.0 | | **AdStorage** | 'AD\_STORAGE' | 6.0.0 | | **AdUserData** | 'AD\_USER\_DATA' | 6.0.0 | | **AnalyticsStorage** | 'ANALYTICS\_STORAGE' | 6.0.0 | | **FunctionalityStorage** | 'FUNCTIONALITY\_STORAGE' | 6.0.0 | | **PersonalizationStorage** | 'PERSONALIZATION\_STORAGE' | 6.0.0 | #### ConsentStatus[ΒΆ](#consentstatus "Permanent link") | Members | Value | Since | | ----------- | --------- | ----- | | **Granted** | 'GRANTED' | 6.0.0 | | **Denied** | 'DENIED' | 6.0.0 | ## Test your implementation[ΒΆ](#test-your-implementation "Permanent link") [Here](https://firebase.google.com/docs/analytics/debugview) you can find more information on how to test the Firebase Analytics implementation using the **DebugView**. ## Changelog[ΒΆ](#changelog "Permanent link") See [CHANGELOG.md](https://github.com/capawesome-team/capacitor-firebase/blob/main/packages/analytics/CHANGELOG.md). ## License[ΒΆ](#license "Permanent link") See [LICENSE](https://github.com/capawesome-team/capacitor-firebase/blob/main/packages/analytics/LICENSE). --- 1. This project is not affiliated with, endorsed by, sponsored by, or approved by Google LLC or any of their affiliates or subsidiaries. [↩](#fnref:1 "Jump back to footnote 1 in the text") May 21, 2026 Back to top