MediationBannerAdUnit

@objcMembers
public class MediationBannerAdUnit : NSObject

This class is responsible for making bid request and providing the winning bid and targeting keywords to mediating SDKs. This class is a part of Mediation API.

Computed properties

  • The configuration ID for an ad unit

    Declaration

    Swift

    public var configID: String { get }

  • The ad format for the ad unit.

    Declaration

    Swift

    public var adFormat: AdFormat { get set }

  • The position of the ad on the screen.

    Declaration

    Swift

    public var adPosition: AdPosition { get set }

  • Parameters for configuring banner ads.

    Declaration

    Swift

    public var bannerParameters: BannerParameters { get }

  • Parameters for configuring video ads.

    Declaration

    Swift

    public var videoParameters: VideoParameters { get }

  • The refresh interval for the ad.

    Declaration

    Swift

    public var refreshInterval: TimeInterval { get set }

  • Additional sizes for the ad unit.

    Declaration

    Swift

    public var additionalSizes: [CGSize]? { get set }

  • OpenRTB configuration

    Declaration

    Swift

    public var ortbConfig: String? { get set }

Ext Data (imp[].ext.data)

  • This method obtains the context data keyword & value for adunit context targeting if the key already exists the value will be appended to the list. No duplicates will be added

    Declaration

    Swift

    @available(*, deprecated, message: "This method is deprecated. Please, use addExtData method instead.")
public func addContextData(key: String, value: String)

  • This method obtains the context data keyword & values for adunit context targeting the values if the key already exist will be replaced with the new set of values

    Declaration

    Swift

    @available(*, deprecated, message: "This method is deprecated. Please, use updateExtData method instead.")
public func updateContextData(key: String, value: Set<String>)

  • This method allows to remove specific context data keyword & values set from adunit context targeting

    Declaration

    Swift

    @available(*, deprecated, message: "This method is deprecated. Please, use removeExtData method instead.")
public func removeContextData(forKey: String)

  • This method allows to remove all context data set from adunit context targeting

    Declaration

    Swift

    @available(*, deprecated, message: "This method is deprecated. Please, use clearExtData method instead.")
public func clearContextData()

  • This method obtains the ext data keyword & value for adunit targeting. If the key already exists the value will be appended to the list. No duplicates will be added

    Declaration

    Swift

    public func addExtData(key: String, value: String)

  • This method obtains the ext data keyword & values for adunit targeting. The values if the key already exist will be replaced with the new set of values

    Declaration

    Swift

    public func updateExtData(key: String, value: Set<String>)

  • This method allows to remove specific ext data keyword & values set from adunit targeting

    Declaration

    Swift

    public func removeExtData(forKey: String)

  • This method allows to remove all ext data set from adunit targeting

    Declaration

    Swift

    public func clearExtData()

Ext keywords (imp[].ext.keywords)

  • This method obtains the context keyword for adunit context targeting Inserts the given element in the set if it is not already present.

    Declaration

    Swift

    @available(*, deprecated, message: "This method is deprecated. Please, use addExtKeyword method instead.")
public func addContextKeyword(_ newElement: String)

  • This method obtains the context keyword set for adunit context targeting Adds the elements of the given set to the set.

    Declaration

    Swift

    @available(*, deprecated, message: "This method is deprecated. Please, use addExtKeywords method instead.")
public func addContextKeywords(_ newElements: Set<String>)

  • This method allows to remove specific context keyword from adunit context targeting

    Declaration

    Swift

    @available(*, deprecated, message: "This method is deprecated. Please, use removeExtKeyword method instead.")
public func removeContextKeyword(_ element: String)

  • This method allows to remove all keywords from the set of adunit context targeting

    Declaration

    Swift

    @available(*, deprecated, message: "This method is deprecated. Please, use clearExtKeywords method instead.")
public func clearContextKeywords()

  • This method obtains the keyword for adunit targeting Inserts the given element in the set if it is not already present.

    Declaration

    Swift

    public func addExtKeyword(_ newElement: String)

  • This method obtains the keyword set for adunit targeting Adds the elements of the given set to the set.

    Declaration

    Swift

    public func addExtKeywords(_ newElements: Set<String>)

  • This method allows to remove specific keyword from adunit targeting

    Declaration

    Swift

    public func removeExtKeyword(_ element: String)

  • This method allows to remove all keywords from the set of adunit targeting

    Declaration

    Swift

    public func clearExtKeywords()

App Content (app.content.data)

  • Sets the app content object, replacing any existing content.

    Declaration

    Swift

    public func setAppContent(_ appContentObject: PBMORTBAppContent)

    Parameters

    appContentObject

    The PBMORTBAppContent object representing the app’s content.

  • Retrieves the current app content object.

    Declaration

    Swift

    public func getAppContent() -> PBMORTBAppContent?

    Return Value

    The current PBMORTBAppContent object, or nil if no content is set.

  • Clears the current app content object.

    Declaration

    Swift

    public func clearAppContent()

  • Adds an array of content data objects to the app content.

    Declaration

    Swift

    public func addAppContentData(_ dataObjects: [PBMORTBContentData])

    Parameters

    dataObjects

    An array of PBMORTBContentData objects to add.

  • Removes a specific content data object from the app content.

    Declaration

    Swift

    public func removeAppContentData(_ dataObject: PBMORTBContentData)

    Parameters

    dataObject

    The PBMORTBContentData object to remove.

  • Clears all content data objects from the app content.

    Declaration

    Swift

    public func clearAppContentData()

User Data (user.data)

  • Adds an array of user data objects.

    Declaration

    Swift

    public func addUserData(_ userDataObjects: [PBMORTBContentData])

    Parameters

    userDataObjects

    An array of PBMORTBContentData objects to add to the user data.

  • Removes a specific user data object.

    Declaration

    Swift

    public func removeUserData(_ userDataObject: PBMORTBContentData)

    Parameters

    userDataObject

    The PBMORTBContentData object to remove from the user data.

  • Clears all user data.

    Declaration

    Swift

    public func clearUserData()

Public Methods

  • Initializes a new mediation banner ad unit with the specified configuration ID, size, and mediation delegate.

    Declaration

    Swift

    public init(configID: String, size: CGSize, mediationDelegate: PrebidMediationDelegate)

    Parameters

    configID

    The unique identifier for the ad unit configuration.
    size

    The size of the ad.
    mediationDelegate

    The delegate for handling mediation.

  • Makes bid request and setups mediation parameters.

    Declaration

    Swift

    public func fetchDemand(completion: ((ResultCode) -> Void)?)

    Parameters

    completion

    The completion handler to call when the demand fetch is complete.

  • Stops the auto-refresh for the ad unit.

    Declaration

    Swift

    public func stopRefresh()

  • Handles the event when the ad object fails to load an ad.

    Declaration

    Swift

    public func adObjectDidFailToLoadAd(adObject: UIView,
                                    with error: Error)

    Parameters

    adObject

    The ad object that failed to load the ad.
    error

    The error that occurred during the ad load.