DeepLink - Android SDK

Install the Airbridge Android SDK and implement the necessary settings following the steps below.

Install SDK

The Airbridge Android SDK can be installed using the method below. After installation, check whether the SDK has been properly installed through the Android SDK test.

Note

For the Gradle setup, refer to Gradle (build.gradle) if your project's build.gradle file contains repositories block, or refer to Gradle (settings.gradle) if your project's settings.gradle file contains repositories block.

Install Restricted SDK

Note

Install only one version of the SDK, either the general SDK or the restricted SDK.

Depending on policies and environments, restrictions on collecting device IDs like GAID and IDFA may be required. When installing the Restricted SDK version, the device IDs are not collected.

Install the Restricted SDK using the method below.

Attention

For the Gradle setup, refer to Gradle (build.gradle) if your project's build.gradle file contains repositories block, or refer to Gradle (settings.gradle) if your project's settings.gradle file contains repositories block.

Initialize SDK

Initializing the Airbridge Android SDK in the Android Application class is recommended.

1. Create an Application class.

import android.app.Application class AndroidApplication: Application() { override fun onCreate() { super.onCreate() }}

2. Set the generated Application in AndroidManifest.xml.

AndroidManifest.xml
<application android:name=".AndroidApplication" ...>

3. Get Airbridge from the Application class.

import co.ab180.airbridge.Airbridge

4. Add the following code snippet to the Application class file registered in AndroidManifest.xml.

The YOUR_APP_NAME and YOUR_APP_SDK_TOKEN can be found on the [Settings]>[Tokens] page in the Airbridge dashboard.

override fun onCreate() { super.onCreate() // YOUR_APP_NAME: input your app name // YOUR_APP_SDK_TOKEN: input your app token val option = AirbridgeOptionBuilder("YOUR_APP_NAME", "YOUR_APP_SDK_TOKEN") .build() Airbridge.initializeSDK(this, option)}

Attention

To ensure initializeSDK works correctly, follow the conditions below.

  • Must be called in the Application class's onCreate.

  • Must be called on the Main thread.

5. Set the following permissions.

Attention

Starting from Airbridge Android SDK 4.9.0, backup rule configuration is not required. Only refer to the backup rule configuration in the troubleshooting guide if you are using a version below 4.9.0.

Deep Linking

Deep linking allows you to redirect users from ads to specific locations within your app. The data collected from the tracking link enables you to monitor the performance of the deep link in Airbridge.

When a user clicks on the Airbridge tracking link, the scheme deep link embedded in the tracking link is converted into an Airbridge Deep Link, which can be either an HTTP deep link or a scheme deep link. This Airbridge Deep Link redirects the user to the desired app location. Then, the Airbridge SDK converts the Airbridge Deep Link back to the original scheme deep link embedded in the tracking link and passes it to the app.

  • Example scheme deep link embedded in the tracking link: YOUR_SCHEME://product/12345

  • Examples of Airbridge Deep Links

    • HTTP deep link format 1: https://YOUR_APP_NAME.airbridge.io/~~~

    • HTTP deep link format 2: https://YOUR_APP_NAME.abr.ge/~~~

    • Scheme deep link format: YOUR_SCHEME://product/12345?airbridge_referrer=~~~

When the app is installed on the device and the tracking link is clicked, the app opens through the Airbridge Deep Link. The Airbridge SDK converts the Airbridge Deep Link into the scheme deep embedded in the tracking link and passes it to the app.

When the app is not installed on the device and the tracking link is clicked, the Airbridge SDK saves the Airbridge Deep Link. After the user is redirected to the app store or website and the app is installed and launched, the Airbridge SDK converts the saved Airbridge Deep Link into the scheme deep link embedded in the tracking link and passes it to the app.

Set up deep linking

For the deep linking setup, the deep link information entered to the Airbridge dashboard and the in-app location address for user redirection is required.

First, enter the deep link information into the Airbridge dashboard.

After entering the deep link information into the Airbridge dashboard, additional setup is required to enable the following.

  • App launch with Airbridge deep links

  • User redirection with Airbridge deep links

For detailed instructions, refer to the information below.

Set up deferred deep linking

When a user clicks on a tracking link with deferred deep linking capabilities and your app is not installed on the device, the Airbridge SDK collects the deep link as follows.

The Airbridge.handleDeferredDeeplink function collects the saved Airbridge deep link and converts it into a scheme deep link to pass it to the app. Users are redirected to the intended destination using the converted scheme deep link.

val isFirstCalled = Airbridge.handleDeferredDeeplink { uri -> // when handleDeferredDeeplink is called firstly after install if (uri != null) { // show proper content using uri (YOUR_SCHEME://...) }}

The Airbridge.handleDeferredDeeplink function returns true if it has been called for the first time after the install and waits for the Airbridge deep link to be retrieved, converts it to a scheme deep link to pass it to onSuccess. You can use this scheme deep link to send users to the intended destination.

If there is no stored Airbridge deep link, null is passed to onSuccess. If the SDK is not initialized or if the Airbridge.handleDeferredDeeplink function has not been called for the first time, false will be returned.

The scheme deep link is usually a URL in the form of YOUR_SCHEME://... If you use services like Meta Deferred App Links, a different form of URL may be passed.

Attention

When the app is opened via a deep link, Airbridge passes null to onSuccess regardless of whether a deferred deep link exists or not, ensuring that only the deep link is processed.

Testing

The SDK functionality test and deep link test allow you to check whether the SDK and deep linking work as intended.

Test SDK functionality

Check whether the Airbridge Android SDK is operating properly. The Install events are collected by the Android SDK regardless of whether the additional configurations have been completed or not.

Check Install event collection

Follow the steps below to check whether the Install events are being collected by the Android SDK.

1. Prepare a test device where the app is not installed, or if the app is already installed, delete it before testing.

2. Set the SDK log level to DEBUG.

// Default log level = Log.INFOval option = AirbridgeOptionBuilder("YOUR_APP_NAME", "YOUR_APP_SDK_TOKEN") .setLogLevel(AirbridgeLogLevel.DEBUG) .build()Airbridge.initializeSDK(this, option)

3. Install the app on the test device. After installing the app, launch it so that the Install event is collected.

The first Open event collected by Airbridge is recorded as an Install event. Therefore, the Open may not be recorded when the app install event is collected.

4. Use LogCat in the Android Studio or the Android Debug Bridge (ADB) to check whether the event performed on the test device with a specific GAID is logged properly. If the Install events are being collected properly, you should see logs such as the following.

  • Send event packets to Airbridge: categories={9161}

  • Send event packets to Airbridge: categories={9163}

For the LogCat messages and their meaning, refer to the following.

5. If you can't see the logs in LogCat even after a sufficient amount of time has passed, check whether the SDK has been initialized, the SDK configurations are completed as instructed, and the network status is stable.

If the problem persists, contact your Airbridge CSM and share your SDK logs. If you don't have a designated Airbridge CSM, contact the Airbridge Help Center.

The deep linking test is available in the [Deep Linking] tab on the [Settings]>[Test Console] page in the Airbridge dashboard.

Pre-setup

Before testing the deep link, make sure the following items have been set up.

Test preparation

The deep link information and app information required to enable deep linking must be submitted to the Airbridge dashboard before starting the test. This stage won’t show in your dashboard if the deep link information and app information have already been submitted. You may move on to the actual testing.

To test deep linking, make sure the required deep link information is submitted to the Airbridge dashboard for at least 1 platform. If you want to add or edit the deep link info, click Go to Settings. You can check and update the information on the [Tracking Link]>[Deep Links] page. For more details, refer to this article.

Refresh to see the latest version

If you've completed the setup in a different browser tab, refresh the Airbridge dashboard tab to reflect the most recent changes.

Submit App Info

The deep link fallback path should be configured in advance so that users who haven’t installed the app on their devices are redirected to the app store. Click Go to Settings and fill in the “Platform” section on the [Settings]>[App Settings] page. For more details, refer to this article.

Enter the deep link configured for the app you want to test. The deep link must be in the form of the URL scheme deep link. It should preferably be set to a specific in-app location instead of the home screen.

Attention

Encode the deep link before entering it into the required field. If you don't, the link will not conform to the standard URL format, and deep linking will not function properly.

Click the [switch] icon on the right to change the input method. This allows you to add the path and parameters separately to input a deep link.

Check readiness for testing

Check if the info required for testing deep linking is submitted to the Airbridge dashboard. If all info is submitted for a platform, the “Ready for testing” tag will show. If not, the “Info incomplete” tag will show. Click the tooltip next to the platform name to see the required info for testing. If you see the “Info incomplete” tag for the platform you want to run the deep linking test, click Go to Settings to add or edit the required info to get ready for testing.

Refresh to see the latest version

If you've completed the setup in a different browser tab, refresh the Airbridge dashboard tab to reflect the most recent changes.

Testing

The testing console offers tests for 2 deep-linking scenarios. There are 3 tests for “Scenario 1: App already installed” and 1 test for “Scenario 2: App not installed." Complete all 4 tests if you are using a custom domain to create tracking links. If not, complete all tests except for the Custom Domain Test.

Why are there multiple tests?

Airbridge supports various deep linking methods, including URL scheme deep links, Universal Links, and App Links. When an app is launched, the system automatically selects the most suitable method based on factors such as the operating system, browser, and whether the app is installed. Test across all possible cases to ensure reliable deep-linking performance.

Testing for Scenario 1: App already installed

Testing Scenario 1 allows you to make sure the deep linking functions as intended for users who have already installed the app on their devices. You can run 3 types of tests, including a test for cases when the app is opened via URL scheme deep links, when the app is opened via Universal Links or App Links, and when the tracking link is created using a custom domain.

Preparation

Before you start the test, check the following items.

1. Prepare a mobile test device.

2. Check whether the app is installed on the test device. If not, download the app.

3. Open the app at least once after download.

4. Make sure the default browser setting is Chrome or Safari. The deep linking test may not work in other browsers.

5. Make sure you have a stable network connection.

Note

If there are no issues with the deep link settings and the deep linking tests have been successfully completed, Airbridge deep linking works on most browsers. Note that deep linking tests are only supported on Chrome and Safari.

How to run each test

1. Click the test you want to run.

2. Scan the QR code with the test device and access the testing page. If you're unable to scan the QR code, use the URL at the bottom of the QR code.

3. Once you access the testing website, click Trigger deep linking. The test will run automatically on the 5 items displayed. If an issue is identified, follow the instructions and refer to the Airbridge user guide to resolve it. Then, start the test again.

When the test is completed successfully, you can find the Deeplink Open event on the [Raw Data]>[App Real-time Log] page.

4. After returning to the [Testing Console] tab, click Done and close the test window.

Testing for Scenario 2: App not installed

Testing Scenario 2 allows you to make sure the deep linking functions as intended for users who have not installed the app on their devices. You can run 1 test for deferred deep linking.

Preparation

Before you start the test, check the following items.

1. Prepare a mobile test device.

2. Check whether the app is not installed on the test device. If installed, delete the app from the device.

3. Make sure the default browser setting is Chrome or Safari. The deep linking test may not work in other browsers.

4. Make sure you have a stable network connection.

How to run the test

1. Click the test you want to run.

2. Scan the QR code with the test device and access the testing page. If you're unable to scan the QR code, use the URL at the bottom of the QR code.

3. Once you access the testing page, click Trigger deep linking. The test will run automatically on the 3 items displayed. If an issue is identified, follow the instructions and refer to the Airbridge user guide to resolve it.

When the test is completed successfully, you can find the Deeplink Open event on the [Raw Data]>[App Real-time Log] page.

4. After returning to the [Testing Console] tab, click Done and close the test window.

Troubleshooting

Refer to the information below for troubleshooting regarding deep links.

Additional SDK Settings

Refer to the information below for additional setup.

Attention

Optional settings. Configure only if necessary.

Android SDK v.4.3.0 or later is required.

Tracking links are links that are embedded in ads for data collection. When users click on the ad, the tracking link is used to pass the touchpoint data to Airbridge, allowing for ad attribution.

Also, users who click on the ad with a tracking link can be redirected to a specific destination.

Use the createTrackingLink function to create tracking links. Refer to the code examples and the parameter details below.

fun createTrackingLink( channel: String, option: Map<String, Any>, onSuccess: OnSuccess<AirbridgeTrackingLink>) fun createTrackingLink( channel: String, option: Map<String, Any>, onSuccess: OnSuccess<AirbridgeTrackingLink>, onFailure: OnFailure?)

Use the option parameter in the createTrackingLink function to configure tracking link options.

Use the onSuccess callback in the createTrackingLink function to pass the AirbridgeTrackingLink.

data class AirbridgeTrackingLink( val shortURL: Uri, val qrcodeURL: Uri)

Refer to the example codes below.