iOS SDK integration instructions

This article describes how to integrate iOS SDK v9.x into your Xcode project. For instructions on displaying different ad types, see iOS SDK ad units.

Requirements

• Your app must target iOS 15.0 or later.
• To request ads, use a valid placement ID. For supported ad units, you can instead use a valid member ID and inventory code.

Installation

Choose an installation method:

Swift Package Manager

1. Open your project in Xcode.

2. Select the project in the Project navigator, and then select Package Dependencies.

3. Select the + button to add a package dependency.

   

4. Enter the following package URL in the search box, and then press Return:

   https://github.com/appnexus/mobile-sdk-ios-spm
   

   

5. Choose the version setting that fits your project. For new projects, select Up to Next Major Version. Then select Add Package.

6. In the Choose Package Products for mobile-sdk-ios-spm window, select AppNexusSDK and your app target. Then select Add Package.

   

7. Verify that AppNexusSDK appears under Package Dependencies.

Alternative installation methods

Use these methods only when Swift Package Manager doesn't meet your project's requirements.

XCFramework

Download iOS SDK v9.14.0. The ZIP file contains the following frameworks and resource bundle. Use AppNexusSDK for a general integration.

1. Open the app’s Xcode project or workspace.

2. Go to the app target’s General configuration page.

3. To use the AppNexusSDK, add the AppNexusSDK.xcframework and ANSDKResources.bundle.

4. To import the AppNexusSDK.xcframework:

   • Navigate to your project's Target settings.
   • Navigate to Target > General.
   • Click the + button under the Frameworks, Libraries, and Embedded Content section.
   • Click Add Other and then Add Files.
   • Choose the AppNexusSDK.xcframework file and click Open.

   

5. To include the ANSDKResources.bundle:

   • Navigate to Target > Build Phase.
   • Expand the Copy Bundle Resources row and click the + icon.
   • Choose the ANSDKResources.bundle file and click Open.

   

Carthage

If you are unfamiliar with Carthage, review the Carthage documentation. After installing Carthage, follow these steps:

1. Open Terminal and navigate to the root directory of your project. Create a Cartfile:

   touch Cartfile
   

2. Open the Cartfile in Xcode:

   open -a Xcode Cartfile
   

3. Add the following lines to the Cartfile:

   binary "https://adsdkprod.azureedge.net/mobile/ios/releases/carthage/AppNexusSDK.json"
   binary "https://adsdkprod.azureedge.net/mobile/ios/releases/carthage/OMSDK_Microsoft.json"
   

   Tip

   Use straight quotation marks in the Cartfile. Carthage doesn't recognize smart quotation marks inserted by some text editors.

4. Save the Cartfile, and then update the dependencies:

   carthage update --use-xcframeworks
   

5. Add AppNexusSDKDynamic.xcframework and OMSDK_AppNexus.xcframework to Target > General > Embedded Binaries.

6. For an application target, select Embed & Sign. For other targets, select Do Not Embed.

CocoaPods

If you are unfamiliar with CocoaPods, review the CocoaPods documentation. After installing CocoaPods, follow these steps:

1. In Terminal, navigate to the root directory of your project and create a Podfile:

   pod init
   

2. Open the Podfile, set the platform version to 15.0, and add AppNexusSDK to the target:

   platform :ios, '15.0'
   project 'FunBanner'
   
   target 'FunBanner' do
     pod 'AppNexusSDK'
   end
   

3. Save the Podfile, and then install the dependency:

   pod install
   

4. Close the open Xcode project, and then open the generated .xcworkspace file.