Introduction

Introduction to ad formats and placements

Introduction

This guide contains the implementation of the various advertising formats organized as placements in the app. The app shall create a separate “Placement” through AATKit for every position of an advertisement inside the app that either:

Has a different ad format.
Shall be controlled separately from others.

Concept of Placements

Placements are the entry point for loading and receiving ads. AATKit provides a separate protocol for each ad format. Creating the placement should be done by calling AATKit public APIs. Once you have created the placement, the later communication callbacks like loading and displaying ads will happen via the created placement instance.

Rules for Placement Names

In order to work with the Gravite backend, placement names must be constant at runtime, i.e. they shouldn’t change on each app start. Note that any placement instance is supposed to be reused. Do not create a placement instance for each ad you want to display. Keep the number of placements low.

The placement name cannot start nor end with a space, and can only contain the following characters:

Character

Unicode

Name

In order to keep track of the performance of your placement over time, your placement name should not change as long as you use Gravite with your app unless you plan a substantial rework of your ad integration.

Placement Types

Communication with Placements

All the communication with placements is being done via placement instances. The app will also receive different kinds of callbacks for ad loads, displays and other events via the placement-specific listeners. So, each placement type has its own listener that will notify the publisher about the different events.

All callback methods have Placement as a parameter to let you verify which placement fired a specific callback. This will be needed if you have one class implementing two types of placements listeners (e.g. StickyBannerPlacementListener and FullscreenPlacementListener), in this case, you can check the placement name to verify which placement fired this callback.

// An example of onHaveAd callback that can belong to 
// either StickyBannerPlacementListener or FullscreenPlacementListener
@Override
public void onHaveAd(@NonNull Placement placement) {
    if (placement.getName().equals("fullscreen_placement_name")) {
        // The fullscreen placement has loaded a new ad
    } else if (placement.getName().equals("banner_placement_name")) {
        // The banner placement has loaded a new ad
    }
}

// An example of onHaveAd callback that can belong to 
// either StickyBannerPlacementListener or FullscreenPlacementListener
override fun onHaveAd(placement: Placement) {
    if (placement.name == "fullscreen_placement_name") {
        // The fullscreen placement has loaded a new ad
    } else if (placement.name == "banner_placement_name") {
        // The banner placement has loaded a new ad
    }
}

Last updated 3 months ago

Character

Unicode

Name

Placement Type

Explanation

Placement

Corresponding Listener

// An example of onHaveAd callback that can belong to // either StickyBannerPlacementListener or FullscreenPlacementListener @Override public void onHaveAd(@NonNull Placement placement) { if (placement.getName().equals("fullscreen_placement_name")) { // The fullscreen placement has loaded a new ad } else if (placement.getName().equals("banner_placement_name")) { // The banner placement has loaded a new ad } }

// An example of onHaveAd callback that can belong to // either StickyBannerPlacementListener or FullscreenPlacementListener override fun onHaveAd(placement: Placement) { if (placement.name == "fullscreen_placement_name") { // The fullscreen placement has loaded a new ad } else if (placement.name == "banner_placement_name") { // The banner placement has loaded a new ad } }