feat: support ad position in original, rendering and mediation ad units

prebid · Nov 27, 2024 · e855f94 · e855f94
1 parent 1759b68
commit e855f94
Show file tree

Hide file tree

Showing 12 changed files with 123 additions and 8 deletions.
diff --git a/PrebidMobile/AdUnits/AdUnit.swift b/PrebidMobile/AdUnits/AdUnit.swift
@@ -23,6 +23,12 @@ public class AdUnit: NSObject, DispatcherDelegate {
         set { adUnitConfig.setPbAdSlot(newValue) }
     }
 
+    /// The position of the ad on the screen.
+    public var adPosition: AdPosition {
+        get { adUnitConfig.adPosition }
+        set { adUnitConfig.adPosition = newValue }
+    }
+
     var adSizes: [CGSize] {
         get { [adUnitConfig.adSize] + (adUnitConfig.additionalSizes ?? []) }
     }

diff --git a/PrebidMobile/AdUnits/MultiformatAdUnit/PrebidAdUnit.swift b/PrebidMobile/AdUnits/MultiformatAdUnit/PrebidAdUnit.swift
@@ -126,6 +126,7 @@ public class PrebidAdUnit: NSObject {
 
         adUnit.adUnitConfig.adConfiguration.isInterstitialAd = request.isInterstitial
         adUnit.adUnitConfig.adConfiguration.isOptIn = request.isRewarded
+        adUnit.adUnitConfig.adPosition = request.adPosition
 
         if request.isInterstitial || request.isRewarded {
             adUnit.adUnitConfig.adPosition = .fullScreen

diff --git a/PrebidMobile/AdUnits/MultiformatAdUnit/PrebidRequest.swift b/PrebidMobile/AdUnits/MultiformatAdUnit/PrebidRequest.swift
@@ -19,6 +19,11 @@ import Foundation
 @objcMembers
 public class PrebidRequest: NSObject {
 
+    // MARK: - Public properties
+
+    /// The position of the ad on the screen.
+    public var adPosition: AdPosition = .undefined
+
     // MARK: - Internal properties
 
     private(set) var bannerParameters: BannerParameters?
@@ -45,8 +50,13 @@ public class PrebidRequest: NSObject {
     ///   - nativeParameters: The native parameters for the ad request.
     ///   - isInterstitial: Indicates if the request is for an interstitial ad.
     ///   - isRewarded: Indicates if the request is for a rewarded ad.
-    public init(bannerParameters: BannerParameters? = nil, videoParameters: VideoParameters? = nil,
-                nativeParameters: NativeParameters? = nil, isInterstitial: Bool = false, isRewarded: Bool = false) {
+    public init(
+        bannerParameters: BannerParameters? = nil,
+        videoParameters: VideoParameters? = nil,
+        nativeParameters: NativeParameters? = nil,
+        isInterstitial: Bool = false,
+        isRewarded: Bool = false
+    ) {
         self.bannerParameters = bannerParameters
         self.videoParameters = videoParameters
         self.nativeParameters = nativeParameters

diff --git a/PrebidMobile/PrebidMobileRendering/AdPosition.swift b/PrebidMobile/PrebidMobileRendering/AdPosition.swift
@@ -33,16 +33,25 @@ import Foundation
 public enum AdPosition: Int {
 
     /// 0 Unknown
-    case undefined  = 0
+    case undefined = 0
+
+    /// 1 Above the Fold
+    case aboveTheFold = 1
+
+    /// 2 Locked (i.e. fixed position)
+    case locked = 2
+
+    /// 3 Below the Fold
+    case belowTheFold = 3
 
     /// 4 Header
-    case header     = 4
+    case header = 4
 
     /// 5 Footer
-    case footer     = 5
+    case footer = 5
 
     /// 6 Sidebar
-    case sidebar    = 6
+    case sidebar = 6
 
     /// 7 Full Screen
     case fullScreen = 7

diff --git a/PrebidMobile/PrebidMobileRendering/Prebid/Integrations/GAM/BaseInterstitialAdUnit.swift b/PrebidMobile/PrebidMobileRendering/Prebid/Integrations/GAM/BaseInterstitialAdUnit.swift
@@ -53,6 +53,12 @@ public class BaseInterstitialAdUnit :
         set { adUnitConfig.adFormats = newValue }
     }
 
+    /// The position of the ad on the screen.
+    public var adPosition: AdPosition {
+        get { adUnitConfig.adPosition }
+        set { adUnitConfig.adPosition = newValue }
+    }
+
     /// The ORTB (OpenRTB) configuration string for the ad unit.
     @objc public var ortbConfig: String? {
         get { adUnitConfig.ortbConfig }

diff --git a/...bidMobileRendering/Prebid/Integrations/MediationAPI/MediationBaseInterstitialAdUnit.swift b/...bidMobileRendering/Prebid/Integrations/MediationAPI/MediationBaseInterstitialAdUnit.swift
@@ -28,6 +28,12 @@ public class MediationBaseInterstitialAdUnit : NSObject {
         get { adUnitConfig.adConfiguration.videoParameters }
     }
 
+    /// The position of the ad on the screen.
+    public var adPosition: AdPosition {
+        get { adUnitConfig.adPosition }
+        set { adUnitConfig.adPosition = newValue }
+    }
+
     /// Indicates whether the video ad is muted.
     public var isMuted: Bool {
         get { adUnitConfig.adConfiguration.videoControlsConfig.isMuted }

diff --git a/PrebidMobileTests/AdUnitTests/AdUnitSuccessorTests.swift b/PrebidMobileTests/AdUnitTests/AdUnitSuccessorTests.swift
@@ -26,7 +26,7 @@ class AdUnitSuccessorTests: XCTestCase {
         Prebid.shared.useExternalClickthroughBrowser = false
     }
 
-    //MARK: - BannerAdUnit
+    // MARK: - BannerAdUnit
 
     func testBannerAdUnitCreation() {
         //when
@@ -51,7 +51,8 @@ class AdUnitSuccessorTests: XCTestCase {
         bannerBasedAdUnits.forEach { checkBannerParametersHelper($0) }
     }
 
-    //MARK: - InterstitialAdUnit
+    // MARK: - InterstitialAdUnit
+
     func testInterstitialAdUnitCreation() {
         //when
         let adUnit = InterstitialAdUnit(configId: Constants.configID1)
@@ -86,6 +87,7 @@ class AdUnitSuccessorTests: XCTestCase {
     }
 
     //MARK: - VideoAdUnit
+
     func testVideoAdUnitCreation() {
         //when
         let adUnit = VideoAdUnit(configId: Constants.configID1, size: CGSize(width: Constants.width1, height: Constants.height1))
@@ -95,6 +97,7 @@ class AdUnitSuccessorTests: XCTestCase {
     }
 
     //MARK: - VideoInterstitialAdUnit
+
     func testVideoInterstitialAdUnitCreation() {
         //when
         let adUnit = VideoInterstitialAdUnit(configId: Constants.configID1)

diff --git a/PrebidMobileTests/AdUnitTests/AdUnitTests.swift b/PrebidMobileTests/AdUnitTests/AdUnitTests.swift
@@ -702,4 +702,24 @@ class AdUnitTests: XCTestCase {
         let objects2 = adUnit.getUserData()!
         XCTAssertEqual(0, objects2.count)
     }
+
+    func testAdUnitSetAdPosition() {
+        let adUnit = AdUnit(
+            configId: "test",
+            size: CGSize(width: 300, height: 250),
+            adFormats: [.banner, .video]
+        )
+
+        let adUnitConfig = adUnit.adUnitConfig
+
+        adUnit.adPosition = .header
+
+        XCTAssertEqual(adUnit.adPosition, adUnitConfig.adPosition)
+        XCTAssertEqual(adUnitConfig.adPosition, .header)
+
+        adUnit.adPosition = .footer
+
+        XCTAssertEqual(adUnit.adPosition, adUnitConfig.adPosition)
+        XCTAssertEqual(adUnitConfig.adPosition, .footer)
+    }
 }
diff --git a/PrebidMobileTests/AdUnitTests/PrebidAdUnitTests.swift b/PrebidMobileTests/AdUnitTests/PrebidAdUnitTests.swift
@@ -402,4 +402,19 @@ class PrebidAdUnitTests: XCTestCase {
 
         waitForExpectations(timeout: 5, handler: nil)
     }
+
+    func testSetAdPosition() {
+        let request = PrebidRequest(bannerParameters: BannerParameters())
+        request.adPosition = .header
+
+        let adUnit = PrebidAdUnit(configId: "test-config-id")
+        adUnit.fetchDemand(request: request, completion: { _ in })
+
+        XCTAssertEqual(adUnit.getConfiguration().adPosition, .header)
+
+        request.adPosition = .footer
+        adUnit.fetchDemand(request: request, completion: { _ in })
+
+        XCTAssertEqual(adUnit.getConfiguration().adPosition, .footer)
+    }
 }
diff --git a/PrebidMobileTests/RenderingTests/Tests/Prebid/BaseInterstitialAdUnitTest.swift b/PrebidMobileTests/RenderingTests/Tests/Prebid/BaseInterstitialAdUnitTest.swift
@@ -40,4 +40,19 @@ class BaseInterstitialAdUnitTest: XCTestCase {
         adUnit.closeButtonPosition = .topLeft
         XCTAssertEqual(adUnit.adUnitConfig.adConfiguration.videoControlsConfig.closeButtonPosition, .topLeft)
     }
+
+    func testSetAdPosition() {
+        let adUnit = BaseInterstitialAdUnit(configID: "test")
+        let adUnitConfig = adUnit.adUnitConfig
+
+        adUnit.adPosition = .header
+
+        XCTAssertEqual(adUnit.adPosition, adUnitConfig.adPosition)
+        XCTAssertEqual(adUnitConfig.adPosition, .header)
+
+        adUnit.adPosition = .footer
+
+        XCTAssertEqual(adUnit.adPosition, adUnitConfig.adPosition)
+        XCTAssertEqual(adUnitConfig.adPosition, .footer)
+    }
 }
diff --git a/...obileTests/RenderingTests/Tests/Prebid/MediationAPI/MediationInterstitialAdUnitTest.swift b/...obileTests/RenderingTests/Tests/Prebid/MediationAPI/MediationInterstitialAdUnitTest.swift
@@ -101,4 +101,22 @@ class MediationInterstitialAdUnitTest: XCTestCase {
         waitForExpectations(timeout: 0.1)
     }
 
+    func testSetAdPosition() {
+        let adUnit = MediationBaseInterstitialAdUnit(
+            configId: "test",
+            mediationDelegate: MockEmptyPrebidMediationDelegate()
+        )
+
+        let adUnitConfig = adUnit.adUnitConfig
+
+        adUnit.adPosition = .header
+
+        XCTAssertEqual(adUnit.adPosition, adUnitConfig.adPosition)
+        XCTAssertEqual(adUnitConfig.adPosition, .header)
+
+        adUnit.adPosition = .footer
+
+        XCTAssertEqual(adUnit.adPosition, adUnitConfig.adPosition)
+        XCTAssertEqual(adUnitConfig.adPosition, .footer)
+    }
 }
diff --git a/PrebidMobileTests/RenderingTests/Tests/Prebid/MediationAPI/MockMediationUtils.swift b/PrebidMobileTests/RenderingTests/Tests/Prebid/MediationAPI/MockMediationUtils.swift
@@ -30,6 +30,12 @@ fileprivate let HBKeywordPrefix                = "hb_"
     @objc var localExtras: [AnyHashable : Any]?
 }
 
+class MockEmptyPrebidMediationDelegate: PrebidMediationDelegate {
+    func setUpAdObject(with values: [String : Any]) -> Bool { true }
+    func cleanUpAdObject() {}
+    func getAdView() -> UIView? { UIView(frame: .zero)}
+}
+
 class MockMediationUtils: PrebidMediationDelegate {
 
     let adObject: MockAdObject