Ad feed

Ad feeds are units that consist of a sequence of ads. Feeds can be added to your app as its main content, or they may come after the existing content. Feeds may contain dozens of ads, which are loaded sequentially (several ads are loaded at once).

This guide covers the process of integrating ad feeds into Android apps. Besides code samples and instructions, it contains format-specific recommendations and links to additional resources.

Appearance

Prerequisite

  1. Follow the SDK integration steps described under Quick start.
  2. First, you need to initialize the advertising SDK.
  3. Make sure you're using the latest version of the Yandex Mobile Ads SDK.

Implementation

Key steps for integrating ad feeds:

  • Configure your ad feed's appearance using the FeedAdAppearance object.
  • Create and set up a request configuration using the FeedAdRequestConfiguration object.
  • Create an ad feed object named FeedAd and register a FeedAdLoadListener for ad load callback methods.
  • Preload your ads as soon as possible by calling feedAd.preloadAd().
  • Create an adapter named FeedAdAdapter and register a FeedAdEventListener for event callback methods.
  • Set the FeedAdAdapter in the RecyclerView.adapter.

Key steps

  1. Create an ad feed's appearance configuration object named FeedAdAppearance.

    The following parameters are available:

    • cardWidth(required): Sets the width of a served ad in dp (density-independent pixels). Calculate the parameter value based on the screen width minus the required side padding.
    • cardCornerRadius: Sets the radius of rounded corners for a served ad in dp (density-independent pixels).
    val feedMarginDp = 24
val screenWidthDp = (screenWidth / resources.displayMetrics.density).roundToInt()
val cardWidthDp = screenWidthDp - 2 * feedMarginDp
val cardCornerRadiusDp = 16.0

val feedAdAppearance = FeedAdAppearance.Builder(cardWidthDp)
          .setCardCornerRadius(cardCornerRadiusDp)
          .build()

    DisplayMetrics displayMetrics = getResources().getDisplayMetrics();

int feedMarginDp = 24;
int screenWidthDp = Math.round(displayMetrics.widthPixels / displayMetrics.density);
val cardWidthDp = screenWidthDp - 2 * feedMarginDp;
double cardCornerRadius = 16.0;

FeedAdAppearance feedAdAppearance = new FeedAdAppearance.Builder(cardWidth)
    .setCardCornerRadius(cardCornerRadius)
    .build();

  2. Create and configure a FeedAdRequestConfiguration object.

    You'll need the placement ID that you obtained in the Partner Interface (AD_UNIT_ID).

    You can expand ad request parameters by providing information about the user's interests, page context, location, and other additional data in the ad request's Builder methods. Extra context added to ad requests can greatly improve the ad quality. Read more in the Ad Targeting section.

    val AD_UNIT_ID = "R-M-XXXXXX-Y" // For debugging reasons you can use "demo-feed-yandex"
val feedAdRequestConfiguration = FeedAdRequestConfiguration.Builder(AD_UNIT_ID).build()

    String AD_UNIT_ID = "R-M-XXXXXX-Y"; // For debugging reasons you can use "demo-feed-yandex"
FeedAdRequestConfiguration feedAdRequestConfiguration = new FeedAdRequestConfiguration.Builder(AD_UNIT_ID).build();

  3. Create an ad feed object named FeedAd and register a FeedAdLoadListener for ad load callback methods.

    val feedAdLoadListener = object : FeedAdLoadListener {

    override fun onAdLoaded() {
	       // Called when additional ads are received for display
    }

    override fun onAdFailedToLoad(error: AdRequestError) {
	       // Called when an additional ad request fails
    }
}

val feedAd = FeedAd.Builder(context, feedAdRequestConfiguration, feedAdAppearance).build()
feedAd.loadListener = feedAdLoadListener

    FeedAdLoadListener feedAdLoadListener = new FeedAdLoadListener() {
    @Override
    public void onAdLoaded() {
        // Called when additional ads are received for display
    }

    @Override
    public void onAdFailedToLoad(AdRequestError error) {
        // Called when an additional ad request fails
    }
};

FeedAd feedAd = new FeedAd.Builder(context, feedAdRequestConfiguration, feedAdAppearance).build();
feedAd.setLoadListener(feedAdLoadListener);

  4. Preload your ad as soon as possible using the preloadAd() method for the FeedAd object. Once the ad feed is preloaded, one of the FeedAdLoadListener methods is called.

    feedAd.preloadAd()

    feedAd.preloadAd();

  5. Create an adapter named FeedAdAdapter and register a FeedAdEventListener for event callback methods.

    val feedAdEventListener = object : FeedAdEventListener {

    override fun onAdClicked() {
	       //  Called when the user clicks on the ad
    }

    override fun onAdImpression(impressionData: ImpressionData?) {
	       // Called when an impression is counted
    }
}

val feedAdAdapter = FeedAdAdapter(feedAd)
feedAdAdapter.eventListener = feedAdEventListener

    FeedAdEventListener feedAdEventListener = new FeedAdEventListener() {
    @Override
    public void onAdClicked() {
        // Called when the user clicks on the ad
    }

    @Override
    public void onAdImpression(ImpressionData impressionData) {
        // Called when an impression is counted
    }
};

FeedAdAdapter feedAdAdapter = new FeedAdAdapter(feedAd);
feedAdAdapter.setEventListener(feedAdEventListener);

  6. Display the ad feed.

    Set the created FeedAdAdapter in the RecyclerView.adapter.

    • Kotlin

      binding.feedRecyclerView.layoutManager = LinearLayoutManager(context)
binding.feedRecyclerView.adapter = feedAdAdapter

    • Java

      binding.feedRecyclerView.setLayoutManager(new LinearLayoutManager(context));
binding.feedRecyclerView.setAdapter(feedAdAdapter);

    To add your ad feed to an existing RecyclerView list, use the ConcatAdapter.

    The ConcatAdapter allows you to combine the RecyclerView adapter of the existing list and the ad feed adapter. The order of passing arguments to the ConcatAdapter builder sets the order of displaying the lists of respective adapters.

    • Kotlin

      val screenContentDataAdapter = ScreenContentDataAdapter() // Your own implementation of RecyclerView.Adapter
val concatAdapter = ConcatAdapter(listOf(screenContentDataAdapter, feedAdAdapter))

binding.feedRecyclerView.layoutManager = LinearLayoutManager(context)
binding.feedRecyclerView.adapter = concatAdapter

    • Java

      ScreenContentDataAdapter screenContentDataAdapter = new ScreenContentDataAdapter(); // Your own implementation of RecyclerView.Adapter
ConcatAdapter concatAdapter = new ConcatAdapter(Arrays.asList(screenContentDataAdapter, feedAdAdapter));

binding.feedRecyclerView.setLayoutManager(new LinearLayoutManager(context));
binding.feedRecyclerView.setAdapter(concatAdapter);

Specifics of ad feed integration

  1. All calls to Yandex Mobile Ads SDK methods must be made from the main thread.

Testing ad feed integration

Using demo ad units for ad testing

Use test ads to check your ad feed integration and the app itself.

To make sure that test ads are returned for each ad request, we created a special demo ad placement ID designed to help you test your ad integration.

Demo adUnitId: demo-feed-yandex.

Warning

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

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

Testing ad integration

You can check if your ad feed is integrated correctly using the SDK's built-in analyzer.

This tool checks whether ads are enabled properly and outputs a detailed report to a log. To view the report, run a search by the "YandexAds" keyword 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 feed was integrated successfully

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

Previous
App open ads
Next
Ad targeting