adjust-icon

Set up direct deep linking

When a user with your app installed clicks an Adjust link, direct deep linking ensures they’re taken directly to specific content within the app.

Setup

iOS provides several methods for receiving direct deep links depending on your app’s implementation.

Within these methods, you’ll pass the deep link to the Adjust SDK using one of the following methods:

Use the processDeeplink(_:completionHandler:) method, which does the following:

  • Records attribution from deep link clicks
  • Resolves short branded links to their long branded link equivalent
  • Passes through all other links as is

Your app can then handle the resolved link by parsing it and navigating to the appropriate screen. You can use this method for all deep links, including Adjust long branded links, other universal links, and app scheme deep links.

Method signature
+ (void)processDeeplink:(nonnull NSURL *)deeplink
completionHandler:(void (^_Nonnull)(NSString * _Nonnull resolvedLink))completionHandler;

The appWillOpen(_:) method records attribution from deep link clicks if you’re not using short branded links.

Method signature
+ (void)appWillOpenUrl:(nonnull NSURL *)url;

The processDeeplink(_:completionHandler:) method supersedes this legacy method.

Implementation

Use the implementation that aligns with your app’s structure:

UIKit apps using AppDelegate lifecycle

Update your AppDelegate to implement iOS direct deep linking methods.

UIKit apps using SceneDelegate lifecycle

Update your SceneDelegate to implement iOS direct deep linking methods.

SwiftUI apps using AppDelegate lifecycle

If you haven’t already done so, create an AppDelegate.swift file in your project’s main directory and reference it in your main application file, as shown in the example App.swift file below. This is required to handle app lifecycle events and Adjust SDK integration. Also, implement the onOpenURL SwiftUI modifier, which receives universal links and app scheme deep links when the app is installed.

SwiftUI apps using SceneDelegate lifecycle

Follow the instructions in the SwiftUI apps using AppDelegate lifecycle section. The onOpenURL SwiftUI modifier receives universal links and app scheme deep links when the app is installed and the link opens the app from a Background or Foreground state.

In addition, implement the scene(_:willConnectTo:options:) method from the UIKit apps using SceneDelegate lifecycle section. This method receives universal links and app scheme deep links when the app is installed and the link opens the app from a “Not Running” state.

Foreground navigation

If you place an Adjust deep link inside your own app, such as in a promotional banner or product recommendation, don’t call UIApplication.open(_:options:completionHandler:) or SwiftUI’s openURL on it. iOS opens your app’s own universal links in Safari instead of routing them within the app. Instead, pass the link through processDeeplink and then route the resolved deep link using the same handling path described on this page.