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. The minimum supported API versions for SDK v5 have been updated. If your app targets a lower version, you need to update it first.
   • iOS: 12.0
   • Android: 21
3. The SDK namespace has been renamed from com.adjust.sdk to AdjustSdk.

Install the SDK

Before you install SDK v5, you first need to remove all SDK v4 assets and code from your project.

If you prefer to append changes to your existing project, follow these steps to remove all Adjust SDK v4 assets:

1. Delete the existing Adjust installation in your Assets directory.
2. Delete all references to Adjust from your Xcode project.
   • Delete the Adjust directory under the Libraries section of your project.
   • Open the General tab and delete the Adjust.a library under Frameworks, Libraries, and Embedded Content.
   • Optional: SDK v4 adds an -ObjC flag under your app target’s Other Linker Flags settings. Only if this was added automatically by the SDK, remove this flag.
3. Delete all references to Adjust in your Android Studio project.
   • Locate and delete the adjust-android.jar library in your project’s libs directory.

Once you’ve removed all SDK v4 assets from your project, you can install SDK v5. To do this, either:

• Download the Adjust unitypackage from the GitHub releases page and import it into your project.
• Install the package using the Unity Package Manager:
  1. Select the Package Manager window in the Unity editor.
  2. Select Add package from git URL.
  3. Enter the following URL: https://github.com/adjust/unity_sdk.git?path=Assets/Adjust.

Install the iOS and Android SDKs

SDK v5 no longer uses the iOS and Android SDKs as binary dependencies. To install the underlying iOS and Android SDKs, you need to use the External Dependency Manager for Unity (EDM4U) to install the packages from CocoaPods and Maven.

Update the initialization method

In SDK v4, the SDK is initialized by configuring an AdjustConfig object and passing it to the Adjust.start() method.

1
AdjustConfig adjustConfig = new AdjustConfig("appToken", AdjustEnvironment.Sandbox);
2
Adjust.start(adjustConfig);

In SDK v5, this method has been renamed to Adjust.InitSdk().

1
AdjustConfig adjustConfig = new AdjustConfig("appToken", AdjustEnvironment.Sandbox);
2
Adjust.InitSdk(adjustConfig);

Set up the 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.

Changed APIs

The following APIs have been changed in SDK v5.

Set log level

In SDK v4, you can set your logging level by passing an AdjustLogLevel constant to the AdjustConfig.setLogLevel() method.

1
adjustConfig.setLogLevel(AdjustLogLevel.Verbose);

In SDK v5, you need to assign an AdjustLogLevel constant to the LogLevel property of your AdjustConfig instance.

1
adjustConfig.LogLevel = AdjustLogLevel.Verbose;

Disable and enable the SDK

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

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

1
Adjust.setEnabled(false); // Disable the SDK
2
Adjust.setEnabled(true); // Enable the 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 the SDK
2
Adjust.Enable(); // Enable the SDK

Send information in background

In SDK v4, you can call the AdjustConfig.setSendInBackground() method with a true argument to enable the SDK to send information to Adjust while your app is running in the background.

1
adjustConfig.setSendInBackground(true);

In SDK v5, you need to set the IsSendingInBackgroundEnabled property on your AdjustConfig instance to true to enable the SDK to send information to Adjust while your app is running in the background.

1
adjustConfig.IsSendingInBackgroundEnabled = true;

Preinstalled app measurement

In SDK v4, you can enable measuring preinstalled apps using the AdjustConfig.setPreinstallTrackingEnabled method.

1
adjustConfig.setPreinstallTrackingEnabled(true);

In SDK v5, you need to set the IsPreinstallTrackingEnabled property on your AdjustConfig instance to true.

1
adjustConfig.IsPreinstallTrackingEnabled = true;

In SDK v4, you can configure the path containing preinstalled app information using the AdjustConfig.setPreinstallFilePath method.

1
adjustConfig.setPreinstallFilePath("path");

In SDK v5, you need to set the PreinstallFilePath property on your AdjustConfig instance to the file path containing your preinstalled app information.

1
adjustConfig.PreinstallFilePath = "path";

In SDK v4, you can set a default link token to measure installs for preinstalled apps using the AdjustConfig.setDefaultTracker() method.

1
adjustConfig.setDefaultTracker("abc123");

In SDK v5, you need to assign your link to the DefaultTracker property on your AdjustConfig instance directly.

1
adjustConfig.DefaultTracker = "abc123";

Set external device ID

In SDK v4, you can set an external device ID by passing an ID to the AdjustConfig.setExternalDeviceId() method.

1
adjustConfig.setExternalDeviceId("unique-custom-device-id");

In SDK v5, you need to assign your ID to the ExternalDeviceID property on your AdjustConfig instance directly.

1
adjustConfig.ExternalDeviceId = "unique-custom-device-id";

Set Meta App ID

In SDK v4, you can set your Meta app ID using the AdjustConfig.setFbAppId() method.

1
adjustConfig.setFbAppId("fb-app-id");

In SDK v5, you need to assign your Meta app ID to the FbAppId property on your AdjustConfig instance.

1
adjustConfig.FbAppId = "fb-app-id";

Disable AdServices information reading

In SDK v4, you can call the AdjustConfig.setAllowAdServicesInfoReading() method with a false argument to prevent the Adjust SDK from reading AdServices information.

1
adjustConfig.setAllowAdServicesInfoReading(false);

In SDK v5, you need to set the IsAdServicesEnabled property on your AdjustConfig instance to false to prevent the Adjust SDK from reading AdServices information.

1
adjustConfig.IsAdServicesEnabled = false;

Disable IDFA reading

In SDK v4, you can call the AdjustConfig.setAllowIdfaReading() method with a false argument to prevent the Adjust SDK from reading the device’s IDFA.

1
adjustConfig.setAllowIdfaReading(false);

In SDK v5, you need to set the IsIdfaReadingEnabled property on your AdjustConfig instance to false to prevent the Adjust SDK from reading the device’s IDFA.

1
adjustConfig.IsIdfaReadingEnabled = false;

Enable cost data in attribution

In SDK v4, you can enable cost data in the device’s attribution information by calling the Adjust.setNeedsCost() method with a true argument.

1
adjustConfig.setNeedsCost(true);

In SDK v5, you need to set the IsCostDataInAttributionEnabled property on your AdjustConfig instance to true to enable cost data in the device’s attribution information.

1
adjustConfig.IsCostDataInAttributionEnabled = true;

Enable LinkMe

In SDK v4, you can enable Adjust LinkMe by calling the AdjustConfig.setLinkMeEnabled() method with a true argument.

1
adjustConfig.setLinkMeEnabled(true);

In SDK v5, you need to set the IsLinkMeEnabled property on your AdjustConfig instance to true to enable LinkMe.

1
adjustConfig.IsLinkMeEnabled = true;

Only read device IDs once

In SDK v4, you can instruct the SDK to only read device identifiers one time upon startup by calling the AdjustConfig.setReadDeviceInfoOnceEnabled() method with a true argument.

1
adjustConfig.setReadDeviceInfoOnceEnabled(true);

In SDK v5, you need to set the IsDeviceIdsReadingOnceEnabled property on your AdjustConfig instance to true to instruct the SDK to only read device IDs once.

1
adjustConfig.IsDeviceIdsReadingOnceEnabled = true;

Offline mode

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

1
Adjust.setOfflineMode(true);
2
Adjust.setOfflineMode(false);

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 the SDK in offline mode
2
Adjust.SwitchBackToOnlineMode(); // Put the SDK back in online mode

Push tokens

In SDK v4, you can set your push tokens using the Adjust.setDeviceToken method.

1
Adjust.setDeviceToken("push-token");

This method has been renamed to Adjust.SetPushToken in SDK v5.

1
Adjust.SetPushToken("push-token");

Session callback parameters

In SDK v4, you can add session parameters by passing a key-value pair to the Adjust.addSessionCallbackParameter() method and remove individual parameters using the Adjust.removeSessionCallbackParameter() method.

1
Adjust.addSessionCallbackParameter("key", "value");
2
Adjust.removeSessionCallbackParameter("key");
3
Adjust.resetSessionCallbackParameters();

In SDK v5, session parameters are renamed to global parameters.

1
Adjust.AddGlobalCallbackParameter("key", "value");
2
Adjust.RemoveGlobalCallbackParameter("key");
3
Adjust.RemoveGlobalCallbackParameters();

Session partner parameters

In SDK v4, you can add session partner parameters by passing a key-value pair to the Adjust.addSessionPartnerParameter() method and remove individual parameters using the Adjust.removeSessionPartnerParameter() method.

1
Adjust.addSessionPartnerParameter("key", "value");
2
Adjust.removeSessionPartnerParameter("key");
3
Adjust.resetSessionPartnerParameters();

In SDK v5, session partner parameters are renamed to global partner parameters.

1
Adjust.AddGlobalPartnerParameter("key", "value");
2
Adjust.RemoveGlobalPartnerParameter("key");
3
Adjust.RemoveGlobalPartnerParameters();

Success and failure callbacks

In SDK v4, you can configure session success and failure callbacks by passing delegate functions to the AdjustConfig.setSessionSuccessDelegate() and AdjustConfig.setSessionFailureDelegate() methods respectively.

1
adjustConfig.setSessionSuccessDelegate(sessionSuccessCallback); // Session success callback
2
adjustConfig.setFailureSuccessDelegate(sessionFailureCallback); // Session failure callback

In SDK v5, you need to set the SessionSuccessDelegate and SessionFailureDelegate properties on your AdjustConfig instance to the relevant delegate functions.

1
adjustConfig.SessionSuccessDelegate = sessionSuccessCallback; // Session success callback
2
adjustConfig.SessionFailureDelegate = sessionFailureCallback; // Session failure callback

The same change also applies to event success and failure callbacks. In SDK v4, these are set by passing delegate functions to the AdjustConfig.setSessionSuccessDelegate() and AdjustConfig.setSessionFailureDelegate() methods respectively.

1
adjustConfig.setEventSuccessDelegate(eventSuccessCallback); // Event success callback
2
adjustConfig.setEventFailureDelegate(eventFailureCallback); // Event failure callback

In SDK v5, you need to set the EventSuccessDelegate and EventFailureDelegate properties on your AdjustConfig instance to the relevant delegate functions.

1
adjustConfig.EventSuccessDelegate = eventSuccessCallback; // Event success callback
2
adjustConfig.EventFailureDelegate = eventFailureCallback; // Event failure callback

App Store Subscriptions

The following class properties should be set directly in SDK v5:

• TransactionDate
• SalesRegion

The following setters have been renamed:

• addCallbackParameter -> AddCallbackParameter
• addCallbackParameter -> AddPartnerParameter

Here is a full example of what has changed:

AdjustAppStoreSubscription subscription = new AdjustAppStoreSubscription(
   price,
   currency,
   transactionId,
   receipt);
  transactionId);
 subscription.setTransactionDate("transaction-date");
 subscription.setSalesRegion("sales-region");
 subscription.addCallbackParameter("key1", "value1");
 subscription.addPartnerParameter("key2", "value2");

 subscription.TransactionDate = "transaction-date";
 subscription.SalesRegion = "sales-region";
 subscription.AddCallbackParameter("key1", "value1");
 subscription.AddPartnerParameter("key2", "value2");

Adjust.trackAppStoreSubscription(subscription);

Play Store Subscriptions

The following class properties should be set directly in SDK v5:

• PurchaseTime

The following setters have been renamed:

• addCallbackParameter -> AddCallbackParameter
• addCallbackParameter -> AddPartnerParameter

Here is a full example of what has changed:

AdjustPlayStoreSubscription subscription = new AdjustPlayStoreSubscription(
   price,
   currency,
   sku,
   orderId,
   signature,
   purchaseToken);
 subscription.setPurchaseTime(purchaseTime);
 subscription.addCallbackParameter("key1", "value1");
 subscription.addPartnerParameter("key2", "value2");

 subscription.PurchaseTime = purchaseTime
 subscription.AddCallbackParameter("key1", "value1");
 subscription.AddPartnerParameter("key2", "value2");

Adjust.trackPlayStoreSubscription(subscription);

AdjustEvent class

The following class properties should be set directly in SDK v5:

• CallbackId
• TransactionId
• ProductId
• PurchaseToken

The following setters have been renamed:

• setRevenue -> SetRevenue
• addCallbackParameter -> AddCallbackParameter
• addCallbackParameter -> AddPartnerParameter

The receipt property has been removed from the AdjustEvent class.

Here is a full example of what has changed:

AdjustEvent adjustEvent = new AdjustEvent("abc123");
 adjustEvent.setRevenue(0.25, "EUR");
 adjustEvent.setTransactionId("random-id");
 adjustEvent.setCallbackId("callback-id");
 adjustEvent.setProductId("product-id");
 adjustEvent.setPurchaseToken("purchase-token");
 adjustEvent.setReceipt("receipt");
 adjustEvent.addCallbackParameter("key", "value");
 adjustEvent.addPartnerParameter("key", "value");
 Adjust.trackEvent(adjustEvent);

 adjustEvent.SetRevenue(0.25, "EUR");
 adjustEvent.TransactionId = "random-id";
 adjustEvent.CallbackId = "callback-id";
 adjustEvent.ProductId = "product-id";
 adjustEvent.PurchaseToken = "purchase-token";
 adjustEvent.AddCallbackParameter("key", "value");
 adjustEvent.AddPartnerParameter("key", "value");
 Adjust.TrackEvent(adjustEvent);

Event deduplication

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

1
adjustEvent.setTransactionId("transaction-id");

In SDK v5, the feature is decoupled from transaction ID. A new ID field called DeduplicationId has been added for event deduplication.

1
adjustEvent.DeduplicationId = "deduplication-id";

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
AdjustConfig adjustConfig = new AdjustConfig("appToken", AdjustEnvironment.Sandbox);
2
adjustConfig.EventDeduplicationIdsMaxSize = 20
3
Adjust.InitSdk(adjustConfig);

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 Adjust.GetAdid() getter method.

In addition, all internal members of the AdjustAttribution class are now public properties.

adjustAttribution.trackerToken
adjustAttribution.trackerName
adjustAttribution.network
adjustAttribution.campaign
adjustAttribution.adgroup
adjustAttribution.creative
adjustAttribution.clickLabel
adjustAttribution.costType
adjustAttribution.costAmount
adjustAttribution.costCurrency
adjustAttribution.fbInstallReferrer

adjustAttribution.TrackerToken
adjustAttribution.TrackerName
adjustAttribution.Network
adjustAttribution.Campaign
adjustAttribution.Adgroup
adjustAttribution.Creative
adjustAttribution.ClickLabel
adjustAttribution.CostType
adjustAttribution.CostAmount
adjustAttribution.CostCurrency
adjustAttribution.FbInstallReferrer

Attribution changed callback

In SDK v4, you can call a delegate function when the device’s attribution changes by assigning the function to the AdjustConfig.setAttributionChangedDelegate() function.

1
adjustConfig.setAttributionChangedDelegate(attributionCallback);

In SDK v5, you need to assign your delegate function to the AttributionChangedDelegate property on your AdjustConfig instance.

1
adjustConfig.AttributionChangedDelegate = attributionCallback;

Reattribution using deep links

In SDK v4, you can pass your deep link information to the Adjust.appWillOpenUrl() method.

1
Adjust.appWillOpenUrl("url");

In SDK v5, this has been renamed to Adjust.ProcessDeeplink() for clarity. A new AdjustDeeplink class has been added for constructing deep links. To process a deep link, instantiate an AdjustDeeplink object with your deep link URL and pass it to the Adjust.ProcessDeeplink method.

1
AdjustDeeplink adjustDeeplink = new AdjustDeeplink("url");
2
Adjust.ProcessDeeplink(adjustDeeplink);

Launch deferred deep links

In SDK v4, you can call the AdjustConfig.setLaunchDeferredDeeplink() method to open deferred deep links.

1
adjustConfig.setLaunchDeferredDeeplink(true);

In SDK v5, you need to set the IsDeferredDeeplinkOpeningEnabled property on your AdjustConfig instance to true to enable the SDK to open deep links.

1
adjustConfig.IsDeferredDeeplinkOpeningEnabled = true;

COPPA compliance

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

1
adjustConfig.setCoppaCompliantEnabled(true);

In SDK v5, you need to set the IsCoppaComplianceEnabled property on your AdjustConfig instance to a bool value.

1
adjustConfig.IsCoppaComplianceEnabled = true;

Play Store Kids Apps

In SDK v4, you can mark an app as a Play Store Kids app using the AdjustConfig class. This property is read during SDK initialization, which means that the value can’t be updated once the SDK is initialized.

1
adjustConfig.setPlayStoreKidsAppEnabled(true);

In SDK v5, you need to set the IsPlayStoreKidsComplianceEnabled property of your AdjustConfig instance to true to enable compliance.

1
adjustConfig.IsPlayStoreKidsComplianceEnabled = true;

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.AdjustDataResidencyEU);

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

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

1
adjustConfig.SetUrlStrategy(new List<String> {"eu.adjust.com"}, true, true);

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

Examples

adjustConfig.SetUrlStrategy(new List<String> {"adjust.net.in", "adjust.com"}, true, false);

adjustConfig.SetUrlStrategy(new List<String> {"adjust.world", "adjust.com"}, true, false);

adjustConfig.SetUrlStrategy(new List<String> {"adjust.cn"}, true, false);

adjustConfig.SetUrlStrategy(new List<String> {"eu.adjust.com"}, true, true);

adjustConfig.SetUrlStrategy(new List<String> {"tr.adjust.com"}, true, true);

adjustConfig.SetUrlStrategy(new List<String> {"us.adjust.com"}, true, true);

AdjustThirdPartySharing class changes

The following methods have been renamed in SDK v5:

• addGranularOption -> AddGranularOption
• addPartnerSharingSetting -> AddPartnerSharingSetting

Here is a full example of what has changed:

AdjustThirdPartySharing adjustThirdPartySharing = new AdjustThirdPartySharing(null);

 adjustThirdPartySharing.addGranularOption("PartnerA", "key", "value");
 adjustThirdPartySharing.addPartnerSharingSetting("PartnerA", "all", false);

 adjustThirdPartySharing.AddGranularOption("PartnerA", "key", "value");
 adjustThirdPartySharing.AddPartnerSharingSetting("PartnerA", "all", false);

Adjust.trackThirdPartySharing(adjustThirdPartySharing);

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.

AdjustAdRevenue adRevenue = new AdjustAdRevenue(AdjustConfig.AdjustAdRevenueSourceAppLovinMAX);
AdjustAdRevenue adRevenue = new AdjustAdRevenue("applovin_max_sdk");

AdjustAdRevenue class changes

The following class properties should be set directly in SDK v5:

• AdImpressionsCount
• AdRevenueNetwork
• AdRevenueUnit
• AdRevenuePlacement

The following setters have been renamed:

• setRevenue -> SetRevenue
• addCallbackParameter -> AddCallbackParameter
• addCallbackParameter -> AddPartnerParameter

Here is a full example of what has changed:

AdjustAdRevenue adRevenue = new AdjustAdRevenue("applovin_max_sdk");
 adRevenue.setRevenue(6.66, "CAD");
 adRevenue.setAdImpressionsCount(6);
 adRevenue.setAdRevenueNetwork("network");
 adRevenue.setAdRevenueUnit("unit");
 adRevenue.setAdRevenuePlacement("placement");
 adRevenue.addCallbackParameter("key1", "value1");
 adRevenue.addPartnerParameter("key2", "value2");

 adRevenue.SetRevenue(6.66, "CAD");
 adRevenue.AdImpressionsCount = 6;
 adRevenue.AdRevenueNetwork = "network";
 adRevenue.AdRevenueUnit = "unit";
 adRevenue.AdRevenuePlacement = "placement";
 adRevenue.AddCallbackParameter("key1", "value1");
 adRevenue.AddPartnerParameter("key2", "value2");

Adjust.trackAdRevenue(adRevenue);

Configure ATT pop-up waiting interval

In SDK v4, you can use the setAttConsentWaitingInterval method of your AdjustConfig instance to configure an interval that delays sending install information to Adjust. This delay gives the user time to interact with an ATT pop-up.

1
adjustConfig.setAttConsentWaitingInterval(66);

In SDK v5, you need to assign your delay interval to the AttConsentWaitingInterval property of your AdjustConfig instance.

1
adjustConfig.AttConsentWaitingInterval = 66;

Disable SKAdNetwork communication

In SDK v4, you can prevent the SDK from communicating with SKAdNetwork by calling the AdjustConfig.deactivateSKAdNetworkHandling() method.

1
AdjustConfig adjustConfig = new AdjustConfig("{YourAppToken}", AdjustEnvironment.Sandbox, true);
2
adjustConfig.deactivateSKAdNetworkHandling();
3
Adjust.start(adjustConfig);

In SDK v5, you need to set the IsSkanAttributionEnabled property on your AdjustConfig instance to false to disable SKAdNetwork communication.

1
AdjustConfig adjustConfig = new AdjustConfig("appToken", AdjustEnvironment.Sandbox);
2
adjustConfig.IsSkanAttributionEnabled = false;
3
Adjust.InitSdk(adjustConfig);

Listen for conversion value updates

In SDK v4, you can assign a delegate function to listen for conversion value updates by passing it to the AdjustConfig.setConversionValueUpdatedDelegate().

1
adjustConfig.setConversionValueUpdatedDelegate(ConversionValueUpdatedCallback);

In SDK v5, you need to assign your delegate function to the SkanUpdatedDelegate property on your AdjustConfig instance.

1
adjust.SkanUpdatedDelegate = skanUpdatedCallback;

Update conversion values

In SDK v4, you can use the Adjust.updateConversionValue() method to send updated conversion values to Adjust. This method wraps Apple’s deprecated updateConversionValue method and has been removed in SDK v5.

To update conversion values in SDK v5, use the Adjust.UpdateSkanConversionValue() method with the following arguments:

• conversionValue (int): The updated conversion value
• coarseValue (string): The updated coarse conversion value
• lockWindow (bool): Whether to send the postback before the conversion window ends
• callback (Action<string>): A callback function which can handle any errors that occur

1
Adjust.UpdateSkanConversionValue(1, "low", false, error =>
2
{
3
    // process error, if any
4
});

App Tracking Transparency authorization wrapper

In SDK v4, you can handle changes to a user’s ATT authorization status using the Adjust requestTrackingAuthorizationWithCompletionHandler() method.

1
Adjust.requestTrackingAuthorizationWithCompletionHandler((status) =>
2
{
3
    switch (status)
4
    {
5
        case 0:
6
            // ATTrackingManagerAuthorizationStatusNotDetermined case
7
            break;
8
        case 1:
9
            // ATTrackingManagerAuthorizationStatusRestricted case
10
            break;
11
        case 2:
12
            // ATTrackingManagerAuthorizationStatusDenied case
13
            break;
14
        case 3:
15
            // ATTrackingManagerAuthorizationStatusAuthorized case
16
            break;
17
    }
18
});

This has been renamed to Adjust.RequestAppTrackingAuthorization() in SDK v5 for clarity.

1
Adjust.RequestAppTrackingAuthorization((status) =>
2
{
3
    switch (status)
4
    {
5
        case 0:
6
            // ATTrackingManagerAuthorizationStatusNotDetermined case
7
            break;
8
        case 1:
9
            // ATTrackingManagerAuthorizationStatusRestricted case
10
            break;
11
        case 2:
12
            // ATTrackingManagerAuthorizationStatusDenied case
13
            break;
14
        case 3:
15
            // ATTrackingManagerAuthorizationStatusAuthorized case
16
            break;
17
    }
18
});

Get device information

In SDK v4, all device information getter methods run synchronously. In SDK v5, these methods have been changed to run asynchronously. You can add a callback function to handle the information when the asynchronous process completes

Adjust.GetIdfa(idfa =>
{
    // use idfa
});

Adjust.GetAdid(adid =>
{
    // use adid
});

Adjust.GetAttribution(attribution =>
{
    // use attribution
});

Adjust.IsEnabled(isEnabled =>
{
    // use isEnabled
});

Adjust.GetSdkVersion(sdkVersion =>
{
    // use sdkVersion
});

Adjust.GetAmazonAdId(amazonAdId =>
{
    // use amazonAdId
});

Adjust.GetLastDeeplink(lastDeeplink =>
{
    // use lastDeeplink
});

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

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("custom-user-agent");

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

This setting has been removed in SDK v5.

Delay SDK start

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

1
adjustConfig.setDelayTimer(10);

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

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

1
AdjustThirdPartySharing adjustThirdPartySharing = new AdjustThirdPartySharing(false);
2
Adjust.TrackThirdPartySharing(adjustThirdPartySharing);

Check for authorization status change

In SDK v4, you can use the Adjust.checkForNewAttStatus() method to prompt the SDK to read a user’s ATT status and forward the information to Adjust’s servers.

1
Adjust.checkForNewAttStatus();

This method has been removed in SDK v5.

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

This setting has been removed in SDK v5.