Set up SKAdNetwork and conversion values

StoreKit Ad Network (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.

Disable SKAdNetwork communication

- (void)deactivateSKAdNetworkHandling;

Added in v4.23.0

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.

Swift
Objective-C

1
let yourAppToken = "{YourAppToken}"
2
let environment = ADJEnvironmentSandbox as? String
3
let adjustConfig = ADJConfig(
4
   appToken: yourAppToken,
5
   environment: environment)
6
//...
7
adjustConfig.deactivateSKAdNetworkHandling()
8
//...
9
Adjust.appDidLaunch(adjustConfig)

1
*adjustConfig = [ADJConfig configWithAppToken:@"{YourAppToken}"
2
                                 environment:ADJEnvironmentSandbox];
3
[adjustConfig.deactivateSKAdNetworkHandling];
4
/// ...
5
[Adjust appDidLaunch:adjustConfig];

Update conversion values

+ (void)updateConversionValue:(NSInteger)conversionValue;

Conversion values are a mechanism used to measure user behavior in SKAdNetwork. You can map 64 conditions to values from 0 through 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 servers update 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

1
Adjust.updateConversionValue(value)

1
[Adjust updateConversionValue:value];

Example

This example shows how to update a conversion value to 10 in response to a user triggering an event.

Swift
Objective-C

1
func onButtonClick() {
2
   Adjust.updateConversionValue(10)
3
}

1
- (void)onButtonClick {
2
   [Adjust updateConversionValue:10];
3
}

Set up completion handlers

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.

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

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

1
if (@available(iOS 16.1, *)) {
2
  [Adjust updatePostbackConversionValue:1
3
                            coarseValue:SKAdNetworkCoarseConversionValueLow
4
                             lockWindow:NO
5
                      completionHandler:^(NSError *_Nullable error) {
6
                        NSLog(@"An error occurred during completion: %a", error);
7
                      }];
8
}

Listen for changes to conversion values

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

Example

This example shows how to log the following when the conversion value updates:

A message confirming the conversion value update
The new conversion value

Swift
Objective-C

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

1
- (void)adjustConversionValueUpdated:(NSNumber *)conversionValue {
2
    NSLog(@"Conversion value: %@", conversionValue);
3
}

SKAdNetwork 4.0 callbacks

SKAdNetwork 4.0 postbacks contain some additional information to give advertisers more insight into their users. When Adjust’s servers update 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`	`NSNumber`	The conversion value sent by Adjust’s servers
`coarseValue`	`NSString`	The coarse conversion value. This value is used if your app doesn’t have sufficient installs to reach the privacy threshold. `none` `low` `medium` `high` Apple sends none whenever none of the conditions that are set for low, medium, and high were met.
`lockWindow`	`NSNumber`	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

This example shows how to 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

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

1
- (void)adjustConversionValueUpdated:(NSNumber *)fineValue coarseValue:(NSString *)coarseValue lockWindow:(NSNumber *)lockWindow {
2
    NSLog(@"Fine conversion value: %@", fineValue);
3
    NSLog(@"Coarse conversion value: %@", coarseValue);
4
    NSLog(@"Will send before conversion value window ends: %u", [lockWindow boolValue]);
5
}

Set up direct install 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 address https://adjust-skadnetwork.com.