Analytics Swift Amplitude Plugin

1. Before you start, go to your Amplitude workspace. Go to Settings > Projects. Select your Project. Copy the Amplitude API Key and Secret Key for the project.
2. From the Segment web app, go to Catalog > Destinations.
3. Find the Destinations Actions item, and click it.
4. Select the "Amplitude" item and click Configure.
5. Choose which of your sources to connect the destination to. (You can connect more sources to the destination later.)

Once you have a mapping, you can follow the steps in the Destinations Actions documentation to customize mappings.

The Amplitude Swift plugin doesn't send events to Amplitude from the client side. It instead adds Amplitude session data and then sends it server side from the Amplitude Actions destination.

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-amplitude

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 the dependencies section:

1
.package(
2
            name: "Segment",
3
            url: "https://github.com/segment-integrations/analytics-swift-amplitude.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 SegmentAmplitude // <-- Add this line

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: AmplitudeSession())

Your events receive session data and start flowing to Amplitude in Cloud Mode.

Newer versions of the Swift Amplitude Plugin (V 1.4.1 and up) will send the native Amplitude Session Start and Session End events in addition to tracking session_id. These versions of the plugin also support sending native Amplitude lifecycle events in lieu of the Segment lifecycle events to Amplitude. These will appear in your Amplitude dashboard with the [Amplitude] prefix but will not be sent to Segment.

Initially, the Log Event Action was reporting purchases to Amplitude for all events containing a products array, even if the products were just added to cart. This inflated the LTV Chart in Amplitude.

To resolve this, purchase reporting takes place in a new Action called Log Purchase.

For instances created prior to before the Log Purchases action was released, you need to manually add the Log Purchases Action to report purchases to Amplitude.

To manually add the Log Purchases Action:

1. Add a new Mapping for the Log Purchases Action. The default trigger for this action is Order Completed events.
2. Modify the Trigger if you need to report purchases for any other events.
3. Modify the Trigger of Log Event to exclude these same events. This helps you to avoid sending the same event twice.
4. Enable the Log Purchases mapping.

The Amplitude (actions) destination does not offer a device-mode connection mode. If you're using one of Segment's new libraries (Analytics.js 2.0, Swift or Kotlin) with the Actions-framework version of the destination, you do not need the device-mode connection.

Most previous deployments of the Amplitude Segment destination used the device-mode connection to use the session_id tracking feature. The new Actions-framework Amplitude destination, includes session ID tracking by default. This means you don't need to bundle any software to run on the user's device, or write any code. It also means that you can use more of the Segment platform features on data going to Amplitude, such as Protocols filtering and transformations, and Profiles Identity Resolution.

Session tracking is available with Segment's new libraries: Analytics.js 2.0, Swift or Kotlin

The Amplitude destination requires that each event include either a Device ID or a User ID. If a User ID isn't present, Amplitude uses the a Device ID, and vice versa, if a Device ID isn't present, Amplitude uses the User ID.

By default, Segment maps the Segment property context.device.id to the Amplitude property Device ID. If context.device.id isn't available, Segment maps the property anonymousId to the Amplitude Device ID. The Actions interface indicates this with the following contents of the Device ID field: coalesce( context.device.id anonymousId ).

To enable session tracking in Amplitude when using the Segment Swift library:

1. Enable trackApplicationLifecycleEvents in your configuration.
2. Add the Amplitude Session plugin to your project.
3. Initialize the plugin (example)
   Copy code block

   analytics?.add(plugin: AmplitudeSession(name: "Amplitude"))

The classic Amplitude destination captures the following user fields in device-mode (when it runs on the user's device):

• Device Type (for example, Mac, PC, mobile device)
• Platform (for example iOS or Android)

Amplitude (Actions) runs in cloud-mode, and does not capture these fields.

You configure the Amplitude (Actions) destination through Filters and Actions. Consult the table below for information about configuring your Amplitude (Actions) destination similarly to your classic Amplitude destination.

The traitsToIncrement setting increases a user property by some numerical value. If the user property does not have a value set yet, Segment initializes it with a value of 0. The trait must have a numerical value so it can be incremented.

In the following example, the Amplitude User property friendCount equals 4.

1
"traits" : {"$add": {"friendCount": 3} }
2
"traits" : {"$add": {"friendCount": 1} }