iOS Adobe Extension v3 migration guide

The Adjust Extension for Adobe Experience SDK has been updated to v3 to support Adjust iOS SDK v5. Follow this guide to migrate from v2 to v3.

To install v3 of the Adjust iOS Extension for Adobe Experience using Swift Package Manager, enter the following URL:

1
https://github.com/adjust/ios_adobe_extension.git

If you're using CocoaPods, add the following line to your Podfile:

pod 'AdjustAdobeExtension'

For a complete guide to setting up the Adjust iOS Extension for Adobe Experience, see the integration guide.

New APIs

Added in v3

The following APIs have been added in v3.

Resolve short branded links

v3 of the Adjust Extension for Adobe Experience SDK adds support for resolving short branded links. To resolve shortened links, call the Adjust.processAndResolveDeeplink method with the following arguments:

deeplink: NSURL: The deep link that opened the app.
withCompletionHandler: ADJResolvedDeeplinkBlock: A completion function that receives the resolved short link as an argument.

Swift
Objective-C

1
func application(_ application: UIApplication, continue userActivity: NSUserActivity, restorationHandler: @escaping ([UIUserActivityRestoring]?) -> Void) -> Bool {
2
    if userActivity.activityType == NSUserActivityTypeBrowsingWeb {
3
        if let incomingUrl = userActivity.webpageUrl {
4
        if let deeplink = ADJDeeplink(deeplink: incomingUrl) {
5
            Adjust.processAndResolveDeeplink(deeplink) { resolveDeeplink in
6
                print("[\(resolveDeeplink)]")
7
            }
8
        }
9
        }
10
    }
11
    return true
12
}

1
- (BOOL)application:(UIApplication *)application continueUserActivity:(NSUserActivity *)userActivity restorationHandler:(void (^)(NSArray<id<UIUserActivityRestoring>> * _Nullable))restorationHandler {
2
    if ([[userActivity activityType] isEqualToString:NSUserActivityTypeBrowsingWeb]) {
3
        ADJDeeplink *deeplink = [[ADJDeeplink alloc] initWithDeeplink:[userActivity webpageURL]];
4
        [Adjust processAndResolveDeeplink:deeplink
5
                withCompletionHandler:^(NSString * _Nullable resolvedLink) {
6
                    NSLog(@"[%@]", resolvedLink);
7
        }];
8
    }
9
    return YES;
10
}

Global callback parameters

v3 of the Adjust Extension for Adobe Experience SDK adds support for the global callback parameters API from iOS SDK v5. To add global callbacks to your sessions, call the Adjust.addGlobalCallbackParameter method with the following arguments:

key: NSString: The key of your parameter.
value: NSString: The value of your parameter.

Swift
Objective-C

1
Adjust.addGlobalCallbackParameter("value", forKey: "key")
2
Adjust.addGlobalCallbackParameter("855", forKey: "user_id")

1
[Adjust addGlobalCallbackParameter:@"value" forKey:@"key"];
2
[Adjust addGlobalCallbackParameter:@"855" forKey:@"user_id"];

Learn how to set up global callback.

Global partner parameters

v3 of the Adjust Extension for Adobe Experience SDK adds support for the global partner parameters API from iOS SDK v5. To add global partner parameters, call the Adjust.addGlobalPartnerParameter method with the following arguments:

key: String: The key of your parameter.
value: String: The value of your parameter.

Swift
Objective-C

1
Adjust.addGlobalPartnerParameter("value", forKey: "key")
2
Adjust.addGlobalPartnerParameter("855", forKey: "user_id")

1
[Adjust addGlobalPartnerParameter:@"value" forKey:@"key"];
2
[Adjust addGlobalPartnerParameter:@"855" forKey:@"user_id"];

Learn how to set up global partner parameters.

Set external device ID

v3 of the Adjust Extension for Adobe Experience SDK adds support for setting external device identifiers. To set an external device ID, call the setExternalDeviceId method of your AdjustAdobeExtensionConfig instance with the following argument:

externalDeviceId: NSString: Your external device identifier.

Swift
Objective-C

1
if let config = AdjustAdobeExtensionConfig(environment: ADJEnvironmentSandbox) {
2
   config.setExternalDeviceId("1a42b171-faa5-46da-b5ae-6f4be6d05167")
3
   AdjustAdobeExtension.setConfiguration(config)
4
}

1
AdjustAdobeExtensionConfig *config = [AdjustAdobeExtensionConfig configWithEnvironment:ADJEnvironmentSandbox];
2
[config setExternalDeviceId:@"1a42b171-faa5-46da-b5ae-6f4be6d05167"];
3
[AdjustAdobeExtension setConfiguration:config];

Learn how to configure external device IDs.

Set default link token for preinstalled apps

v3 of the Adjust Extension for Adobe Experience SDK adds support for setting a default link token for recording preinstalled app installs to a default campaign. To set a default link token, call the setDefaultTracker method of your AdjustAdobeExtensionConfig instance with the following argument:

defaultTracker: NSString: The alphanumeric link token of your preinstall campaign.

Swift
Objective-C

1
if let config = AdjustAdobeExtensionConfig(environment: ADJEnvironmentSandbox) {
2
   config.setDefaultTracker("abc123")
3
   AdjustAdobeExtension.setConfiguration(config)
4
}

1
AdjustAdobeExtensionConfig *config = [AdjustAdobeExtensionConfig configWithEnvironment:ADJEnvironmentSandbox];
2
[config setDefaultTracker:@"abc123"];
3
[AdjustAdobeExtension setConfiguration:config];

Learn how to send preinstalled app activity.

Changed APIs

Changed in v3

The following APIs have changed in v3.

Direct deep linking

In SDK v2, you can open deep links for attribution by calling the AdjustAdobeExtension.application method with the deep link data as an argument.

Swift
Objective-C

1
func application(_ app: UIApplication, open url: URL, options: [UIApplication.OpenURLOptionsKey : Any] = [:]) -> Bool {
2
    return AdjustAdobeExtension.application(app, open: url, options: options)
3
}

1
- (BOOL)application:(UIApplication *)app openURL:(NSURL *)url options:(NSDictionary<UIApplicationOpenURLOptionsKey,id> *)options {
2
    return [AdjustAdobeExtension application:app openURL:url options:options];
3
}

SDK v3 has been updated to use the Adjust iOS SDK's processDeeplink method. To open direct deep links:

Create a new ADJDeeplink instance with the deep link URL.

Pass your ADJDeeplink instance to the Adjust.processDeeplink method.

Swift
Objective-C

1
func application(_ app: UIApplication, open url: URL, options: [UIApplication.OpenURLOptionsKey : Any] = [:]) -> Bool {
2
   if let deeplink = ADJDeeplink(deeplink: url) {
3
      Adjust.processDeeplink(deeplink)
4
   }
5
   return true
6
}

1
- (BOOL)application:(UIApplication *)app openURL:(NSURL *)url options:(NSDictionary<UIApplicationOpenURLOptionsKey,id> *)options {
2
   [Adjust processDeeplink: [[ADJDeeplink alloc] initWithDeeplink:url]];
3
   return YES;
4
}

Learn how to reattribute users with direct deep links.

Deferred deep linking callback

In SDK v2, you can configure the SDK to launch a callback function when a deferred deep link is opened by passing a function to the setDeeplinkResponseBlock method of your AdjustAdobeExtensionConfig instance.

Swift
Objective-C

1
if let config = AdjustAdobeExtensionConfig(environment: ADJEnvironmentSandbox) {
2
    config.setDeeplinkResponseBlock { deepLink in
3
        // Deep link response received
4
        // Apply your logic to determine whether the Adjust SDK should try to open the deep link
5
        return true;
6
        // or
7
        // return false;
8
    }
9
    AdjustAdobeExtension.setConfiguration(config)
10
}

1
AdjustAdobeExtensionConfig *config = [AdjustAdobeExtensionConfig configWithEnvironment:ADJEnvironmentSandbox];
2
[config setDeeplinkResponseBlock:^BOOL(NSURL * _Nullable deeplink) {
3
    // Deep link response received
4
    // Apply your logic to determine whether the Adjust SDK should try to open the deep link
5
    return YES;
6
    // or
7
    // return NO;
8
}];
9
[AdjustAdobeExtension setConfiguration:config];

In SDK v3, the setDeeplinkResponseBlock method has been renamed to setDeferredDeeplinkReceivedBlock.

Swift
Objective-C

1
if let config = AdjustAdobeExtensionConfig(environment: ADJEnvironmentSandbox) {
2
    config.setDeferredDeeplinkReceivedBlock { (deeplink: URL?) -> Bool in
3
        if let deeplinkString = deeplink?.absoluteString.lowercased(),
4
        deeplinkString.contains("no_open") {
5
            return false
6
        }
7
        return true
8
    }
9
    AdjustAdobeExtension.setConfiguration(config)
10
}

1
AdjustAdobeExtensionConfig *config = [AdjustAdobeExtensionConfig configWithEnvironment:ADJEnvironmentSandbox];
2
[config setDeferredDeeplinkReceivedBlock:^BOOL(NSURL * _Nullable deeplink) {
3
    if (deeplink && [[deeplink.absoluteString lowercaseString] containsString:@"no_open"]) {
4
        return NO;
5
    }
6
    return YES;
7
}];
8
[AdjustAdobeExtension setConfiguration:config];

Learn how to work with deferred deep link callbacks.