iOS Guidelines |

Getting Started with iOS Integration

You can get started with the following:

The latest version of InMobi SDK supports iOS 8 and later. Also, this version of iOS SDK requires XCode 9.0 and later.

Version 7.2.1 8.0.1 (Beta)
Size (.IPA Inflation) 730 KB 1.2 MB
SDK Links

Adding the SDK to your Project

Method 1: Integration via Cocoapods (https://cocoapods.org/pods/InMobiSDK)

Follow these steps :

  1. Go to your Xcode project directory and create a pod file using the command below.
                pod init
    			
  2. Add the following to Podfile.
                pod 'InMobiSDK'
                Eg. pod ‘InMobiSDK’
    			
  3. Run the command below to complete the task for dependency.
                pod install
    			

    Workspace with pods is created.

Method 2: Integrating the framework directly

Add the following MANDATORY frameworks to your Xcode project:

  • InMobiSDK.framework from the downloaded InMobi iOS SDK bundle
  • libsqlite3.0.tbd
  • libz.tbd
  • WebKit.framework

Add -ObjC flag to the Other Linker Flags:

  1. Open your project in Xcode.
  2. Select Application Target > Build Settings.
  3. In the Search box, search for Other Linker Flags.
  4. Add the -ObjC flag

Preparing your App for iOS 9+

App Transport Security (ATS), a default setting introduced with iOS 9 that mandates apps to make network connections only over TLS version 1.2 and later. Though InMobi is committed towards the adoption of HTTPS, the current setup requires our demand partners to support this change and be 100% compliant with all the requirements of ATS.

While we work with our partners progressing towards a secure environment, to ensure ads work on iOS 9 and later versions, you need to follow these steps as a near-term fix:

  • Disable ATS (Recommended) - to ensure non-secure content from the partners work correctly in your updated apps. To disable ATS flag, add the following code snippet to your app's Info.plist.

                <key>NSAppTransportSecurity</key>
                <dict>
                <key>NSAllowsArbitraryLoads</key>
                <true/>
                </dict>
    			
  • Disable ATS with exceptions (Not Recommended) - in case you plan to migrate towards ATS compliance. You can achieve so by allowing secure content from your domains by adding them on the exception list.
    	        <key>NSAppTransportSecurity</key>
       	        <dict>
                <key>NSAllowsArbitraryLoads</key>
        	    <true/>
                <key>NSExceptionDomains</key>
            	<dict>
                <key>example.com</key>
                <dict>
                <key>NSIncludesSubdomains</key>
                <true/>
                </dict>
             	</dict>
        	    </dict>
    			

Note: Refrain from using InMobi domains and CDN in the exception list as it will result in errors during the runtime.

iOS 12 WiFi Settings

Apple has introduced privacy settings to access WiFi details from iOS 12 onwards. To boost monetization and relevant user experience we encourage sharing WiFi details for targeted advertising.

Step 1: Enable ‘Access WiFi Information’ on your App ID.

Step 2: Enable access ‘Access WiFi Information’ for your target app from XCode capabilities.

Step 3: Ensure WiFi Access is added to your App.entitlements file.

Initializing the SDK

  1. Import the InMobi SDK header in your AppDelegate.swift file:
                                 @import InMobiSDK;
                                 /**Please do not remove the window property as it can lead to undefined behavior**/
                                // @property (strong, nonatomic) UIWindow *window;
    			
  2. Initialize the SDK in the didFinishLaunchingWithOptions method within the AppDelegate.swift file:
                           func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {
                           //Initialize InMobi SDK with your account ID
                           //consent value needs to be collected from the end user
                           let consentDict: NSMutableDictionary = [IM_GDPR_CONSENT_AVAILABLE : "true"]
                           consentDict.setValue( 1, forKey: "gdpr")
                           IMSdk.initWithAccountID(INMOBI_ACCOUNT_ID, consentDictionary:consentDict as! [AnyHashable : Any])
    	               // Do your stuff.
    	               return YES;
                           }
    			
    1. consentObject - A consentObject is a dictionary representation of all kind of consent provided by the publisher to the SDK. The key is mandatory if you wish to monetize traffic from EEA region. You can read further on GDPR regulations here.
      Key Type Inference
      gdpr_consent_available String

      "true" - Publisher has provided consent to collect and use user’s data.

      "false" - Publisher has not provided consent to collect and use user’s data.

      Any value other than “true” and “false” is invalid and will be treated as value not provided by publisher, i.e. empty value.

      gdpr Number Whether or not the request is subjected to GDPR regulations, deviation from the set values (0 = No, 1 = Yes ), indicate an unknown entity.

      The key gdpr_consent_available can be accessed via string constant IM_GDPR_CONSENT_AVAILABLE.

      Important

      1. You need to provide consentObject in every session. The SDK does not persist consent, it only keeps the consentObject in memory. If the app is relaunched or crashes - SDK will lose the consentObject.
      2. Within a session, you can update the consent like this:
        IMSdk.updateGDPRConsent(<Insert consentObject dictionary here>)
        					
      3. As part of the General Data Protection Regulation (“GDPR”) publishers who collect data on their apps, are required to have a legal basis for collecting and processing the personal data of users in the European Economic Area (“EEA”). Please ensure that you obtain appropriate consent from the user before making ad requests to InMobi for Europe and indicate the same by following our recommended SDK implementation. Please do not pass any demographics information of a user; if you do not have user consent from such user in Europe.
    2. Find your account ID from the account interface as shown in the image below.

  3. Pass the location information to allow better ad targeting.

    Recommended: If your app collects location from the user, we recommend passing it up, as impressions with location signal have higher revenue potential. InMobi SDK will automatically pass the location signals if available in the app. If you use location in your app, but would like to disable passing location signals to InMobi, then TURN OFF the “Location Automation” for your property on the InMobi dashboard.

    Otherwise: You can set NSLocationWhenInUseUsageDescription flag (description for asking location permission) in your info.plist file.

                    let mgr = CLLocationManager()
                    let loc = mgr.location
                    IMSdk.setLocation(loc)
    			
  4. Pass age and gender information to allow better ad targeting. Ensure that you have user consent to share this data.
    The following values are supported:
    Age Gender
    • kIMSDKAgeGroupBelow18
    • kIMSDKAgeGroupBelow18And24
    • kIMSDKAgeGroupBetween25And29
    • kIMSDKAgeGroupBetween30And34
    • kIMSDKAgeGroupBetween35And44
    • kIMSDKAgeGroupBetween45And54
    • kIMSDKAgeGroupBetween55And65
    • kIMSDKAgeGroupAbove65
    • male
    • female
                      IMSdk.setGender(.male)
                      IMSdk.setAgeGroup(.between25And29)
    			

Note:

Audio Handling in WKWebView

For publishers running any audio or video media as the main content, we recommend listening to interruptions by observing AVAudioSessionInterruptionnotification posted by AVAudioSession. This will help preempt any content interruptions and help address user experience issues upfront. For more information read these Apple documents: Article 1, Article 2.

Start monetizing your iOS app with these ad formats: