Thumbnail Ad

This article will go through all the steps required to display a Thumbnail Ad in your application.

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.
​Create a Thumbnail Ad ad unit.
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.
Integrate the Thumbnail Ad 
Step 1: Instantiate a Thumbnail Ad
You need to change the code to instantiate the banner ad from adMob as following:
Swift
Objective-C
let thumbnailAd = OguryThumbnailAdForGoogleMobileAds(adUnitId: "YOUR_ADMOB_AD_UNIT_ID")
OguryThumbnailAdForGoogleMobileAds *thumbnailAd = [[OguryThumbnailAdForGoogleMobileAds alloc] initWithAdUnitId:@"YOUR_ADMOB_AD_UNIT_ID"];
Step 2: Load a Thumbnail Ad
To start loading an ad, call the load method:
Swift
Objective-C
self.thumbnailAd.load()
[self.thumbnailAd load];
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.
Since it may take a few seconds to fetch the ad resources (video, image, ...) from the network, you should call the load method as soon as possible after getting the user's consent. 
Ideally, you should implement one of the two following examples depending on your use case:
Call the load method right after the setupWithAssetKey method in the ViewController:
Swift
Objective-C
import UIKit
import OgurySdk
​
class ViewController: UIViewController {
​
    var thumbnailAd: OguryThumbnailAdForGoogleMobileAds?
    
    override func viewDidLoad() {
        super.viewDidLoad()
    
        self.thumbnailAd = OguryThumbnailAdForGoogleMobileAds(adUnitId: "YOUR_ADMOB_AD_UNIT_ID")
​
        OguryAds.shared()?.setup(withAssetKey: "OGY-XXXXXXXXXXXX") { error in
            self.thumbnailAd.load()
        }
    }   
}
#import <UIKit/UIKit.h>
#import <OgurySdk/OgurySdk.h>
#import "OguryThumbnailAdForGoogleMobileAds.h"
​
@interface ViewController : UIViewController
​
@property (nonatomic, strong) OguryThumbnailAdForGoogleMobileAds *thumbnailAd;
​
@end
​
@implementation ViewController
​
- (void)viewDidLoad {
    [super viewDidLoad];
    
    self.thumbnailAd = [[OguryThumbnailAdForGoogleMobileAds alloc] initWithAdUnitId:@"YOUR_ADMOB_AD_UNIT_ID"];   
    
    [[OguryAds shared] setupWithAssetKey:@"OGY-XXXXXXXXXXXX" andCompletionHandler:^(NSError *error) {
        [self.thumbnailAd load];   
     }];
}
​
@end
Call the load method in the viewDidLoad of your other ViewController
Swift
Objective-C
override func viewDidLoad() {
    super.viewDidLoad()
    
    self.thumbnailAd = OguryThumbnailAdForGoogleMobileAds(adUnitId: "YOUR_ADMOB_AD_UNIT_ID")
    self.thumbnailAd.load()
}
- (void)viewDidLoad {
    [super viewDidLoad];
​
    self.thumbnailAd = [[OguryThumbnailAdForGoogleMobileAds alloc] initWithAdUnitId:@"YOUR_ADMOB_AD_UNIT_ID"];
    [self.thumbnailAd load];
.}
Additionally, if you want to follow the lifecycle of the Thumbnail Ad, you can attach a delegate.
Step 3: Show a Thumbnail Ad
To display the ad call the show function:
Swift
Objective-C
self.thumbnailAd.show(in: self)
[self.thumbnailAd showInViewController:self];
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. 
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 4: 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, call load method with maxWidth and maxHeight parameters:
Swift
Objective-C
self.thumbnailAd.load(with: CGSize(width: maxWidth, height: maxHeight))
[self.lf.thumbnailAd loadWithSize: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.
maxWidth and maxHeight 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
To set the Thumbnail Ad position, call the show method with OguryRectCorner and OguryOffset  parameters:
Swift
Objective-C
self.thumbnailAd.setOguryRectCorner(rectCorner, offset: OguryOffset(x: xMargin, y: yMargin))
[self.thumbnailAd setOguryRectCorner:rectCorner offset:OguryOffsetMake(xMargin, yMargin)];
The show method takes the following parameter:
rectCorner: the corner based on which the Thumbnail Ad will be positioned. The OguryRectCorner enum has the following values:
OguryTopRight 
OguryTopLeft 
OguryBottomLeft 
OguryBottomRight 
anOguryOffset: the distance from the corner to the Thumbnail Ad
xMargin: distance  from the x axis to the Thumbnail Ad. Value must be in points.
yMargin: distance from the  y axis to the Thumbnail Ad. Value must be in points.
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.
Call the setWhitelistBundleIdentifiers method to whitelist bundles:
Swift
Objective-C
self.thumbnailAd.setWhitelistBundleIdentifiers(["com.example.bundle", "com.example.bundle2"])
[self.thumbnailAd setWhitelistBundleIdentifiers:@[@"com.example.bundle", @"com.example.bundle2"]];
Blacklist View Controllers
You can prevent Thumbnail Ads from being displayed on a given ViewController by using the setBlacklistViewControllers method:
Swift
Objective-C
self.thumbnailAd.setBlacklistViewControllers([NSStringFromClass(TermsAndConditionsViewController.classForCoder()), NSStringFromClass(SettingsViewController.classForCoder())])
[self.thumbnailAd setBlacklistViewControllers:@[NSStringFromClass([TermsAndConditionsViewController class]), NSStringFromClass([SettingsViewController class])]];
When the user navigates to a 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.
Delegate
The Ogury SDK provides OguryThumbnailAdDelegate to listen to the lifecycle of a Thumbnail Ad instance. 
To register a OguryThumbnailAdDelegate, add the following code just after instantiating the OguryThumbnailAdForGoogleMobileAds:
Swift
Objective-C
self.thumbnailAd.delegate = self
self.thumbnailAd.delegate = self;
The OguryThumbnailAdDelegate exposes the following methods:
Methods
Definition
didLoadOguryThumbnailAd
The SDK is ready to display the ad provided by the ad server.
didDisplayOguryThumbnailAd
The ad has been displayed on the screen.
didClickOguryThumbnailAd
The as has been clicked by the user.
didCloseOguryThumbnailAd
The ad has been closed by the user.
didFailOguryThumbnailAdWithError
The ad failed to load or display. The error parameter contains the reason of the failure. All error codes are detailed in the section below.
Error codes
When an ad fails to load or to be displayed, the SDK will call the didFailOguryTAdWithError callback with one of error code defined in OguryAdsError:
Name
Value
Definition
OguryCoreErrorTypeNoInternetConnection
0
No Internet connection
The device has no Internet connection. Try again once the device is connected to the Internet.
OguryAdsAdDisabledError
2001
Ad disabled
Ad serving has been disabled for this placement/application.
OguryAdsProfigNotSyncedError
2002
Profig not synchronized
An internal SDK error has occurred.
OguryAdsAdExpiredError
2003
Ad expired
The loaded ad is expired. You must call the show method within 4 hours after the load.
OguryAdsSdkInitNotCalledError
2004
SDK init not called
The Ogury.start() method has not been called before a call to the load or show methods.
OguryAdsAnotherAdAlreadyDisplayedError
2005
Another ad already displayed
Another ad is already displayed on the screen.
OguryAdsAssetKeyNotValidError
2006
SDK init failed
An error occurred during the initialization  of the SDK.
OguryAdsNotAvailableError
2008
Ad not available
The server returns no ads.
OguryAdsCantShowAdsInPresentingViewControllerError
2010
A view controller is already being presented
Only one view controller may be presented at a time.
OguryAdsUnknownError
2011
Unknown error
An unknown error occurred.

Methods	Definition
`didLoadOguryThumbnailAd`	The SDK is ready to display the ad provided by the ad server.
`didDisplayOguryThumbnailAd`	The ad has been displayed on the screen.
`didClickOguryThumbnailAd`	The as has been clicked by the user.
`didCloseOguryThumbnailAd`	The ad has been closed by the user.
`didFailOguryThumbnailAdWithError`	The ad failed to load or display. The error parameter contains the reason of the failure. All error codes are detailed in the section below.

Name	Value	Definition
`OguryCoreErrorTypeNoInternetConnection`	`0`	No Internet connection The device has no Internet connection. Try again once the device is connected to the Internet.
`OguryAdsAdDisabledError`	`2001`	Ad disabled Ad serving has been disabled for this placement/application.
`OguryAdsProfigNotSyncedError`	`2002`	Profig not synchronized An internal SDK error has occurred.
`OguryAdsAdExpiredError`	`2003`	Ad expired The loaded ad is expired. You must call the `show` method within 4 hours after the `load`.
`OguryAdsSdkInitNotCalledError`	`2004`	SDK init not called The `Ogury.start()` method has not been called before a call to the `load` or `show` methods.
`OguryAdsAnotherAdAlreadyDisplayedError`	`2005`	Another ad already displayed Another ad is already displayed on the screen.
`OguryAdsAssetKeyNotValidError`	`2006`	SDK init failed An error occurred during the initialization of the SDK.
`OguryAdsNotAvailableError`	`2008`	Ad not available The server returns no ads.
`OguryAdsCantShowAdsInPresentingViewControllerError`	`2010`	A view controller is already being presented Only one view controller may be presented at a time.
`OguryAdsUnknownError`	`2011`	Unknown error An unknown error occurred.

AD FORMATS - Previous

Banner Ad

Next - Legacy

Thumbnail Ad (legacy)

Last modified 10mo ago