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

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.

allprojects {
    repositories {
        maven { url = uri("https://sdk-download.airbridge.io/maven") }
    }
}

allprojects {
    repositories {
        maven { url = uri("https://sdk-download.airbridge.io/maven") }
    }
}

dependencies {
    // Replace $HERE_LATEST_VERSION with latest version
    // - Versions: https://sdk-download.airbridge.io/maven
    // - Example: implementation "io.airbridge:sdk-android:0.0.0"
    implementation "io.airbridge:sdk-android:$HERE_LATEST_VERSION"
}

dependencies {
    // Replace $HERE_LATEST_VERSION with latest version
    // - Versions: https://sdk-download.airbridge.io/maven
    // - Example: implementation("io.airbridge:sdk-android:0.0.0")
    implementation("io.airbridge:sdk-android:$HERE_LATEST_VERSION")
}

dependencyResolutionManagement {
    repositories {
        maven { url = uri("https://sdk-download.airbridge.io/maven") }
    }
}

dependencyResolutionManagement {
    repositories {
        maven { url = uri("https://sdk-download.airbridge.io/maven") }
    }
}

dependencies {
    // Replace $HERE_LATEST_VERSION with latest version
    // - Versions: https://sdk-download.airbridge.io/maven
    // - Example: implementation "io.airbridge:sdk-android:0.0.0"
    implementation "io.airbridge:sdk-android:$HERE_LATEST_VERSION"
}

dependencies {
    // Replace $HERE_LATEST_VERSION with latest version
    // - Versions: https://sdk-download.airbridge.io/maven
    // - Example: implementation("io.airbridge:sdk-android:0.0.0")
    implementation("io.airbridge:sdk-android:$HERE_LATEST_VERSION")
}

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.

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.

allprojects {
    repositories {
        maven { url = uri("https://sdk-download.airbridge.io/maven") }
    }
}

allprojects {
    repositories {
        maven { url = uri("https://sdk-download.airbridge.io/maven") }
    }
}

dependencies {
    // Replace $HERE_LATEST_VERSION` with latest version
    // - Versions: https://sdk-download.airbridge.io/maven
    // - Example: implementation "io.airbridge:sdk-android-restricted:0.0.0"
    implementation "io.airbridge:sdk-android-restricted:$HERE_LATEST_VERSION"
}

dependencies {
    // Replace $HERE_LATEST_VERSION with latest version
    // - Versions: https://sdk-download.airbridge.io/maven
    // - Example: implementation("io.airbridge:sdk-android-restricted:0.0.0")
    implementation("io.airbridge:sdk-android-restricted:$HERE_LATEST_VERSION")
}

dependencyResolutionManagement {
    repositories {
        maven { url = uri("https://sdk-download.airbridge.io/maven") }
    }
}

dependencyResolutionManagement {
    repositories {
        maven { url = uri("https://sdk-download.airbridge.io/maven") }
    }
}

dependencies {
    // Replace $HERE_LATEST_VERSION` with latest version
    // - Versions: https://sdk-download.airbridge.io/maven
    // - Example: implementation "io.airbridge:sdk-android-restricted:0.0.0"
    implementation "io.airbridge:sdk-android-restricted:$HERE_LATEST_VERSION"
}

dependencies {
    // Replace $HERE_LATEST_VERSION with latest version
    // - Versions: https://sdk-download.airbridge.io/maven
    // - Example: implementation("io.airbridge:sdk-android-restricted:0.0.0")
    implementation("io.airbridge:sdk-android-restricted:$HERE_LATEST_VERSION")
}

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.

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()
    }
}

import android.app.Application;

public class AndroidApplication extends Application {

    @Override
    public void onCreate() {
        super.onCreate();
    }
}

2. Set the generated Application in AndroidManifest.xml.

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

3. Get Airbridge from the Application class.

import co.ab180.airbridge.Airbridge

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)
}

@Override
public void onCreate() {
    super.onCreate();
    // YOUR_APP_NAME: input your app name
    // YOUR_APP_SDK_TOKEN: input your app token
    AirbridgeOption option = new AirbridgeOptionBuilder("YOUR_APP_NAME", "YOUR_APP_SDK_TOKEN")
        .build();
    Airbridge.initializeSDK(this, option);
}

Attention

Make sure that the initalizeSDK function is called within the onCreate method of the Application class for proper functionality.

5. Set the following permissions.

<manifest ...>
  ...
  <uses-permission android:name="android.permission.INTERNET" />
  <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
  ...
</manifest>

<manifest ...>
  ...
  <uses-permission android:name="com.google.android.gms.permission.AD_ID" />
  ...
</manifest>

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.

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.

keytool -list -v -keystore YOUR_KEYSTORE.keystore

Certificate fingerprints:
    MD5:  4C:65:04:52:F0:3F:F8:65:08:D3:71:86:FC:EF:C3:49
    SHA1: C8:BF:B7:B8:94:EA:5D:9D:38:59:FE:99:63:ED:47:B2:D9:5A:4E:CC
    SHA256: B5:EF:4D:F9:DC:95:E6:9B:F3:9A:5E:E9:D6:E0:D8:F6:7B:AB:79:C8:78:67:34:D9:A7:01:AB:6A:86:01:0E:99

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.

import android.os.Bundle
import androidx.appcompat.app.AppCompatActivity

class DeeplinkActivity: AppCompatActivity() {

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
    }
}

import android.os.Bundle;

import androidx.annotation.Nullable;
import androidx.appcompat.app.AppCompatActivity;

public class DeeplinkActivity extends AppCompatActivity {

    @Override
    protected void onCreate(@Nullable Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
    }
}

<application
    ...>

    <activity android:name=".DeeplinkActivity" />

</application>

<activity ...>
    ...
    <intent-filter>
        <action android:name="android.intent.action.VIEW" />

        <category android:name="android.intent.category.DEFAULT" />
        <category android:name="android.intent.category.BROWSABLE" />

        <data android:scheme="YOUR_SCHEME" />
    </intent-filter>
    ...
</activity>

<activity ...>
    ...
    <intent-filter android:autoVerify="true">
        <action android:name="android.intent.action.VIEW" />

        <category android:name="android.intent.category.DEFAULT" />
        <category android:name="android.intent.category.BROWSABLE" />

        <data android:scheme="http" android:host="YOUR_APP_NAME.abr.ge" />
        <data android:scheme="https" android:host="YOUR_APP_NAME.abr.ge" />
    </intent-filter>
    <intent-filter android:autoVerify="true">
        <action android:name="android.intent.action.VIEW" />

        <category android:name="android.intent.category.DEFAULT" />
        <category android:name="android.intent.category.BROWSABLE" />

        <data android:scheme="http" android:host="YOUR_APP_NAME.airbridge.io" />
        <data android:scheme="https" android:host="YOUR_APP_NAME.airbridge.io" />
    </intent-filter>
    ...
</activity>

// when activity is opened with scheme deeplink or app links
override fun onResume() {
	super.onResume()
	
	// handle airbridge deeplink
	val isAirbridgeDeeplink = Airbridge.handleDeeplink(intent) {
		// when app is opened with airbridge deeplink
        // show proper content using url (YOUR_SCHEME://...)
	}
	if (isAirbridgeDeeplink) return

	// when app is opened with other deeplink
    // use existing logic as it is
}

override fun onNewIntent(intent: Intent?) {
	super.onNewIntent(intent)
	setIntent(intent)
}

// when activity is opened with scheme deeplink or app links
@Override
protected void onResume() {
    super.onResume();

    boolean isAirbridgeDeeplink = Airbridge.handleDeeplink(
        getIntent(),
        uri -> {
            // when app is opened with airbridge deeplink
            // show proper content using url (YOUR_SCHEME://...)
        }
    );
    if (isAirbridgeDeeplink) return;

    // when app is opened with other deeplink
    // use existing logic as it is
}

@Override
protected void onNewIntent(Intent intent) {
    super.onNewIntent(intent);
    setIntent(intent);
}

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://...)
    }
}

boolean 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.

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

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.

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.INFO
val option = AirbridgeOptionBuilder("YOUR_APP_NAME", "YOUR_APP_SDK_TOKEN")
    .setLogLevel(AirbridgeLogLevel.DEBUG)
    .build()
Airbridge.initializeSDK(this, option)

AirbridgeOption option = new 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.

Check whether the deep linking feature configured in the Airbridge Android SDK works as intended.

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

Airbridge provides a website for testing deep links. If you want to test deferred deep links, you need to uninstall the app from your test device.

1. Visit the deep link testing site from your test device. You can access the website directly by using the QR code below.

2. Enter the App Name you registered with Airbridge. You can find it on the [Settings]>[Tokens] page in the Airbridge dashboard.

If you want to test a specific deep link address, enter the scheme deep link into the Deeplink URL field. The scheme deep link format is {YOUR_SCHEME}://...If you're using a custom domain, make sure to enter your custom domain.

3. Click one of the buttons listed below. Click the button depending on the deep link type you are testing.

Note that you can only test deferred deep links if the app is not installed on your test device.

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 as follows.

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

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

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

If the SDK log level has been set to DEBUG in the Airbridge SDK initialization process, you can check the value sent through the network.

5. The client request: method={...} message transmits the header and body values. Check the following items based on the button clicked on the deep link test site. If the deep link is working properly, all items should be confirmed.

6. If you can't see the logs in LogCat even after a considerable 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.

Refer to the information below for troubleshooting regarding deep links.

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?
)

public void createTrackingLink(
    @NonNull String channel,
    @NonNull Map<String, Object> option,
    @NonNull OnSuccess<AirbridgeTrackingLink> onSuccess
)

public void createTrackingLink(
    @NonNull String channel,
    @NonNull Map<String, Object> option,
    @NonNull OnSuccess<AirbridgeTrackingLink> onSuccess,
    @Nullable 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
)

public class AirbridgeTrackingLink {
    Uri shortURL;
    Uri qrcodeURL;
}

Refer to the example codes below.

Airbridge.createTrackingLink(
    channel = "test_channel",
    option = mapOf(
		AirbridgeTrackingLinkOption.CAMPAIGN to "test_campaign",
        AirbridgeTrackingLinkOption.DEEPLINK_URL to "YOUR_SCHEME://...",
        AirbridgeTrackingLinkOption.FALLBACK_IOS to "store",
        AirbridgeTrackingLinkOption.FALLBACK_ANDROID to "store",
        AirbridgeTrackingLinkOption.FALLBACK_DESKTOP: "https://example.com/")
    onSuccess = { trackingLink ->
        // Handling created tracking-link
    },
    onFailure = { error ->
        // Handling error
    }
)

Airbridge.createTrackingLink(
    "test_channel",
    new HashMap<String, Object>() {{
        put(AirbridgeTrackingLinkOption.CAMPAIGN, "test_campaign");
        put(AirbridgeTrackingLinkOption.DEEPLINK_URL, "YOUR_SCHEME://...");
        put(AirbridgeTrackingLinkOption.FALLBACK_IOS, "store");
        put(AirbridgeTrackingLinkOption.FALLBACK_ANDROID, "store");
        put(AirbridgeTrackingLinkOption.FALLBACK_DESKTOP, "https://example.com/");
    }},
    (OnSuccess<AirbridgeTrackingLink>) trackingLink -> {

    },
    (OnFailure) error -> {

    }
);

Airbridge.createTrackingLink(
    channel = "test_channel",
    option = mapOf(
		AirbridgeTrackingLinkOption.CAMPAIGN to "test_campaign",
        AirbridgeTrackingLinkOption.DEEPLINK_URL to "sample://home",
        AirbridgeTrackingLinkOption.FALLBACK_IOS to "https://example.com/",
        AirbridgeTrackingLinkOption.FALLBACK_ANDROID to "https://example.com/",
        AirbridgeTrackingLinkOption.FALLBACK_DESKTOP to "https://example.com/"),
    onSuccess = { trackingLink ->
        // Handling created tracking-link
    },
    onFailure = { error ->
        // Handling error
    }
)

Airbridge.createTrackingLink(
    "test_channel",
    new HashMap<String, Object>() {{
        put(AirbridgeTrackingLinkOption.CAMPAIGN, "test_campaign");
        put(AirbridgeTrackingLinkOption.DEEPLINK_URL, "sample://home");
        put(AirbridgeTrackingLinkOption.FALLBACK_IOS, "https://example.com/");
        put(AirbridgeTrackingLinkOption.FALLBACK_ANDROID, "https://example.com/");
        put(AirbridgeTrackingLinkOption.FALLBACK_DESKTOP, "https://example.com/");
    }},
    (OnSuccess<AirbridgeTrackingLink>) trackingLink -> {

    },
    (OnFailure) error -> {

    }
);

Airbridge.createTrackingLink(
    channel = "test_channel",
    option = mapOf(
		AirbridgeTrackingLinkOption.CAMPAIGN to "test_campaign",
        AirbridgeTrackingLinkOption.FALLBACK_IOS to "store",
        AirbridgeTrackingLinkOption.FALLBACK_ANDROID to "store",
        AirbridgeTrackingLinkOption.FALLBACK_DESKTOP to "https://example.com/"),
    onSuccess = { trackingLink ->
        // Handling created tracking-link
    },
    onFailure = { error ->
        // Handling error
    }
)

Airbridge.createTrackingLink(
    "test_channel",
    new HashMap<String, Object>() {{
        put(AirbridgeTrackingLinkOption.CAMPAIGN, "test_campaign");
        put(AirbridgeTrackingLinkOption.FALLBACK_IOS, "store");
        put(AirbridgeTrackingLinkOption.FALLBACK_ANDROID, "store");
        put(AirbridgeTrackingLinkOption.FALLBACK_DESKTOP, "https://example.com/");
    }},
    (OnSuccess<AirbridgeTrackingLink>) trackingLink -> {

    },
    (OnFailure) error -> {

    }
);

Airbridge.createTrackingLink(
    channel = "test_channel",
    option = mapOf(
		AirbridgeTrackingLinkOption.CAMPAIGN to "test_campaign",
        AirbridgeTrackingLinkOption.FALLBACK_IOS to "https://example.com/",
        AirbridgeTrackingLinkOption.FALLBACK_ANDROID to "https://example.com/",
        AirbridgeTrackingLinkOption.FALLBACK_ANDROID to "https://example.com/"),
    onSuccess = { trackingLink ->
        // Handling created tracking-link
    },
    onFailure = { error ->
        // Handling error
    }
)

Airbridge.createTrackingLink(
    "test_channel",
    new HashMap<String, Object>() {{
        put(AirbridgeTrackingLinkOption.CAMPAIGN, "test_campaign");
        put(AirbridgeTrackingLinkOption.FALLBACK_IOS, "https://example.com");
        put(AirbridgeTrackingLinkOption.FALLBACK_ANDROID, "https://example.com");
        put(AirbridgeTrackingLinkOption.FALLBACK_DESKTOP, "https://example.com");
    }},
    (OnSuccess<AirbridgeTrackingLink>) trackingLink -> {

    },
    (OnFailure) error -> {

    }
);