We constantly publish updates to our documentation, which may not yet be available in your language. For the most current information, use the English version.

for Developers

Set up SKAdNetwork and conversion values

Important:

This feature is only available on devices running iOS 14 and above.

SKAdNetwork is Apple's attribution framework for app install and reinstall attribution. The SKAdNetwork workflow goes like this:

Apple gathers attribution information and notifies the relevant ad network.
The network sends a postback with this information to Adjust.
Adjust displays SKAdNetwork data in Datascape and Data Canvas.

Listen for conversion value updates

If you use Adjust to manage conversion values, the Adjust backend sends conversion value updates to the SDK. You can set up a delegate function to listen for these changes using the adjustConversionValueUpdated method.

Arguments	Data type	Description
`conversionValue`	Integer	The conversion value sent by the Adjust backend.

Example

In this example, we log the new conversion value when the backend sends an update.

Swift

Objective-C

func adjustConversionValueUpdated(_ conversionValue: NSNumber?) {
    print("Conversion value: \(conversionValue ?? 0)")
}

SKAdNetwork 4.0 callbacks

Note:

This method is available in Adjust SDK 4.33.0 and above

SKAdNetwork 4.0 postbacks contain some additional information to give advertisers more insight into their users. When the Adjust backend updates conversion values, this additional information is sent in a payload. You can access this information with the adjustConversionValueUpdated callback method.

Arguments	Data type	Description
`fineValue`	Integer	The conversion value sent by the Adjust backend.
`coarseValue`	String	The coarse conversion value. This value is used if your app doesn't have sufficient installs to reach the privacy threshold. Accepted values: `low` `medium` `high`
`lockWindow`	Integer	Whether to send the postback before the conversion window ends. `1` indicates the postback will be sent before the conversion window ends. Defaults to `0` in SKAdNetwork 4.0 postbacks and `nil` in older SKAdNetwork versions.

Example

In this example, we log the the fine conversion value, the coarse conversion value, and whether the SKAdNetwork postback is set to send before the conversion window ends.

Swift

Objective-C

func adjustConversionValueUpdated(_ fineValue: NSNumber?, coarseValue: String?, lockWindow: NSNumber?) {
    print("Fine conversion value: \(fineValue ?? 0)")
    print("Coarse conversion value: \(coarseValue ?? "")")
    print("Will send before conversion value window ends: \(lockWindow?.boolValue ?? nil)")
}

Update conversion values

Conversion values are a mechanism used to track user behavior in SKAdNetwork. You can map 64 conditions to values from 0-63 and send this integer value to SKAdNetwork on user install. This gives you insight into how your users interact with your app in the first few days.

If you manage your conversion values with Adjust, the backend updates this value in the SDK. You can also update this value by using the updateConversionValue method. This method wraps Apple's updateConversionValue method. It accepts an integer argument representing your updated conversion value.

Swift

Objective-C

Adjust.updateConversionValue(value)

Example

Set up completion handlers

Note:

This feature requires Adjust v4.33.0 and above.

The Adjust SDK contains wrappers for Apple's updatePostbackConversionValue methods. These methods provide more options for handling SKAdNetwork postbacks, including the option to handle failures.

The following methods are supported:

updatePostbackConversionValue(_:completionHandler:) – update conversion values and handle failures.
updatePostbackConversionValue(_:completionHandler:coarseValue:) – update both fine and coarse conversion values and handle failures.
updatePostbackConversionValue(_:coarseValue:lockWindow:completionHandler:) – update both fine and coarse conversion values, determine whether to send the postback before the end of the conversion value window, and handle errors.

Arguments

Argument	Data type	Description
`fineValue`	Integer	Your conversion value. Must be between 0 and 63.
`coarseValue`	SKAdNetwork.CoarseConversionValue	The coarse conversion value. This value is used if your app doesn't have sufficient installs to reach the privacy threshold. Accepted values: `SKAdNetworkCoarseConversionValueLow` `SKAdNetworkCoarseConversionValueMedium` `SKAdNetworkCoarseConversionValueHigh`
`lockWindow`	Boolean	Whether to send the postback before the conversion window ends. Use `true` to tell the system to send the postback without waiting for the end of the conversion window. Defaults to `false`.
`completion`	Function	An optional completion handler you provide to catch and handle any errors this method encounters when you update a conversion value. Set this value to `nil` if you don’t provide a handler.

Example

Swift

Objective-C

if #available(iOS 16.1, *) {
    Adjust.updatePostbackConversionValue(
        1,
        coarseValue: SKAdNetwork.CoarseConversionValue.low.rawValue,
        lockWindow: false) { error in
        if let error {
            print(String(format: "An error occurred during completion: %a", error))
        }
    }
}

Set up direct install postbacks

Note:

Direct install postbacks contain only SKAdNetwork information. Information such as campaign data is not included in these postbacks.

You can configure your app to send a copy of winning SKAdNetwork callbacks to Adjust. This enables you to use SKAdNetwork information in your analytics.

To set up direct install postbacks, you need to add the Adjust callback URL to your Info.plist file:

Select Info.plist in the Project navigator in Xcode.
Select the Add button (+) beside a key in the property list editor and press Return.
Enter NSAdvertisingAttributionReportEndpoint as the key name.
Set the Type to String in the pop up menu.
Enter the URL https://adjust-skadnetwork.com.

See Apple's guide on Configuring an Advertised App for more information.

Disable SKAdNetwork communication

The Adjust SDK communicates with SKAdNetwork by default on v4.23.0 and above. The SDK registers for SKAdNetwork attribution upon initialization.

Your config object contains a boolean isSKAdNetworkHandlingActive property that controls this behavior. You can disable SKAdNetwork communication by calling the deactivateSKAdNetworkHandling method with no argument.

Important:

You must call the deactivateSKAdNetworkHandling method before initializing the Adjust SDK in your app.

Swift

Objective-C

let yourAppToken = "{YourAppToken}"
let environment = ADJEnvironmentSandbox as? String
let myConfig = ADJConfig(
    appToken: yourAppToken,
    environment: environment)
//...
myConfig.deactivateSKAdNetworkHandling()
//...
Adjust.appDidLaunch(myConfig)