Upgrade to the Experience Platform SDKs

This section contains a checklist that you can use as you plan your upgrade to the Experience Platform SDKs.
The Experience Platform SDK contains breaking changes from the 4x SDKs.
In addition to changed APIs, the new SDK includes new APIs and deprecation of APIs such as timed action and milestone media video tracking.

Important considerations

The Experience Platform SDK have been significantly architecturally re-designed, which changes how customers implement and leverage the SDKs.
Review the following checklist to understand some of the changes and what is required to upgrade:
  • The Experience Platform SDKs introduce the Mobile Core and constituent extensions.
    Mobile Core contains core SDK functionality that is required for all implementations that require Adobe and/or third-party extensions.
  • The Mobile Core and other extensions are configured in Launch in a mobile property.
    When published, Launch hosts this property configuration and makes it for your SDK implementation.
  • You decide which SDK extensions to add, configure, and ultimately include in your app project.
    This provides the flexibility to customize your implementations.
    Important: Some extensions depend on others for proper functioning, and these are documented where applicable.
  • We recommend that you ease your build process by use supported dependency managers, such as Gradle for Android and Cocoapods for iOS. Launch provides inline instructions and specs to help you with this process.

Upgrade checklist

  1. 1.
    Begin with Getting Started section and ensure that you are appropriately provisioned for Launch.
  2. 2.
    Ensure all of the required SDK APIs that you currently use are available in the new SDK.
    For more information, see Experience Platform SDKs vs. the 4x SDKs.
    Tip: The Experience Platform SDK supports iOS versions 10+, Android 4+ (API 14+).
  3. 3.
    If you are implementing Analytics, see Processing rules overview to map the variables and rules.
  4. 4.
    In the Experience Platform SDK, you need to manually implement your Lifecycle calls. For more information, see Manual Lifecycle Implementation.
The Experience Platform SDK automatically performs migration tasks that are required to preserve locally stored user context. Without manual intervention, you should expect no change to your visitor reporting or marketing campaigns.
This client-side, SDK upgrade does not affect marketing campaigns that are in progress, reporting, or other app activities that are configured in Experience Cloud solutions.

Additional information

Get help