iOS Guidelines

Add the InMobi SDK

Option 1: Integration via Cocoapods

1. If you are not already using Cocoapods, 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'
   

   
   If you want to integrate InMobiSDK without MOAT Libraries:

   pod ‘InMobiSDK/Core’
   

3. Once you have added it to the pod file, run the command below to complete the task for dependency. You now have a workspace with the pods.

   pod update
   

Option 2: Integrating the framework directly

Alternatively, you can integrate the framework directly.

1. Add the following MANDATORY frameworks to your Xcode project:

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

2. 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

Important Prerequisites

Let’s pause for some checks before we begin initializing the SDK:

Checkpoint 1: Preparing your App for iOS 10

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) - if 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>

Checkpoint 2: 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.

1. Enable ‘Access WiFi Information’ on your App ID.
   
   
    
2. Enable access ‘Access WiFi Information’ for your target app from XCode capabilities.
   
   
    
3. Ensure WiFi Access is added to your App.entitlements file.
   
   

Initializing the SDK

Import the InMobi SDK header in your AppDelegate.h file:

@import InMobiSDK; 
/**Please do not remove the window property as it can lead to undefined behavior**/ 
@property (strong, nonatomic) UIWindow *window;

import InMobiSDK
/**Please do not remove the window property as it can lead to undefined behavior**/ 
var window: UIWindow?

Initialize the SDK in the didFinishLaunchingWithOptions method within the app delegate's.m file:

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions { 
    void (^completionBlock)(NSError*) = ^( NSError* _Nullable  error) { 
        if (error) { 
            NSLog(@"SDK Initialization Error - %@", error.description); 
        } 
        else { 
            NSLog(@"IM Media SDK successfully initialized"); 
        } 
    }; 
    [IMSdk setLogLevel:kIMSDKLogLevelDebug]; 
    [IMSdk initWithAccountID:kIMAccountID consentDictionary:@{IM_GDPR_CONSENT_AVAILABLE: @"true", IM_GDPR_CONSENT_IAB: @"<<consent in IAB format>>"} andCompletionHandler:completionBlock]; 
    return YES; 
} 

func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
        IMSdk.setLogLevel(IMSDKLogLevel.debug)
        IMSdk.initWithAccountID("accountID", consentDictionary: [IM_GDPR_CONSENT_AVAILABLE: "true", IM_GDPR_CONSENT_IAB: "<<consent in IAB format>>" ]) { (error) in
            if let error = error {
                print(error.localizedDescription)
            }
           
        }
        return true
    }

Let’s understand a few things here before you proceed:

What is a consentObject? - A consentObject is a dictionary representation of all kinds 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.

A consentObject has to be provided in every session. SDK does not persist consent, it only keeps the consentObject in memory. If the app is relaunched, SDK will lose the consentObject. Within a session, a consentObject can be updated as below:

[IMSdk updateGDPRConsent:@{<Insert consentObject dictionary here>}];

IMSdk.updateGDPRConsent(<Insert consentObject dictionary here>)

Optimization

A. Pass the Location Information

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

//Using <CoreLocation/CoreLocation.h> fetch the coordinate
    self.locationMgr = [[CLLocationManager alloc] init];
    [self.locationMgr requestWhenInUseAuthorization];
    self.locationMgr.desiredAccuracy = kCLLocationAccuracyHundredMeters;
    self.locationMgr.delegate = self;
    [self.locationMgr startUpdatingLocation];
 
#pragma mark - CLLocationManagerDelegate
- (void)locationManager:(CLLocationManager *)manager didUpdateLocations:(NSArray *)locations {
    CLLocation *clLocation = locations.lastObject;
    [IMSdk setLocation:clLocation];
    [self.locationMgr stopUpdatingLocation];
} 

"var locationMgr: CLLocationManager?

//Using CLLocationManagerDelegate fetch the coordinate
locationMgr = CLLocationManager()
locationMgr?.requestWhenInUseAuthorization()
locationMgr?.delegate = self
locationMgr?.startUpdatingLocation()

func locationManager(_ manager: CLLocationManager, didUpdateLocations locations: [CLLocation]) {
    if let clLocation = locations.last {
            IMSdk.setLocation(clLocation)
    }
    locationMgr?.stopUpdatingLocation()
 }"

B. Pass Age and Gender information

Ensure that you have user consent to share this data. The following values are supported:

Example:

[IMSdk setGender:kIMSDKGenderFemale];
[IMSdk setAgeGroup:kIMSDKAgeGroupBetween25And29];

IMSdk.setGender(.female)
IMSdk.setAgeGroup(.between25And29)