Skip to contentSkip to navigationSkip to topbar
On this page
Looking for more inspiration?Visit the
(information)
You're in the right place! Segment documentation is now part of Twilio Docs. The content you are used to is still here—just in a new home with a refreshed look.

Analytics Swift Adjust Plugin


Adjust(link takes you to an external page) is the mobile attribution provider of choice for hundreds of organizations across the globe. They unify all your marketing activities into one powerful platform, giving you the insights you need to scale your business. The Adjust Destination is open-source. You can browse the code on GitHub in the @segment-integrations/analytics-swift-integration-adjust(link takes you to an external page) repo.

(information)

The Analytics Swift Adjust plugin adds session data for Adjust

Session data events are sent in Cloud Mode.


Getting started

getting-started page anchor
  1. From the Segment web app, click Catalog.
  2. Search for "Adjust" in the Catalog, select it, and choose which of your sources to connect the destination to. You don't need to include Adjust's SDK natively, as this prevent you from successfully implementing the Adjust.
  3. Depending on the source you've selected, include Adjust's library by adding the following lines to your dependency configuration.

Xcode

xcode page anchor

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 repo.

https://github.com/segment-integrations/analytics-swift-integration-adjust(link takes you to an external page)

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

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

Using the plugin in your app

using-the-plugin-in-your-app page anchor

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 SegmentAdjust // <-- 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: AdjustDestination())

Here's an example of the Identify method:

1
struct MyTraits: Codable {
2
let favoriteColor: String
3
}
4
5
analytics.identify(userId: "a user's id", MyTraits(favoriteColor: "fuscia"))

When you call Identify, Segment calls Adjust's addSessionPartnerParameter(link takes you to an external page) method and sets the userId and/or anonymousId. This sets these values within Adjust, and allows Adjust to send back attribution data from their servers.


Here's an example of the Track method:

1
struct TrackProperties: Codable {
2
let someValue: String
3
}
4
5
analytics.track(name: "My Event", properties: TrackProperties(someValue: "Hello"))

When you call Track, Segment maps the event to your pre-defined Adjust custom event. You must map your Track events to your custom Adjust Event Token in your Adjust destination settings.

If you don't provide a mapping, Adjust cannot accept the event. Segment includes all the event properties as callback parameters on the Adjust event, and automatically translates revenue and currency to the appropriate Adjust event properties based on Segment's spec'd properties.


Segment will trigger an Install Attributed event if you have trackAttributionData enabled in your settings and the Segment-Adjust integration installed in your app.

Using Adjust's Attribution callback(link takes you to an external page), Segment listens for an attribution change from Adjust's SDK and triggers the call with the following Adjust attribution parameters:

KeyValueDescription
providerAdjusthardcoded by Segment
trackerTokenattribution.trackerTokenthe tracker token of the current install
trackerNameattribution.trackerNamethe tracker name of the current install
campaign.sourceattribution.networkthe network grouping level of the current install
campaign.nameattribution.campaignthe campaign grouping level of the current install
campaign.contentattribution.clickLabelthe click label of the current install
campaign.adCreativeattribution.creativethe creative grouping level of the current install
campaign.adGroupattribution.adgroupthe ad group grouping level of the current install

If any value is unavailable, it will default to nil. This call will be sent to all enabled device and cloud mode destinations.


By default, Segment's destination sends data to the Adjust Sandbox Environment. When you release your app to the App Store, enable the Production option in the Adjust destination settings on Segment (or use two separate sources, one for dev and one for prod, with different environment settings for Adjust).

The destination sends all event properties as callback parameters to Adjust. To set Partner Parameters(link takes you to an external page), you can access the Adjust SDK directly(link takes you to an external page).

Transaction deduplication

transaction-deduplication page anchor

The destination will automatically recognize the spec'd orderId property, and send it as the transaction ID to Adjust for revenue de-duplication.

In-app purchase receipts

in-app-purchase-receipts page anchor

The destination does not currently support in-app purchase receipts. If this is important to you, reach out to Segment support(link takes you to an external page).

The destination automatically forwards push notification tokens through to Adjust.

By default, Segment's Adjust destination enables event buffering. This saves your customers' battery life. However, you can disable this in the options on the Adjust destination settings in the Segment app.