Links

Thumbnail Ad (legacy)

This article will go through all the steps required to display a Thumbnail Ad in your application.
Use the recommended API for the Thumbnail Ad format.
Thumbnail Ads are small rectangle ads that are displayed as overlays to your application content. They are closable and draggable by the user, and can be used to (i) monetize your application through new incremental inventories and (ii) push cross-promotion campaigns.
Unlike our other ad formats, there is no equivalent ad format in AdMob mediation. To integrate Thumbnail Ads, the Ogury SDK uses Google Mobile Ads SDK custom events to present them as banner to the mediation.
You must create a dedicated AdMob banner ad unit and mediation group for the Thumbnail Ad in order to prevent undesired side-effect (blank banner, etc.).

Requirements

You have registered an application on your Ogury Dashboard. If not, please refer to the Getting Started section before the next steps.

Step 1: Create an Ogury Thumbnail Ad ad unit

  • Go to your Asset list in the Ogury Dashboard and select your Asset.
  • Click on the Monetization settings in the left-menu.
  • Copy the Ad unit id as you will need this information later to finish the integration.
In all the following code samples, we will refer to this Ad unit id by using the string AD_UNIT_ID.

Step 2: Create a dedicated AdMob Banner ad unit

  • Go to your AdMob dashboard.
  • Go to the list of ad units and click on the Add ad unit button.
  • Click on Banner.
  • Configure the banner ad unit as following:
    • Set the ad unit name: Thumbnail Ad.
    • Click on Advanced settings link to unfold them.
    • In Automatic refresh setting, select Disabled.
    • In eCPM floor, set the global eCPM floor to $1000.
The eCPM floor must be set to prevent AdMob to serve an ad on this dedicated ad unit.
We recommend to disable auto-refresh to avoid having Thumbnail Ads popping in front of the user every X seconds.

Step 3: Create a dedicated Mediation Group

In order to display Ogury Thumbnail Ad through AdMob mediation, you need to configure a Custom Event for Ogury in a dedicated mediation group.
  • Go on the Mediation Group page.
  • Click on CREATE MEDIATION GROUP.
  • Select Banner as ad format.
  • Set a Name for the mediation group.
  • In Ad units section, click on ADD AD UNITS.
  • Select the dedicated ad unit you created above.
  • Click on ADD CUSTOM EVENT, in the Waterfall section
  • Enter Ogury as Label, set an eCPM and click on CONTINUE.
For eCPM, you need to set the value that you agreed with your Ogury Account Manager.
  • Next to the name of your Thumbnail ad ad unit, enter the following configuration and click on DONE:
Class Name:
OguryThumbnailCustomEvents
Parameter:
{"assetKey":"ASSET_KEY","adUnitId":"AD_UNIT_ID"}
  • Click on SAVE.

Step 4: Integrate the Thumbnail Ad as a AdMob banner

Compared to a standard integration of a banner ad from AdMob, you must adapt your integration in order to take care of the particularities of the Thumbnail Ad ad format.

Instantiate a Thumbnail Ad

You need to change the code to instantiate the banner ad from AdMob to pass the maximum size of the Thumbnail Ad.
Swift
Objective-C
let adSize = GADAdSizeFromCGSize(CGSize(width: maxWidth, height: maxHeight)
let adView = GADBannerView(adSize: adSize))
adView.adUnitID = "ADMOB_AD_UNIT_ID"
GADBannerView* adView = [[GADBannerView alloc] initWithAdSize:kGADAdSizeFluid];
adView.adUnitID = @"ADMOB_AD_UNIT_ID";
The ad is loaded with a default max size of 180x180 points. The max size can be changed by following the instructions in this section.

Show a Thumbnail Ad

The Thumbnail Ad will display either:
  • Once attached to your ViewController if it is loaded.
  • Once loaded if it already attached to your ViewController layout.
Thumbnail Ads are displayed bottom-right aligned, with a margin of 20 points on the right and 70 points on the bottom. More details on how to set the thumbnail position can be found in this section.
The Thumbnail Ad displays outside of the GADBannerView and will leave the GADBannerView empty. To solve this issue you can set the frame of the view to be 0x0.
By default the Thumbnail Ad remains on screen while the user is navigating between View Controllers of your application. A Thumbnail Ad is displayed in a ViewController if bundle identifier of the ViewController corresponds to the main bundle of application.
You can customize where Thumbnail Ads are displayed in this section.

Step 5: Test your integration

As our algorithm works with personified targeting, you may not receive any ad while testing your application.
You can test your integration by adding the suffix _test to your interstitial ad unit id, for more details go to Test your implementation page.
Note that if you have just registered your application in the Ogury Dashboard, it will take around 15 minutes until you can successfully load an ad.

Advanced Topics

Customize a Thumbnail Ad size

In order to control the thumbnail size, instantiate your GADBannerView with maxWidth and maxHeight parameters:
Swift
Objective-C
let adSize = GADAdSizeFromCGSize(CGSize(width: maxWidth, height: maxHeight)
let adView = GADBannerView(adSize: adSize))
GADBannerView* adView = [[GADBannerView alloc] initWithAdSize:
GADAdSizeFromCGSize(CGSizeMake(maxWidth, maxHeight))
];
maxWidth and maxHeight parameters define the maximum size that the Thumbnail Ad will take on the screen. Both values are in points.
We recommend to use maxWidth = 180 and maxHeight = 180 to improve the readability of the content of the Thumbnail Ad.
Example: when given maxWidth= 180 and maxHeight= 180, the Ogury SDK may decide to display a 16:9 video ad inside. In this case the Thumbnail Ad size will be 180x101 points to match the ratio of the 16:9 video.
The following constraints apply on the values you can pass to these parameters:
  • maxWidth and maxHeight must not be greater than the size of the screen.
  • maxWidthandmaxHeight must be greater than or equal to 101 points.
  • longest side, either maxWidth or maxHeight, must be greater than or equal to
    180 points.

Customize Thumbnail Ad position

You can set the position where the Thumbnail Ad will be displayed in the GADAdRequest. The position is passed using custom event extras:
  • "rect_corner" : the corner based on which the thumbnail will be positioned, it can have the following values:
    • "top_left"
    • "top_right"
    • "bottom_left"
    • "bottom_right"
  • "x_margin": distance on the x axis from the gravity corner to thumbnail. Value must be in points.
  • "y_margin": distance on the y axis from the gravity corner to thumbnail. Value must be in points.
Swift
Objective-C
let extras = GADCustomEventExtras()
extras.setExtras([
"rect_corner": "bottom_right",
"left_margin": xMargin,
"top_margin": yMargin
], forLabel:"Ogury")
let request = GADRequest()
request.register(extras)
adView.load(request)
GADCustomEventExtras* extras = [GADCustomEventExtras new];
[extras setExtras:@{
@"rect_corner": @"bottom_right",
@"left_margin": xMargin,
@"top_margin": yMargin,
} forLabel:@"Ogury"];
GADRequest* request = [GADRequest new];
[request registerAdNetworkExtras:extras];
[adView loadRequest:request];

Customize where the Thumbnail Ad is displayed

Thumbnail Ad remains on screen while the user is navigating between ViewController of your application.
By default, a Thumbnail Ad is displayed in an ViewController only if this bundle identifier are the main bundle of application.
You can override these default settings using whitelists and blacklists.

Whitelist bundles

You can increase the number of whitelisted bundles where Thumbnail Ads are displayed and stay on screen. This can be useful if you have ViewController provided by a library like a game engine, in this case you need to whitelist the bundle associated to this library.
You can set the whitelisted packages by setting the "whitelist" attribute in the extras:
Swift
Objective-C
let extras = GADCustomEventExtras()
extras.setExtras([
"left_margin": leftMargin,
"top_margin": topMargin
// Set whitelisted packages.
"whitelist": ["com.example.bundle", "com.example.bundle2"]
], forLabel:"Ogury")
let request = GADRequest()
request.register(extras)
adView.load(request)
GADCustomEventExtras* extras = [GADCustomEventExtras new];
[extras setExtras:@{
@"left_margin": @120,
@"top_margin": @120,
// Set whitelisted packages.
@"whitelist": @[@"com.example.bundle", @"com.example.bundle2"]
} forLabel:@"Ogury"];
GADRequest* request = [GADRequest new];
[request registerAdNetworkExtras:extras];
[adView loadRequest:request];

Blacklist View Controllers

You can prevent Thumbnail Ads from being displayed on given ViewController by setting the "blacklist" attribute in the extras:
Swift
Objective-C
let extras = GADCustomEventExtras()
extras.setExtras([
"left_margin": leftMargin,
"top_margin": topMargin
// Set blacklisted view controllers.
"blacklist": [
NSStringFromClass(TermsAndConditionsViewController.classForCoder()),
NSStringFromClass(SettingsViewController.classForCoder())
]
], forLabel:"Ogury")
let request = GADRequest()
request.register(extras)
adView.load(request)
GADCustomEventExtras* extras = [GADCustomEventExtras new];
[extras setExtras:@{
@"left_margin": @120,
@"top_margin": @120,
// Set blacklisted view controllers.
@"blacklist": @[
NSStringFromClass([TermsAndConditionsViewController class]),
NSStringFromClass([SettingsViewController class])
]
} forLabel:@"Ogury"];
GADRequest* request = [GADRequest new];
[request registerAdNetworkExtras:extras];
[adView loadRequest:request];
When the user navigates to an ViewController that is not in a whitelisted bundle or that is explicitly blacklisted, the Thumbnail Ad is hidden and paused. It comes back on the screen when the user navigates back to a ViewController that is allowed.

Integration Sample

Checkout our sample applications in our GitHub repository :