Experiment iOS SDK

Official documentation for Amplitude Experiment's Client-side iOS SDK implementation.

Install

1pod 'AmplitudeExperiment', '~> <VERSION>'

 1// (1) Initialize the experiment client with Amplitude Analytics
 2let experiment = Experiment.initializeWithAmplitudeAnalytics(
 3    apiKey: "DEPLOYMENT_KEY",
 4    config: ExperimentConfigBuilder().build()
 5)
 6 
 7// (2) Start the SDK
 8experiment.start() { error in
 9 
10    // (3) Lookup a flag's variant
11    let variant = experiment.variant("FLAG_KEY")
12    if variant.value == "on" {
13        // Flag is on
14    } else {
15        // Flag is off
16    }
17}

 1 
 2// (1) Initialize the experiment client and implement a
 3//     custom exposure tracking provider.
 4class ExposureTracker: ExposureTrackingProvider {
 5   func track(exposure: Exposure) {
 6       // TODO: Implement exposure tracking
 7       // analytics.track(name: "$exposure", properties: [
 8       //     "flag_key": exposure.flagKey,
 9       //     "variant": exposure.variant,
10       //     "experiment_key": exposure.experimentKey
11       // ])
12   }
13}
14let experiment = Experiment.initialize(
15   apiKey: "DEPLOYMENT_KEY",
16   config: ExperimentConfigBuilder()
17       .exposureTrackingProvider(ExposureTracker())
18       .build()
19)
20// (2) Start the SDK with the user.
21let user = ExperimentUserBuilder()
22   .userId("user@company.com")
23   .deviceId("abcdefg")
24   .userProperty("premium", value: true)
25   .build()
26experiment.start(user) { error in
27 
28   // (3) Lookup a flag's variant
29   let variant = experiment.variant("FLAG_KEY")
30   if variant.value == "on" {
31       // Flag is on
32   } else {
33       // Flag is off
34   }
35}

Core functions

The following functions make up the core of the Experiment client-side SDK.

Initialize

The SDK client should be initialized in your application on startup. The deployment key argument passed into the apiKey parameter must live within the same project that you are sending analytics events to.

1func initializeWithAmplitudeAnalytics(
2    apiKey: String,
3    config: ExperimentConfig
4) -> ExperimentClient

1func initialize(apiKey: String, config: ExperimentConfig) -> ExperimentClient

The initializer returns a singleton instance, so subsequent initializations for the same instance name will always return the initial instance. To create multiple instances, use the instanceName configuration.

1let experiment = Experiment.initializeWithAmplitudeAnalytics(
2    apiKey: "DEPLOYMENT_KEY",
3    config: ExperimentConfigBuilder().build()
4)

 1// (1) Initialize the experiment client and implement a
 2//     custom exposure tracking provider.
 3class ExposureTracker: ExposureTrackingProvider {
 4    func track(exposure: Exposure) {
 5        // TODO: Implement exposure tracking
 6        // analytics.track(name: "$exposure", properties: [
 7        //     "flag_key": exposure.flagKey,
 8        //     "variant": exposure.variant,
 9        //     "experiment_key": exposure.experimentKey
10        // ])
11    }
12}
13let experiment = Experiment.initialize(
14    apiKey: "DEPLOYMENT_KEY",
15    config: ExperimentConfigBuilder()
16        .exposureTrackingProvider(ExposureTracker())
17        .build()
18)

Configuration

The SDK client can be configured once on initialization.

Integrations

If you use either Amplitude or Segment Analytics SDKs to track events into Amplitude, you'll want to set up an integration on initialization. Integrations automatically implement provider interfaces to enable a more streamlined developer experience by making it easier to manage user identity and track exposures events.

1Amplitude.instance().initializeApiKey("API_KEY")
2let experiment = Experiment.initializeWithAmplitudeAnalytics( 
3    apiKey: "DEPLOYMENT_KEY",
4    config: ExperimentConfigBuilder().build()
5)

 1class SegmentExposureTrackingProvider : ExposureTrackingProvider {
 2    private let analytics: Analytics
 3    init(analytics: Analytics) {
 4        self.analytics = analytics
 5    }
 6    func track(exposure: Exposure) {
 7        analytics.track("$exposure", properties: [
 8            "flag_key": exposure.flagKey,
 9            "variant": exposure.variant,
10            "experiment_key": exposure.experimentKey
11        ])
12    }
13}

1let analytics = // Initialize segment analytics
2ExperimentConfig config = ExperimentConfigBuilder()
3    .exposureTrackingProvider(SegmentExposureTrackingProvider(analytics))
4    .build()
5let experiment = Experiment.initialize(apiKey: "<DEPLOYMENT_KEY>", config: config)

1let userId = SEGState.sharedInstance().userInfo.userId
2let deviceId = SEGState.sharedInstance().userInfo.anonymousId
3 
4let user = ExperimentUserBuilder()
5    .userId(userId)
6    .deviceId(deviceId)
7    .build()
8experiment.fetch(user: user, completion: nil)

Start

Start the SDK by getting flag configurations from the server and fetching remote evaluation variants for the user. The SDK is ready once the completion callback is called.

1func start(_ user: ExperimentUser? = nil, completion: ((Error?) -> Void)? = nil)

Call start() when your application is initializing, after user information is available to use to evaluate or fetch variants. The provided completion block is called after loading local evaluation flag configurations and fetching remote evaluation variants.

Configure the behavior of start() by setting fetchOnStart in the SDK configuration on initialization to improve performance based on the needs of your application.

• If your application never relies on remote evaluation, set fetchOnStart to false to avoid increased startup latency caused by remote evaluation.
• If your application relies on remote evaluation, but not right at startup, you may set fetchOnStart to false and call fetch() separately.

1experiment.start() { error in
2    // SDK Started
3}

1let user = ExperimentUserBuilder()
2    .userId("user@company.com")
3    .deviceId("abcdefg")
4    .userProperty("premium", value: true)
5    .build()
6experiment.start(user) { error in
7    // SDK Started
8}

Fetch

Fetches variants for a user and store the results in the client for fast access. This function remote evaluates the user for flags associated with the deployment used to initialize the SDK client.

1func fetch(user: ExperimentUser?, options: FetchOptions?, completion: ((ExperimentClient, Error?) -> Void)?)

Amplitude Experiment recommends calling fetch() during application start up so that the user gets the most up-to-date variants for the application session. Furthermore, you'll need to wait for the fetch request to return a result before rendering the user experience to avoid the interface "flickering".

1let user = ExperimentUserBuilder()
2    .userId("user@company.com")
3    .userProperty("premium", value: true)
4    .build()
5experiment.fetch(user: user) { experiment, error in
6    // Do something...
7}

If you're using an integration or a custom user provider then you can fetch without inputting the user.

1experiment.fetch(user: nil, completion: nil)

Variant

Access a variant for a flag or experiment from the SDK client's local store.

1func variant(_ key: String, fallback: Variant? = nil) -> Variant

When determining which variant a user has been bucketed into, you'll want to compare the variant value to a well-known string.

1let variant = experiment.variant("<FLAG_KEY>")
2if variant.value == "on" {
3    // Flag is on
4} else {
5    // Flag is off
6}

???info "Accessing the variant's payload"

1let variant = client.variant("<FLAG_KEY>")
2if variant.value == "on" {
3    if let payload = variant.payload as? [String:String] {
4        let value = payload["key"]
5    }
6}

A null variant value means that the user hasn't been bucketed into a variant. You may use the built in fallback parameter to provide a variant to return if the store doesn't contain a variant for the given flag key.

1let variant = experiment.variant("<FLAG_KEY>", fallback: Variant("control"))
2if variant.value == "control" {
3    // Control
4} else if variant.value == "treatment" {
5    // Treatment
6}

All

Access all variants stored by the SDK client.

1func all() -> [String:Variant]

Clear

Clear all variants in the cache and storage.

1func clear()

You can call clear after user logout to clear the variants in cache and storage.

1experiment.clear()

Exposure

Manually track an exposure event for the current variant of the given flag key through configured integration or custom exposure tracking provider. Generally used in conjunction with setting the automaticExposureTracking configuration optional to false.

1func exposure(key: String)

 1let variant = experiment.variant("<FLAG_KEY>")
 2 
 3// Do other things...
 4 
 5experiment.exposure("<FLAG_KEY>")
 6if variant.value == "control" {
 7    // Control
 8} else if variant.value == "treatment" {
 9    // Treatment
10}

Providers

Provider implementations enable a more streamlined developer experience by making it easier to manage user identity and track exposures events.

User provider

The user provider is used by the SDK client to access the most up-to-date user information only when it's needed (for example: when fetch() is called). This provider is optional, but helps if you have a user information store already set up in your application. This way, you don't need to manage two separate user info stores in parallel, which may result in a divergent user state if the application user store is updated and experiment isn't (or via versa).

1protocol ExperimentUserProvider {
2    func getUser() -> ExperimentUser
3}

To use your custom user provider, set the userProvider configuration option with an instance of your custom implementation on SDK initialization.

1let config = ExperimentConfigBuilder()
2    .userProvider(CustomUserProvider())
3    .build()
4let experiment = Experiment.initialize(apiKey: "<DEPLOYMENT_KEY>", config: config)

Exposure tracking provider

Implementing an exposure tracking provider is highly recommended. Exposure tracking increases the accuracy and reliability of experiment results and improves visibility into which flags and experiments a user is exposed to.

1protocol ExposureTrackingProvider {
2    func track(exposure: Exposure)
3}

The implementation of track() should track an event of type $exposure (a.k.a name) with two event properties, flag_key and variant, corresponding to the two fields on the Exposure object argument. Finally, the event tracked must eventually end up in Amplitude Analytics for the same project that the [deployment] used to initialize the SDK client lives within, and for the same user that variants were fetched for.

To use your custom user provider, set the exposureTrackingProvider configuration option with an instance of your custom implementation on SDK initialization.

1ExperimentConfig config = ExperimentConfigBuilder()
2    .exposureTrackingProvider(CustomExposureTrackingProvider(analytics))
3    .build()
4let experiment = Experiment.initialize(apiKey: "<DEPLOYMENT_KEY>", config: config)