Use the methods in this document to configure the behavior of the Adjust SDK.
Instantiate your config object
- (nullable ADJConfig *)initWithAppToken:(nonnull NSString *)appToken environment:(nonnull NSString *)environment andSuppressLogLevel:(BOOL)allowSuppressLogLevel;To configure the Adjust SDK, you need to instantiate an ADJConfig object. This object contains the read-only configuration options that you need to pass to the Adjust SDK.
To instantiate your config object, create a new ADJConfig instance and pass the following parameters:
appToken(NSString): Your Adjust app token.environment(NSString): The environment you want to run the SDK in. PassADJEnvironmentSandboxto run the SDK in sandbox mode for testing. PassADJEnvironmentProductionto run the SDK in production mode for release.allowSuppressLogLevel(BOOL): Whether to suppress all logging. Set totrueto suppress logging orfalseto enable logging.
let yourAppToken = "{YourAppToken}"let environment = ADJEnvironmentSandboxlet adjustConfig = ADJConfig( appToken: yourAppToken, andEnvironment: environment)NSString *yourAppToken = @"{YourAppToken}"; ADJConfig *adjustConfig = [[ADJConfig alloc] initWithAppToken:yourAppToken andEnvironment:environment];setupWebViewJavascriptBridge(function (bridge) { var yourAppToken = yourAppToken; var environment = AdjustConfig.EnvironmentSandbox; var adjustConfig = new AdjustConfig(yourAppToken, environment);});Read-only configuration
Read-only configuration options are set in your ADJConfig instance before the initialization of the SDK. They can’t be changed while the SDK is running. You MUST configure any options you want to use before running Adjust.initSdk().
Set your logging level
@property (nonatomic, assign) ADJLogLevel logLevel;The Adjust SDK provides configurable log levels to return different amounts of information. The following log levels are available:
| ADJLogLevel | Description |
|---|---|
ADJLogLevelVerbose | Enable all logging |
ADJLogLevelDebug | Enable debug logging |
ADJLogLevelInfo | Only show info level logs (default option) |
ADJLogLevelWarn | Disable info logging |
ADJLogLevelError | Disable warning level logging and below |
ADJLogLevelAssert | Disable error level logging and below |
ADJLogLevelSuppress | Suppress all logging |
You can set your log level by assigning an ADJLogLevel value to the logLevel property of your config instance.
logLevel(ADJLogLevel): The log level you want to use.
let yourAppToken = "{YourAppToken}"let environment = ADJEnvironmentSandboxlet adjustConfig = ADJConfig( appToken: yourAppToken, andEnvironment: environment)// ...adjustConfig?.logLevel = ADJLogLevelVerboseNSString *yourAppToken = @"{YourAppToken}";NSString *environment = ADJEnvironmentSandbox; ADJConfig *adjustConfig = [[ADJConfig alloc] initWithAppToken:yourAppToken andEnvironment:environment];// ...[adjustConfig setLogLevel:ADJLogLevelVerbose];setupWebViewJavascriptBridge(function (bridge) { // ... var yourAppToken = yourAppToken; var environment = AdjustConfig.EnvironmentSandbox; var adjustConfig = new AdjustConfig(yourAppToken, environment); adjustConfig.setLogLevel(AdjustConfig.LogLevelVerbose);});Set external device identifier
@property (nonatomic, copy, nullable) NSString *externalDeviceId;An external device identifier is a custom value that you can assign to a device or user. They help you recognize users across sessions and platforms. They can also help you deduplicate installs by user so that a user isn’t counted as duplicate new installs. Contact your Adjust representative to get started with external device IDs.
You can use an external device ID as a custom identifier for a device. This helps you keep continuity with your other systems. Assign your external device ID to the externalDeviceId property on your config instance.
externalDeviceId(NSString): Your external device identifier. This value is case sensitive. If you have imported external device IDs, make sure the value you pass matches the imported value.
See the External device identifiers article in the Adjust help center for more information.
let yourAppToken = "{YourAppToken}"let environment = ADJEnvironmentSandboxlet adjustConfig = ADJConfig( appToken: yourAppToken, andEnvironment: environment)// ...adjustConfig?.externalDeviceId = "yourExternalDeviceId"NSString *yourAppToken = @"{YourAppToken}";NSString *environment = ADJEnvironmentSandbox; ADJConfig *adjustConfig = [[ADJConfig alloc] initWithAppToken:yourAppToken andEnvironment:environment];// ...[adjustConfig setExternalDeviceId:@"yourExternalDeviceId"];setupWebViewJavascriptBridge(function (bridge) { var yourAppToken = yourAppToken; var environment = AdjustConfig.EnvironmentSandbox; var adjustConfig = new AdjustConfig(yourAppToken, environment); adjustConfig.setExternalDeviceId("yourExternalDeviceId");});If you want to use the external device ID in your business analytics, you can pass it as a session callback parameter.
You can import existing external device IDs into Adjust. This ensures that the Adjust servers match future data to your existing device records. Contact your Adjust representative for more information.
Set default link token
@property (nonatomic, copy, nullable) NSString *defaultTracker;You can configure a default link token if your app is preinstalled on a device. When a user opens the preinstalled app for the first time, the install is attributed to the default link token. Assign your default link token to the defaultTracker property of your config instance.
defaultTracker(NSString): The Adjust link token you want to record preinstalled installs against.
let yourAppToken = "{YourAppToken}"let environment = ADJEnvironmentSandboxlet adjustConfig = ADJConfig( appToken: yourAppToken, andEnvironment: environment)adjustConfig?.defaultTracker = "{Token}"Adjust.initSdk(adjustConfig)ADJConfig *adjustConfig = [[ADJConfig alloc] initWithAppToken:appToken andEnvironment:environment];[adjustConfig setDefaultTracker:@"{Token}"];[Adjust initSdk:adjustConfig];setupWebViewJavascriptBridge(function (bridge) { var yourAppToken = yourAppToken; var environment = AdjustConfig.EnvironmentSandbox; var adjustConfig = new AdjustConfig(yourAppToken, environment); adjustConfig.setDefaultTracker("{Token}");});Enable cost data sending
- (void)enableCostDataInAttribution;By default, the Adjust SDK doesn’t send cost data as part of a user’s attribution. You can configure the SDK to send this data by enabling cost data sending. To enable cost data sending, call the [ADJConfig enableCostDataInAttribution] method.
Cost data is accessible in the user’s attribution information.
let yourAppToken = "{YourAppToken}"let environment = ADJEnvironmentSandboxlet adjustConfig = ADJConfig( appToken: yourAppToken, andEnvironment: environment)// ...adjustConfig.enableCostDataInAttribution()NSString *yourAppToken = @"{YourAppToken}";NSString *environment = ADJEnvironmentSandbox; ADJConfig *adjustConfig = [[ADJConfig alloc] initWithAppToken:appToken andEnvironment:environment]; environment:environment];// ...[adjustConfig enableCostDataInAttribution];setupWebViewJavascriptBridge(function (bridge) { var yourAppToken = yourAppToken; var environment = AdjustConfig.EnvironmentSandbox; var adjustConfig = new AdjustConfig(yourAppToken, environment); adjustConfig.enableCostDataInAttribution();});Enable background sending
- (void)enableSendingInBackground;By default, the Adjust SDK pauses the sending of requests when your app is running in the background. You can configure the SDK to send requests in the background by enabling the background recording. To enable background recording, call the [Adjust enableSendingInBackground] method.
Adjust.enableSendingInBackground()[Adjust enableSendingInBackground];Adjust.enableSendingInBackground();Dynamic configuration
Dynamic configuration options may be changed during the SDK’s lifecycle in response to events or actions taken by the user.
Activate offline mode
The Adjust SDK sends event and session data to Adjust’s servers in real time. You can pause the sending of information by putting the SDK in offline mode. In offline mode the SDK stores all data in a local file on the device. The SDK sends this information to Adjust’s servers when you disable offline mode.
You can toggle offline mode at any time by calling the [Adjust switchToOfflineMode] method.
Adjust.switchToOfflineMode()[Adjust switchToOfflineMode]Deactivate offline mode
You can re-enable the SDK by calling the [Adjust switchBackToOnlineMode] method. This prompts the SDK to resume sending information.
Adjust.switchBackToOnlineMode()[Adjust switchBackToOnlineMode]Set push tokens
+ (void)setPushToken:(nonnull NSData *)pushToken;Push tokens are used for Audiences and client callbacks. They’re also required for Uninstall and reinstall measurement.
You can update your push token at any time by calling the [Adjust setPushToken] method and passing the following arguments:
pushToken(NSData): Your push token.
If you have access to the push token from the web view, you can call the setPushToken method in Javascript.
func application(_ app: UIApplication, didRegisterForRemoteNotificationsWithDeviceToken pushToken: Data) { Adjust.setPushToken(pushToken)}- (void)application:(UIApplication *)app didRegisterForRemoteNotificationsWithDeviceToken:(NSData *)pushToken { [Adjust setPushToken:pushToken];}Disable the SDK
+ (void)disable;The Adjust SDK runs by default when your app is open. You can disable the Adjust SDK to pause sending information to Adjust by calling the [Adjust disable] method. When you disable the Adjust SDK, it doesn’t send any data to Adjust’s servers.
Adjust.disable()[Adjust disable];Enable the SDK
+ (void)enable;If you’ve disabled the SDK and want to re-enable it, call the [Adjust enable] method. When the SDK is enabled, it will send information to Adjust’s servers.
Adjust.enable()[Adjust enable];Check enabled status
+ (void)isEnabledWithCompletionHandler:(nonnull ADJIsEnabledGetterBlock)completion;You can check if the Adjust SDK is enabled at any time by calling the [Adjust isEnabledWithCompletionHandler] method with a completion handler. The status is return asynchronously and passed to your completion handler as a BOOL value.
Adjust.isEnabled() { isEnabled in // Your completion handler};[Adjust isEnabledWithCompletionHandler:^(BOOL * isEnabled) { // Your completion handler}]Use the methods in this document to configure the behavior of the Adjust SDK.
Instantiate your config object
+ (nullable ADJConfig *)configWithAppToken:(nonnull NSString *)appToken environment:(nonnull NSString *)environment allowSuppressLogLevel:(BOOL)allowSuppressLogLevel;To configure the Adjust SDK, you need to instantiate an ADJConfig object. This object contains the read-only configuration options that you need to pass to the Adjust SDK.
To instantiate your config object, create a new ADJConfig instance and pass the following parameters:
appToken(NSString): Your Adjust app token.environment(NSString): The environment you want to run the SDK in. PassADJEnvironmentSandboxto run the SDK in sandbox mode for testing. PassADJEnvironmentProductionto run the SDK in production mode for release.allowSuppressLogLevel(BOOL): Whether to suppress all logging. Set totrueto suppress logging orfalseto enable logging.
let yourAppToken = "{YourAppToken}"let environment = ADJEnvironmentSandbox as? Stringlet adjustConfig = ADJConfig( appToken: yourAppToken, environment: environment)NSString *yourAppToken = @"{YourAppToken}";NSString *environment = ADJEnvironmentSandbox;*adjustConfig = [ADJConfig configWithAppToken:yourAppToken environment:environment];setupWebViewJavascriptBridge(function (bridge) { var yourAppToken = yourAppToken; var environment = AdjustConfig.EnvironmentSandbox; var adjustConfig = new AdjustConfig(yourAppToken, environment);});Read-only configuration
Read-only configuration options are set in your ADJConfig instance before the initialization of the SDK. They can’t be changed while the SDK is running. You MUST configure any options you want to use before running Adjust.appDidLaunch().
Set your logging level
@property (nonatomic, assign) ADJLogLevel logLevel;The Adjust SDK provides configurable log levels to return different amounts of information. The following log levels are available:
| ADJLogLevel | Description |
|---|---|
ADJLogLevelVerbose | Enable all logging |
ADJLogLevelDebug | Enable debug logging |
ADJLogLevelInfo | Only show info level logs (default option) |
ADJLogLevelWarn | Disable info logging |
ADJLogLevelError | Disable warning level logging and below |
ADJLogLevelAssert | Disable error level logging and below |
ADJLogLevelSuppress | Suppress all logging |
You can set your log level by assigning an ADJLogLevel value to the logLevel property of your config instance.
logLevel(ADJLogLevel): The log level you want to use.
let yourAppToken = "{YourAppToken}"let environment = ADJEnvironmentSandbox as? Stringlet adjustConfig = ADJConfig( appToken: yourAppToken, environment: environment)// ...adjustConfig?.logLevel = ADJLogLevelVerboseNSString *yourAppToken = @"{YourAppToken}";NSString *environment = ADJEnvironmentSandbox;*adjustConfig = [ADJConfig configWithAppToken:yourAppToken environment:environment];// ...[adjustConfig setLogLevel:ADJLogLevelVerbose];setupWebViewJavascriptBridge(function (bridge) { // ... var yourAppToken = yourAppToken; var environment = AdjustConfig.EnvironmentSandbox; var adjustConfig = new AdjustConfig(yourAppToken, environment); adjustConfig.setLogLevel(AdjustConfig.LogLevelVerbose);});Set external device identifier
@property (nonatomic, copy, nullable) NSString *externalDeviceId;An external device identifier is a custom value that you can assign to a device or user. They help you recognize users across sessions and platforms. They can also help you deduplicate installs by user so that a user isn’t counted as duplicate new installs. Contact your Adjust representative to get started with external device IDs.
You can use an external device ID as a custom identifier for a device. This helps you keep continuity with your other systems. Assign your external device ID to the externalDeviceId property on your config instance.
externalDeviceId(NSString): Your external device identifier. This value is case sensitive. If you have imported external device IDs, make sure the value you pass matches the imported value.
See the External device identifiers article in the Adjust help center for more information.
let yourAppToken = "{YourAppToken}"let environment = ADJEnvironmentSandbox as? Stringlet adjustConfig = ADJConfig( appToken: yourAppToken, environment: environment)// ...adjustConfig?.externalDeviceId = "yourExternalDeviceId"NSString *yourAppToken = @"{YourAppToken}";NSString *environment = ADJEnvironmentSandbox;*adjustConfig = [ADJConfig configWithAppToken:yourAppToken environment:environment];// ...[adjustConfig setExternalDeviceId:@"yourExternalDeviceId"];setupWebViewJavascriptBridge(function (bridge) { var yourAppToken = yourAppToken; var environment = AdjustConfig.EnvironmentSandbox; var adjustConfig = new AdjustConfig(yourAppToken, environment); adjustConfig.setExternalDeviceId("yourExternalDeviceId");});If you want to use the external device ID in your business analytics, you can pass it as a session callback parameter.
You can import existing external device IDs into Adjust. This ensures that the Adjust servers match future data to your existing device records. Contact your Adjust representative for more information.
Set default link token
@property (nonatomic, copy, nullable) NSString *defaultTracker;You can configure a default link token if your app is preinstalled on a device. When a user opens the preinstalled app for the first time, the install is attributed to the default link token. Assign your default link token to the defaultTracker property of your config instance.
defaultTracker(NSString): The Adjust link token you want to record preinstalled installs against.
let yourAppToken = "{YourAppToken}"let environment = ADJEnvironmentSandbox as? Stringlet adjustConfig = ADJConfig( appToken: yourAppToken, environment: environment)adjustConfig?.defaultTracker = "{Token}"Adjust.appDidLaunch(adjustConfig)*adjustConfig = [ADJConfig configWithAppToken:@"{YourAppToken}" environment:ADJEnvironmentSandbox];[adjustConfig setDefaultTracker:@"{Token}"];[Adjust appDidLaunch:adjustConfig];setupWebViewJavascriptBridge(function (bridge) { var yourAppToken = yourAppToken; var environment = AdjustConfig.EnvironmentSandbox; var adjustConfig = new AdjustConfig(yourAppToken, environment); adjustConfig.setDefaultTracker("{Token}");});Enable cost data sending
@property (nonatomic, assign) BOOL needsCost;By default, the Adjust SDK doesn’t send cost data as part of a user’s attribution. You can configure the SDK to send this data by enabling cost data sending. To enable cost data sending, assign a Boolean value to the needsCost property of your config instance.
needsCost(BOOL): set totrueto enable cost data sending orfalseto disable cost data sending.
Cost data is accessible in the user’s attribution information.
let yourAppToken = "{YourAppToken}"let environment = ADJEnvironmentSandbox as? Stringlet adjustConfig = ADJConfig( appToken: yourAppToken, environment: environment)// ...adjustConfig?.needsCost = trueNSString *yourAppToken = @"{YourAppToken}";NSString *environment = ADJEnvironmentSandbox;*adjustConfig = [ADJConfig configWithAppToken:yourAppToken environment:environment];// ...[adjustConfig setNeedsCost:YES];setupWebViewJavascriptBridge(function (bridge) { var yourAppToken = yourAppToken; var environment = AdjustConfig.EnvironmentSandbox; var adjustConfig = new AdjustConfig(yourAppToken, environment); adjustConfig.setNeedsCost(true);});Enable background recording
@property (nonatomic, assign) BOOL sendInBackground;By default, the Adjust SDK pauses the sending of requests when your app is running in the background. You can configure the SDK to send requests in the background by enabling the background recording. To enable background recording, assign a Boolean value to the sendInBackground property of your config instance.
sendInBackground(BOOL): Set totrueto enable background sending orfalseto disable background sending.
let yourAppToken = "{YourAppToken}"let environment = ADJEnvironmentSandbox as? Stringlet adjustConfig = ADJConfig( appToken: yourAppToken, environment: environment)// ...adjustConfig?.sendInBackground = trueNSString *yourAppToken = @"{YourAppToken}";NSString *environment = ADJEnvironmentSandbox;*adjustConfig = [ADJConfig configWithAppToken:yourAppToken environment:environment];// ...[adjustConfig setSendInBackground:YES];setupWebViewJavascriptBridge(function (bridge) { // ... var yourAppToken = yourAppToken; var environment = AdjustConfig.EnvironmentSandbox; var adjustConfig = new AdjustConfig(yourAppToken, environment); adjustConfig.setSendInBackground(true);});Enable event buffering
@property (nonatomic, assign) BOOL eventBufferingEnabled;The Adjust SDK sends event information as soon as a user triggers an event in your app. You can send event information on a schedule by enabling event buffering. Event buffering stores events in a local buffer on the device and sends all requests once per minute.
Your config object contains a boolean eventBufferingEnabled property that controls this behavior. To enable event buffering, assign a Boolean value to the eventBufferingEnabled property of your config instance.
eventBufferingEnabled(BOOL): Set totrueto enable event buffering orfalseto disable event buffering.
let yourAppToken = "{YourAppToken}"let environment = ADJEnvironmentSandbox as? Stringlet adjustConfig = ADJConfig( appToken: yourAppToken, environment: environment)adjustConfig?.eventBufferingEnabled = trueAdjust.appDidLaunch(adjustConfig)*adjustConfig = [ADJConfig configWithAppToken:@"{YourAppToken}" environment:ADJEnvironmentSandbox];[adjustConfig setEventBufferingEnabled:YES];[Adjust appDidLaunch:adjustConfig];setupWebViewJavascriptBridge(function (bridge) { var yourAppToken = yourAppToken; var environment = AdjustConfig.EnvironmentSandbox; var adjustConfig = new AdjustConfig(yourAppToken, environment); adjustConfig.setEventBufferingEnabled(true);});Delay the start of the SDK
@property (nonatomic, assign) double delayStart;By default, the Adjust SDK starts as soon as your app opens. If you want to send data that’s not available at launch in session parameters, you can delay the start of the SDK. This can be helpful if you are sending information such as unique identifiers.
To configure a startup delay, assign a double value to the delayStart property of your config instance.
delayStart(double): The time (in seconds) by which to delay the start of the SDK. You can delay the start of the SDK by up to 10 seconds.
let yourAppToken = "{YourAppToken}"let environment = ADJEnvironmentSandbox as? Stringlet adjustConfig = ADJConfig( appToken: yourAppToken, environment: environment)adjustConfig?.delayStart = 5.5// ...Adjust.appDidLaunch(adjustConfig)*adjustConfig = [ADJConfig configWithAppToken:@"{YourAppToken}" environment:ADJEnvironmentSandbox];[adjustConfig setDelayStart:5.5];/// ...[Adjust appDidLaunch:adjustConfig];setupWebViewJavascriptBridge(function (bridge) { var yourAppToken = yourAppToken; var environment = AdjustConfig.EnvironmentSandbox; var adjustConfig = new AdjustConfig(yourAppToken, environment); adjustConfig.setDelayStart(5.5);});Dynamic configuration
Dynamic configuration options may be changed during the SDK’s lifecycle in response to events or actions taken by the user.
Toggle offline mode
+ (void)setOfflineMode:(BOOL)enabled;The offline mode setting isn’t remembered between sessions. Offline mode is disabled at the start of each new session.
The Adjust SDK sends event and session data to Adjust’s servers in real time. You can pause the sending of information by putting the SDK in offline mode. In offline mode the SDK stores all data in a local file on the device. The SDK sends this information to Adjust’s servers when you disable offline mode.
You can toggle offline mode at any time by calling the setOfflineMode method with the following argument:
enabled(BOOL): Set totrueto enable offline mode orfalseto disable offline mode.
Adjust.setOfflineMode(true);[Adjust setOfflineMode:YES];Adjust.setOfflineMode(true);Set push tokens
+ (void)setDeviceToken:(nonnull NSData *)deviceToken;Push tokens are used for Audiences and client callbacks. They’re also required for Uninstall and reinstall measurement.
Your config object contains a deviceToken property that you can use to store your push token. You can update this property at any time by calling the setDeviceToken method and passing the following arguments:
deviceToken(NSData): Your push token.
If you have access to the push token from the web view, you can call the setPushToken method in Javascript.
func application(_ app: UIApplication, didRegisterForRemoteNotificationsWithDeviceToken deviceToken: Data) { Adjust.setDeviceToken(deviceToken)}- (void)application:(UIApplication *)app didRegisterForRemoteNotificationsWithDeviceToken:(NSData *)deviceToken { [Adjust setDeviceToken:deviceToken];}Adjust.setDeviceToken(deviceToken);Disable or enable the SDK
You can only call this method after the first session. This setting persists between sessions.
+ (void)setEnabled:(BOOL)enabled;The Adjust SDK runs by default when your app is open. You can disable and re-enable the Adjust SDK to pause and resume recording. When you disable the Adjust SDK, it doesn’t send any data to Adjust’s servers.
You can enable or disable the SDK at any time by calling the setEnabled method with the following argument:
enabled(BOOL): Set totrueto enable the SDK orfalseto disable the SDK.
Adjust.setEnabled(true)[Adjust setEnabled:NO];Adjust.setEnabled(false);Check enabled status
+ (BOOL)isEnabled;You can check if the Adjust SDK is enabled at any time by calling the isEnabled method. This method returns a BOOL value indicating if the SDK is enabled (true) or disabled (false).
Adjust.isEnabled()[Adjust isEnabled];Adjust.isEnabled();