Skip to content
This repository has been archived by the owner on Jul 8, 2024. It is now read-only.

Latest commit

 

History

History
128 lines (96 loc) · 9.78 KB

README.md

File metadata and controls

128 lines (96 loc) · 9.78 KB
Raw

Adobe Experience Platform SDKs

Notice of deprecation

As of June 30, 2024, Adobe has deprecated support for the Adobe Experience Platform 1.x SDKs for Android. We will continue to provide support for Experience Platform 2.x SDKs for Android, but we strongly recommend upgrading to the 3.x version to access new features. The Adobe Experience Platform 3.x SDKs for Android were released on April 4th, 2024. Please consult the migration guide for instructions on upgrading to the latest version.

Since April 25, 2023, Apple has required apps submitted to the App Store to be built with Xcode 14.1 or later. The Experience Platform Mobile SDKs and extensions outlined below were built with prior versions of Xcode and are no longer compatible with iOS and iPadOS given Apple’s current App Store requirements. Consequently, on August 31, 2023, Adobe will be deprecating support for the following Experience Platform Mobile SDKs and wrapper extensions:

After August 31, 2023, applications already submitted to the App Store that contain these SDKs and wrapper extensions will continue to operate, however, Adobe will not be providing security updates or bug fixes, and these SDKs and wrapper extensions will be provided as-is exclusive of any warranty, due to the App Store policy outlined above.

We encourage all customers to migrate to the latest Adobe Experience Platform versions of the Mobile SDK to ensure continued compatibility and support. Documentation for the latest versions of the Adobe Experience Platform Mobile SDKs can be found here. The iOS migration guide can be found here.

To learn more about your topic of interest, click the following links:

Release notes

Latest versions

Installing the AEP SDK for Android

⚠️ Important

Beginning August 31, 2023, any new AARs for the 1.x SDK will not be available in this repository. To install them manually, you can directly obtain them from the Maven Central repository.

⚠️ Important

A newer version of the AEP Mobile SDKs for Android (Mobile Core 2.x and compatible extensions) is now available! These SDKs are open source, and bring many exciting new features. If you are currently using the 1.x libraries, please see the guide for migrating to latest SDKs for Android for next steps.

The AEP SDK 1.x supports Android API 14 (Ice Cream Sandwich) and newer.

Installation using Maven/Gradle << Preferred >>

Installation via Maven & Gradle is the easiest and recommended way to get the AEP SDK into your Android app. In your build.gradle file, include the following dependencies:

implementation 'com.adobe.marketing.mobile:sdk-core:1.+'
implementation 'com.adobe.marketing.mobile:analytics:1.+'
implementation 'com.adobe.marketing.mobile:audience:1.+'
implementation 'com.adobe.marketing.mobile:campaign:1.+'
implementation 'com.adobe.marketing.mobile:campaignclassic:1.+'
implementation 'com.adobe.marketing.mobile:target:1.+'
implementation 'com.adobe.marketing.mobile:assurance:1.+'
implementation 'com.adobe.marketing.mobile:userprofile:1.+'

Manual installation

In order to do a manual installation of the AEP SDK .aar binaries, complete the following steps for each .aar you need:

  • Download the .aar file from the Android/ directory on the master branch.
  • Go to "File > New > New Module" in the menu.
  • Select the "Import .JAR/.AAR Package" from the New Module window.
  • In the "Import Module from Library" dialog, enter the path to the .aar you are installing.
    • Enter a Subproject Name of your choice.
  • Click "Finish".
  • Once Gradle sync is complete and you see the library as a module in the Android project view, add the new library module as a dependency to your app.
    • Right-click on your app module, and select "Open Module Settings".
    • In the next dialog, select your app and click on the "Dependencies" tab.
    • Click on the "+" button on the bottom, and select module dependency.
    • In the next dialog, select the library module as your dependency.

Important - all AEP SDK Android binaries depend on core-1.x.x.aar.

Installing the AEP SDK (2.x) for iOS

⚠️ Important

A newer version of the AEP Mobile SDKs (3.x) is now available! These SDKs are open source, bring many exciting new features and include support for Swift Package Manager (SPM), CocoaPods and XCFrameworks. If you are currently using our Objective-C (ACP-prefix 2.x) libraries, please see the guide for migrating to Swift for next steps.

Important - The latest versions of the AEP SDK for iOS are distributed using XCFrameworks. If using the XCFramework distribution, Xcode 12 or newer is required and Cocoapods 1.10.0 or newer is required (where applicable). The AEP SDK supports iOS 10 and newer.

Installation using Cocoapods << Preferred >>

Installation via Cocoapods is the easiest and recommended way to get the AEP SDK into your iOS app. In your Podfile, simply add the following changes as needed:

# minimum supported version of iOS is 10.0
platform :ios, '10.0'    

# Uncomment the next line if you're using Swift or would like to use dynamic frameworks
# use_frameworks!

# Adobe ACP Pods
pod 'ACPCore', '~> 2.0'
pod 'ACPAnalytics', '~> 2.0'
pod 'ACPAudience', '~> 2.0'
pod 'ACPCampaign', '~> 1.0'
pod 'ACPCampaignClassic', '~> 2.0'
pod 'ACPTarget', '~> 2.0'
pod 'AEPAssurance', '~> 1.0'
pod 'ACPUserProfile', '~> 2.0'

Manual installation - XCFrameworks

In order to do a manual installation of the AEP SDK XCFrameworks, complete the following steps:

  • Download the extensions needed by your app from the iOS/ directory.
  • In the Xcode project create a new Group, then drag all the extensions downloaded and drop them under the group. Verify the following:
    • The Copy Items if needed checkbox is selected.
    • Create groups is selected.
    • In the Add to targets section, select all the targets that need AEP SDKs.
  • Select your project from the Project Navigator, select your App from the TARGETS frame, then select the General tab at the top of the window.
  • In the Link Binary With Libraries section, click the + link and add the following frameworks and libraries: UIKit, SystemConfiguration, WebKit, UserNotifications, libsqlite3.0, libc++, libz.
  • If you have a Swift application, include a bridging header and import the AEP SDK headers available in the include folder. For more information see Importing Objective-C into Swift

Important - all AEP SDK iOS XCFrameworks depend on ACPCore.xcframework.

Manual installation - static libraries

In order to do a manual installation of the AEP SDK libraries, complete the following steps:

  • Download the extensions needed by your app from the iOS/ directory.
  • In the Xcode project create a new Group, then drag all the extensions downloaded and drop them under the group. Verify the following:
    • The Copy Items if needed checkbox is selected.
    • Create groups is selected.
    • In the Add to targets section, select all the targets that need AEP SDKs.
  • Select your project from the Project Navigator, select your App from the TARGETS frame, then select the General tab at the top of the window.
  • In the Link Binary With Libraries section, click the + link and add the following frameworks and libraries: UIKit, SystemConfiguration, WebKit, UserNotifications, libsqlite3.0, libc++, libz.
  • Important - If you have a Swift application, include a bridging header and import the AEP SDK headers available in the include folder. For more information see Importing Objective-C into Swift.

Important - all AEP SDK iOS libraries depend on libACPCore.a.