Android Adobe Extension v3 migration guide

The Adjust Extension for Adobe Experience SDK has been updated to v3 to support Adjust Android SDK v5. Follow this guide to migrate from v2 to v3.

To install v3 of the Adjust Android Extension for Adobe Experience, update the dependency declarations in your build.gradle as follows:

com.adjust.adobeextension:adobeextension MUST be updated to 3.0.0 or later.
com.adjust.sdk:adjust-android MUST be updated to 5.0.0 or later.

1
dependencies {
2
   implementation 'com.adjust.adobeextension:adobeextension:3.0.0'
3
   implementation 'com.adjust.sdk:adjust-android:5.0.1'
4
   implementation 'com.adobe.marketing.mobile:core:3.2.0'
5
   implementation 'com.android.installreferrer:installreferrer:2.2'
6
}

For a complete guide to setting up the Adjust Android Extension for Adobe Experience, see the integration guide.

New APIs

Added in v3

The following APIs have been added in v3.

Resolve short branded links

v3 of the Adjust Extension for Adobe Experience SDK adds support for resolving short branded links. To resolve shortened links, call the Adjust.processAndResolveDeeplink method with the following arguments:

adjustDeeplink: AdjustDeeplink: The deep link that opened the app.
context: Context: The app context. CallgetApplicationContext()to fill this value.
callback: OnDeeplinkResolvedListener: A callback function that receives the resolved short link as an argument.

1
Intent intent = getIntent();
2
Uri data = intent.getData();
3
AdjustDeeplink adjustDeeplink = new AdjustDeeplink(data);
4
Adjust.processAndResolveDeeplink(adjustDeeplink, getApplicationContext(), new OnDeeplinkResolvedListener() {
5
   @Override
6
   public void onDeeplinkResolved(String s) {
7

8
   }
9
});

Global callback parameters

v3 of the Adjust Extension for Adobe Experience SDK adds support for the global callback parameters API from Android SDK v5. To add global callbacks to your sessions, call the Adjust.addGlobalCallbackParameter method with the following arguments:

key: String: The key of your parameter.
value: String: The value of your parameter.

1
Adjust.addGlobalCallbackParameter("key", "value");
2
Adjust.addGlobalCallbackParameter("user_id", "855");

Learn how to set up global callback.

Global partner parameters

v3 of the Adjust Extension for Adobe Experience SDK adds support for the global partner parameters API from Android SDK v5. To add global partner parameters, call the Adjust.addGlobalPartnerParameter method with the following arguments:

key: String: The key of your parameter.
value: String: The value of your parameter.

1
Adjust.addGlobalPartnerParameter("key", "value");
2
Adjust.addGlobalPartnerParameter("user_id", "855");

Learn how to set up global partner parameters.

Set external device ID

v3 of the Adjust Extension for Adobe Experience SDK adds support for setting external device identifiers. To set an external device ID, call the setExternalDeviceId method of your AdjustAdobeExtensionConfig instance with the following argument:

externalDeviceId: String: Your external device identifier.

1
String environment = AdjustAdobeExtensionConfig.ENVIRONMENT_SANDBOX;
2
AdjustAdobeExtensionConfig config = new AdjustAdobeExtensionConfig(environment);
3
config.setExternalDeviceId("{YourExternalDeviceId}");
4
AdjustAdobeExtension.setConfiguration(config);

Learn how to configure external device IDs.

Set default link token for preinstalled apps

v3 of the Adjust Extension for Adobe Experience SDK adds support for setting a default link token for recording preinstalled app installs to a default campaign. To set a default link token, call the setDefaultTracker method of your AdjustAdobeExtensionConfig instance with the following argument:

defaultTracker: String: The alphanumeric link token of your preinstall campaign.

1
String environment = AdjustAdobeExtensionConfig.ENVIRONMENT_SANDBOX;
2
AdjustAdobeExtensionConfig config = new AdjustAdobeExtensionConfig(environment);
3
config.setDefaultTracker("{Token}");
4
AdjustAdobeExtension.setConfiguration(config);

Learn how to send preinstalled app activity.

Changed APIs

Changed in v3

The following APIs have changed in v3.

Retrieve device ADID

In SDK v2, the AdjustAttribution class has a property called adid. This property has been removed. You can retrieve the device's ADID asynchronously, by calling Adjust.getAdid.

1
Adjust.getAdid(new OnAdidReadListener() {
2
    @Override
3
    public void onAdidRead(String adid) {
4
      // Your callback function
5
    }
6
});

Direct deep linking

In SDK v2, you can open deep links for attribution by calling the AdjustAdobeExtension.openUrl method with the deep link data as an argument.

1
Intent intent = getIntent();
2
Uri data = intent.getData();
3
AdjustAdobeExtension.openUrl(data, getApplicationContext());

SDK v3 has been updated to use the Adjust Android SDK's processDeeplink method. To open direct deep links:

Create a new AdjustDeeplink instance with the deep link URL.
Pass your AdjustDeeplink instance to the Adjust.processDeeplink method.

1
Intent intent = getIntent();
2
Uri data = intent.getData();
3
AdjustDeeplink adjustDeeplink = new AdjustDeeplink(data);
4
Adjust.processDeeplink(adjustDeeplink, getApplicationContext());

Learn how to reattribute users with direct deep links.

Deferred deep linking callback

In SDK v2, you can configure the SDK to launch a callback function when a deferred deep link is opened by passing a function to the setOnDeeplinkResponseListener method of your AdjustAdobeExtensionConfig instance.

1
AdjustAdobeExtensionConfig config = new AdjustAdobeExtensionConfig(environment);
2

3
config.setOnDeeplinkResponseListener(new OnDeeplinkResponseListener() {
4
    @Override
5
    public boolean launchReceivedDeeplink(Uri deeplink) {
6
        if (shouldAdjustSdkLaunchTheDeeplink(deeplink)) {
7
            return true;
8
        } else {
9
            return false;
10
        }
11
    }
12
});
13

14
AdjustAdobeExtension.setConfiguration(config);

In SDK v3, the setOnDeeplinkResponseListener method has been renamed to setOnDeferredDeeplinkResponseListener.

1
AdjustAdobeExtensionConfig config = new AdjustAdobeExtensionConfig(environment);
2

3
config.setOnDeferredDeeplinkResponseListener(new OnDeferredDeeplinkResponseListener() {
4
    @Override
5
    public boolean launchReceivedDeeplink(Uri deeplink) {
6
        if (shouldAdjustSdkLaunchTheDeeplink(deeplink)) {
7
            return true;
8
        } else {
9
            return false;
10
        }
11
    }
12
});
13

14
AdjustAdobeExtension.setConfiguration(config);

Learn how to work with deferred deep link callbacks.