This feature is only available on devices running iOS 14 and above.
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)disableSkanAttribution;The Adjust SDK communicates with SKAdNetwork by default. The SDK registers for SKAdNetwork attribution upon initialization.
You can disable SKAdNetwork communication by calling the disableSkanAttribution method with no argument.
You must call the disableSkanAttribution method before initializing the Adjust SDK.
let yourAppToken = "{YourAppToken}"let environment = ADJEnvironmentSandboxlet adjustConfig = ADJConfig( appToken: yourAppToken, andEnvironment: environment)//...adjustConfig.disableSkanAttribution()//...Adjust.initSdk(adjustConfig)ADJConfig *adjustConfig = [[ADJConfig alloc] initWithAppToken:@"{YourAppToken}" andEnvironment:ADJEnvironmentSandbox];[adjustConfig disableSkanAttribution];/// ...[Adjust initSdk: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 updateSkanConversionValue method. This method wraps Apple’s updateConversionValue method. It accepts the following 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.
|
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. |
Adjust.updateSkanConversionValue( 1, coarseValue: SKAdNetwork.CoarseConversionValue.low, lockWindow: false) { error in if let error { print(String(format: "An error occurred during completion: %@", error)) }}[Adjust updateSkanConversionValue:1 coarseValue:SKAdNetworkCoarseConversionValueLow lockWindow:NO withCompletionHandler:^(NSError *_Nullable error) { NSLog(@"An error occurred during completion: %@", error);}];SKAdNetwork 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 an untyped dictionary. To access this information, pass a completion handler to the [adjustSkanUpdatedWithConversionData] method. You can access the callback information in your completion handler.
conversion_value: The updated conversion value.coarse_value: The updated coarse conversion valuelock_window: Whether to send the postback before the conversion window endserror: Any error message returned by the update.
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.
func adjustSkanUpdated(withConversionData data: [String: String]) { print("Conversion value updated callback called!") print(String(format: "Conversion value dictionary: \n%@", data.description))}- (void)adjustSkanUpdatedWithConversionData:(NSDictionary<NSString *, NSString *> *)data { NSLog(@"Conversion value updated callback called!"); NSLog(@"Conversion value dictionary: \n%@", data.description);}Set up direct install postbacks
Direct install postbacks contain only SKAdNetwork information. Information such as campaign data isn’t 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
NSAdvertisingAttributionReportEndpointas the key name. - Set the Type to String in the pop up menu.
- Enter the address
https://adjust-skadnetwork.com.
See Apple’s guide on Configuring an Advertised App for more information.
This feature is only available on devices running iOS 14 and above.
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;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.
You must call the deactivateSKAdNetworkHandling method before initializing the Adjust SDK.
let yourAppToken = "{YourAppToken}"let environment = ADJEnvironmentSandbox as? Stringlet adjustConfig = ADJConfig( appToken: yourAppToken, environment: environment)//...adjustConfig.deactivateSKAdNetworkHandling()//...Adjust.appDidLaunch(adjustConfig)*adjustConfig = [ADJConfig configWithAppToken:@"{YourAppToken}" environment:ADJEnvironmentSandbox];[adjustConfig.deactivateSKAdNetworkHandling];/// ...[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.
Adjust.updateConversionValue(value)[Adjust updateConversionValue:value];Example
This example shows how to update a conversion value to 10 in response to a user triggering an event.
func onButtonClick() { Adjust.updateConversionValue(10)}- (void)onButtonClick { [Adjust updateConversionValue:10];}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.
|
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
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)) } }}if (@available(iOS 16.1, *)) { [Adjust updatePostbackConversionValue:1 coarseValue:SKAdNetworkCoarseConversionValueLow lockWindow:NO completionHandler:^(NSError *_Nullable error) { NSLog(@"An error occurred during completion: %a", error); }];}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
func adjustConversionValueUpdated(_ conversionValue: NSNumber?) { print("Conversion value: \(conversionValue ?? 0)")}- (void)adjustConversionValueUpdated:(NSNumber *)conversionValue { NSLog(@"Conversion value: %@", conversionValue);}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.
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.
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)")}- (void)adjustConversionValueUpdated:(NSNumber *)fineValue coarseValue:(NSString *)coarseValue lockWindow:(NSNumber *)lockWindow { NSLog(@"Fine conversion value: %@", fineValue); NSLog(@"Coarse conversion value: %@", coarseValue); NSLog(@"Will send before conversion value window ends: %u", [lockWindow boolValue]);}Set up direct install postbacks
Direct install postbacks contain only SKAdNetwork information. Information such as campaign data isn’t 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
NSAdvertisingAttributionReportEndpointas the key name. - Set the Type to String in the pop up menu.
- Enter the address
https://adjust-skadnetwork.com.
See Apple’s guide on Configuring an Advertised App for more information.