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.

How it works

User clicks an Adjust link.
The OS opens your app and passes the deep link to native code (iOS or Android).
The app_links library forwards the link to your Flutter code.
Your code passes the link to the Adjust SDK for attribution. The SDK also resolves short branded links.
Your code navigates the user based on the resolved link.

Adjust SDK methods

Process deep link (recommended)

Use the Adjust.processDeeplink 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

static Future<String?> processDeeplink(String deeplink)

App will open URL (legacy)

The Adjust.appWillOpenUrl method records attribution from deep link clicks but doesn’t resolve short branded links.

static void appWillOpenUrl(String url)

The processDeeplink method supersedes this legacy method.

Implementation

Use the app_links library to receive deep links and pass them to the Adjust SDK.

dependencies:
   app_links: ^6.0.0 # check pub.dev for latest version

1
final _appLinks = AppLinks();
2

3
Future<void> _initDeepLinks() async {
4
  // Handle link when app is started from a deep link
5
  final initialLink = await _appLinks.getInitialLink();
6
  if (initialLink != null) {
7
    _handleDeepLink(initialLink);
8
  }
9

10
  // Handle links when app is already running
11
  _appLinks.uriLinkStream.listen(_handleDeepLink);
12
}
13

14
Future<void> _handleDeepLink(Uri incomingLink) async {
15
  // Send deep link to Adjust's servers for attribution.
16
  // If short branded link, receive long link.
17
  // Otherwise, receive original link.
18
  final resolvedLink = await Adjust.processDeeplink(incomingLink.toString());
19

20
  // Handle failure if resolvedLink is null
21
  if (resolvedLink == null) return;
22

23
  /*
24
   * TODO: Handle the deep link by parsing the path
25
   * and navigating to the appropriate screen.
26
   *
27
   * Possible resolvedLink formats:
28
   *
29
   * 1. https://brandname.go.link/?adj_t=abc123&
30
   *    adj_link=https%3A%2F%2Fexample.com%2Fsummer-clothes%3Fpromo%3Dbeach
31
   *    -> extract and decode the deep link from adj_link
32
   *
33
   * 2. https://brandname.go.link/summer-clothes?promo=beach&adj_t=abc123
34
   *    -> extract path from the URL
35
   *
36
   * 3. example://summer-clothes?promo=beach&adj_t=abc123
37
   *    -> extract path from the URL
38
   *
39
   * Note (Android only): If your Android app scheme path differs from iOS,
40
   * you may receive:
41
   *    https://brandname.go.link/?adj_t=abc123&
42
   *    adj_deep_link=example%3A%2F%2Fandroid-specific-path%3Fparam%3Dvalue
43
   *    -> extract and decode the deep link from adj_deep_link
44
   */
45
}