Configuration

Use the methods in this guide to configure the behavior of the Adtrace iOS SDK.

The SDK supports two kinds of configuration:

Type	When you set it	Can change after init?
Read-only	On ADTConfig before appDidLaunch	No
Dynamic	On Adtrace at any time after the SDK starts	Yes

Create an ADTConfig instance

Read-only options live on an ADTConfig object. Create that object, set the options you need, then pass it to [Adtrace appDidLaunch:] / Adtrace.appDidLaunch(...).

Required parameters

Parameter	Type	Description
appToken	String	Your Adtrace app token from the Adtrace panel.
environment	String	Use ADTEnvironmentSandbox for testing, or ADTEnvironmentProduction for release.
allowSuppressLogLevel	BOOL / Bool	Optional. Set YES / true if you want to allow ADTLogLevelSuppress.

Example

Objective-C

AppDelegate.m

NSString *appToken = @"{YourAppToken}";
NSString *environment = ADTEnvironmentSandbox;
ADTConfig *adtraceConfig = [ADTConfig configWithAppToken:appToken
                                             environment:environment];
// Configure read-only options on adtraceConfig here, then:
[Adtrace appDidLaunch:adtraceConfig];

Swift

AppDelegate.swift

let appToken = "{YourAppToken}"
let environment = ADTEnvironmentSandbox
let adtraceConfig = ADTConfig(appToken: appToken, environment: environment)
// Configure read-only options on adtraceConfig here, then:
Adtrace.appDidLaunch(adtraceConfig)

Replace {YourAppToken} with your app token from the Adtrace panel.

Read-only configuration

Read-only options are set on your ADTConfig instance before SDK initialization. They cannot be changed while the SDK is running.

You must configure any options you need before calling appDidLaunch.

Set log level

Control how much the Adtrace SDK writes to device logs

Set external device ID

Set a custom device or user ID before SDK init

Delay SDK start

Delay SDK startup to attach late session parameters

Enable event buffering

Batch events and send them once per minute

Enable background tracking

Continue tracking when the app moves to the background

Enable cost data in attribution

Include campaign cost fields in attribution data

Set default tracker

Attribute preinstalled apps with a default tracker

Dynamic configuration

Dynamic configuration options can change after the SDK has started. Call these methods on Adtrace at any time during the SDK lifecycle.

Unlike read-only options on ADTConfig, you do not need to restart the SDK to apply a dynamic change.

Disable SDK

Pause or resume tracking on the current device

Offline mode

Store requests locally and send them when back online

Set push token

Send APNs tokens for uninstall and reinstall measurement

Next steps

After you configure ADTConfig, initialize and test your integration in Getting started with the iOS SDK, then track actions with Event tracking.