SDK v5 migration guide

Before you begin

Here’s what you need to do before updating to SDK v5:

1. SDK v5 supports SDK signature verification natively. If you currently use the SDK signature library, you need to uninstall this first.
2. If your app targets API versions lower than 21 you need to update your app before you can use SDK v5.

Install the SDK

To start using SDK v5, you need to add it as a dependency in your project. To do this:

1. Remove any older versions of the SDK you currently have in your build.gradle file.

2. Add the following dependencies to your build.gradle file:

   dependencies {
      implementation 'com.adjust.sdk:adjust-android:5.0.0'
      implementation 'com.android.installreferrer:installreferrer:2.2'
      // Add the following if you are using the Adjust SDK inside web views on your app
      implementation 'com.adjust.sdk:adjust-android-webbridge:5.0.0'
   }

Update the initialization method

In SDK v4, the initialization method is Adjust.onCreate(AdjustConfig). This has been changed to Adjust.initSdk(AdjustConfig) in SDK v5.

Adjust.onCreate(adjustConfig) // v4
Adjust.initSdk(adjustConfig) // v5

Adjust.onCreate(adjustConfig); // v4
Adjust.initSdk(adjustConfig); // v5

Configure the SDK Signature library

SDK v5 includes the SDK signature library. You can test this by following the testing steps in the Signature library integration guide.

Signature protection is inactive by default. To enable it, you need to:

1. Enforce signature validation.
2. Provide your app’s SHA-1 fingerprints prior to testing.

Once you’ve installed the v5 SDK, you need to update your existing Adjust code to use the new APIs.

New APIs

The following APIs have been added in SDK v5.

Install referrer getters

SDK v5 contains new getter methods for fetching install referrer information.

Adjust.getGooglePlayInstallReferrer(
   applicationContext,
   object : OnGooglePlayInstallReferrerReadListener {
         override fun onInstallReferrerRead(referrerDetails: GooglePlayInstallReferrerDetails) {}
         override fun onFailure(message: String) {}
   })

AdjustHuaweiReferrer.getHuaweiAdsInstallReferrer(
   applicationContext,
   object : OnHuaweiInstallReferrerReadListener() {
         fun onInstallReferrerDetailsRead(referrerDetails: HuaweiInstallReferrerDetails?) {}
         fun onFail(message: String?) {}
   })


AdjustHuaweiReferrer.getHuaweiAppGalleryInstallReferrer(
   applicationContext,
   object : OnHuaweiInstallReferrerReadListener() {
         fun onInstallReferrerDetailsRead(referrerDetails: HuaweiInstallReferrerDetails?) {}
         fun onFail(message: String?) {}
   })

AdjustSamsungReferrer.getSamsungInstallReferrer(
   applicationContext,
   object : OnSamsungInstallReferrerReadListener() {
         fun onSamsungInstallReferrerRead(referrerDetails: SamsungInstallReferrerDetails?) {}
         fun onFail(message: String?) {}
   })

AdjustVivoReferrer.getVivoInstallReferrer(
   applicationContext,
   object : OnVivoInstallReferrerReadListener() {
         fun onVivoInstallReferrerRead(referrerDetails: VivoInstallReferrerDetails?) {}
         fun onFail(message: String?) {}
   })

AdjustXiaomiReferrer.getXiaomiInstallReferrer(
   applicationContext,
   object : OnXiaomiInstallReferrerReadListener() {
         fun onXiaomiInstallReferrerRead(referrerDetails: XiaomiInstallReferrerDetails?) {}
         fun onFail(message: String?) {}
   })

Adjust.getGooglePlayInstallReferrer(getApplicationContext(), new OnGooglePlayInstallReferrerReadListener() {
    @Override
    public void onInstallReferrerRead(GooglePlayInstallReferrerDetails referrerDetails) {
    }

    @Override
    public void onFailure(String message) {
    }
});

AdjustHuaweiReferrer.getHuaweiAdsInstallReferrer(getApplicationContext(), new OnHuaweiInstallReferrerReadListener() {
   @Override
   public void onInstallReferrerDetailsRead(HuaweiInstallReferrerDetails referrerDetails) {
   }


   @Override
   public void onFail(String message) {
   }
});

AdjustHuaweiReferrer.getHuaweiAppGalleryInstallReferrer(getApplicationContext(), new OnHuaweiInstallReferrerReadListener() {
   @Override
   public void onInstallReferrerDetailsRead(HuaweiInstallReferrerDetails referrerDetails) {
   }


   @Override
   public void onFail(String message) {
   }
});

AdjustSamsungReferrer.getSamsungInstallReferrer(getApplicationContext(), new OnSamsungInstallReferrerReadListener() {
   @Override
   public void onSamsungInstallReferrerRead(SamsungInstallReferrerDetails referrerDetails) {
   }


   @Override
   public void onFail(String message) {
   }
});

AdjustVivoReferrer.getVivoInstallReferrer(getApplicationContext(), new OnVivoInstallReferrerReadListener() {
   @Override
   public void onVivoInstallReferrerRead(VivoInstallReferrerDetails referrerDetails) {
   }


   @Override
   public void onFail(String message) {
   }
});

AdjustXiaomiReferrer.getXiaomiInstallReferrer(getApplicationContext(), new OnXiaomiInstallReferrerReadListener() {
   @Override
   public void onXiaomiInstallReferrerRead(XiaomiInstallReferrerDetails referrerDetails) {
   }


   @Override
   public void onFail(String message) {
   }
});

Changed APIs

The following APIs have changed in SDK v5.

Disable and enable the SDK

In SDK v4, you can enable and disable the SDK by calling Adjust.setEnabled() with a boolean value.

• Call Adjust.setEnabled(false) to disable the SDK.
• Call Adjust.setEnabled(true) to enable the SDK

1
Adjust.setEnabled(false) // disable SDK
2
Adjust.setEnabled(true) // enable SDK

1
Adjust.setEnabled(false); // disable SDK
2
Adjust.setEnabled(true); // enable SDK

In SDK v5, this feature is split into separate commands for clarity.

• Call Adjust.disable() to disable the SDK.
• Call Adjust.enable() to enable the SDK.

1
Adjust.disable() // disable SDK
2
Adjust.enable() // enable SDK

1
Adjust.disable(); // disable SDK
2
Adjust.enable(); // enable SDK

Offline mode

In SDK v4, you can enable and disable offline mode in the SDK by calling Adjust.setOfflineMode() with a boolean value.

1
Adjust.setOfflineMode(false) // put SDK in offline mode
2
Adjust.setOfflineMode(true) // put SDK back in online mode

1
Adjust.setOfflineMode(false); // put SDK in offline mode
2
Adjust.setOfflineMode(true); // put SDK back in online mode

In SDK v5, this feature is split into separate commands for clarity.

• Call Adjust.switchToOfflineMode() to set the SDK to offline mode.
• Call Adjust.switchBackToOnlineMode() to set the SDK back to online mode.

1
Adjust.switchToOfflineMode() // put SDK in offline mode
2
Adjust.switchBackToOnlineMode() // put SDK back in online mode

1
Adjust.switchToOfflineMode(); // put SDK in offline mode
2
Adjust.switchBackToOnlineMode(); // put SDK back in online mode

Preinstall recording

In SDK v4, you can enable the SDK to record activity from apps that came preinstalled on a user’s device by calling the setPreinstallTrackingEnabled method of your AdjustConfig instance with a boolean argument.

1
adjustConfig.setPreinstallTrackingEnabled(true)

1
adjustConfig.setPreinstallTrackingEnabled(true);

In SDK v5, this method has been renamed to enablePreinstallTracking for clarity. This method takes no arguments.

1
adjustConfig.enablePreinstallTracking()

1
adjustConfig.enablePreinstallTracking();

Send session information

In SDK v4, you need to register activity lifecycle callbacks by implementing ActivityLifecycleCallbacks and calling Adjust.onResume() and Adjust.onPause() on Activity resume and pause respectively.

In SDK v5, the ActivityLifecycleCallbacks functionality is handled by the SDK. You should remove all custom activity lifecycle callbacks from your code.

Session callback parameters

Session callback parameters has been renamed to Global callback parameters in SDK v5.

Adjust.addSessionCallbackParameter("foo", "bar")
Adjust.removeSessionCallbackParameter("foo")
Adjust.resetSessionCallbackParameters()

Adjust.addGlobalCallbackParameter("foo", "bar")
Adjust.removeGlobalCallbackParameter("foo")
Adjust.removeGlobalCallbackParameters()

Adjust.addSessionCallbackParameter("foo", "bar");
Adjust.removeSessionCallbackParameter("foo");
Adjust.resetSessionCallbackParameters();

Adjust.addGlobalCallbackParameter("foo", "bar");
Adjust.removeGlobalCallbackParameter("foo");
Adjust.removeGlobalCallbackParameters();

Session partner parameters

Session partner parameters has been renamed to Global partner parameters in SDK v5.

Adjust.addSessionPartnerParameter("foo", "bar")
Adjust.removeSessionPartnerParameter("foo")
Adjust.resetSessionPartnerParameters()

Adjust.addGlobalPartnerParameter("foo", "bar")
Adjust.removeGlobalPartnerParameter("foo")
Adjust.removeGlobalPartnerParameters()

Adjust.addSessionPartnerParameter("foo", "bar");
Adjust.removeSessionPartnerParameter("foo");
Adjust.resetSessionPartnerParameters();

Adjust.addGlobalPartnerParameter("foo", "bar");
Adjust.removeGlobalPartnerParameter("foo");
Adjust.removeGlobalPartnerParameters();

Event deduplication

In SDK v4, event deduplication is coupled with the event order ID and is limited to a maximum of 10 unique IDs.

1
val event = AdjustEvent("event_token")
2
event.setOrderId("deduplication_id")
3
Adjust.trackEvent(event)

1
AdjustEvent event = new AdjustEvent("event_token");
2
event.setOrderId("deduplication_id");
3
Adjust.trackEvent(event);

In SDK v5, the feature is decoupled from order ID. A new ID field called deduplicationId has been added for event deduplication. Users can set a custom limit on the number of deduplicationId that can be added to the list for identifying duplicate events. By default, the limit is set to 10.

1
val adjustConfig = AdjustConfig(this, appToken, environment)
2

3
adjustConfig.setEventDeduplicationIdsMaxSize(20) // if not set, then 10
4
Adjust.initSdk(adjustConfig)
5

6
val event = AdjustEvent("event_token")
7
event.setDeduplicationId("deduplication_id")
8
Adjust.trackEvent(event)

1
AdjustConfig adjustConfig = new AdjustConfig(this, appToken, environment);
2

3
adjustConfig.setEventDeduplicationIdsMaxSize(20); // if not set, then 10
4
Adjust.initSdk(adjustConfig);
5

6
AdjustEvent event = new AdjustEvent("event_token");
7
event.setDeduplicationId("deduplication_id");
8
Adjust.trackEvent(event);

AdjustAttribution class

In SDK v4, the AdjustAttribution calls has a property called adid. In SDK v5, the adid property has been removed from the AdjustAttribution class. You can retrieve the device’s ADID using the getAdid() getter method.

Reattribution using deep links

The method used for passing deep link data to the Adjust SDK has been renamed.

• v4: Adjust.appWillOpenUrl().
• v5: Adjust.processDeeplink().

Adjust.appWillOpenUrl(url, applicationContext) //v4
Adjust.processDeeplink(adjustDeepLink, applicationContext) //v5

Adjust.appWillOpenUrl(url, getApplicationContext()); //v4
Adjust.processDeeplink(adjustDeepLink, getApplicationContext()); //v5

Deferred deep linking callback

In SDK v4, you can call the setOnDeeplinkResponseListener method to handle deferred deep link callbacks.

1
adjustConfig.setOnDeeplinkResponseListener { deeplink ->
2
   Log.d("example", "Deferred deep link callback called!")
3
   true
4
}

1
adjustConfig.setOnDeeplinkResponseListener(new OnDeeplinkResponseListener() {
2
            @Override
3
            public boolean launchReceivedDeeplink(Uri deeplink) {
4
                Log.d("example", "Deferred deep link callback called!");
5
                return true;
6
            }
7
        });

In SDK v5, this method is has been renamed to setOnDeferredDeeplinkResponseListener for clarity. All arguments are the same.

1
adjustConfig.setOnDeferredDeeplinkResponseListener {uri ->
2
            Log.d("example", "Deferred deep link callback called!")
3
            true
4
        }

1
adjustConfig.setOnDeferredDeeplinkResponseListener(new OnDeferredDeeplinkResponseListener() {
2
            @Override
3
            public boolean launchReceivedDeeplink(Uri deeplink) {
4
                Log.d("example", "Deferred deep link callback called!");
5
                return true;
6
            }
7
        });

COPPA compliance

In SDK v4, you can mark your app as COPPA compliant by calling the setCoppaCompliantEnabled method on your AdjustConfig instance with a boolean value.

1
adjustConfig.setCoppaCompliantEnabled(true)

1
adjustConfig.setCoppaCompliantEnabled(true);

In SDK v5, this method has been renamed to enableCoppaCompliance for clarity. This method takes no arguments.

1
adjustConfig.enableCoppaCompliance()

1
adjustConfig.enableCoppaCompliance();

Play Store Kids Apps

In SDK v4, you can mark an app as a Play Store Kids app by calling the setPlayStoreKidsAppEnabled method on your AdjustConfig instance with a boolean argument.

1
adjustConfig.setPlayStoreKidsAppEnabled(true)

1
adjustConfig.setPlayStoreKidsAppEnabled(true);

In SDK v5, this method has been renamed to enablePlayStoreKidsCompliance for clarity. This method takes no arguments.

1
adjustConfig.enablePlayStoreKidsCompliance()

1
adjustConfig.enablePlayStoreKidsCompliance();

Send ad revenue from a specific source

In SDK v4, ad revenue sources are defined as constants in the AdjustConfig class. In SDK v5, ad revenue sources need to be passed as a string.

val adjustAdRevenue = AdjustAdRevenue(AdjustConfig.AD_REVENUE_APPLOVIN_MAX) // v4
val adjustAdRevenue = AdjustAdRevenue("applovin_max_sdk") // v5

AdjustAdRevenue adjustAdRevenue = new AdjustAdRevenue(AdjustConfig.AD_REVENUE_APPLOVIN_MAX); // v4
AdjustAdRevenue adjustAdRevenue = new AdjustAdRevenue("applovin_max_sdk"); // v5

Set data residency and URL strategy

In SDK v4, URL strategy and data residency domains are defined as constants in the AdjustConfig class.

1
adjustConfig.setUrlStrategy(AdjustConfig.DATA_RESIDENCY_EU)

1
adjustConfig.setUrlStrategy(AdjustConfig.DATA_RESIDENCY_EU);

In SDK v5, you need to pass your chosen domain or domains as an array. You can also set the following:

• useSubdomains (boolean): Whether the source should prefix a subdomain.
• isDataResidency (boolean): Whether the domain should be used for data residency.

1
val domains: List<String> = mutableListOf("domain") // eg. eu.adjust.com
2
val useSubdomains = true // or false
3
val isDataResidency = false // or true for data residency
4
adjustConfig.setUrlStrategy(domains, useSubdomains, isDataResidency)

1
List<String> domains = Arrays.asList("domain"); // eg. eu.adjust.com
2
boolean useSubdomains = true; // or false
3
boolean isDataResidency = false; // or true for data residency
4
adjustConfig.setUrlStrategy(domains, useSubdomains, isDataResidency);

Check the table below to see how to configure your URL strategy in SDK v5.

Examples

adjustConfig.setUrlStrategy(listOf("adjust.net.in", "adjust.com"), true, false)

adjustConfig.setUrlStrategy(listOf("adjust.world", "adjust.com"), true, false)

adjustConfig.setUrlStrategy(listOf("adjust.cn"), true, false)

adjustConfig.setUrlStrategy(listOf("eu.adjust.com"), true, true)

adjustConfig.setUrlStrategy(listOf("tr.adjust.com"), true, true)

adjustConfig.setUrlStrategy(listOf("us.adjust.com"), true, true)

config.setUrlStrategy(Arrays.asList("adjust.net.in", "adjust.com"), true, false);

adjustConfig.setUrlStrategy(Arrays.asList("adjust.world", "adjust.com"), true, false);

adjustConfig.setUrlStrategy(Arrays.asList("adjust.cn"), true, false);

adjustConfig.setUrlStrategy(Arrays.asList("eu.adjust.com"), true, true);

adjustConfig.setUrlStrategy(Arrays.asList("tr.adjust.com"), true, true);

adjustConfig.setUrlStrategy(Arrays.asList("us.adjust.com"), true, true);

Device ID getters

In SDK v4, all device ID getter methods run synchronously. In SDK v5, these methods have been changed to run asynchronously.

Adjust.getGoogleAdId(this, object : OnGoogleAdIdReadListener {
   override fun onGoogleAdIdRead(googleAdId: String) {}
})

Adjust.getAdid { adid ->
  // read adid
}

Adjust.getAttribution {attribution ->
   // read attribution
}

AdjustOaid.getOaid(applicationContext, object : OnOaidReadListener() {
      fun onOaidRead(oaid: String?) {}
      fun onFail(message: String?) {}
   })

Adjust.getAmazonAdId(applicationContext, object : OnAmazonAdIdReadListener {
      override fun onAmazonAdIdRead(amazonAdId: String) {}
   })

Adjust.getSdkVersion {sdkVersion ->
   // read sdk version
}

Adjust.isEnabled(applicationContext) { isEnabled ->
   // read isEnabled
}

Adjust.getGoogleAdId(this, new OnGoogleAdIdReadListener() {
    @Override
    public void onGoogleAdIdRead(String googleAdId) {}
});

Adjust.getAdid(new OnAdidReadListener() {
    @Override
    public void onAdidRead(String adid) {
    }
});

Adjust.getAttribution(new OnAttributionReadListener() {
    @Override
    public void onAttributionRead(AdjustAttribution attribution) {
    }
});

AdjustOaid.getOaid(getApplicationContext(), new OnOaidReadListener() {
   @Override
   public void onOaidRead(String oaid) {
   }


   @Override
   public void onFail(String message) {
   }
});

Adjust.getAmazonAdId(getApplicationContext(), new OnAmazonAdIdReadListener() {
    @Override
    public void onAmazonAdIdRead(String amazonAdId) {
    }
});

Adjust.getSdkVersion(new OnSdkVersionReadListener() {
    @Override
    public void onSdkVersionRead(String sdkVersion) {
    }
});

Adjust.isEnabled(getApplicationContext(), new OnIsEnabledListener() {
    @Override
    public void onIsEnabledRead(boolean isEnabled) {

    }
});

Removed APIs

The following APIs have been removed in SDK v5.

Event buffering

SDK v4 supports event buffering. This feature stores requests event, ad revenue, push tokens, and other information on a local buffer to send at a later date.

1
adjustConfig.setEventBufferingEnabled(true)

1
adjustConfig.setEventBufferingEnabled(true);

This setting has been removed in SDK v5.

Custom user agent string

SDK v4 supports setting a custom User Agent by calling AdjustConfig.setUserAgent() with a user agent string.

1
adjustConfig.setUserAgent("user_agent_value")

1
adjustConfig.setUserAgent("user_agent_value");

This setting has been removed in SDK v5.

Set whether a device is known

In SDK v4, you can call the AdjustConfig.setDeviceKnown() method to manually inform the SDK whether a device is known.

1
adjustConfig.setDeviceKnown(true)

1
adjustConfig.setDeviceKnown(true);

This setting has been removed in SDK v5.

Delay SDK start

SDK v4 supports delaying the start of the SDK by calling AdjustConfig.setDelayStart() with up to 120 seconds of delay.

1
adjustConfig.setDelayStart(delay)

1
adjustConfig.setDelayStart(delay);

This setting has been removed in SDK v5.

Disable third party sharing globally

In SDK v4, you can call the Adjust.disableThirdPartySharing() method to globally disable sharing information with third parties globally.

1
Adjust.disableThirdPartySharing(applicationContext)

1
Adjust.disableThirdPartySharing(getApplicationContext());

This feature has been removed from SDK v5. In SDK v5, use the Adjust.trackThirdPartySharing() method to enable or disable third party sharing.

1
val adjustThirdPartySharing = AdjustThirdPartySharing(true)
2
Adjust.trackThirdPartySharing(adjustThirdPartySharing)

1
AdjustThirdPartySharing adjustThirdPartySharing = new AdjustThirdPartySharing(true);
2
Adjust.trackThirdPartySharing(adjustThirdPartySharing);

Set an App Secret

SDK v4 supports setting an App Secret by calling setAppSecret method on your AdjustConfig instance to sign the SDK traffic with.

1
adjustConfig.setAppSecret(secretId, info1, info2, info3, info4)

1
adjustConfig.setAppSecret(secretId, info1, info2, info3, info4);

This setting has been removed in SDK v5.

New plugins

The following plugins have been added to SDK v5.

Huawei Install Referrer plugin

SDK v5 supports a Huawei Install Referrer plugin to record a device’s Huawei Install Referrer information. To add the plugin, add the following dependency to your build.gradle file:

dependencies {
   implementation 'com.adjust.sdk:adjust-android-huawei-referrer:5.0.0'
}

Meta Install Referrer plugin

SDK v5 supports a Meta Install Referrer plugin to record Meta Install Referrer information. To read this information:

1. Add the following dependency to your build.gradle file:

   dependencies {
      implementation 'com.adjust.sdk:adjust-android-meta-referrer:5.0.0'
   }

2. Find your Meta app ID in your App Dashboard. See Meta’s App Dashboard documentation for more information.

3. Pass your App ID as a String argument to the AdjustConfig.setFbAppId method.

val config = AdjustConfig(this, appToken, environment)
config.setFbAppId(<FB_APP_ID_STRING>)
Adjust.initSdk(config)

AdjustConfig config = new AdjustConfig(this, appToken, environment);
config.setFbAppId(<FB_APP_ID_STRING>);
Adjust.initSdk(config);

Removed plugins

The following plugins have been removed in SDK v5:

• Criteo
• Trademob
• Sociomantic