Deep linking

You can create deep links to take users to specific pages in your app. The Adjust SDK uses different logic depending on whether 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 them directly to the page specified in the link.
• Deferred deep linking: Occurs if the user doesn’t have your app installed. The link takes them to an app store to install the app first. After installation, the app opens to the page specified in the link.

Set up deep linking

In order to set up deep linking in your Solar2d / Corona app, please follow the official platform guide.

Reattribution using deep links

To reattribute a user, pass the deep link that opened your app as a parameter to the processDeeplink method call.

function processDeeplink(deeplink)

1
local function onSystemEvent(event)
2
   if event.type == "applicationOpenURL" then
3
      print("App opened via URL: " .. event.url)
4
      local adjustDeeplink = {}
5
      adjustDeeplink.deeplink = event.url
6
      adjust.processDeeplink(adjustDeeplink)
7
    end
8
end
9

10
Runtime:addEventListener("system", onSystemEvent)

Deferred deep linking

isDeferredDeeplinkOpeningEnabled;

The SDK opens deferred deep links by default. No additional setup is required. You can disable this behavior by setting the isDeferredDeeplinkOpeningEnabled key in your configuration table to false.

1
local adjust = require "plugin.adjust"
2

3
adjust.initSdk({
4
    appToken = "YourAppToken",
5
    environment = "SANDBOX",
6
    logLevel = "VERBOSE",
7
    isDeferredDeeplinkOpeningEnabled = false
8
})

Set up a deferred deep link callback

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

1
local adjust = require "plugin.adjust"
2

3
-- make sure to set the callback before calling initSdk
4
adjust.setDeferredDeeplinkCallback(function(event)
5
    print("Deferred deep link: " .. event.message)
6
end)
7

8
-- ...
9

10
adjust.initSdk({
11
    appToken = "YourAppToken",
12
    environment = "SANDBOX",
13
    logLevel = "VERBOSE"
14
})

Enable LinkMe

The Adjust SDK can 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 later.

When a user clicks a LinkMe URL, they have the option to copy the link information to their system pasteboard. The Adjust SDK can then read this data and route the user to the correct page in your app.

To enable pasteboard checking, set the isLinkMeEnabled key to true in your configuration table:

1
local adjust = require "plugin.adjust"
2

3
adjust.initSdk({
4
    appToken = "YourAppToken",
5
    environment = "SANDBOX",
6
    logLevel = "VERBOSE",
7
    isLinkMeEnabled = true
8
})

Handling Deeplinks with Referrer

An optional referrer URL can help track the source of a deep link or app open for better attribution or reattribution. This is useful for channels like SEO or organic search, where Adjust links are not directly used. If the client’s root domain has Android App Links implemented and triggers an app open, attribution may rely on signals coming from the referrer URL.

If your app is able to obtain this information internally (see how it’s done on iOS and Android), you can pass the referrer information to the SDK as described below:

1
local adjust = require "plugin.adjust"
2

3
adjustDeeplink = {}
4
adjustDeeplink.deeplink = "your-deep-link"
5
adjustDeeplink.referrer = "your-referrer"
6

7
adjust.processDeeplink(adjustDeeplink)