@capacitor-firebase/analytics
v8.0.1TypeScript
Capacitor plugin for Firebase Analytics.
0/weekUpdated 1 months agoApache-2.0Unpacked: 148.1 KB
Published by Robin Genz
npm install @capacitor-firebase/analytics@capacitor-firebase/analytics
Unofficial Capacitor plugin for Firebase Analytics.[^1]
Compatibility
| 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
``bash`
npm install @capacitor-firebase/analytics firebase
npx cap sync
Add Firebase to your project if you haven't already (Android / iOS / Web).
$3
#### Disable Analytics data collection
See Disable Analytics data collection if you want to disable Analytics data collection.
#### Disable Advertising ID collection
See Disable Advertising ID collection if you want to disable Advertising ID collection.
#### Variables
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.
$3
If you are using CocoaPods for your iOS project, you need to add the CapacitorFirebaseAnalytics/Analytics pod to your Podfile (usually ios/App/Podfile):
`diff`
target 'App' do
capacitor_podsAdd your Pods here
+ pod 'CapacitorFirebaseAnalytics/Analytics', :path => '../../node_modules/@capacitor-firebase/analytics'
end
Attention: Do not add the pod in the section def capacitor_pods, but under the comment # Add your Pods here (example).
#### Disable Analytics data collection
See Disable Analytics data collection if you want to disable Analytics data collection.
#### Disable IDFA collection
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:
`diff`
target 'App' do
capacitor_podsAdd your Pods here
- pod 'CapacitorFirebaseAnalytics/Analytics', :path => '../../node_modules/@capacitor-firebase/analytics'
+ pod 'CapacitorFirebaseAnalytics/AnalyticsWithoutAdIdSupport', :path => '../../node_modules/@capacitor-firebase/analytics'
end
Configuration
No configuration required for this plugin.
Demo
A working example can be found here: robingenz/capacitor-firebase-plugin-demo
Usage
`typescript
import { FirebaseAnalytics } from '@capacitor-firebase/analytics';
const setUserId = async () => {
await FirebaseAnalytics.setUserId({
userId: '123',
});
};
const setUserProperty = async () => {
await FirebaseAnalytics.setUserProperty({
key: 'language',
value: 'en',
});
};
const setCurrentScreen = async () => {
await FirebaseAnalytics.setCurrentScreen({
screenName: 'Login',
screenClassOverride: 'LoginPage',
});
};
const logEvent = async () => {
await FirebaseAnalytics.logEvent({
name: 'sign_up',
params: { method: 'password' },
});
};
const setSessionTimeoutDuration = async () => {
await FirebaseAnalytics.setSessionTimeoutDuration({
duration: '120',
});
};
const setEnabled = async () => {
await FirebaseAnalytics.setEnabled({
enabled: true,
});
};
const isEnabled = async () => {
const { enabled } = await FirebaseAnalytics.isEnabled();
return enabled;
};
const resetAnalyticsData = async () => {
await FirebaseAnalytics.resetAnalyticsData();
};
const initiateOnDeviceConversionMeasurementWithEmailAddress = async () => {
await FirebaseAnalytics.initiateOnDeviceConversionMeasurementWithEmailAddress({
emailAddress: 'mail@example.com',
});
};
const initiateOnDeviceConversionMeasurementWithPhoneNumber = async () => {
await FirebaseAnalytics.initiateOnDeviceConversionMeasurementWithPhoneNumber({
phoneNumber: '+49123456789',
});
};
const initiateOnDeviceConversionMeasurementWithHashedEmailAddress = async () => {
await FirebaseAnalytics.initiateOnDeviceConversionMeasurementWithHashedEmailAddress({
emailAddressToHash: 'mail@example.com',
});
};
const initiateOnDeviceConversionMeasurementWithHashedPhoneNumber = async () => {
await FirebaseAnalytics.initiateOnDeviceConversionMeasurementWithHashedPhoneNumber({
phoneNumberToHash: '+49123456789',
});
};
`
API
* getAppInstanceId()
* setConsent(...)
* setUserId(...)
* setUserProperty(...)
* setCurrentScreen(...)
* logEvent(...)
* setSessionTimeoutDuration(...)
* setEnabled(...)
* isEnabled()
* resetAnalyticsData()
* initiateOnDeviceConversionMeasurementWithEmailAddress(...)
* initiateOnDeviceConversionMeasurementWithPhoneNumber(...)
* initiateOnDeviceConversionMeasurementWithHashedEmailAddress(...)
* initiateOnDeviceConversionMeasurementWithHashedPhoneNumber(...)
* Interfaces
* Enums
$3
`typescript`
getAppInstanceId() => Promise
Retrieves the app instance id.
Only available for Android and iOS.
Returns: Promise<GetAppInstanceIdResult>
Since: 1.4.0
--------------------
$3
`typescript`
setConsent(options: SetConsentOptions) => Promise
Sets the user's consent mode.
| Param | Type |
| ------------- | --------------------------------------------------------------- |
| options | SetConsentOptions |
Since: 6.0.0
--------------------
$3
`typescript`
setUserId(options: SetUserIdOptions) => Promise
Sets the user ID property.
| Param | Type |
| ------------- | ------------------------------------------------------------- |
| options | SetUserIdOptions |
Since: 0.1.0
--------------------
$3
`typescript`
setUserProperty(options: SetUserPropertyOptions) => Promise
Sets a custom user property to a given value.
| Param | Type |
| ------------- | ------------------------------------------------------------------------- |
| options | SetUserPropertyOptions |
Since: 0.1.0
--------------------
$3
`typescript`
setCurrentScreen(options: SetCurrentScreenOptions) => Promise
Sets the current screen name.
| Param | Type |
| ------------- | --------------------------------------------------------------------------- |
| options | SetCurrentScreenOptions |
Since: 0.1.0
--------------------
$3
`typescript`
logEvent(options: LogEventOptions) => Promise
Logs an app event.
| Param | Type |
| ------------- | ----------------------------------------------------------- |
| options | LogEventOptions |
Since: 0.1.0
--------------------
$3
`typescript`
setSessionTimeoutDuration(options: SetSessionTimeoutDurationOptions) => Promise
Sets the duration of inactivity that terminates the current session.
Only available for Android and iOS.
| Param | Type |
| ------------- | --------------------------------------------------------------------------------------------- |
| options | SetSessionTimeoutDurationOptions |
Since: 0.1.0
--------------------
$3
`typescript`
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 |
Since: 0.1.0
--------------------
$3
`typescript`
isEnabled() => Promise
Returns whether or not automatic data collection is enabled.
Only available for Web.
Returns: Promise<IsEnabledResult>
Since: 0.1.0
--------------------
$3
`typescript`
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
--------------------
$3
`typescript`
initiateOnDeviceConversionMeasurementWithEmailAddress(options: InitiateOnDeviceConversionMeasurementWithEmailAddressOptions) => Promise
Initiates on-device conversion measurement with an email address.
Only available for iOS.
| Param | Type |
| ------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
| options | InitiateOnDeviceConversionMeasurementWithEmailAddressOptions |
Since: 7.2.0
--------------------
$3
`typescript`
initiateOnDeviceConversionMeasurementWithPhoneNumber(options: InitiateOnDeviceConversionMeasurementWithPhoneNumberOptions) => Promise
Initiates on-device conversion measurement with a phone number.
Only available for iOS.
| Param | Type |
| ------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |
| options | InitiateOnDeviceConversionMeasurementWithPhoneNumberOptions |
Since: 7.2.0
--------------------
$3
`typescript`
initiateOnDeviceConversionMeasurementWithHashedEmailAddress(options: InitiateOnDeviceConversionMeasurementWithHashedEmailAddressOptions) => Promise
Initiates on-device conversion measurement with a hashed email address.
Only available for iOS.
| Param | Type |
| ------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| options | InitiateOnDeviceConversionMeasurementWithHashedEmailAddressOptions |
Since: 7.2.0
--------------------
$3
`typescript`
initiateOnDeviceConversionMeasurementWithHashedPhoneNumber(options: InitiateOnDeviceConversionMeasurementWithHashedPhoneNumberOptions) => Promise
Initiates on-device conversion measurement with a hashed phone number.
Only available for iOS.
| Param | Type |
| ------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| options | InitiateOnDeviceConversionMeasurementWithHashedPhoneNumberOptions |
Since: 7.2.0
--------------------
$3
#### GetAppInstanceIdResult
| 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
| Prop | Type | Description | Since |
| ------------ | ------------------------------------------------------- | ------------------- | ----- |
| type | ConsentType | The consent type. | 6.0.0 |
| status | ConsentStatus | The consent status. | 6.0.0 |
#### SetUserIdOptions
| Prop | Type | Since |
| ------------ | --------------------------- | ----- |
| userId | string \| null | 0.1.0 |
#### SetUserPropertyOptions
| Prop | Type | Since |
| ----------- | --------------------------- | ----- |
| key | string | 0.1.0 |
| value | string \| null | 0.1.0 |
#### SetCurrentScreenOptions
| 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
| Prop | Type | Description | Since |
| ------------ | ------------------------------------ | -------------------------- | ----- |
| name | string | The event name. | 0.1.0 |
| params | { [key: string]: any; } | The optional event params. | 0.1.0 |
#### SetSessionTimeoutDurationOptions
| Prop | Type | Description | Default | Since |
| -------------- | ------------------- | -------------------- | ----------------- | ----- |
| duration | number | Duration in seconds. | 1800 | 0.1.0 |
#### SetEnabledOptions
| Prop | Type | Since |
| ------------- | -------------------- | ----- |
| enabled | boolean | 0.1.0 |
#### IsEnabledResult
| Prop | Type | Since |
| ------------- | -------------------- | ----- |
| enabled | boolean | 0.1.0 |
#### InitiateOnDeviceConversionMeasurementWithEmailAddressOptions
| Prop | Type | Description | Since |
| ------------------ | ------------------- | -------------------------------------------------------------------- | ----- |
| emailAddress | string | The email address to initiate on-device conversion measurement with. | 7.2.0 |
#### InitiateOnDeviceConversionMeasurementWithPhoneNumberOptions
| Prop | Type | Description | Since |
| ----------------- | ------------------- | ------------------------------------------------------------------- | ----- |
| phoneNumber | string | The phone number to initiate on-device conversion measurement with. | 7.2.0 |
#### InitiateOnDeviceConversionMeasurementWithHashedEmailAddressOptions
| Prop | Type | Description | Since |
| ------------------------ | ------------------- | -------------------------------------------------------------------- | ----- |
| emailAddressToHash | string | The email address to initiate on-device conversion measurement with. | 7.2.0 |
#### InitiateOnDeviceConversionMeasurementWithHashedPhoneNumberOptions
| Prop | Type | Description | Since |
| ----------------------- | ------------------- | ------------------------------------------------------------------- | ----- |
| phoneNumberToHash | string | The phone number to initiate on-device conversion measurement with. | 7.2.0 |
$3
#### ConsentType
| 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
| Members | Value | Since |
| ------------- | ---------------------- | ----- |
| Granted | 'GRANTED' | 6.0.0 |
| Denied` | 'DENIED' | 6.0.0 |
Test your implementation
Here you can find more information on how to test the Firebase Analytics implementation using the DebugView.
Changelog
See CHANGELOG.md.
License
See LICENSE.
[^1]: This project is not affiliated with, endorsed by, sponsored by, or approved by Google LLC or any of their affiliates or subsidiaries.