Skip to main content

Standard Prebid Integration - TeadsPBMPluginRenderer

warning

Important: Experimental API

This article shows you how to deliver Teads ads on your application using the Prebid Mobile SDK. This integration uses the official Prebid Mobile SDK. Teads provides a Plugin Renderer that handles ad display for Teads demand while other demand partners continue working normally.

Sample Teads App on GitHub Teads inApp SDK iOS sample App

Sample Prebid App on GitHub Prebid Internal Test App

Prerequisites​

Installation​

Before installing the Teads Prebid plugin, you will need to integrate PrebidMobile SDK into your application.

Installing the Teads Prebid plugin will automatically import the Teads inApp SDK framework.

CocoaPods​

If your project is managing dependencies through CocoaPods, you just need to add this pod in your Podfile.

It will install the Teads adapter along with the Teads inApp SDK.

  1. Add Pod named TeadsPBMPluginRenderer in your Podfile:
pod 'TeadsPBMPluginRenderer', '~> 6.0'
  1. Run the following to install the adapter in your project.
$ pod install --repo-update

Swift Package Manager​

SPM is a tool for managing the distribution of Swift code. It's integrated with the Swift build system to automate the process of downloading, compiling, and linking dependencies.

Installing from Xcode​

  1. Add a package by selecting File → Add Packages… in Xcode's menu bar.
  2. Search for the Teads iOS SDK using the repo's URL:
https://github.com/teads/TeadsSDK-iOS
  1. Next, set the Dependency Rule to be Up to Next Major Version and keep 6.0.0 < 7.0.0.
  2. Choose the Teads product that you want to be installed in your app: TeadsPBMPluginRenderer

Alternatively, add Teads to your Package.swift manifest​

  1. Add it to the dependencies of your Package.swift:
dependencies: [
    .package(url: "https://github.com/teads/TeadsSDK-iOS", .upToNextMajor(from: "6.0.0"))
]
  1. in any target that depends on a Teads product, add it to the dependencies array of that target:
.target(
  name: "MyTargetName",
  dependencies: [
    .product(name: "TeadsPBMPluginRenderer", package: "Teads"),
  ]
),

Register the Teads plugin renderer​

You need to register the Teads plugin renderer. Such registration can be done just once during the initialization of your app in AppDelegate or in UIViewController.

import TeadsPBMPluginRenderer
import PrebidMobile

Prebid.registerPluginRenderer(TeadsPBMPluginRenderer())

You can also pass in the plugin renderer constructor a TeadsAdapterSettings class.

import TeadsPBMPluginRenderer
import PrebidMobile

let teadsSettings = TeadsAdapterSettings { (settings) in
    settings.enableDebug()
}


Prebid.registerPluginRenderer(TeadsPBMPluginRenderer(settings: teadsSettings))

Specify contextUrl targeting​

Set the publisher's http page URL that matches the content where Teads Ad will be loaded. This value helps to target the context and also guarantees brand safety to our advertisers.

Targeting.shared.addAppExtData(key: "contextUrl", value: "https://example.com/my_article_1")

Settings​

Find the full settings list here

Ad Formats​

Currently, the Teads plugin renderer supports Banner only.

ℹ️ Notice that banners could serve image and video as well according to your banner ad unit setup.

If you make use of other ad formats in your Prebid SDK implementation, other demand partners will continue to be able to serve your bid requests normally.

Ad Request​

No additional step should be made on your app implementation in order to request ads, just integrate your Prebid BannerView normally according to the Prebid SDK docs.

Ad Listener​

To be fully aware of the Teads ad lifecycle, subscribe on your Prebid BannerView to the TeadsPBMEventDelegate protocol.

import PrebidMobile
import TeadsPBMPluginRenderer

bannerView?.setPluginEventDelegate(self)
// TeadsPBMEventDelegate conformance
extension MyViewController: TeadsPBMEventDelegate {
    func didUpdateRatio(adRatio: TeadsAdRatio) { }
    func onAdExpandedToFullScreen() { }
    func onAdCollapsedFromFullScreen() { }
    func onFailedToLoadAd(reason: String) { }
}

Other ad events such as onAdClicked, onAdDisplayed, and so on can be listened by implementing Prebid BannerViewDelegate protocol directly. Please check all events on the Prebid SDK docs.

Ad Resizing​

This part is a must and not implementing it will drastically affect the fill rate from Teads demand.

Teads ads can adopt flexible dimensions. Your app must dynamically resize the ad container when the creative requests a new ratio. TeadsAdRatio.calculateHeight(for:) computes the correct height.

It is mandatory to programmatically adapt the size of the ad container via the ratio update delegate method.

import TeadsPBMPluginRenderer
import PrebidMobile

class MyViewController : UIViewController, TeadsPBMEventDelegate {

    @IBOutlet weak var slotHeightConstraint: NSLayoutConstraint! // set to 0 in InterfaceBuilder
    var bannerView: BannerView?

    override func viewDidLoad() {
        super.viewDidLoad()
        bannerView = BannerView(configID: prebidConfigId, eventHandler: adEventHandler)
        bannerView?.setPluginEventDelegate(self)
    }

    func didUpdateRatio(adRatio: TeadsAdRatio) {
        guard let bannerView else {
            return
        }
        slotHeightConstraint.constant = adRatio.calculateHeight(for: bannerView.frame.width)
    }
}

PluginRenderer under the hood​

If you look for more understanding regarding how a plugin renderer works over the Prebid Mobile SDK, please find more here.

Prebid Server setup​

Notice that in order to turn your Teads plugin renderer fully functional and leverage from Teads demand you need to wire the Teads Adapter to your Prebid Server, please find more here.

The following configuration for each of your ad slots name is required:

{
  "name": "imp-300x250-banner"
}

A placement id provided by your publisher manager is required as the sample below:

{
  "ext": {
    "teads": {
      "placementId": 204344
    }
  }
}

Checklist​

  • ✅ Register the Teads plugin renderer
  • ✅ Subscribe to the event listeners
  • ✅ Implement ad view resizing
  • ✅ Setup your Prebid Server with the Teads Adapter
  • ✅ Ensure Brand Safety is enabled
  • ✅ Ensure you comply with privacy legal requirements (GDPR/CCPA/GPP)
  • ✅ Comply with app-ads.txt