Integration of a new third-party ad network

This page is focused on how the Equativ Display SDK is actually handling mediation and mostly how to create a custom mediation adapter on your own. For more general information about the mediation and the mediation adapters provided out of the box, please check the Supported Ad Networks article.

Table of contents

  1. Implement a custom mediation adapter
    1. Overview
    2. Implementation
  2. Set up your insertion on Equativ Management Platform (EMP)

Implement a custom mediation adapter

Overview

The Equativ Display SDK cannot use a third-party SDK directly.

It must instead rely on an intermediate component called an mediation adapter that will be responsible of retrieving an ad from the third-party SDK. This adapter will then forward the ad to the Equativ Display SDK via its mediation adapter listener/delegate.

Implementation

Creating a custom adapter is done by implementing an interface/protocol depending on the type of ad you want to deliver:

  • SASMediationBannerAdapter for banner ad format,
  • SASMediationInterstitialAdapter for interstitial ad format.

For more information about how to implement these interfaces/protocols, please refer to each platform dedicated articles:

Custom adapters on Android Custom adapters on iOS

Set up your insertion on Equativ Management Platform (EMP)

Alongside creating your custom mediation adapter, you have to set up a dedicated ad insertion for your mediation adapter.

To do so, create an insertion as you usually do, and make sure to choose one of the templates named In-App Mediation Custom Adapter, compatible with the App environment.

Using this template, you will have to fill out 4 mandatory fields:

  • SDK Name: The name of the third-party SDK wrapped by your custom mediation adapter.

  • Format Type: The ad format type that will be delivered by this insertion. This will ensure the compatibility between this format type and the format type expected by the SDK. Only two possiblities: banner or interstitial.

    This In-App Mediation customer Adapter template is compatible with both Equativ Display SDK v8.2+ and Smart Display SDK v7.x, therefore there is more format types listed in the template than format type compatible with the Equativ Display SDK. Be sure to only select banner or interstitial if you are setting up an insertion for the Equativ Display SDK.

  • Adapter class: The name of the adapter class. The Equativ Display SDK will use that class name to dynamically instantiate the mediation adapter, so be careful to avoid any spelling mistake. Please note that on Android the full name of a class includes the package name.

  • Placement info: A string containing the parameters needed by the third-party SDK to make the ad call. Usually placement ID, application ID or similar. This string will be passed as is to the mediation adapter instance (of class specified above). Therefore, it is up to the publisher to decide of a String representation for those parameters (comma separated, slash separated or even a JSON string) and implement the mediation adapter accordingly to properly extract them.

You will find more general information about the insertion management in EMP here.


Back to top

Copyright Equativ © 2024. All right reserved.

Page last modified: Dec 2 2024.