FirebaseSettingsBuilder

public class FirebaseSettingsBuilder : DispatcherSettingsBuilder<FirebaseMappings>

The Firebase module is a Dispatcher module that routes Tealium Prism tracking events to the Firebase Analytics iOS SDK — events, user properties, consent settings, and more. Firebase Analytics only supports a single shared instance, so only one Firebase dispatcher can be active at a time in your app.

Installation/Configuration

The Firebase module can be configured using three different approaches:

Local and Remote Settings

Configure the module using local JSON settings file (via settingsFile parameter) and/or remote settings (via settingsUrl parameter):

var config = TealiumConfig(account: "my_account",
                          profile: "my_profile",
                          environment: "dev",
                          modules: [Modules.firebaseDispatcher(forcingSettings: nil)],
                          settingsFile: "TealiumSettings",
                          settingsUrl: "https://tags.tiqcdn.com/dle/my_account/my_profile/example_settings.json")

Passing nil registers the module factory without enforcing any settings. The factory has to be registered for a settings-driven module to be created at all, while nil keeps its initialization conditional on the local or remote settings.

Default initialization - module will be initialized only if configured in settings file specified:

{
    "modules": {
        "FirebaseDispatcher": {
            "module_type": "FirebaseDispatcher"
        }
    }
}

Custom configuration - module with specific settings:

{
    "modules": {
        "FirebaseDispatcher": {
            "module_type": "FirebaseDispatcher",
            "enabled": true,
            "order": 1,
            "configuration": {
                "session_timeout_seconds": 1800,
                "analytics_collection_enabled": true,
                "log_level": "debug"
            }
        }
    }
}

If a setting is omitted, Firebase uses its own default value. When both local and remote settings are provided, they are deep merged with remote settings taking priority.

Programmatic Configuration

Configure the module programmatically by adding it to the modules parameter in TealiumConfig.

Default initialization - module will be initialized with default settings:

let config = TealiumConfig(account: "my_account",
                          profile: "my_profile",
                          environment: "dev",
                          modules: [
                              Modules.firebaseDispatcher(),
                              // other modules...
                          ])

Custom configuration - module with enforced settings:

let config = TealiumConfig(account: "my_account",
                          profile: "my_profile",
                          environment: "dev",
                          modules: [
                              Modules.firebaseDispatcher(forcingSettings: { builder in
                                  builder.setSessionTimeout(30.minutes)
                                         .setAnalyticsEnabled(true)
                                         .setLogLevel(.min)
                              }),
                              // other modules...
                          ])

⚠️ Important: Programmatic settings are deep merged onto local and remote settings and will always take precedence. Only provide programmatic settings for configuration values that you never want to be changed remotely.

Configuration Options

The Firebase module supports the following configuration options:

Omitted settings are left untouched on the SDK — only explicitly provided values are applied.

Note: Firebase defines FirebaseLoggerLevel.min and .error with the same underlying value, as it does .max and .debug. Programmatic setLogLevel(.min) therefore persists as "error" in the settings payload, and setLogLevel(.max) as "debug". The effect on Firebase is identical.

Settings Builders Reference

The Firebase module uses the FirebaseSettingsBuilder for configuration. This is an extension of the DispatcherSettingsBuilder<FirebaseMappings> which offers common settings like:

• ModuleSettingsBuilder.setEnabled(_:)
• ModuleSettingsBuilder.setOrder(_:)
• RuleModuleSettingsBuilder.setRules(_:)
• DispatcherSettingsBuilder.setMappings(_:)

Firebase-specific methods:

• FirebaseSettingsBuilder.setSessionTimeout(_:) - Set the session timeout duration (e.g. 30.minutes)
• FirebaseSettingsBuilder.setAnalyticsEnabled(_:) - Enable or disable analytics collection
• FirebaseSettingsBuilder.setLogLevel(_:) - Set the Firebase internal log verbosity

Commands

Each command is driven by the FirebaseMappings system, using the type-safe FirebaseCommand and FirebaseDestination enums:

builder.setMappings { mappings in
    mappings.mapCommand(.logEvent).ifValueIn("tealium_event", equals: "log_event")
    mappings.mapFrom("tealium_event", to: .eventName)
    mappings.mapFrom("total", to: .eventParam(AnalyticsParameterValue))
}

See the Mappings guide for the shared mapping concepts, and the per-command guides for the full JSON and programmatic mapping reference — including item formats, consent types, and conversion measurement credential priority.

FirebaseSettingsBuilder

Builder for Firebase Dispatcher configuration settings.

Use this builder to configure Firebase Analytics behavior. For data mappings, use setMappings(_:) with FirebaseMappings type-safe enums.

Available Configuration Options

• setSessionTimeout(_:) - Session timeout duration
• setAnalyticsEnabled(_:) - Enable/disable analytics collection
• setLogLevel(_:) - Firebase internal logging verbosity

Example

Modules.firebaseDispatcher(forcingSettings: { builder in
    builder
        .setSessionTimeout(30.minutes)
        .setAnalyticsEnabled(true)
        .setMappings { mappings in
            mappings.mapCommand(.logEvent)
            mappings.mapFrom("tealium_event", to: .eventName)
        }
})