Upgrade guide

Upgrading The iOS SDK From 3.0.2 To 3.1.3-beta

Integration Via Pods

1. Update your pod file. See pod versions in CocoaPods integration guide.

Manual Integration

1. Manual integration stays the same as for 3.0.2. Add the necessary libraries in your project.

Upgrading The iOS SDK From 3.0.1 To 3.0.2

Integration Via Pods

1. Update your pod file. See pod versions in CocoaPods integration guide.

Manual Integration

1. Manual integration stays the same as for 3.0.0. Add the necessary libraries in your project.

Upgrading The iOS SDK From 3.0.0 To 3.0.1

Integration Via Pods

1. Update your pod file. See pod versions in CocoaPods integration guide.

Manual Integration

1. Manual integration stays the same as for 3.0.0. Add the necessary libraries in your project.

Upgrading The iOS SDK From 2.11.1 To 3.0.0

Integration Via Pods

1. Update your pod file. See pod versions in CocoaPods integration guide.

Manual Integration

1. Download the latest version of Appodeal.zip
2. Add all downloaded content to Framework, Libraries, and Embedded Content in General settings of project.

Changes

1. Initilization with consent manager. Since Appodeal SDK 3.0.0 Stack Consent Manager is embdedded in Appodeal SDK core and synchronising by default. Removes all consent manager related logic from project. Call initialization method in your app delegate -application:didFinishLaunchingWithOptions: method:

   • Swift
   • Objective C

   @UIApplicationMain 
   final class MyAppDelegate: UIResponder, UIApplicationDelegate, AppodealInitializationDelegate { 
   	func application( 
   		_ application: UIApplication, didFinishLaunchingWithOptions
   		launchOptions: [UIApplication.LaunchOptionsKey : Any]? = nil ) -> Bool {
   		/// Any pre-initialization 
   		/// app specific logic 
   		Appodeal.initialize( 
   			withApiKey: "APP_KEY", 
   			types: .interstitial 
   		) 
   		return true 
   	} 	
   }

   @interface MyAppDelegate () <AppodealInitializationDelegate> 
   
   @end 
   
   @implementation MyAppDelegate 
   - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions { 
   	/// Any pre-initialization 
   	/// app specific logic 
   	[Appodeal initializeWithApiKey:@"APP KEY" types:AppodealAdTypeInterstitial];
   	return YES; 
   } 
   
   @end

   If you still want to use your own implementation of Stack Consent Manager integration, you are able to keep it. In this case Appodeal SDK will skip consent synchronisation process during initialization and will use given consent report.

2. Initilization without consent manager. You don't need to pass boolean flag into initialization method. Instead of this approach call the one of +updateUserConsentGDPR: or +updateUserConsentCCPA: before initialization. In case the SDK will have at least one non unknown user consent for GDPR or CCPA zone it will skip consent synchronisation process during initialization.  

   • Swift
   • Objective C

   @UIApplicationMain 
   final class MyAppDelegate: UIResponder, UIApplicationDelegate, AppodealInitializationDelegate { 
   	func application( 
   		_ application: UIApplication, didFinishLaunchingWithOptions
   		launchOptions: [UIApplication.LaunchOptionsKey : Any]? = nil ) -> Bool {
   		
   		// App specific logic to dertmine regulation zone and user consent
   		requestUserConsent { zone, userConsent in
   			switch (zone, userConsent) {
   				case .GDPR, true: Appodeal.updateUserConsentGDPR(.personalized)
   			 	case .GDPR, false: Appodeal.updateUserConsentGDPR(.nonPersonalized)
   			 	case .CCPA, true: Appodeal.updateUserConsentCCPA(.optIn)
   			 	case .CCPA, false: Appodeal.updateUserConsentCCPA(.optOut)
   			}
   			Appodeal.initialize( 
   				withApiKey: "APP_KEY", 
   				types: .interstitial 
   			) 
   		}
   		return true 
   	} 	
   }

   @interface MyAppDelegate () <AppodealInitializationDelegate> 
   
   @end 
   
   @implementation MyAppDelegate 
   - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {    		
   	// App specific logic to dertmine regulation zone and user consent
   	[self requestUserCosent:^(Zone zone, BOOL userConsent) {
   		switch (zone) {
   			case GDPR: [Appodeal updateUserConsentGDPR:userConsent ? APDGDPRUserConsentPersonalized : APDGDPRUserConsentNonPersonalized]; break;
   		 	case CCPA: [Appodeal updateUserConsentCCPA:userConsent ? APDCCPAUserConsentOptIn : APDCCPAUserConsentOptOut]; break;
   			default: break;
   		}
   		[Appodeal initializeWithApiKey:@"APP KEY" types:AppodealAdTypeInterstitial];
   	}];  
   	return YES; 
   } 
   
   @end

   3. User data. If your app is setting user age or user gender in Appodeal SDK, you will need to removes current implementation and use the next code. 
   • Swift
   • Objective C

   Appodeal.setCustomStateValue(AppodealUserGender.male, forKey: kAppodealUserGenderKey)
   Appodeal.setCustomStateValue(40, forKey: kAppodealUserAgeKey)

   [Appodeal setCustomStateValue:AppodealUserGenderMale forKey: kAppodealUserGenderKey];
   [Appodeal setCustomStateValue:40 forKey: kAppodealUserAgeKey];

Upgrading The iOS SDK From 2.11.0 To 2.11.1

Integration Via Pods

1. Update your pod file. See pod versions in CocoaPods integration guide.

Manual Integration

1. Manual integration stays the same as for 2.11.0. All libraries remain the same.

Upgrading The iOS SDK From 2.10.3 To 2.11.0

Integration Via Pods

1. Update your pod file. See pod versions in CocoaPods integration guide.

2. Xcode 13 is required

Manual Integration

1. Add all downloaded content to Framework, Libraries, and Embedded Content in General settings of project.

2. Xcode 13 is required
3. iOS 10 or higher is required

Upgrading The iOS SDK From 2.10.2 To 2.10.3

Integration Via Pods

1. Update your pod file. See pod versions in CocoaPods integration guide.

Manual Integration

1. Manual integration stays the same as for 2.10.2. All libraries remain the same.

Upgrading The iOS SDK From 2.10.1 To 2.10.2

Integration Via Pods

1. Update your pod file. See pod versions in CocoaPods integration guide.

Manual Integration

1. Manual integration stays the same as for 2.10.1. All libraries remain the same.

Upgrading The iOS SDK From 2.10.0-Beta To 2.10.1

Integration Via Pods

1. Update your pod file. See pod versions in CocoaPods integration guide.

Manual Integration

1. Manual integration stays the same as for 2.10.0-Beta. All libraries remain the same.

Changes

1. XCode 12.5 is required

Upgrading The iOS SDK From 2.9.1 To 2.10.0-Beta

Integration Via Pods

1. Update your pod file. See pod versions in CocoaPods integration guide.

Manual Integration

1. Manual integration stays the same as for 2.9.1. Add all libraries from downloaded archive into your project.

Upgrading The iOS SDK From 2.8.1 To 2.9.1

Integration Via Pods

1. Update your pod file. See pod versions in CocoaPods integration guide.

Manual Integration

1. Manual integration stays the same as for 2.8.1. All libraries remain the same.

Upgrading The iOS SDK From 2.8.1 To 2.9.0-Beta

Integration Via Pods

1. Update your pod file. See pod versions in CocoaPods integration guide.

Manual Integration

1. Manual integration stays the same as for 2.8.1. All libraries remain the same.

Upgrading The iOS SDK From 2.7.5 To 2.8.1

Integration Via Pods

1. Update CocoaPods to 1.10.0 version or higher if needed.

2. Update your pod file. See pods versions in CocoaPods integration guide.

3. Xcode 12 is required
4. iOS 10 or higher is required

Manual Integration

1. Add all downloaded content to Framework, Libraries, and Embedded Content in General settings of project.

2. If you are planning to use libAPDMopubAdapter.a, you also need to add compatible version of MoPub framework.
3. Xcode 12 is required
4. iOS 10 or higher is required

Upgrading The iOS SDK From 2.8.1-Beta To 2.8.1

Integration Via Pods

1. Update CocoaPods to 1.10.0 version or higher if needed.

2. Update your pod file. See pod versions in CocoaPods integration guide.

Manual Integration

1. Manual integration stays the same as for 2.8.1-Beta. All libraries remain the same.

Upgrading The iOS SDK From 2.8.0-Beta To 2.8.1-Beta

Integration Via pods

1. Update CocoaPods to 1.9.0 version or higher if needed.

2. Update your pod file. See pod versions in CocoaPods integration guide.

Manual Integration

1. Add all downloaded content to Framework, Libraries, and Embedded Content in General settings of project.

2. If you are planning to use libAPDMopubAdapter.a, you also need to add compatible version of MoPub framework.

Upgrading The iOS SDK From 2.7.4-Beta To 2.8.0-Beta

Integration Via Pods

1. Update your pod file. See pod versions in CocoaPods integration guide .

Manual Integration

1. Manual integration stays the same as for 2.7.4-Beta. All libraries remain the same.

Upgrading The iOS SDK From 2.7.3-Beta To 2.7.4-Beta

Integration Via Pods

1. Update your pod file. See pod versions in CocoaPods integration guide .

Manual Integration

1. Manual integration stays the same as for 2.7.3-Beta. All libraries remain the same.

Upgrading The iOS SDK From 2.7.2-Beta To 2.7.3-Beta

Integration Via Pods

1. Update your pod file. See pod versions in CocoaPods integration guide.

Manual Integration

1. Manual integration stays the same as for 2.7.2-Beta. All libraries remain the same.

Changes

1. Method +setSegmentFilter: has been deprecated. If you are using this method, change it to +setCustomState:

Upgrading The iOS SDK From 2.7.1-Beta To 2.7.2-Beta

Integration Via Pods

1. Update your pod file. See pod versions in integration guide.

Manual Integration

1. Manual integration stays the same as for 2.7.1-Beta. All libraries remain the same.

Upgrading The iOS SDK From 2.7.0-Beta To 2.7.1-Beta

Integration Via Pods

1. Update your pod file. See pod versions in integration guide.

Manual Integration

1. Manual integration stays the same as for 2.7.0-Beta. All libraries remain the same.

Upgrading The iOS SDK From 2.6.1-Beta To 2.7.0-Beta

Integration Via Pods

1. Update your pod file. See pod versions in integration guide.

Manual Integration

1. Manual integration stays the same as for 2.6.1-Beta. All libraries remain the same.

Upgrading The iOS SDK From 2.6.0-Beta To 2.6.1-Beta

Integration Via Pods

1. Update your pod file. See pod versions in integration guide.

Manual Integration

1. Manual integration stays the same as for 2.6.0-Beta. All libraries remain the same.

Upgrading The iOS SDK From 2.5.13 To 2.6.0-Beta

Integration Via Pods

1. Update your pod file: deployment target remains the same as for 2.5.13 (it should be 9.0) and pod version should be changed from '2.5.13' to '2.6.0-Beta'.

2. Add all pod adapters into your Podfile. You can get list of pod adapters in CocoaPods integration guide.

Manual Integration

1. Manual integration stays the same as for 2.5.13. All libraries remain the same.

Changes

1. If your project is a pure Objective-C project, you should add an empty Swift file. For example Dummy.swift.

Upgrading The iOS SDK From 2.5.12 To 2.5.13

Integration Via Pods

1. Update your pod file: deployment target remains the same as for 2.5.12 (it should be 9.0) and pod version should be changed from '2.5.12' to '2.5.13'.

Manual Integration

1. Manual integration stays the same as for 2.5.12. All libraries remain the same.

Changes

You can use the +updateConsent: method to provide the GDPR user consent to ad networks in Appodeal SDK anywhere in your application. Appodeal SDK doesn't keep the GDPR user consent between sessions, that means you have to provide consent every time, otherwise, Appodeal SDK uses default or server value. By default, consent value is true.

Upgrading The iOS SDK From 2.5.11 To 2.5.12

Integration Via Pods

1. Update your pod file: deployment target remains the same as for 2.5.11 (it should be 9.0) and pod version should be changed from '2.5.11' to '2.5.12'.

2. Several subspecs were renamed:

   pod 'Appodeal/AppodealAdExchangeAdapter', '2.5.12' 
   pod 'Appodeal/IronSourceAdapter', '2.5.12'

Manual Integration

1. Manual integration stays the same as for 2.5.11. All libraries remain the same.

Upgrading The iOS SDK From 2.5.10 To 2.5.11

Integration Via Pods

1. Update your pod file: deployment target remains the same as for 2.5.10 (it should be 9.0) and pod version should be changed from '2.5.10' to '2.5.11'.

Manual Integration

1. Manual integration stays the same as for 2.5.10. All libraries remain the same.

Upgrading The iOS SDK From 2.5.9 To 2.5.10

Integration Via Pods

1. Update your pod file: deployment target remains the same as for 2.5.9 (it should be 9.0) and pod version should be changed from '2.5.9' to '2.5.10'.

Manual Integration

1. Manual integration stays the same as for 2.5.9. All libraries remain the same.

Upgrading The iOS SDK From 2.5.8 To 2.5.9

Integration Via Pods

1. Update your pod file: deployment target remains the same as for 2.5.8 (it should be 9.0) and pod version should be changed from '2.5.8' to '2.5.9'.

2. If you use only some parts of Appodeal SDK (ad types), pod file updating process will be the same. For example: from "pod 'Appodeal/Banner', '2.5.8' " to "pod 'Appodeal/Banner', '2.5.9'" and deployment target stays the same as for 2.5.8 (it should be 9.0).

Manual Integration

1. Manual integration stays the same as for 2.5.8. All libraries remain the same.

Changes

1. Add your GADApplicationIdentifier into info.plist file

<key>GADApplicationIdentifier</key>
<string>ca-app-pub-3940256099942544~1458002511</string>

Upgrading The iOS SDK From 2.5.7 To 2.5.8

Integration Via Pods

1. Update your pod file: deployment target remains the same as for 2.5.5 (it should be 9.0) and pod version should be changed from '2.5.7' to '2.5.8'.

2. If you use only some parts of Appodeal SDK (ad types), pod file updating process will be the same. For example: from "pod 'Appodeal/Banner', '2.5.7' " to "pod 'Appodeal/Banner', '2.5.8'" and deployment target stays the same as for 2.5.7 (it should be 9.0).
   

3. FBAudienceNetwork 5.4.0 has FBSDKCoreKit as external dependency and will be installed when your update Appodeal SDK to 2.5.8.

Manual Integration

1. Manual integration stays the same as for 2.5.7. All libraries remain the same.

Upgrading The iOS SDK From 2.5.6 To 2.5.7

Integration Via Pods

1. Update your pod file: deployment target remains the same as for 2.5.5 (it should be 9.0) and pod version should be changed from '2.5.6' to '2.5.7.

2. If you use only some parts of Appodeal SDK (ad types), pod file updating process will be the same. For example: from "pod 'Appodeal/Banner', '2.5.6' " to "pod 'Appodeal/Banner', '2.5.7'" and deployment target stays the same as for 2.5.6 (it should be 9.0).
   

3. FBAudienceNetwork 5.4.0 has FBSDKCoreKit as external dependency and will be installed when your update Appodeal SDK to 2.5.7.

Manual Integration

1. Manual integration stays the same as for 2.5.6. All libraries remain the same.

Upgrading The iOS SDK From 2.5.5 To 2.5.6

Integration Via Pods

1. Update your pod file: deployment target remains the same as for 2.5.5 (it should be 9.0) and pod version should be changed from '2.5.5' to '2.5.6'.
2. If you use only some parts of Appodeal SDK (ad types), pod file updating process will be the same. For example: from "pod 'Appodeal/Banner', '2.5.5' " to "pod 'Appodeal/Banner', '2.5.5'" and deployment target stays the same as for 2.5.5 (it should be 9.0).

Manual Integration

1. Manual integration stays the same as for 2.5.5. All libraries remain the same.

Upgrading The iOS SDK From 2.5.4 To 2.5.5

Integration Via Pods

1. Update your pod file: deployment target remains the same as for 2.5.4 (it should be 9.0) and pod version should be changed from '2.5.4' to '2.5.5'.

2. If you use only some parts of Appodeal SDK (ad types), pod file updating process will be the same. For example: from "pod 'Appodeal/Banner', '2.5.4-Beta' " to "pod 'Appodeal/Banner', '2.5.5' " and deployment target stays the same as for 2.5.4 (it should be 9.0).

Manual Integration

1. Manual integration stays the same as for 2.5.4. All libraries remain the same.

Upgrading The iOS SDK From 2.5.3 To 2.5.4

Integration Via Pods

1. Update your pod file: deployment target remains the same as for 2.5.2( it should be 9.0) and pod version should be changed from '2.5.3' to '2.5.4'.

2. If you use only some parts of Appodeal SDK (ad types), pod file updating process will be the same. For example: from "pod 'Appodeal/Banner', '2.5.3-Beta' " to "pod 'Appodeal/Banner', '2.5.4-Beta' " and deployment target stays the same as for 2.5.3 (it should be 9.0).

Manual Integration

1. Manual integration stays the same as for 2.5.3. All libraries remain the same

2. Update rewarded video callback on reward. 

Upgrading The iOS SDK From 2.5.2 To 2.5.3

Integration Via Pods

1. Update your pod file: deployment target remains the same as for 2.5.2( it should be 9.0) and pod version should be changed from '2.5.2' to '2.5.3'.

2. If you use only some parts of Appodeal SDK (ad types), pod file updating process will be the same. For example: from "pod 'Appodeal/Banner', '2.5.2-Beta' " to "pod 'Appodeal/Banner', '2.5.3-Beta' " and deployment target stays the same as for 2.5.2 (it should be 9.0).

Manual Integration

1. Manual integration stays the same as for 2.5.2. All libraries remain the same.

Upgrading The iOS SDK From 2.5.0 To 2.5.2

Integration Via Pods

1. Update your pod file: deployment target remains the same as for 2.5.0( it should be 9.0) and pod version should be changed from '2.5.0' to '2.5.2'.

2. If you use only some parts of Appodeal SDK (ad types), pod file updating process will be the same. For example: from "pod 'Appodeal/Banner', '2.5.0-Beta' " to "pod 'Appodeal/Banner', '2.5.2-Beta' " and deployment target stays the same as for 2.5.0 (it should be 9.0).

Manual Integration

1. Manual integration stays the same as for 2.5.0. All libraries remain the same.

Upgrading The iOS SDK From 2.4.10 To 2.5.0

Integration Via Pods

1. Update your pod file: deployment target remains the same as for 2.4.10 ( it should be 9.0) and pod version should be changed from '2.4.10' to '2.5.0'.

2. If you use only some parts of Appodeal SDK (ad types), pod file updating process will be the same. For example: from "pod 'Appodeal/Banner', '2.4.10' " to "pod 'Appodeal/Banner', '2.5.0-Beta' " and deployment target stays the same as for 2.4.10 (it should be 9.0).

Manual Integration

1. Manual integration stays the same as for 2.4.10. All libraries remain the same.