Firebase

Follow the steps in this section to add Firebase to your Kotlin project.

1. Project setup

See the Firebase documentation for more information on setting up your project.

1. Register your mobile app in the Firebase console.
2. Once you have successfully created the app in the Firebase console, you will be prompted to download the google-services.json file.
3. Copy this file in the app folder of your project. It contains all necessary information about the project and the integration.
4. To make the values in your google-services.json config file accessible to the Firebase SDK, you will need the Google services Gradle plugin (google-services).

• In your root-level (project-level) Gradle file (<project>/build.gradle.kts or <project>/build.gradle), add the Google services plugin as a dependency:

Kotlin DSL (build.gradle.kts)

plugins {
  // Add the dependency for the Google services Gradle plugin
  id("com.google.gms.google-services") version "4.4.2" apply false
}

Groovy DSL (build.gradle)

plugins {
  // Add the dependency for the Google services Gradle plugin
  id 'com.google.gms.google-services' version '4.4.2' apply false
}

• In your module (app-level) Gradle file (usually <project>/<app-module>/build.gradle.kts or <project>/<app-module>/build.gradle), add the Google services plugin:

Kotlin DSL (build.gradle.kts)

plugins {
  // Add the Google services Gradle plugin
  id("com.google.gms.google-services")
}

Groovy DSL (build.gradle)

plugins {
  // Add the Google services Gradle plugin
  id 'com.google.gms.google-services'
}

2. Add dependencies

In your module (app-level) Gradle file (usually <project>/<app-module>/build.gradle.kts or <project>/<app-module>/build.gradle), add the dependencies for the RudderStack Firebase integration:

dependencies {
  // ...
  
  // Add Rudder Kotlin and Firebase integration:
  implementation("com.rudderstack.sdk.kotlin:android:<latest-version>")
  implementation("com.rudderstack.integration.kotlin:firebase:<latest-version>")

  // Add Firebase dependencies:
  // Import the Firebase BoM
  implementation(platform("com.google.firebase:firebase-bom:33.7.0"))

  // When using the BoM, you don't specify versions in Firebase library dependencies

  // Add the dependency for the Firebase SDK for Google Analytics
  implementation("com.google.firebase:firebase-analytics")
}

3. Initialize the SDK and integration

Add the SDK initialization and the Rudder-Firebase integration in your Application class:

import android.app.Application
import com.rudderstack.sdk.kotlin.android.Analytics
import com.rudderstack.sdk.kotlin.android.Configuration
import com.rudderstack.integration.kotlin.firebase.FirebaseIntegration

class MyApplication : Application() {
    lateinit var analytics: Analytics

    override fun onCreate() {
        super.onCreate()
        analytics = Analytics(
            configuration = Configuration(
                writeKey = "WRITE_KEY",
                application = this,
                dataPlaneUrl = "DATA_PLANE_URL",
            )
        )
        
        analytics.add(FirebaseIntegration())
    }
}

Add Firebase to your iOS project

1. Register your app in the Firebase console. It will then prompt you to download the GoogleServices-Info.plist file.

2. Add the GoogleServices-Info.plist file to the root of your XCode project.

Integrate the Firebase SDK with your project

1. In Xcode, select File > Add Package Dependencies….

2. Enter the below package repository URL in the search bar:

https://github.com/rudderlabs/integration-swift-firebase/

3. Select the latest version and the target to which you want to add the package.
4. Click Add Package.

Alternatively, you can add the dependency to your Package.swift file, as shown:

dependencies: [
    .package(url: "<https://github.com/rudderlabs/integration-swift-firebase.git>", from: "<latest_integration_version>")
]

Usage

1. Import the SDK and integration:

import RudderStackAnalytics
import RudderIntegrationFirebase

2. Add FirebaseIntegration to your analytics instance:

// Initialize RudderStack Analytics
let analytics = Analytics(
    configuration: Configuration(
        writeKey: "<WRITE_KEY>",
        dataPlaneUrl: "<DATA_PLANE_URL>"
    )
)

// Add Firebase Integration
analytics.add(plugin: FirebaseIntegration())

Follow these steps to add Firebase to your Unity project:

1. Register your project in the Firebase Console. Currently, RudderStack supports only Android and iOS platforms for Unity.
2. After adding the project, Firebase will prompt you to download the google-services.json for Android and GoogleServices-Info.plist for iOS.
3. Add those two files to your project’s Assets folder.
4. Integrate the RudderStack core SDK with your project. For more information, refer to the Unity SDK documentation.
5. Download and import the Firebase Unity SDK and follow the instructions to add the Firebase SDK (specifically, FirebaseAnalytics.unitypackage) to your project.
6. Download the RudderStack Firebase Extension from the GitHub page and import it in your project.
7. Attach the RudderPreferbs.prefab file from Rudder to your main GameObject
8. Finally, change the SDK initialization using the following code snippet:

// Build your config
RudderConfigBuilder configBuilder = new RudderConfigBuilder()
    .WithEndPointUrl(<data_plane_url>)
    .WithFactory(RudderFirebaseIntegrationFactory.GetFactory());

// get instance for RudderClient
RudderClient rudderClient = RudderClient.GetInstance(
    <source_write_key>,
    configBuilder.Build()
);

Note the following:

• Starting with v3.0.0, the React Native SDK supports the new React Native architecture.
• RudderStack recommends using the latest version of the Firebase React Native device mode to get the latest updates and performance enhancements.

1. Register your Android and iOS applications in the Firebase console.
2. Once you have successfully created the applications in the Firebase console, you will be prompted to download the google-services.json and GoogleServices-Info.plist files.
3. Add the RudderStack React Native SDK to your app by referring to the React Native SDK documentation.
4. Add the RudderStack-Firebase React Native module to your app using the following command:

npm install @rudderstack/rudder-integration-firebase-react-native
// OR //
yarn add @rudderstack/rudder-integration-firebase-react-native

5. Next, import the module you added above and add it to your SDK initialization code as shown:

import rudderClient from '@rudderstack/rudder-sdk-react-native';
import firebase from "@rudderstack/rudder-integration-firebase-react-native";

const config = {
    dataPlaneUrl: <data_plane_url>,
    trackAppLifecycleEvents: true,
    withFactories: [firebase]
};

rudderClient.setup(<source_write_key>, config);

6. Navigate to your app’s android folder and follow the steps below:

• Copy the google-services.json file in the app folder of your Android project. This file contains all necessary information about the project and the integration.
• Add the classpath under dependencies to your project level build.gradle file:

buildscript {
  repositories {
    google()
  }
  dependencies {
    // add this line
    classpath 'com.google.gms:google-services:4.3.3'
  }
}

• Once you have completed the steps above, you can add the plugins and dependencies to your app/build.gradle file:

apply plugin: 'com.android.application'
apply plugin: 'com.google.gms.google-services'

• Then, add the necessary permissions under AndroidManifest.xml:

<uses-permission android:name="android.permission.INTERNET"></uses-permission>
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE"></uses-permission>

7. For React-Native Firebase version 1.0.16 and above, if you encounter any static libraries issue while installing the Rudder-Firebase pods, add the below lines in your iOS app’s Podfile:

pod 'FirebaseCore', :modular_headers => true
pod 'GoogleUtilities', :modular_headers => true

8. Finally, navigate to your app’s iOS folder and follow these steps:

• Install all required pods using the pod install command.
• Add the GoogleServices-Info.plist file to the root of your XCode project.

Follow the below steps to add Firebase to your Flutter Project:

1. Add the following dependency to the dependencies section of your pubspec.yaml file.

rudder_integration_firebase_flutter: ^1.0.1

2. Run the below command to install the dependency added in the above step:

flutter pub get

3. Import the RudderIntegrationFirebaseFlutter in your application where you are initializing the SDK.

import 'package:rudder_integration_firebase_flutter/rudder_integration_firebase_flutter.dart';

4. Change the initialization of your RudderClient as shown:

final RudderController rudderClient = RudderController.instance;
RudderConfigBuilder builder = RudderConfigBuilder();
builder.withFactory(RudderIntegrationFirebaseFlutter());
rudderClient.initialize(<write_key>, config: builder.build(), options: null);

5. Navigate to your app’s android folder and follow the below steps:

• Copy the google-services.json file in the app folder of your Android project. This file contains all necessary information about the project and the integration.
• Add the classpath under dependencies to your project level build.gradle file:

buildscript {
  repositories {
    google()
  }
  dependencies {
    // add this line
    classpath 'com.google.gms:google-services:4.3.3'
  }
}

• Add mavenCentral() as a repository under buildscript.repositories and allprojects.repositories to your project level build.gradle file:

buildscript {
  repositories {
    google()
    // should be added
    mavenCentral()
  }
  dependencies {
    classpath 'com.google.gms:google-services:4.3.3'
  }
}
allprojects {
  repositories {
      google()
      // should be added
      mavenCentral()
  }
}

• Next, add the plugins and dependencies to your app/build.gradle file:

apply plugin: 'com.android.application'
apply plugin: 'com.google.gms.google-services'

• Add the necessary permissions under AndroidManifest.xml:

<uses-permission android:name="android.permission.INTERNET"></uses-permission>
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE"></uses-permission>

6. Finally, navigate to your app’s iOS folder and add the GoogleServices-Info.plist file to the root of your XCode project.

Use the latest version of the Firebase Android device mode to get the latest updates, bug fixes, and performance enhancements.

1. Register your mobile app in the Firebase console.
2. Once you have successfully created the app in the Firebase console, you will be prompted to download the google-services.json file.
3. Copy this file in the app folder of your project. It contains all necessary information about the project and the integration.
4. Add the classpath under dependencies to your project level build.gradle:

buildscript {
  repositories {
    google()
  }
  dependencies {
    // add this line
    classpath 'com.google.gms:google-services:4.3.3'
  }
}

5. Now, you can add the plugins and dependencies to your app/build.gradle file:

apply plugin: 'com.android.application'
apply plugin: 'com.google.gms.google-services'

6. Then, add the mavenCentral repository:

repositories {
  mavenCentral()
}

7. Add the RudderStack-Firebase SDK extension along with the core SDK under dependencies:

implementation 'com.rudderstack.android.sdk:core:1.+'
implementation 'com.rudderstack.android.integration:firebase:2.+'

//Firebase
implementation platform('com.google.firebase:firebase-bom:28.4.2')
implementation 'com.google.firebase:firebase-analytics'

8. Next, add the necessary permissions under AndroidManifest.xml:

<uses-permission android:name="android.permission.INTERNET"></uses-permission>
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE"></uses-permission>

9. Finally, change the SDK initialization in your Application class:

// initialize Rudder SDK
val rudderClient =
    RudderClient.getInstance(
        this,
        WRITE_KEY,
        RudderConfig.Builder()
            .withDataPlaneUrl(DATA_PLANE_URL)
            .withFactory(FirebaseIntegrationFactory.FACTORY)
            .build()
    )

If you’re using the Firebase iOS device mode v1.0.2, update to the latest version to get the latest updates, bug fixes, and performance enhancements.

1. Register your app in the Firebase console. It will then prompt you to download the GoogleServices-Info.plist file.
2. Add the file to the root of your XCode project.
3. Go to your Podfile and add the Rudder-Firebase extension along with the core SDK using the following code:

pod 'Rudder-Firebase', '~> 2.0.5'

Rudder-Firebase version 2.0.5 is tested and fully compatible with Firebase/Analytics version 8.15.0.

#import "RudderFirebaseFactory.h"

5. Finally, change the SDK initialization, as shown in the following snippet:

RSConfigBuilder *builder = [[RSConfigBuilder alloc] init];
[builder withDataPlaneUrl:<data_plane_url>];
[builder withFactory:[RudderFirebaseFactory instance]];
[builder withLoglevel:RSLogLevelDebug];
[RSClient getInstance:<write_key> config:[builder build]];

This device mode integration is supported for Firebase v8.15.0 and above.

1. Add Firebase as a destination in the RudderStack dashboard.
2. Register your app in the Firebase console. It will then prompt you to download the GoogleServices-Info.plist file.
3. Download and place this file in your project.
4. Install RudderFirebase (available through CocoaPods) by adding the following line to your Podfile:

pod 'RudderFirebase', '~> 1.0.0'

5. Run the pod install command.
6. Then, import the SDK depending on your preferred platform:

import RudderFirebase

@import RudderFirebase;

7. Next, add the imports to your AppDelegate file under the didFinishLaunchingWithOptions method:

RSConfig *config = [[RSConfig alloc] initWithWriteKey:WRITE_KEY];
[config dataPlaneURL:DATA_PLANE_URL];
[[RSClient sharedInstance] configureWith:config];
[[RSClient sharedInstance] addDestination:[[RudderFirebaseDestination alloc] init]];

let config: RSConfig = RSConfig(writeKey: WRITE_KEY)
            .dataPlaneURL(DATA_PLANE_URL)
RSClient.sharedInstance().configure(with: config)
RSClient.sharedInstance().addDestination(RudderFirebaseDestination())