InterstitialRenderingAdUnit

@objcMembers
public class InterstitialRenderingAdUnit : NSObject, BaseInterstitialAdUnitProtocol

Represents an interstitial ad unit. Built for rendering type of integration.

  • A delegate for handling interactions with the ad unit.

    Declaration

    Swift

    public weak var delegate: InterstitialAdUnitDelegate?

  • A Boolean value indicating whether the ad unit is ready to be displayed.

    Declaration

    Swift

    public var isReady: Bool { get }

  • The set of ad formats supported by this ad unit.

    Declaration

    Swift

    public var adFormats: Set<AdFormat> { get set }

  • The position of the ad on the screen.

    Declaration

    Swift

    public var adPosition: AdPosition { get set }

  • The ORTB (OpenRTB) configuration string for the ad unit.

    Declaration

    Swift

    @available(*, deprecated, message: "Deprecated. Use setImpORTBConfig(_:﹚ and getImpORTBConfig(﹚ for impression-level ORTB configuration.")
public var ortbConfig: String? { get set }

  • The banner parameters used for configuring ad unit.

    Declaration

    Swift

    public var bannerParameters: BannerParameters { get }

  • The video parameters used for configuring ad unit.

    Declaration

    Swift

    public var videoParameters: VideoParameters { get }

Video controls configuration

  • The area of the close button in the video controls as a percentage.

    Declaration

    Swift

    public var closeButtonArea: Double { get set }

  • The position of the close button in the video controls.

    Declaration

    Swift

    public var closeButtonPosition: Position { get set }

  • The area of the skip button in the video controls, specified as a percentage of the screen width.

    Declaration

    Swift

    public var skipButtonArea: Double { get set }

  • The position of the skip button in the video controls.

    Declaration

    Swift

    public var skipButtonPosition: Position { get set }

  • The delay before the skip button appears, in seconds.

    Declaration

    Swift

    public var skipDelay: Double { get set }

  • A Boolean value indicating whether the video controls are muted.

    Declaration

    Swift

    public var isMuted: Bool { get set }

  • A Boolean value indicating whether the sound button is visible in the video controls.

    Declaration

    Swift

    public var isSoundButtonVisible: Bool { get set }

Private properties

  • Initializes a new BaseInterstitialAdUnit with the specified configuration ID.

    Declaration

    Swift

    public convenience init(configID: String)

    Parameters

    configID

    The unique identifier for the ad unit configuration.

  • Initializes a new InterstitialRenderingAdUnit with the specified configuration ID and minimum size percentage.

    Declaration

    Swift

    public convenience init(configID: String, minSizePercentage: CGSize)

    Parameters

    configID

    The unique identifier for the ad unit configuration.
    minSizePercentage

    The minimum size percentage for the ad unit.

  • Initializes a new InterstitialRenderingAdUnit with the specified configuration ID and event handler.

    Declaration

    Swift

    public convenience init(configID: String, eventHandler: AnyObject?)

    Parameters

    configID

    The unique identifier for the ad unit configuration.
    eventHandler

    An object for handling ad events.

  • Initializes a new InterstitialRenderingAdUnit with the specified configuration ID, minimum size percentage, and event handler.

    Declaration

    Swift

    public convenience init(
    configID: String,
    minSizePercentage: CGSize,
    eventHandler: AnyObject
)

    Parameters

    configID

    The unique identifier for the ad unit configuration.
    minSizePercentage

    The minimum size percentage for the ad unit.
    eventHandler

    An object for handling ad events.

Public methods

  • Loads a new ad.

    Declaration

    Swift

    public func loadAd()

  • Shows the ad from a specified view controller.

    Note

    This method must be called on the main thread.

    Declaration

    Swift

    public func show(from controller: UIViewController)

    Parameters

    controller

    The view controller from which the ad will be presented.

Arbitrary ORTB Configuration

  • Sets the impression-level OpenRTB configuration string for the ad unit.

    Declaration

    Swift

    public func setImpORTBConfig(_ ortbConfig: String?)

    Parameters

    ortbObject

    The impression-level OpenRTB configuration string to set. Can be nil to clear the configuration.

  • Returns the impression-level OpenRTB configuration string.

    Declaration

    Swift

    public func getImpORTBConfig() -> String?

Ext Data (imp[].ext.data)

  • Adds context data for a specified key.

    Declaration

    Swift

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

    Parameters

    data

    The data to add.
    key

    The key associated with the data.

  • Updates context data for a specified key.

    Declaration

    Swift

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

    Parameters

    data

    A set of data to update.
    key

    The key associated with the data.

  • Removes context data for a specified key.

    Declaration

    Swift

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

    Parameters

    key

    The key associated with the data to remove.

  • Clears all context data.

    Declaration

    Swift

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

  • Adds ext data.

    Declaration

    Swift

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

    Parameters

    key

    The key for the data.
    value

    The value for the data.

  • Updates ext data.

    Declaration

    Swift

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

    Parameters

    key

    The key for the data.
    value

    The value for the data.

  • Removes ext data.

    Declaration

    Swift

    public func removeExtData(forKey: String)

    Parameters

    key

    The key for the data.

  • Clears ext data.

    Declaration

    Swift

    public func clearExtData()

Ext keywords (imp[].ext.keywords)

  • Adds a context keyword.

    Declaration

    Swift

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

    Parameters

    newElement

    The keyword to add.

  • Adds a set of context keywords.

    Declaration

    Swift

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

    Parameters

    newElements

    A set of keywords to add.

  • Removes a context keyword.

    Declaration

    Swift

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

    Parameters

    element

    The keyword to remove.

  • Clears all context keywords.

    Declaration

    Swift

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

  • Adds an extended keyword.

    Declaration

    Swift

    public func addExtKeyword(_ newElement: String)

    Parameters

    newElement

    The keyword to be added.

  • Adds multiple extended keywords.

    Declaration

    Swift

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

    Parameters

    newElements

    A set of keywords to be added.

  • Removes an extended keyword.

    Declaration

    Swift

    public func removeExtKeyword(_ element: String)

    Parameters

    element

    The keyword to be removed.

  • Clears all extended keywords.

    Declaration

    Swift

    public func clearExtKeywords()

App Content (app.content.data)

  • Sets the app content data.

    Declaration

    Swift

    public func setAppContent(_ appContent: PBMORTBAppContent)

    Parameters

    appContent

    The app content data.

  • Clears the app content data.

    Declaration

    Swift

    public func clearAppContent()

  • Adds app content data objects.

    Declaration

    Swift

    public func addAppContentData(_ dataObjects: [PBMORTBContentData])

    Parameters

    dataObjects

    The data objects to be added.

  • Removes an app content data object.

    Declaration

    Swift

    public func removeAppContentDataObject(_ dataObject: PBMORTBContentData)

    Parameters

    dataObject

    The data object to be removed.

  • Clears all app content data objects.

    Declaration

    Swift

    public func clearAppContentDataObjects()

User Data (user.data)

  • Adds user data objects.

    Declaration

    Swift

    public func addUserData(_ userDataObjects: [PBMORTBContentData])

    Parameters

    userDataObjects

    The user data objects to be added.

  • Removes a user data object. - Parameter userDataObject: The user data object to be removed.

    Declaration

    Swift

    public func removeUserData(_ userDataObject: PBMORTBContentData)

  • Clears all user data objects.

    Declaration

    Swift

    public func clearUserData()