AdUnit

@objcMembers
public class AdUnit : NSObject, DispatcherDelegate

Base class for ad units built for original type of integration.

  • ORTB: imp[].ext.data.adslot

    Declaration

    Swift

    public var pbAdSlot: String? { get set }

  • Initializes a new AdUnit instance with the specified configuration ID, size, and ad formats.

    Declaration

    Swift

    public init(configId: String, size: CGSize?, adFormats: Set<AdFormat>)

    Parameters

    configId

    The configuration ID for the ad unit.
    size

    The primary size of the ad. If nil, a default size of .zero is used.
    adFormats

    A set of ad formats supported by the ad unit.

  • Makes bid request and provides the result as a dictionary of key-value pairs.

    Declaration

    Swift

    @available(*, deprecated, message: "Deprecated. Use fetchDemand(completion: @escaping (_ bidInfo: BidInfo﹚ -> Void﹚ instead.")
dynamic public func fetchDemand(completion: @escaping (_ result: ResultCode, _ kvResultDict: [String : String]?) -> Void)

    Parameters

    completion

    A closure called with the result code and an optional dictionary of targeting keywords.

    • result: The result code indicating the outcome of the demand fetch.
    • kvResultDict: A dictionary containing key-value pairs, or nil if no demand was fetched.

  • Makes bid request and provides the result as a BidInfo object.

    Declaration

    Swift

    dynamic public func fetchDemand(completionBidInfo: @escaping (_ bidInfo: BidInfo) -> Void)

    Parameters

    completionBidInfo

    A closure called with a BidInfo object representing the fetched demand.

  • Makes bid request for a specific ad object and provides the result code. Setups targeting keywords into the adObject.

    Declaration

    Swift

    dynamic public func fetchDemand(adObject: AnyObject, completion: @escaping (_ result: ResultCode) -> Void)

    Parameters

    adObject

    The ad object for which demand is being fetched.
    completion

    A closure called with the result code indicating the outcome of the demand fetch.

adunit ext data aka inventory 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()

adunit 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)

  • Retrieves the current user data.

    Declaration

    Swift

    public func getUserData() -> [PBMORTBContentData]?

    Return Value

    An array of PBMORTBContentData objects representing the user data, or nil if no data is available.

  • 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()

GPID

  • Sets the GPID for the ad unit.

    Declaration

    Swift

    public func setGPID(_ gpid: String?)

    Parameters

    gpid

    The GPID string to set. Can be nil to clear the GPID.

  • Retrieves the current GPID for the ad unit.

    Declaration

    Swift

    public func getGPID() -> String?

    Return Value

    The GPID string, or nil if no GPID is set.

Global ORTBObject

  • Sets the OpenRTB configuration string for the ad unit.

    Declaration

    Swift

    public func setOrtbConfig(_ ortbObject: String?)

    Parameters

    ortbObject

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

  • Retrieves the current OpenRTB configuration string for the ad unit.

    Declaration

    Swift

    public func getOrtbConfig() -> String?

    Return Value

    The OpenRTB configuration string, or nil if no configuration is set.

others

  • This method allows to set the auto refresh period for the demand

    Declaration

    Swift

    public func setAutoRefreshMillis(time: Double)

    Parameters

    time

    refresh time interval

  • This method stops the auto refresh of demand

    Declaration

    Swift

    public func stopAutoRefresh()

  • This method resumes the auto refresh of demand

    Declaration

    Swift

    public func resumeAutoRefresh()