Banner
Banner types
The Yandex Mobile Ads SDK supports three banner types:
|
Banner |
Description |
When to use |
|
Sticky banner |
A banner that is pinned to the screen edge and displayed on top of other elements. Banners of this type are unaffected by scrolling. |
When you want a banner to “stick”, which means to remain in its place and be shown on top of content even if a user scrolls the screen. |
|
Inline banner |
A banner that is embedded in your app (for example, in content or a list) as if it's a UI element. |
When the banner should be part of the page content, appearing in a news feed, between posts, or as a list item. |
|
Fixed banner |
A banner that is fixed in a certain place or used for spaces with fixed height. |
When you need to place a banner in a static location, for example, under a toolbar or at the bottom of the screen. |
Banners of all types automatically refresh creatives every 60 seconds.
Code-wise, these banners only differ in how you set their sizes. Examples:
BannerAdSize.stickySize(context: Context, widthDp: Int)
BannerAdSize.inlineSize(widthDp: Int, heightDp: Int)
BannerAdSize.fixedSize(widthDp: Int)
Note
Examples showing how all the format types work are available in the demo project.
Entity descriptions:
|
Entity |
Description |
|
|
The banner height:
All banner sizes must be specified in dp. |
|
|
Use:
|
Implementation
Key steps to integrate an adaptive inline banner:
- Create and configure a view for displaying banner ads.
- Register a callback listener.
- Load the ad.
- Pass additional settings if you're using Adfox.
Specifics of adaptive inline banner integration
-
All calls to Yandex Mobile Ads SDK methods must be made from the main thread.
-
In order for video ads to show successfully on your app screen, hardware acceleration must be enabled. Hardware acceleration is enabled by default, but some apps may choose to disable it. If this applies to your app, we recommend enabling hardware acceleration for Activity classes that use ads.
-
If the
onAdFailedToLoad()callback returns an error, don't try to load a new ad again. If there's no other option, limit the number of ad load retries. This will help avoid constant unsuccessful requests and connection issues if there are limitations. -
For adaptive inline banners to work properly, make your app layouts adaptive. Otherwise, your ads might render incorrectly.
-
Adaptive inline banners work best when utilizing the full available width. In most cases, this will be the full width of the device screen. Be sure to consider the padding parameters set in your app and the display's safe area.
-
Adaptive inline banners are designed to be placed in scrollable content. Their height can be the same as the device screen or limited by the maximum height, depending on the API.
-
To get the size of the ad, use the method
BannerAdSize.inline(context, adWidth, maxAdHeight), which accepts the context, the available width of the ad container, and the maximum acceptable ad height as arguments. -
The
BannerAdSizeobject calculated using theBannerAdSize.inline(context, adWidth, maxAdHeight)method contains technical data for choosing the most optimal ad sizes on the backend. The height of an ad may change each time it is loaded. You can get the actual width and height of the ad after receiving a message confirming that the ad has been loaded successfully.
Adding an ad view to the app layout
To display banner ads, add BannerAdView to your app layout. You can do that programmatically or by using an XML file.
Example of adding BannerAdView to an app screen layout:
# activity.xml
...
<com.yandex.mobile.ads.banner.BannerAdView
android:id="@+id/ad_container_view"
android:layout_width="match_parent"
android:layout_height="wrap_content" />
...
You can also create a BannerAdView instance programmatically:
val bannerAd = BannerAdView(this)
final BannerAdView bannerAd = new BannerAdView(this);
Loading and rendering ads
Once you created and added BannerAdView to the app screen, you need to load the ads. Before loading an adaptive inline banner, calculate the ad size for each device.
This is done automatically via the SDK API method: BannerAdSize.inline(context, adWidth, maxAdHeight). Pass the context, the available width of the ad container, and the maximum acceptable ad height as arguments. Adaptive inline banners work best when utilizing the full available screen width. In most cases, this will be the full width of the device screen. Be sure to consider the padding parameters set in your app and the display's safe area:
private val adSize: BannerAdSize
get() {
val screenHeight = resources.displayMetrics.run { heightPixels / density }.roundToInt()
// Calculate the width of the ad, taking into account the padding in the ad container.
var adWidthPixels = binding.adContainerView.width
if (adWidthPixels == 0) {
// If the ad hasn't been laid out, default to the full screen width
adWidthPixels = resources.displayMetrics.widthPixels
}
val adWidth = (adWidthPixels / resources.displayMetrics.density).roundToInt()
val maxAdHeight = screenHeight / 2
return BannerAdSize.inline(context, adWidth, maxAdHeight)
}
@NonNull
private BannerAdSize getAdSize() {
final DisplayMetrics displayMetrics = getResources().getDisplayMetrics();
final int screenHeight = Math.round(displayMetrics.heightPixels / displayMetrics.density);
// Calculate the width of the ad, taking into account the padding in the ad container.
int adWidthPixels = mBinding.adContainerView.getWidth();
if (adWidthPixels == 0) {
// If the ad hasn't been laid out, default to the full screen width
adWidthPixels = displayMetrics.widthPixels;
}
final int adWidth = Math.round(adWidthPixels / displayMetrics.density);
// Determine the maximum allowable ad height. The current value is given as an example.
final int maxAdHeight = screenHeight / 2;
return BannerAdSize.inline(this, adWidth, maxAdHeight);
}
To load ads, you also need the Activity Context and the ad unit ID (adUnitId) you obtained in the interface Yandex Advertising Network.
To enable notifications when ads load of fail to load and track an adaptive inline banner's lifecycle events, set the BannerAdEventListener callback listener for the BannerAdView class instance.
You can extend ad request parameters with the AdRequest.Builder() class to include information about the user's interests, page context, location, and other additional data in the ad request. Adding extra context to ad requests can greatly improve ad relevance.
The example below shows how to load an adaptive inline banner. Once loaded, the banner is displayed automatically:
class AdaptiveInlineBannerAdActivity : AppCompatActivity(R.layout.activity_inline_banner_ad) {
private var bannerAd: BannerAdView? = null
private lateinit var binding: ActivityInlineBannerAdBinding
private val adSize: BannerAdSize
get() {
val screenHeight = resources.displayMetrics.run { heightPixels / density }.roundToInt()
// Calculate the width of the ad, taking into account the padding in the ad container.
var adWidthPixels = binding.adContainerView.width
if (adWidthPixels == 0) {
// If the ad hasn't been laid out, default to the full screen width
adWidthPixels = resources.displayMetrics.widthPixels
}
val adWidth = (adWidthPixels / resources.displayMetrics.density).roundToInt()
// Determine the maximum allowable ad height. The current value is given as an example.
val maxAdHeight = screenHeight / 2
return BannerAdSize.inline(context, adWidth, maxAdHeight)
}
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
binding = ActivityInlineBannerAdBinding.inflate(layoutInflater)
setContentView(binding.root)
// Since we're loading the banner based on the adContainerView size,
// we need to wait until this view is laid out before we can get the width
binding.adContainerView.viewTreeObserver.addOnGlobalLayoutListener(object :
ViewTreeObserver.OnGlobalLayoutListener {
override fun onGlobalLayout() {
binding.adContainerView.viewTreeObserver.removeOnGlobalLayoutListener(this);
bannerAd = loadBannerAd(adSize)
}
})
}
private fun loadBannerAd(adSize: BannerAdSize): BannerAdView {
return binding.banner.apply {
setAdSize(adSize)
setBannerAdEventListener(object : BannerAdEventListener {
override fun onAdLoaded() {
// If this callback occurs after the activity is destroyed, you
// must call destroy and return or you may get a memory leak.
// Note `isDestroyed` is a method on Activity.
if (isDestroyed) {
bannerAd?.destroy()
return
}
}
override fun onAdFailedToLoad(adRequestError: AdRequestError) {
// Ad failed to load with AdRequestError.
// Attempting to load a new ad from the onAdFailedToLoad() method is strongly discouraged.
}
override fun onAdClicked() {
// Called when a click is recorded for an ad.
}
override fun onImpression(impressionData: ImpressionData?) {
// Called when an impression is recorded for an ad.
}
})
loadAd(
AdRequest.Builder("your-ad-unit-id")
// Methods in the AdRequest.Builder class can be used here to specify individual options settings.
.build()
)
}
}
}
public class AdaptiveInlineBannerAdActivity extends AppCompatActivity {
@Nullable
private BannerAdView mBannerAd = null;
private ActivityInlineBannerAdBinding mBinding;
public AdaptiveInlineBannerAdActivity() {
super(R.layout.activity_inline_banner_ad);
}
@Override
protected void onCreate(@Nullable Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
mBinding = ActivityInlineBannerAdBinding.inflate(getLayoutInflater());
setContentView(mBinding.getRoot());
// Since we're loading the banner based on the adContainerView size,
// we need to wait until this view is laid out before we can get the width
mBinding.adContainerView.getViewTreeObserver().addOnGlobalLayoutListener(
new ViewTreeObserver.OnGlobalLayoutListener() {
@Override
public void onGlobalLayout() {
mBinding.adContainerView.getViewTreeObserver().removeOnGlobalLayoutListener(this);
mBannerAd = loadBannerAd(getAdSize());
}
}
);
}
@NonNull
private BannerAdSize getAdSize() {
final DisplayMetrics displayMetrics = getResources().getDisplayMetrics();
final int screenHeight = Math.round(displayMetrics.heightPixels / displayMetrics.density);
// Calculate the width of the ad, taking into account the padding in the ad container.
int adWidthPixels = mBinding.adContainerView.getWidth();
if (adWidthPixels == 0) {
// If the ad hasn't been laid out, default to the full screen width
adWidthPixels = displayMetrics.widthPixels;
}
final int adWidth = Math.round(adWidthPixels / displayMetrics.density);
// Determine the maximum allowable ad height. The current value is given as an example.
final int maxAdHeight = screenHeight / 2;
return BannerAdSize.inline(this, adWidth, maxAdHeight);
}
@NonNull
private BannerAdView loadBannerAd(@NonNull final BannerAdSize adSize) {
final BannerAdView bannerAd = mBinding.banner;
bannerAd.setAdSize(adSize);
bannerAd.setBannerAdEventListener(new BannerAdEventListener() {
@Override
public void onAdLoaded() {
// If this callback occurs after the activity is destroyed, you
// must call destroy and return or you may get a memory leak.
// Note `isDestroyed` is a method on Activity.
if (isDestroyed() && mBannerAd != null) {
mBannerAd.destroy();
}
}
@Override
public void onAdFailedToLoad(@NonNull final AdRequestError adRequestError) {
// Ad failed to load with AdRequestError.
// Attempting to load a new ad from the onAdFailedToLoad() method is strongly discouraged.
}
@Override
public void onAdClicked() {
// Called when a click is recorded for an ad.
}
@Override
public void onImpression(@Nullable ImpressionData impressionData) {
// Called when an impression is recorded for an ad.
}
});
final AdRequest adRequest = new AdRequest.Builder("your-ad-unit-id")
// Methods in the AdRequest.Builder class can be used here to specify individual options settings.
.build();
bannerAd.loadAd(adRequest);
return bannerAd;
}
}
Releasing resources
If a callback occurs after the Activity is destroyed, call the destroy() function for the used ad object to release resources:
private fun loadBannerAd(adSize: BannerAdSize): BannerAdView {
return binding.banner.apply {
setBannerAdEventListener(object : BannerAdEventListener {
override fun onAdLoaded() {
// If this callback occurs after the activity is destroyed, you
// must call destroy and return or you may get a memory leak.
// Note `isDestroyed` is a method on Activity.
if (isDestroyed) {
bannerAd?.destroy()
return
}
}
...
})
...
}
}
@NonNull
private BannerAdView loadBannerAd(@NonNull final BannerAdSize adSize) {
final BannerAdView bannerAd = mBinding.banner;
bannerAd.setBannerAdEventListener(new BannerAdEventListener() {
@Override
public void onAdLoaded() {
// If this callback occurs after the activity is destroyed, you
// must call destroy and return or you may get a memory leak.
// Note `isDestroyed` is a method on Activity.
if (isDestroyed() && mBannerAd != null) {
mBannerAd.destroy();
}
}
...
});
...
return bannerAd;
}
Checking integration
Build and run your project. You can check if the SDK integration is successful by searching the YandexAds keyword in Logcat:
[Integration] Ad type banner was integrated successfully