Adaptive inline banner

An adaptive inline banner is a flexible banner ad format that ensures maximum efficiency by optimizing ad size for each device.

With this ad type, developers can set the maximum allowable ad width and height, and the system determines the optimal ad size automatically. To choose the best ad size, adaptive inline banners use a maximum height instead of a fixed one. This helps improve performance.

Typically, this format is used in feed-based apps or contexts where it's acceptable to primarily focus user attention on ads.

Appearance

This guide covers the process of integrating adaptive inline banners into React Native apps. Besides code samples and instructions, it also contains format-specific recommendations and links to additional resources.

Prerequisite

  1. Follow the Yandex Mobile Ads React Native plugin integration steps described under Quick start.
  2. Make sure that you have the latest version of the Yandex Mobile Ads React Native plugin. If you're using mediation, update to the most recent single build version.

Implementation

Key steps for integrating adaptive inline banners:

  • Get the banner size.
  • Set up the parameters for loading ads using an AdRequestParams object.
  • Display the ad by setting the required properties and callback functions to handle events within the ad lifecycle.

Specifics of adaptive inline banner integration

  1. We strongly discourage attempting to load a new ad when receiving an error in the onAdFailedToLoad callback. If you need to load an ad from onAdFailedToLoad, limit retry attempts to avoid recurring failed ad requests in case of network connection constraints.

  2. For adaptive inline banners to work properly, make your app layouts adaptive. Otherwise, your ads might render incorrectly.

  3. 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.

  4. 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.

  5. To get the size of the ad, use the method BannerAdSize.inlineSize(width, maxHeight) which accepts the available width of the ad container and the maximum acceptable ad height as arguments.

  6. The ad width and height values contained within a BannerAdSize object that was calculated using the BannerAdSize.inlineSize(width, maxHeight) method are consistent across the same device. When testing your app's layout on a specific device, you can be sure that the ad size for that device will remain the same.

Getting the banner size

To get the size of the ad, use the method BannerAdSize.inlineSize(width, maxHeight) which accepts the available width of the ad container and the maximum acceptable ad height as arguments. Be sure to consider the padding parameters set in your app and the display's safe area:

let adSize = await BannerAdSize.inlineSize(Dimensions.get('window').width, bannerMaxHeight);

Ad display

To load an ad, you need the size calculated using the BannerAdSize.inlineSize(width, maxHeight) method as well as the placement ID that you obtained in the Boost interface (adUnitId).

To enable notifications when ads load or fail to load and track an adaptive inline banner's lifecycle events, set callback functions for the BannerView component.

You can also expand the request parameters by passing an AdRequestParams object to the adRequest property of the BannerView component.

The example below shows how to set the adaptive inline banner properties and the callback functions for handling its lifecycle events. Once loaded, the banner is displayed automatically:

const createBanner = async () => {
    let adSize = await BannerAdSize.inlineSize(Dimensions.get('window').width, bannerMaxHeight);

    return (
        <BannerView
            size={adSize}
            adRequest={{
                adUnitId: 'R-M-XXXXXX-Y', // for debug you can use 'demo-banner-yandex'
                targeting: {
                    age: '20',
                    contextQuery: 'context-query',
                    contextTags: ['context-tag'],
                    gender: Gender.Male,
                    location: new Location(55.734202, 37.588063),
                },
            }}
            onAdLoaded={(event) => console.log(`Did load, adInfo: ${JSON.stringify(event.nativeEvent.adInfo)}`)}
            onAdFailedToLoad={(event: any) => console.log(`Did fail to load with error: ${JSON.stringify(event.nativeEvent)}`)}
            onAdClicked={() => console.log('Did click')}
            onAdImpression={(event: any) => console.log(`Did track impression: ${JSON.stringify(event.nativeEvent.impressionData)}`)}
        />
    );
}

Testing adaptive inline banner integration

Using demo ad units for ad testing

Use test ads to check your adaptive inline banner integration and the app itself. To make sure that test ads are returned for each ad request, you can use a special demo ad placement ID.

Demo adUnitId: demo-banner-yandex.

Warning

Before publishing your app in the store, make sure to replace the demo placement ID with the real ID you obtained in the Boost interface.

For the list of all available demo ad placement IDs, see Demo ad units for testing.

Testing ad integration

You can check if your adaptive inline banners are integrated correctly using the SDK's built-in analyzer. A detailed report with the test results will appear in the log.

To view the report, search for the keyword “YandexAds” in Logcat, a tool for debugging Android apps.

adb logcat -v brief '*:S YandexAds'

If the integration is successful, the following message is returned:

adb logcat -v brief '*:S YandexAds'
mobileads$ adb logcat -v brief '*:S YandexAds'
I/YandexAds(13719): [Integration] Ad type banner was integrated successfully

If there are any banner integration issues, you'll get a detailed issue report and troubleshooting recommendations.

Using demo ad units for ad testing

We recommend using test ads to test your ad integration and your app itself.

To guarantee that test ads are returned for every ad request, we created a special demo ad placement ID. Use it to check your ad integration.

Demo adUnitId: demo-banner-yandex.

Warning

Before publishing your app to the store, make sure you replace the demo ad unit ID with a real one obtained from the Boost interface.

You can find the list of available demo ad placement IDs in the Demo ad units for testing section.

Testing ad integration

You can test your ad integration using the native Console tool.

To view detailed logs, call the YandexAds class's enableLogging method.

YandexAds.enableLogging()

To view SDK logs, go to the Console tool and set Subsystem = com.mobile.ads.ads.sdk. You can also filter logs by category and error level.

If you're having problems integrating ads, you'll get a detailed report on the issues and recommendations for how to fix them.

Additional resources

Previous
Ad formats
Next
Adaptive sticky banner