This information helps you migrate from the 3.x or 2.x version of the Android library to version 4.x.

Important: The SDK uses SharedPreferences to store data that is needed to calculate unique users, lifecycle metrics, and other data related to core SDK functionality. If you modify or remove the values in SharedPreferences that are expected by the SDK, unexpected behavior might result in the form of data inconsistencies.

In the version 4.x library, the public methods are consolidated into one header. Also, all functionality is now accessible through class level methods, so you do not have to keep track of pointers, instances, or singletons.

In version 4, you can no longer assign variables such as events, eVars, props, heirs, and lists in your app. Instead, the SDK uses context data and processing rules to map your app data to Analytics variables for reporting.

Processing rules provide the following advantages:

• You can change your data mapping without submitting an update to the App Store.

• You can use meaningful names for data instead of setting variables that are specific to a report suite.

• There is little impact to sending in extra data.

  These values will not appear in reports until they are mapped using processing rules.

Tip: Values that you assigned directly to variables should be added to the data HashMap.

The new ADBMobileConfig.json file contains application-specific, global settings, and replaces most of the configuration variables that were used in previous versions. Here is an example of an ADBMobileConfig.json file:

{
    "version" : "1.0",
    "analytics" : {
        "rsids" : "coolApp",
        "server" : "my.CoolApp.com",
        "charset" : "UTF-8",
        "ssl" : true,
        "offlineEnabled" : true,
        "lifecycleTimeout" : 5,
        "privacyDefault" : "optedin",
        "poi" : [
                    ["san francisco",37.757144,-122.44812,7000],
                    ["santa cruz",36.972935,-122.01725,600]
                ]
    },
 "target" : {
  "clientCode" : "myTargetClientCode",
  "timeout" : 5
 },
 "audienceManager" : {
  "server" : "myServer.demdex.com"
 }
}

The following tables list the configuration variables that you need to move to the configuration file.

1. Move the value that is set for the variable in the first column to the variable in the second column.
2. Remove the old configuration variable from your code.

To migrate from version 3.x to 4, move the configuration variable/method value to the ADBMobileConfig.json variable.

To migrate from version 2.x to version 4, move the value from the first column to the variable in the second column.

Instead of using the web-focused track and trackLink calls, the version 4 SDK uses the following methods:

• trackState, which are the views that are available in your app, such as home dashboard, app settings, cart, and so on.

  These states are similar to pages on a website, and trackState calls increment page views.

• trackAction actions, such as logons, banner taps, feed subscriptions, and so on that occur in your app and that you want to measure.

The contextData parameter for both of these methods is a HashMap<String, Object>, which contains the name-value pairs that are sent as context data.

In version 4, you can no longer assign variables such as events, eVars, props, heirs, and lists directly in your app. The SDK now uses context data and processing rules to map your app data to Analytics variables for reporting.

Processing rules provide the following advantages:

• You can change your data mapping without submitting an update to the app store.

• You can use meaningful names for data instead of setting variables that are specific to a report suite.

• There is little impact to sending in extra data.

  These values will not appear in reports until they are mapped using processing rules. For more information, see Processing Rules and Context Data.

Values that you were assigning directly to variables should be added to the data HashMap. This means that calls to setProp, setEvar, and assignments to persistent context data should be removed and the values be added to the data parameter.

Data that you were setting on the measurement object, including the variables listed above, should be added to the data HashMap. The only data that is sent with a trackState or trackAction call is the payload in the data parameter.

Replace the following methods with a call to trackState or trackAction:

• Migrating from version 3.x

  • trackAppState (trackState)
  • trackEvents (trackAction)
  • track (trackAction)
  • trackLinkURL (trackAction)

• Migrating from version 2.x

  • track (trackState)
  • trackLink (trackAction)

Replace the visitorID variable with a call to setUserIdentifier.

Offline tracking is enabled in the ADBMobileConfig.json file, and all other offline configuration is done automatically.

Remove calls to the following methods:

Version 3.x

• setOnline
• setOffline

Version 2.x

• forceOffline
• forceOnline

For more information about the products variable, see Products variable.