Android Advanced Usage NH - yanivav/Documentation GitHub Wiki

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 the automatic banner, please refer to Step 4, Showing Banners. If you do not wish to add the Automatic Banner, use one of the following options:

####Loading a Standard Banner Add the following View inside your Activity layout .XML:

<com.startapp.android.publish.banner.bannerstandard.BannerStandard
    	android:id="@+id/startAppStandardBanner"
    	android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:layout_centerHorizontal="true"/>

####Loading a 3D Banner Add the following View inside your Activity layout .XML:

<com.startapp.android.publish.banner.banner3d.Banner3D 
    	android:id="@+id/startApp3DBanner"
    	android:layout_width="wrap_content"
        android:layout_height="wrap_content" 
        android:layout_centerHorizontal="true"/>

NOTE: This code replaces a View inside your Activity. You also have the option to add additional attributes for placing it in the desired location in your Activity.

Back to top

When using this mode, the following additional methods must be implemented in the Activity’s lifecycle:

1 Override the onSaveInstanceState(Bundle outState) method and add a call to startAppAd.onSaveInstanceState(outstate).

NOTE: Add this method immediately after the super.onSaveInstanceState(outState) method.

Example

@Override
protected void onSaveInstanceState (Bundle outState){
   super.onSaveInstanceState(outState);
   startAppAd.onSaveInstanceState(outState);
}

2 Override the onRestoreInstanceState(Bundle savedInstanceState) method and add a call to startAppAd.onRestoreInstanceState(savedInstanceState).

NOTE: Add this method immediately before the method super.onRestoreInstanceState(savedInstanceState).

Example

@Override
protected void onRestoreInstanceState (Bundle savedInstanceState){
   startAppAd.onRestoreInstanceState(savedInstanceState);
   super.onRestoreInstanceState(savedInstanceState);
}

Back to top

NOTE: Keep in mind that the user can close the Ad before timeout expires

Back to top

Example

startAppAd.loadAd (new AdEventListener() {
    @Override
    public void onReceiveAd(Ad ad) {
    }
    @Override
    public void onFailedToReceiveAd(Ad ad) {
    }
});

####Adding a Callback when an Interstitial Ad is shown startAppAd.showAd() can get a parameter implementation of AdDisplayListener. To get a callback when an Ad is shown, pass the object that implements AdDisplayListener (this may be your Activity) as a parameter of the method. This object must implement the following methods:

@Override
public void adHidden(Ad ad) {
}

@Override
public void adDisplayed(Ad ad) {
}

Example

startAppAd.showAd(new AdDisplayListener() {
    @Override
    public void adHidden(Ad ad) {
    }
    @Override
    public void adDisplayed(Ad ad) {
    }
});

Back to top

####Customizing the Template Splash Screen In the OnCreate method of your Activity, after calling StartAppAd.init and before setContentView, call the following static function:

StartAppAd.showSplash(this, savedInstanceState, splashConfig);

Apply the following parameters:

• this: The context (Activity)
• savedInstanceState: The Bundle parameter passed to your onCreate(Bundle savedInstanceState) method.
• 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:

StartAppAd.showSplash(this, savedInstanceState, 
          new SplashConfig()
                 .setTheme(SplashConfig.Theme.OCEAN)
                 .setAppName("Yout Application Name")  
                 .setLogo(R.drawable.your_360x360_logo)   // resource ID
                 .setOrientation(SplashConfig.Orientation.LANDSCAPE)
);

NOTE: for optimal appearance of your Splash screen on all device densities, provide a logo of 360x360px and place it in the drawable folder of your project. If this folder does not exist, then create it.

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.

####Adding a User-Defined Splash Screen Use the following option if you already have a Splash screen for your application or if you want to design your own custom layout for your Splash screen.

1 Set a SplashConfig object with a specific layout resource ID.

2 Pass on the SplashConfig object to the showSplash static function.

For a full description of the SplashConfig API, please refer to SplashConfig API.

Example

StartAppAd.showSplash(this, savedInstanceState, 
     new SplashConfig()
            .setTheme(SplashConfig.Theme.USER_DEFINED)
            .setCustomScreen(R.layout.your_splash_screen_layout_id)
);

Back to top

##SplashConfig API The following describes the methods that you can use for customizing the Splash screen displayed in a StartApp In-App Splash screen Ad.

####► Set the Splash screen mode

public SplashConfig setTheme(SplashConfig.Theme theme)

Sets the Splash theme to Template mode or User-defined mode. Use one of the first five options below to specify a design theme for the Template mode. The last option sets the mode to User-Defined. You may refer to Customizing the Splash Screen for more information about Splash screen modes.

Parameters
SplashConfig.Theme.DEEP_BLUE (default)
SplashConfig.Theme.SKY
SplashConfig.Theme.ASHEN_SKY
SplashConfig.Theme.BLAZE
SplashConfig.Theme.GLOOMY
SplashConfig.Theme.OCEAN
SplashConfig.Theme.USER_DEFINED – user-defined mode

####► Set a Custom screen

public SplashConfig setCustomScreen(int resource)

Sets the splash layout to Custom mode. This is mandatory if you are using SplashConfig.Theme.USER_DEFINED.

Parameters
Layout Resource ID

####► 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(int resource)

Sets the logo to be displayed in the Template mode.

Parameters
Drawable resource ID (default is the icon resource from the manifest).

####► Set the orientation

public SplashConfig setOrientation(SplashConfig.Orientation orientation)

Sets the orientation to be used in the Template or User-defined mode.

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

Back to top

NativeAdPreferences can be used to customize some of the native ad properties to suit your needs, such as the number of ads to load, the image size of the ad, or whether the image should be pre-cached or not. For a full description of the NativeAdPreferences, please refer to NativeAdPreferences API.

NOTE: By default, StartAppNativeAd retrieves the image URL of the ad. The SDK is also capable of auto-loading the image as a BITMAP object. This feature is turned off by default. For enabling it, set autoBitmapDownload in NativeAdPreferences to true (please refer to Ad's image configuration).

You can register your startAppNativeAd object for callbacks by passing an AdEventListener object to the loadAd() method:

startAppNativeAd.loadAd(new NativeAdPreferences(), new AdEventListener() {
	  @Override
	  public void onReceiveAd(Ad arg0) {
			// Native Ad Received
	  }
	  
	  @Override
	  public void onFailedToReceiveAd(Ad arg0) {
			// Native Ad failed to receive
	  }
});

####Using the Native Ad Object After initializing and loading your startAppNativeAd object, use the getNativeAds() method to obtain an array of NativeAdDetails objects for all returning ads. The NativeAdDetails object provides access to each ad's details, such as the ad's title, description, image, etc. This object also provides methods for firing an impression once the ad is displayed, and for executing the user's click on the ad. For a full description of the NativeAdDetails object, please refer to NativeAdDetails API.

Example: the following is an example of how to load 3 native ads with a pre-cached images of 150x150 pixels size, and logging their details once ready (using callbacks)

// Declare Native Ad Preferences
NativeAdPreferences nativePrefs = new NativeAdPreferences()
										  .setAdsNumber(3)                // Load 3 Native Ads
										  .setAutoBitmapDownload(true)    // Retrieve Images object
										  .setImageSize(NativeAdBitmapSize.SIZE150X150);

// Declare Ad Callbacks Listener
AdEventListener adListener = new AdEventListener() {     // Callback Listener
	  @Override
	  public void onReceiveAd(Ad arg0) {              
			// Native Ad received
			ArrayList<NativeAdDetails> ads = startAppNativeAd.getNativeAds();    // get NativeAds list
			
			// Print all ads details to log
			Iterator<NativeAdDetails> iterator = ads.iterator();
			while(iterator.hasNext()){
				  Log.d("MyApplication", iterator.next().toString());
			}
	  }
	  
	  @Override
	  public void onFailedToReceiveAd(Ad arg0) {
			// Native Ad failed to receive
			Log.e("MyApplication", "Error while loading Ad");
	  }
};

// Load Native Ads
startAppNativeAd.loadAd(nativePrefs, adListener);

Note: It is possible to get less ads than you requested. It is also possible that no ad will be returned. In this case you will receive an empty array.

####Showing and Clicking a Native Ad

• Once you decide to actually show a native ad, you must call the NativeAdDetails.sendImpression() method.
• Once the user clicks on the ad, you must call NativeAdDetails.sendClick() method.

#####► Set the number of Native ads to retrieve

public NativeAdPreferences setAdsNumber(int adsNumber)

set number of native ads to be received from the server.

######Parameters
adsNumber - integer of the ads number

######Return Value
NatvieAdPreferences – current object

You can choose between two options to obtain the ad's image:

1. get the image pre-cached as a BITMAP.
   
2. get the image URL only.
   

######Parameters
autoBitmapDownload - Boolean:

• true – native ad object will be loaded automatically with bitmap object
• false – native ad wont load the image automatically

######Return Value
NatvieAdPreferences – current object

#####► Set Ad's image size

public NativeAdPreferences setImageSize(NativeAdBitmapSize bitmapSize)

Set the image size of the ad to be retrieved.

######Parameters
bitmapSize - NativeAdBitmapSize for selecting image size. The NativeAdBitmapSize can get the following values:

• SIZE72X72 – for image size 72px X 72px
  
• SIZE100X100 – for image size 100px X 100px
  
• SIZE150X150 – for image size 150px X 150px
  
• SIZE340X340 – for image size 340px X 340px
  

######Return Value
NatvieAdPreferences – current object

######Return Value: String

#####► Get the Ad's description

public String getDescription()

######Return Value: String

#####► Get the Ad's rating

public String getRating()

Get the rating of the ad in the Google Play store. The rating range is 1-5.

######Return Value: Float

#####► Get the Ad's image URL

public String getImageUrl()

Get the image URL of the ad, according to the selected size.

######Return Value: String

#####► Get the Ad's image URL

public Bitmap getImageBitmap()

Get the image of the ad as a pre-cached bitmap, if requested using the NativeAdPreferences.setAutoBitmapDownload() method.

######Return Value: Bitmap

#####► Get the Ad's installs numbers

public String getInstalls()

Get the amount of installs in Google Play store.

######Return Value: String

#####► Get the Ad's category

public String getCategory()

Get the category of the ad in the Google Play store.

######Return Value: String

#####► Get the Ad's package name

public String getPackacgeName()

Get the ad's package name in the Google Play store (for example, "com.startapp.quicksearchbox").

######Return Value: String

#####► To be called when you actually show the ad

public void sendImpression(Context context)

Call this method when you show the ad in your application.

######Parameters
this - the context of the host app

#####► To be called when the user clicks on the ad

public void sendClick(Context context)

Call this method when the user clicks on the ad.

######Parameters
this - the context of the host app

Back to top