iOS InApp Documentation - yanivav/Documentation GitHub Wiki

Last SDK Version: 2.4.2

For Swift documentation, please click here.

This document describes the basic procedure for integrating StartApp In-App Ads into your iOS applications.
After this simple integration process, StartApp In-App Ads enables you to reap the benefits of StartApp's In-App monetization products, which maximize the revenue generated by your application. All this profit-making is achieved with minimal effort and minimal interference with your users’ experience.

NOTES:

• The code samples in this document can be copy/paste into your source code
• When submitting your application to the App Store,do not forget to update your "IDFA Settings"
• Please notice that steps 1-3 are mandatory
• If you have any questions, contact us via [email protected]

##Step 1, Adding the StartApp SDK to your project

NOTE: If you're upgrading from an StartApp SDK, please refer to the Advanced Usage section before moving forward with the steps below.

1. Right-click on you project and choose "Add Files to…"
   
2. Add the StartApp SDK files:
   StartApp.framework
   StartApp.bundle

Back to top

Back to top

// AppDelegate.m

#import <StartApp/StartApp.h>

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions
{
    // initialize the SDK with your appID and devID
    STAStartAppSDK* sdk = [STAStartAppSDK sharedInstance];
    sdk.devID = @"your account id";
    sdk.appID = @"your app Id";

    return YES;
}

Replace "your account id" and "your app id" with your own values provided in the developers’ portal.
After logging in, your account ID will be displayed at the top right-hand corner of the page:

To find your application ID, click on the "Apps and Sites" tab on the left pane and choose the relevant ID from your app list:

Back to top

StartApp Splash Ad is a top performing ad unit, presenting the industry's highest CPM's

StartApp SDK provides two modes for displaying Splash screens:

####Adding the Splash Screen In your application delegate class (AppDelegate.m), after initializing the SDK, call the sdk showSplashAd method:

// AppDelegate.m

#import <StartApp/StartApp.h>

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions
{
    // initialize the SDK with your appID and devID
    STAStartAppSDK* sdk = [STAStartAppSDK sharedInstance];
    sdk.appID = @"your app Id";
    sdk.devID = @"your developer id";
	
	[sdk showSplashAd];  // display the splash screen

    return YES;
}

If you wish to customize or use a different splash screen, please refer to the Advanced Usage.

Back to top

Import the StartApp SDK in your view controller and call showAd where you want to show the ad

// YourViewController.m
#import <StartApp/StartApp.h>

[STAStartAppAdBasic showAd];

NOTE
If you need to gain more control over your interstitial ad like using callbacks or multiple ads with different properties, you should implement it as an object. For more info please refer to the Advanced Usage

Back to top

Return ads are enabled and activated by default. If you want to disable this feature, simply call [sdk disableReturnAd] as part of the initialization process, in your AppDelegate.m file:

// AppDelegate.m

#import <StartApp/StartApp.h>

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions
{
   // initialize the SDK with your appID and devID
   STAStartAppSDK* sdk = [STAStartAppSDK sharedInstance];
   sdk.appID = @"your app Id";
   sdk.devID = @"your developer id";
   
   [sdk disableReturnAd];  // disable return ads

   return YES;
}

Back to top

For a full integration guide, please refer to the "Using Native Ads" section under the "Advanced Usage" page.

Back to top

1 In the header file of your view controller, import STABannerView.h and STABannerSize.h and declare an STABannerView instance variable

// YourViewController.h

#import <UIKit/UIKit.h>
#import <StartApp/StartApp.h>

@interface YourViewController : UIViewController 
{
    STABannerView* bannerView;
}

2 Create and initialize the STABannerView and add it as a subView to the view where you want it to be displayed. Remember to release the bannerView object in your dealloc() function in case you're not using ARC in your project

// YourViewController.m

- (void) viewDidAppear:(BOOL)animated {
    [super viewDidAppear:animated];
     if (bannerView == nil) {
        bannerView = [[STABannerView alloc] initWithSize:STA_AutoAdSize autoOrigin:STAAdOrigin_Top     
                                            withView:self.view withDelegate:nil];
        [self.view addSubview:bannerView];
    }
}

- (void) dealloc
{
    // Don't release bannerView if you are using ARC in your project
    [bannerView release];  // Add this line
    [super dealloc];
}

The STA_AutoAdSize detects the width of the device's screen in its current orientation, and provides the optimal banner for this size.

NOTE:

• You can find your "developerId" and "appId" the same way as in step 3 above
• This example shows the banner at the top of the root view controller (self.view), but you can pass any other view where you want to show the banner

3 Implement didRotateFromInterfaceOrientation in your view controller

// YourViewController.m

- (void) didRotateFromInterfaceOrientation:(UIInterfaceOrientation)fromInterfaceOrientation {
    [bannerView didRotateFromInterfaceOrientation:fromInterfaceOrientation];
    [super didRotateFromInterfaceOrientation:fromInterfaceOrientation];    
}

4 If your app supports iOS 8, implement viewWillTransitionToSize in your view controller

// YourViewController.m

- (void)viewWillTransitionToSize:(CGSize)size withTransitionCoordinator:(id<UIViewControllerTransitionCoordinator>)coordinator {
    [bannerView viewWillTransitionToSize:size withTransitionCoordinator:coordinator];
	[super viewWillTransitionToSize:size withTransitionCoordinator:coordinator];
}  

NOTE
If you wish to use a fixed origin for the banner, please refer to the "Advanced Manual"

Back to top

####Set Age and Gender Upon initialization, after providing your DevId and AppId, use the following line:

sdk.preferences = [STASDKPreferences prefrencesWithAge:<USER_AGE> andGender:<USER_GENDER>];

• Replace <USER_AGE> with the user's real age
• Replace <USER_GENDER> with the user's real gender, using STAGender_Male or STAGender_Female.

Example

// AppDelegate.m

#import <StartApp/StartApp.h>

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions
{
    // initialize the SDK with your appID and devID
    STAStartAppSDK* sdk = [STAStartAppSDK sharedInstance];
    sdk.appID = @"your app Id";
    sdk.devID = @"your developer id";

    sdk.preferences = [STASDKPreferences prefrencesWithAge:22 andGender:STAGender_Male];

    return YES;
}

####Set Location The location of the user is a dynamic property which is changed constantly. Hence, you should provide it every time you load a new Ad:

[startAppAd loadAdWithAdPreferences:[STAAdPreferences prefrencesWithLatitude:<Real_Longitude> andLongitude:<Real_Latitude>]];

Example

- (void) viewDidAppear:(BOOL)animated {
    [super viewDidAppear:animated];

        [startAppAd loadAdWithAdPreferences:[STAAdPreferences prefrencesWithLatitude:37.3190383911 andLongitude:-121.96269989]];
}

Back to top

On the "Advertising Identifier" section:
1 Choose "Yes" on the right pane
2 Opt-in the "Serve advertisements within the app" checkbox
3 Opt-in the confirmation checkbox under "Limit Ad tracking setting in iOS"

Back to top

Back to top

Back to top