Implement a custom mediation adapter on iOS
This page is focused on how to create a custom mediation adapter on your own. For more general information about the mediation and the alreadymediation adapters provided out of the box, please check the Supported Ad Networks article.
Table of contents
- Overview
- Mediation adapter protocols
- Mediation adapter delegate protocols
- Set up your insertion on Equativ Management Platform (EMP)
- Implementation samples
Overview
The Equativ Display SDK can not use a third-party SDK directly.
It must instead rely 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 delegate.
Mediation adapter protocols
Creating a custom adapter is done by implementing an protocol depending on the type of ad you want to deliver:
-
SASMediationBannerAdapter
for banner ad format, -
SASMediationInterstitialAdapter
for interstitial ad format.
Please follow the API documentation to know which APIs must be implemented for each mediation adapter protocol.
Mediation adapter delegate protocols
When implementing an mediation adapter, you will receive an instance of a specific mediation adapter delegate protocol through the loading API of your mediation adapter.
This delegate object acts as a callback that will notify the Equativ Display SDK of the third-party SDK lifecycle events.
You must call these methods depending on the event occuring on the third-party SDK side. Failing to do so, therefore failing to notify , might break either the mediation waterfall, the impression counting or any other kind of tracking.
Please check the API documentation to have more information about when to call these mediation adapter protocol methods, depending on the ad format of your mediation adapter:
-
SASMediationBannerAdapterDelegate
is the delegate to notify when implementing theSASMediationBannerAdapter
protocol. -
SASMediationInterstitialAdapterDelegate
is the delegate to notify when implementing theSASMediationInterstitialAdapter
protocol.
Set up your insertion on Equativ Management Platform (EMP)
Please check the “Integrate new ad network” article to learn more about this part.
Implementation samples
Equativ provides open source adapters for some common third-party SDKs. You can use them as implementation samples for your own custom adapter.