iOS InApp cocos2dx Documentation - yanivav/Documentation GitHub Wiki

Last SDK Version: 2.4.0

This document describes the basic procedure for integrating StartApp In-App Ads into your Cocos2d-x applications for iOS.
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/pasted into your source code
• When submitting your application to the App Store,do not forget to update your "IDFA Settings"
• If you have any questions, contact us via [email protected]

##Step 1, Adding the StartApp SDK and StartApp Cocos2d-x plugin to your project In order to add StartApp SDK to your application please follow the following steps:

1. Unzip the SDK files to a temporary folder
2. Drag and drop StartApp framework, StartApp bundle, StartApp_Cocos2DX_x_x_x.a and StartAppPlugin.h to your project

Back to top

Back to top

// AppDelegate.cpp

#include "StartAppPlugin.h"
bool AppDelegate::applicationDidFinishLaunching() 
{
    startappiOS* startAppBridge = startappiOS().sharedInstance();
    startAppBridge->STAInit("your app Id", "your developer id");
    return true;
}

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 SDK provides two modes for displaying Splash screens:

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

// AppDelegate.cpp

#include "StartAppPlugin.h"

bool AppDelegate::applicationDidFinishLaunching() 
{
    startappiOS* startAppBridge = startappiOS().sharedInstance();
    startAppBridge->showSplashAd();
    return true;
}

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

Back to top

First, import the StartApp SDK in your view controller and add the following lines to the cpp file for each view in which you would like to show an ad

// HelloWorldScene.cpp

#include "StartAppPlugin.h"

bool HelloWorld::init()
{
    startappiOS* startAppBridge =  startappiOS().sharedInstance();
    startAppBridge->loadAd();    
    return true;
}

Then, just add the following line where you want to show the ad

startAppBridge->showAd();   

IMPORTANT
Loading an ad might take a few seconds so it's important to show the ad as late as you can. In case you call showAd() while the ad hasn't been successfully loaded yet, nothing will be displayed. For example, if you'd like to show an ad after completing a game's level, the best practice would be to show the ad upon completing the level (for example in your viewDidDisappear() function). On the other hand, loading and showing the ad together at the beginning of the next level might result with a failure – as the ad might not have enough time to load.

Back to top

Return ads are enabled and activated by default. If you want to disable this feature, simply call startAppBridge->disableReturnAd() as part of the initialization process, in your AppDelegate.cpp file:

// AppDelegate.cpp

#include "StartAppPlugin.h"

bool AppDelegate::applicationDidFinishLaunching()
{
   startAppBridge->disableReturnAd(); 
   return true;
}

Back to top

Then, call loadBanner in the view controller where you want the banner to be displayed.

startAppBridge->loadBanner(startappiOS::STAAdOrigin_Bottom, 
						   startappiOS::STA_AutoAdSize);

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, add the age and gender:

startAppBridge->STAInit("your app Id", "your developer id", "user age", "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 - for a 22 years male use:

// AppDelegate.cpp

#include "StartAppPlugin.h"
bool AppDelegate::applicationDidFinishLaunching() 
{
    startappiOS* startAppBridge = startappiOS().sharedInstance();
    startAppBridge->STAInit("1234", "5678", 22, startappiOS::STAGender_Male);
    return true;
}

(replace "1234" and "5678" with your REAL developer Id and App Id)

####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, uasing the STAAdPreferences object:

startappiOS::STAAdPreferences *pref = new startappiOS::STAAdPreferences();
pref->userLocation.longitude = 32.44444;
pref->userLocation.latitude = 30.2222;

startAppBridge->loadAd(pref, STACallbacks);

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