Analytics Swift Firebase Plugin

In the Xcode File menu, click Add Packages. You'll see a dialog where you can search for Swift packages. In the search field, enter the URL to this repository:

https://github.com/segment-integrations/analytics-swift-firebase

You'll then have the option to pin to a version, or specific branch, as well as which project in your workspace to add it to. Once you've made your selections, click the Add Package button.

Open your Package.swift file and add the following to your dependencies section:

1
.package(
2
            name: "Segment",
3
            url: "https://github.com/segment-integrations/analytics-swift-firebase.git",
4
            from: "1.1.3"
5
        ),

Open the file where you setup and configure the Analytics-Swift library. Add this plugin to the list of imports.

1
import Segment
2
import SegmentFirebase // <-- Add this line

Just under your Analytics-Swift library setup, call analytics.add(plugin: ...) to add an instance of the plugin to the Analytics timeline.

1
let analytics = Analytics(configuration: Configuration(writeKey: "<YOUR WRITE KEY>")
2
                    .flushAt(3)
3
                    .trackApplicationLifecycleEvents(true))
4
analytics.add(plugin: FirebaseDestination())

Your events will now flow to Firebase in device mode.

When you call Identify, Segment maps events and properties to the corresponding Firebase Analytics calls:

• If there is a userId on your Identify call, Segment triggers setUserId using the Firebase SDK
• If there are traits included, Segment will set user properties for each trait you include on the identify call

You can use these traits to create audiences and views to analyze your users' behavior.

Firebase has strict requirements for User Property names. User Property names must:

• Begin with a letter (not a number or symbol, including an underscore)
• Contain only alphanumeric characters and underscores
• Be no longer than 40 characters

User Property values must be fewer than 100 characters.

You are limited to 25 unique user properties per Firebase Console.

Firebase automatically collects these user properties.

When you call Track, Segment logs the event with Firebase and maps from the Segment spec to Firebase's spec. For anything that does not match, Segment will pass the event to Firebase as a custom event. Custom parameters cannot be seen directly in the Firebase Analytics dashboard but they can be used as filters in Audiences.

Firebase automatically tracks the events listed here and will still do so when bundling with Segment.

Like with user properties, Segment performs the following transformations on both your event names and event parameters. Unlike user properties, you do not need to pre-define event parameters in your Firebase dashboard.

• Trims leading and trailing whitespace from property names
• Replaces spaces with underscores
• Trims property names to 40 characters (Android only)

Event parameter values must be fewer than 100 characters.

Segment adheres to Firebase's semantic event specification and maps the following Segment spec-matching events (left) to the corresponding Firebase events (right):

Segment maps the followed Segment spec-matching properties (left) to the corresponding Firebase event parameters (right):

Ecommerce events containing "revenue" or "total" must also include the appropriate ISO 4217 "currency" string for revenue data to populate to the Firebase dashboard. If a "currency" value is not included, Segment default to "USD".

1
Properties properties = new Properties()
2
        .putValue("orderId", "p966540")
3
        .putValue("revenue", 25.00)
4
        .putCurrency("USD");
5

6

7
Analytics.with(this).track("Order Completed", properties);

1
struct TrackProperties: Codable {
2
        let orderId: String
3
        let revenue: Int
4
        let currency: String
5
}
6

7
analytics.track(name: "Order Completed", properties: TrackProperties(orderId: "order-123", revenue: 23.00, currency: "USD"))

Segment doesn't map Screen events to Firebase, because Firebase's SDK collects screen information out of the box for you.

For iOS, you can configure recordScreenViews which will automatically track screen views, or pass in a screen manually using a Screen call. You should be able to disable the Automatic Screen reporting by adding the plist flag FirebaseScreenReportingEnabled to Info.plist and set its value to NO (Boolean).

Google Analytics for Firebase iOS does NOT support the case of manual-only screen reporting. Firebase only supports automatic + manual screen reporting or no screen reporting at all.

Firebase Dynamic Links are smart URLs that can change behavior dynamically depending on the platform where the user clicks them. Use them in web, email, social media, referral and physical promotions to increase user acquisition, retention and lifetime value. Key features include ability to survive app installs, controlling user experience depending on what platform they access the link on and knowing which content and campaigns are working using tracking in the Firebase console. Check out Firebase's Docs here.

To use Firebase Dynamic Links, search for the Firebase package in Swift Package Manager and add the Dynamic Links library:

https://github.com/firebase/firebase-ios-sdk

Then, enter the deep link URL scheme in your Segment Firebase destination settings.

Firebase is Google's recommended method for reporting conversions to Adwords. To use Firebase, track the conversion events as you normally would with Segment and Segment will send them through to Firebase.

Firebase has great logging. If you are having any issues, enable debug mode as outlined in Google's Debug events docs.