---
title: adobe/aepsdk-optimize-ios
framework: Swift Package Catalog
role: article
path: packages/adobe/aepsdk-optimize-ios
---

# adobe/aepsdk-optimize-ios

The AEPOptimize Mobile SDK provides APIs to enable real-time personalization workflows in the Adobe Experience Platform Mobile SDKs using Adobe Target or Adobe Journey Optimizer Offer Decisioning. It requires AEPCore and AEPEdge extensions to send personalization query events to

## About this project

The AEPOptimize Mobile SDK provides APIs to enable real-time personalization workflows in the Adobe Experience Platform Mobile SDKs using Adobe Target or Adobe Journey Optimizer Offer Decisioning. It requires AEPCore and AEPEdge extensions to send personalization query events to the Experience Edge network.

## Requirements

- Xcode 15 (or newer) - Swift 5.1 (or newer)

## Installation

These are currently the supported installation options:

### [CocoaPods](https://guides.cocoapods.org/using/using-cocoapods.html)

```ruby # Podfile use_frameworks!

# for app development, include all the following pods target 'YOUR_TARGET_NAME' do       pod 'AEPCore'       pod 'AEPEdge'       pod 'AEPOptimize' end ```

Replace `YOUR_TARGET_NAME` and then, in the `Podfile` directory, type:

```ruby $ pod install ```

### [Swift Package Manager](https://github.com/apple/swift-package-manager)

To add the AEPOptimize Package to your application, from the Xcode menu select:

`File > Swift Packages > Add Package Dependency...`

Enter the URL for the AEPOptimize package repository: `https://github.com/adobe/aepsdk-optimize-ios.git`. Click Next.

Specify the Version rule for the package options. Click Next and Finish.

Alternatively, if your project has a `Package.swift` file, you can add AEPOptimize directly to your dependencies:

``` dependencies: [     .package(url: "https://github.com/adobe/aepsdk-optimize-ios.git", .upToNextMajor(from: "5.0.0")) ], targets: [        .target(name: "YourTarget",                dependencies: ["AEPOptimize"],                path: "your/path"),     ] ] ```

### Binaries

To generate `AEPOptimize.xcframework`, run the following Makefile target from the project root directory:

```ruby $ make archive ```

This generates the xcframework under the `build` folder. Drag and drop the `.xcframework` to your app target in Xcode.

## Development

To install pod dependencies after you clone or download this project, run the following Makefile target from the root directory:

~~~ make pod-install ~~~

To fetch latest versions of the dependencies, run the following Makefile target from the project root directory:

~~~ make pod-update ~~~

#### Open the project Xcode workspace

To open the project workspace in Xcode, click on `AEPOptimize.xcworkspace` or run the following Makefile target from the project root directory:

~~~ make open ~~~

#### Run tests

To execute the tests, run the following Makefile target from the project root directory:

~~~ make test ~~~

## Documentation

Check out the [Documentation](./Documentation/README.md) directory to learn more about the Optimize extension.

Try out this [Optimize extension tutorial](https://opensource.adobe.com/aepsdk-optimize-ios/#/tutorials/README) to retrieve and track Adobe Target offers fetched via Experience Edge network using the provided sample application.

## Related Projects

| Project                                                      | Description                                                  | | ------------------------------------------------------------ | ------------------------------------------------------------ | | [AEPCore Extensions](https://github.com/adobe/aepsdk-core-ios) | The AEPCore extensions provide a common set of functionality and services required by all the Mobile SDK extensions. | | [AEPEdge Extension](https://github.com/adobe/aepsdk-edge-ios) | The AEPEdge extension enables sending data to Adobe Experience Platform from Mobile Apps. |

## Contributing

Contributions are welcome! Read the [Contributing Guide](./.github/CONTRIBUTING.md) for more information.

## Licensing

This project is licensed under the Apache V2 License. See [LICENSE](LICENSE) for more information.

## Package Metadata

Repository: adobe/aepsdk-optimize-ios

Default branch: main

README: README.md