Deep linking

You can create deep links to take users to specific pages in your app. The Adjust SDK uses different logic depending on if the user already has your app installed on their device:

• Direct deep linking: occurs if the user already has your app installed. The link takes the user to the page specified in the link
• Deferred deep linking: occurs if the user doesn’t have your app installed. The link takes the user to a storefront to install your app first. After the user installs the app, it opens to the page specified in the link.

The SDK can read deep link data after a user opens your app from a link.

Set up deep linking

To use deep links with the Adjust SDK, you first need to enable the opening and reading of deep link information in your app.

Deferred deep linking

Disable deferred deep linking

disableDeferredDeeplinkOpening(): void

The SDK opens deferred deep links by default. You can configure this by calling the disableDeferredDeeplinkOpening method.

1
const adjustConfig = new AdjustConfig(
2
   "{YourAppToken}",
3
   AdjustConfig.EnvironmentSandbox,
4
);
5

6
adjustConfig.disableDeferredDeeplinkOpening();
7

8
Adjust.initSdk(adjustConfig);

Set up a deferred deep link delegate

setDeferredDeeplinkCallback(deferredDeeplinkCallback: (deeplink: string) => void): void

You can configure the Adjust SDK to call a delegate function when it receives a deferred deep link. This delegate function receives the deep link as a string argument.

1
const adjustConfig = new AdjustConfig(
2
   "{YourAppToken}",
3
   AdjustConfig.EnvironmentSandbox,
4
);
5

6
adjustConfig.setDeferredDeeplinkCallback(function (deeplink) {
7
   console.log("Deferred deep link URL content: " + deeplink);
8
});
9

10
Adjust.initSdk(adjustConfig);

Example

This example shows how to log a deep link address when the user opens a deferred deep link.

1
const adjustConfig = new AdjustConfig(
2
   "{YourAppToken}",
3
   AdjustConfig.EnvironmentSandbox,
4
);
5
adjustConfig.setDeferredDeeplinkCallback(function(deeplink) {
6
    console.log("Deferred deep link URL: " + deeplink);
7
)};
8

9
Adjust.initSdk(adjustConfig);

Reattribution via deep links

processDeeplink(adjustDeeplink: AdjustDeeplink): void

Adjust enables you to run re-engagement campaigns using deep links. For more information, check out how to set up Deep links in Campaign Lab.

To reattribute your user, you need to call the processDeeplink method when the app receives deep link content. The Adjust SDK then looks for new attribution data within the deep link. If the SDK finds new information, it forwards the information to Adjust’s servers for reattribution.

1
function handleOpenURL(url) {
2
   setTimeout(function () {
3
      // Check content of the url object and get information about the URL.
4
      Adjust.appWillOpenUrl(new AdjustDeeplink(url));
5
   }, 300);
6
}

You can call the Adjust.processDeeplink function inside your didLaunchAppFromLink method to open universal links.

1
var app = {
2
   initialize: function () {
3
      this.bindEvents();
4
   },
5

6
   bindEvents: function () {
7
      document.addEventListener("deviceready", this.onDeviceReady, false);
8
   },
9

10
   onDeviceReady: function () {
11
      if (device.platform == "iOS") {
12
         universalLinks.subscribe(
13
            "adjustDeepLinking",
14
            app.didLaunchAppFromLink,
15
         );
16
      }
17
   },
18

19
   didLaunchAppFromLink: function (eventData) {
20
      // Check content of the url object and get information about the URL.
21
      Adjust.appWillOpenUrl(new AdjustDeeplink(eventData.url));
22
   },
23
};

Enable LinkMe

enableLinkMe(): void

The Adjust SDK lets you copy deep link information from the device pasteboard. When combined with Adjust’s LinkMe solution, this feature enables deferred deep linking on devices running iOS 15 and above.

When a user clicks on a LinkMe URL they have the option to copy the link information to their system pasteboard. You can use the Adjust SDK to read the system pasteboard for deep link information. If deep link information is present, the SDK forwards the user to the correct page in your app.

To enable pasteboard checking in your app, call the enableLinkMe method on your config object:

1
const adjustConfig = new AdjustConfig(
2
   "{YourAppToken}",
3
   AdjustConfig.EnvironmentSandbox,
4
);
5

6
adjustConfig.enableLinkMe();
7

8
Adjust.initSdk(adjustConfig);