unity android advanced usage - yanivav/Documentation GitHub Wiki

######This section describes advanced usage and personal customization options and is not mandatory for the integration.

###Selecting Banner Type There are 3 different types of banners:

We highly recommend adding an Automatic banner, which automatically selects whether to display a standard banner or a 3D banner. The banner remains displayed throughout the entire activity life-cycle.

To add a banner to your application add the following code in the appropriate place:

1. Import the SDK namespace

using StartApp;

2. Display the banner

void Start () {
     #if UNITY_ANDROID
     StartAppWrapper.addBanner( 
           StartAppWrapper.BannerType.AUTOMATIC,
	       StartAppWrapper.BannerPosition.BOTTOM);
     #endif
}

Parameters

BannerType - type of banner. Can receive one of the following:
StartAppWrapper.BannerType.AUTOMATIC
StartAppWrapper.BannerType.STANDARD
StartAppWrapper.BannerType.THREED

BannerPosition - position of the banner. Can receive one of the following:
StartAppWrapper.BannerPosition.BOTTOM
StartAppWrapper.BannerPosition.TOP

###Hiding the Banner In order to hide an already displayed banner, use the removeBanner() method. Simply pass the position of the banner you want to hide.

For example:

#if UNITY_ANDROID
StartAppWrapper.removeBanner(StartAppWrapper.BannerPosition.BOTTOM);
#endif

In order to show the banner again, simply use the addBanner() method as described in "Showing Banners".

Back to top

StartAppWrapper.loadAd() can get an implementation of AdEventListener as a parameter. In case you want to get a callback for the ad load, pass the object which implements StartAppWrapper.AdEventListener as a parameter to the method. This object should implement the following methods:

public void onReceiveAd(){
}
public void onFailedToReceiveAd(){
}

StartAppWrapper.showAd() can get an implementation of AdDisplayListener as a parameter. In case you want to get a callback for the ad show, pass the object which implements StartAppWrapper.AdDisplayListener as a parameter of the method. This object should implement the following methods:

public void adHidden(){
}
public void adDisplayed(){
}
public void adClicked(){
}

Back to top

####Customizing the Splash Screen In the Start() method of your script, call the following static function:

#if UNITY_ANDROID
StartAppWrapper.showSplash(splashConfig);
#endif

Apply the following parameters:

• splashConfig: Optional object that can be used to customize some of your template's properties to suit your needs, such as your application name, logo and theme (see the example below). For a full description of the SplashConfig API, please refer to SplashConfig API.

Example: the following is an example of a custom template with an OCEAN theme, modified application name, logo and landscape orientation:

#if UNITY_ANDROID
StartAppWrapper.showSplash(new StartAppWrapper.SplashConfig()
				.setTheme(StartAppWrapper.SplashConfig.Theme.OCEAN)
				.setAppName("Your Application Name")
				.setLogo("Your logo")
				.setOrientation(StartAppWrapper.SplashConfig.Orientation.LANDSCAPE)				
);
#endif

NOTE: for optimal appearance of your Splash screen on all device densities, provide a logo of 360x360px and place it in the Resources folder of your project. If you do not provide a logo, then StartApp In-App uses the default application icon (as declared in the Manifest) and stretches it to 360x360px.

Back to top

####► Set the Splash screen mode

public SplashConfig setTheme(StartAppWrapper.SplashConfig.Theme theme)

Sets the Splash theme. Use one of the options below to select a design theme for your splash screen.

Parameters
SplashConfig.Theme.DEEP_BLUE (default)
SplashConfig.Theme.SKY
SplashConfig.Theme.ASHEN_SKY
SplashConfig.Theme.BLAZE
SplashConfig.Theme.GLOOMY
SplashConfig.Theme.OCEAN

####► Set the application name

public SplashConfig setAppName(String appName)

Sets the application name to be used in the Template mode.

Parameters
String (default is the application name from the manifest).

####► Set the logo

public SplashConfig setLogo(String logo)

Sets the logo to be displayed in the Template mode.

Parameters
logo the logo resource name under the Resources folder (default is the icon resource from the manifest).

####► Set the orientation

public SplashConfig setOrientation(StartAppWrapper.SplashConfig.Orientation orientation)

Sets the orientation to be used.

Parameters
StartAppWrapper.SplashConfig.Orientation.PORTRAIT (default)
StartAppWrapper.SplashConfig.Orientation.LANDSCAPE
StartAppWrapper.SplashConfig.Orientation.AUTO (use the device's orientation upon entering the application)

Back to top