PrebidMobile 2.2.3 Docs (27% documented)
+PrebidMobile 2.2.3 Docs (94% documented)
Swift
-public class InstreamVideoAdUnit : AdUnit, VideoBasedAdUnitProtocolpublic class InstreamVideoAdUnit : AdUnit, VideoBasedAdUnitProtocolUndocumented
+Represents an interstitial ad unit built for original type of integration.
See moreSwift
-public class InterstitialAdUnit : AdUnit, BannerBasedAdUnitProtocol, VideoBasedAdUnitProtocolpublic class InterstitialAdUnit : AdUnit, BannerBasedAdUnitProtocol, VideoBasedAdUnitProtocolUndocumented
+Represents a native ad and handles its various properties and functionalities.
See moreUndocumented
+Represents the configuration for a native ad, including markup and version information.
See moreUndocumented
+Represents the markup for a native ad, including assets, tracking URLs, and other metadata.
See moreUndocumented
+Represents an asset in the native ad markup, which can be a title, image, data, or link.
See moreUndocumented
+Represents a generic native ad asset which could be a title, image, or data.
See moreUndocumented
+Represents a request object for native markup, including details about the ad’s context, placement, and supported features.
See moreUndocumented
+Represents the title element in a native ad, including optional text and length.
See moreUndocumented
+Represents parameters for a native ad request, including assets, event trackers, and configuration settings.
See more
-
-
- SingleContainerInt
+
+
+ Signals
Undocumented
+A class containing constants related to OpenRTB signals.
- See more +This class provides static constants and values representing different +API frameworks, playback methods, protocols, start delays, and video +placement types as defined in the OpenRTB specification.
+ + See moreSwift
-public class SingleContainerInt : NSObject, ExpressibleByIntegerLiteralpublic class Signals : NSObject
-
-
- Signals
+
+
+ SingleContainerInt
Swift
-public class Signals : NSObjectpublic class SingleContainerInt : NSObject, ExpressibleByIntegerLiteralSwift
-public class RewardedVideoAdUnit : AdUnit, VideoBasedAdUnitProtocolpublic class RewardedVideoAdUnit : AdUnit, VideoBasedAdUnitProtocolUndocumented
+A utility class for handling various ad-related operations and conversions.
See moreUndocumented
+A deprecated class representing a video interstitial ad unit.
+This class is used to configure and manage video interstitial ads. It inherits from AdUnit and provides
+specific settings for video ads including interstitial ad configuration and placement.
Swift
-public class VideoInterstitialAdUnit : AdUnit@available(*, deprecated, message: "This class is deprecated. Please, use InterstitialAdUnit with video adFormat.")
+public class VideoInterstitialAdUnit : AdUnitUndocumented
+The Prebid class manages the configuration and initialization of the PrebidMobile SDK.
Undocumented
+A class that manages targeting information for ads.
+ +This class provides properties and methods for setting and retrieving +user-specific targeting information, such as user ID, gender, and custom +data. It also includes details for OMID (Open Measurement Interface Definition) +partner and supports managing user identity links and custom extensions.
See moreUndocumented
+A singleton class that manages the Prebid server URL, including a custom URL.
See moreUndocumented
+AdFormat is a class that represents different types of ad formats using an OptionSet.
+The class also includes a deprecated display format for backward compatibility, marked with a deprecation message.
Undocumented
+A class representing the configuration for video controls in an ad. +This includes properties for video duration, mute status, and button positioning and visibility. +Configuration values can be initialized from bid response or set directly by the user.
See moreThe view that will display the particular banner ad.
+The view that will display the particular banner ad. Built for rendering type of integration.
See moreUndocumented
+Represents an interstitial ad unit. Built for rendering type of integration.
See moreUndocumented
+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.
See moreSwift
@objcMembers
-public class MediationInterstitialAdUnit : MediationBaseInterstitialAdUnit
-
-
- MediationNativeAdUnit
+
+
+ MediationInterstitialAdUnit
Undocumented
+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.
- See more + See moreSwift
@objcMembers
-public class MediationNativeAdUnit : NSObject
-
-
- MediationNativeUtils
+
+
+ MediationNativeAdUnit
Undocumented
+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.
- See more + See moreSwift
-@objc(PBMMediationNativeUtils)
-@objcMembers
-public class MediationNativeUtils : NSObject@objcMembers
+public class MediationNativeAdUnit : NSObjectUndocumented
+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.
See moreSwift
@objcMembers
-public class MediationRewardedAdUnit : MediationBaseInterstitialAdUnit
-
-
- InterstitialController
-
- Undocumented
- - See more -Swift
-public class InterstitialController : NSObject, PBMAdViewManagerDelegateUndocumented
+AdFormat is a class that represents different types of ad formats using an OptionSet.
+The class also includes a deprecated display format for backward compatibility, marked with a deprecation message.
The underlying type of the raw value.
+The raw integer value representing the ad format.
+Undocumented
+The string representation of the ad format.
Undocumented
+Initializes an AdFormat instance with a specified raw value and its string equivalent.
+
+ rawValue
+
+ |
+
+
+
+ The raw value representing the ad format. + |
+
+
+ stringEquivalent
+
+ |
+
+
+
+ A string equivalent of the ad format. + |
+
-
+
- init(rawValue:)
+ init(rawValue:)
Initializes an AdFormat instance with a specified raw value.
+
+ rawValue
+
+ |
+
+
+
+ The raw value representing the ad format. + |
+
Undocumented
+Represents a banner ad format.
Undocumented
+Represents a video ad format.
Undocumented
+Represents a native ad format.
Undocumented
+Represents a deprecated display ad format.
Swift
-public static let display: AdFormat@available(*, deprecated, message: "Display ad format is deprecated. Please, use banner ad format instead.")
+public static let display: AdFormatUndocumented
+An array containing all cases of ad formats, excluding deprecated ones.
Undocumented
+Base class for ad units built for original type of integration.
Undocumented
+ORTB: imp[].ext.data.adslot
Undocumented
+Initializes a new AdUnit instance with the specified configuration ID, size, and ad formats.
+
+ configId
+
+ |
+
+
+
+ The configuration ID for the ad unit. + |
+
+
+ size
+
+ |
+
+
+
+ The primary size of the ad. If |
+
+
+ adFormats
+
+ |
+
+
+
+ A set of ad formats supported by the ad unit. + |
+
Undocumented
+Makes bid request and provides the result as a dictionary of key-value pairs.
Swift
-dynamic public func fetchDemand(completion: @escaping (_ result: ResultCode, _ kvResultDict: [String : String]?) -> Void)@available(*, deprecated, message: "Deprecated. Use fetchDemand(completion: @escaping (_ bidInfo: BidInfo﹚ -> Void﹚ instead.")
+dynamic public func fetchDemand(completion: @escaping (_ result: ResultCode, _ kvResultDict: [String : String]?) -> Void)
+
+ completion
+
+ |
+
+
+
+ A closure called with the result code and an optional dictionary of targeting keywords. + +
|
+
Undocumented
+Makes bid request and provides the result as a BidInfo object.
+
+ completionBidInfo
+
+ |
+
+
+
+ A closure called with a |
+
Undocumented
+Makes bid request for a specific ad object and provides the result code. Setups targeting keywords into the adObject.
+
+ 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. + |
+
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
+If the key already exists the value will be appended to the list. No duplicates will be addedThis 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
+The values if the key already exist will be replaced with the new set of valuesThis 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
+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
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
+The values if the key already exist will be replaced with the new set of valuesUndocumented
+Sets the app content object, replacing any existing content.
+
+ appContentObject
+
+ |
+
+
+
+ The |
+
Undocumented
+Retrieves the current app content object.
The current PBMORTBAppContent object, or nil if no content is set.
Undocumented
+Clears the current app content object.
Undocumented
+Adds an array of content data objects to the app content.
+
+ dataObjects
+
+ |
+
+
+
+ An array of |
+
Undocumented
+Removes a specific content data object from the app content.
+
+ dataObject
+
+ |
+
+
+
+ The |
+
Undocumented
+Clears all content data objects from the app content.
Undocumented
+Retrieves the current user data.
An array of PBMORTBContentData objects representing the user data, or nil if no data is available.
Undocumented
+Adds an array of user data objects.
+
+ userDataObjects
+
+ |
+
+
+
+ An array of |
+
Undocumented
+Removes a specific user data object.
+
+ userDataObject
+
+ |
+
+
+
+ The |
+
Undocumented
+Clears all user data.
Undocumented
+Sets the GPID for the ad unit.
+
+ gpid
+
+ |
+
+
+
+ The GPID string to set. Can be |
+
Undocumented
+Retrieves the current GPID for the ad unit.
The GPID string, or nil if no GPID is set.
Undocumented
+Sets the OpenRTB configuration string for the ad unit.
+
+ ortbObject
+
+ |
+
+
+
+ The OpenRTB configuration string to set. Can be |
+
Undocumented
+Retrieves the current OpenRTB configuration string for the ad unit.
The OpenRTB configuration string, or nil if no configuration is set.
Undocumented
+This method resumes the auto refresh of demand
PrebidMobile 2.2.3 Docs (27% documented)
+PrebidMobile 2.2.3 Docs (94% documented)
PrebidMobile 2.2.3 Docs (27% documented)
+PrebidMobile 2.2.3 Docs (94% documented)
Undocumented
+Clears all context keywords.
Swift
-@objc
+ @available(*, deprecated, message: "This method is deprecated. Please, use clearExtKeywords method instead.")
+@objc
public func clearContextKeywords()
Undocumented
+A base class for interstitial ad units.
Undocumented
+The banner parameters used for configuring ad unit.
Undocumented
+The video parameters used for configuring ad unit.
Undocumented
+The last bid response received for the ad unit.
Undocumented
+The configuration ID for the ad unit.
Undocumented
+The set of ad formats supported by this ad unit.
Undocumented
+The ORTB (OpenRTB) configuration string for the ad unit.
Undocumented
+A Boolean value indicating whether the ad unit is ready to be displayed.
Undocumented
+A Boolean value indicating whether the video controls are muted.
Undocumented
+A Boolean value indicating whether the sound button is visible in the video controls.
Undocumented
+The area of the close button in the video controls as a percentage.
Undocumented
+The position of the close button in the video controls.
Undocumented
+A delegate for handling interactions with the ad unit.
Undocumented
+The configuration object for the ad unit.
Undocumented
+Initializes a new BaseInterstitialAdUnit with the specified configuration ID, minimum size percentage, and event handler.
+
+ configID
+
+ |
+
+
+
+ The unique identifier for the ad unit configuration. + |
+
+
+ minSizePerc
+
+ |
+
+
+
+ The minimum size percentage for the ad unit. + |
+
+
+ eventHandler
+
+ |
+
+
+
+ An optional event handler object for handling ad events. + |
+
Undocumented
+Initializes a new BaseInterstitialAdUnit with the specified configuration ID, minimum size percentage, and event handler.
+
+ configID
+
+ |
+
+
+
+ The unique identifier for the ad unit configuration. + |
+
+
+ minSizePercentage
+
+ |
+
+
+
+ The minimum size percentage for the ad unit. + |
+
+
+ eventHandler
+
+ |
+
+
+
+ An optional event handler object for handling ad events. + |
+
Undocumented
+Initializes a new BaseInterstitialAdUnit with the specified configuration ID and event handler.
+
+ configID
+
+ |
+
+
+
+ The unique identifier for the ad unit configuration. + |
+
+
+ eventHandler
+
+ |
+
+
+
+ An optional event handler object for handling ad events. + |
+
Undocumented
+Initializes a new BaseInterstitialAdUnit with the specified configuration ID and minimum size percentage.
+
+ configID
+
+ |
+
+
+
+ The unique identifier for the ad unit configuration. + |
+
+
+ minSizePercentage
+
+ |
+
+
+
+ The minimum size percentage for the ad unit. + |
+
Undocumented
+Initializes a new BaseInterstitialAdUnit with the specified configuration ID.
+
+ configID
+
+ |
+
+
+
+ The unique identifier for the ad unit configuration. + |
+
Undocumented
+Loads a new ad.
Undocumented
+Shows the ad from a specified view controller.
+Note
+ This method must be called on the main thread. + +
+
+ controller
+
+ |
+
+
+
+ The view controller from which the ad will be presented. + |
+
Undocumented
+Adds context data for a specified key.
Swift
-@objc
+ @available(*, deprecated, message: "This method is deprecated. Please, use addExtData method instead.")
+@objc
public func addContextData(_ data: String, forKey key: String)
+
+ data
+
+ |
+
+
+
+ The data to add. + |
+
+
+ key
+
+ |
+
+
+
+ The key associated with the data. + |
+
Undocumented
+Updates context data for a specified key.
Swift
-@objc
+ @available(*, deprecated, message: "This method is deprecated. Please, use updateExtData method instead.")
+@objc
public func updateContextData(_ data: Set<String>, forKey key: String)
+
+ data
+
+ |
+
+
+
+ A set of data to update. + |
+
+
+ key
+
+ |
+
+
+
+ The key associated with the data. + |
+
Undocumented
+Removes context data for a specified key.
Swift
-@objc
+ @available(*, deprecated, message: "This method is deprecated. Please, use removeExtData method instead.")
+@objc
public func removeContextDate(forKey key: String)
+
+ key
+
+ |
+
+
+
+ The key associated with the data to remove. + |
+
Undocumented
+Clears all context data.
Swift
-@objc
+ @available(*, deprecated, message: "This method is deprecated. Please, use clearExtData method instead.")
+@objc
public func clearContextData()
Undocumented
+Adds ext data.
+
+ key
+
+ |
+
+
+
+ The key for the data. + |
+
+
+ value
+
+ |
+
+
+
+ The value for the data. + |
+
Undocumented
+Updates ext data.
+
+ key
+
+ |
+
+
+
+ The key for the data. + |
+
+
+ value
+
+ |
+
+
+
+ The value for the data. + |
+
Undocumented
+Removes ext data.
+
+ key
+
+ |
+
+
+
+ The key for the data. + |
+
Undocumented
+Clears ext data.
Undocumented
+Adds a context keyword.
Swift
-@objc
+ @available(*, deprecated, message: "This method is deprecated. Please, use addExtKeyword method instead.")
+@objc
public func addContextKeyword(_ newElement: String)
+
+ newElement
+
+ |
+
+
+
+ The keyword to add. + |
+
Undocumented
+Adds a set of context keywords.
Swift
-@objc
+ @available(*, deprecated, message: "This method is deprecated. Please, use addExtKeywords method instead.")
+@objc
public func addContextKeywords(_ newElements: Set<String>)
+
+ newElements
+
+ |
+
+
+
+ A set of keywords to add. + |
+
Undocumented
+Removes a context keyword.
Swift
-@objc
+ @available(*, deprecated, message: "This method is deprecated. Please, use removeExtKeyword method instead.")
+@objc
public func removeContextKeyword(_ element: String)
+
+ element
+
+ |
+
+
+
+ The keyword to remove. + |
+
Undocumented
+Clears all context keywords.
Swift
-@objc
+ @available(*, deprecated, message: "This method is deprecated. Please, use clearExtKeywords method instead.")
+@objc
public func clearContextKeywords()
Undocumented
+Adds an extended keyword.
+
+ newElement
+
+ |
+
+
+
+ The keyword to be added. + |
+
Undocumented
+Adds multiple extended keywords.
+
+ newElements
+
+ |
+
+
+
+ A set of keywords to be added. + |
+
Undocumented
+Removes an extended keyword.
+
+ element
+
+ |
+
+
+
+ The keyword to be removed. + |
+
Undocumented
+Clears all extended keywords.
Undocumented
+Sets the app content data.
+
+ appContent
+
+ |
+
+
+
+ The app content data. + |
+
Undocumented
+Clears the app content data.
Undocumented
+Adds app content data objects.
+
+ dataObjects
+
+ |
+
+
+
+ The data objects to be added. + |
+
Undocumented
+Removes an app content data object.
+
+ dataObject
+
+ |
+
+
+
+ The data object to be removed. + |
+
Undocumented
+Clears all app content data objects.
Undocumented
+Adds user data objects.
+
+ userDataObjects
+
+ |
+
+
+
+ The user data objects to be added. + |
+
Undocumented
+Removes a user data object.
+
+ userDataObject
+
+ |
+
+
+
+ The user data object to be removed. + |
+
Undocumented
+Clears all user data objects.
Undocumented
+Internal delegate method.
Undocumented
+Internal delegate method.
Swift
public func interstitialAdLoader(_ interstitialAdLoader: PBMInterstitialAdLoader,
- createdInterstitialController interstitialController: InterstitialController)Undocumented
+The event handler for the interstitial events.
Undocumented
+Called when the ad load flow controller is about to send a bid request.
Undocumented
+Called when the ad load flow controller is about to request the primary ad.
Undocumented
+Called to determine if the ad load flow controller should continue with the current flow.
Undocumented
+Called when the ad load flow controller fails with an error.
Undocumented
+Tracks an impression for the given interstitial controller.
Swift
-public func trackImpression(forInterstitialController: InterstitialController)public func trackImpression(forInterstitialController: InterstitialController)Undocumented
+Called when the ad in the interstitial controller is clicked.
Swift
-public func interstitialControllerDidClickAd(_ interstitialController: InterstitialController)public func interstitialControllerDidClickAd(_ interstitialController: InterstitialController)Undocumented
+Called when the ad in the interstitial controller is closed.
Swift
-public func interstitialControllerDidCloseAd(_ interstitialController: InterstitialController)public func interstitialControllerDidCloseAd(_ interstitialController: InterstitialController)Undocumented
+Called when the ad in the interstitial controller causes the app to leave.
Swift
-public func interstitialControllerDidLeaveApp(_ interstitialController: InterstitialController)public func interstitialControllerDidLeaveApp(_ interstitialController: InterstitialController)Undocumented
+Called when the interstitial controller displays an ad.
Swift
-public func interstitialControllerDidDisplay(_ interstitialController: InterstitialController)public func interstitialControllerDidDisplay(_ interstitialController: InterstitialController)Undocumented
+Called when the interstitial controller completes the ad display.
Swift
-public func interstitialControllerDidComplete(_ interstitialController: InterstitialController)public func interstitialControllerDidComplete(_ interstitialController: InterstitialController)Undocumented
+Provides the view controller to use for modal presentation.
Swift
-public func viewControllerForModalPresentation(fromInterstitialController: InterstitialController) -> UIViewController?public func viewControllerForModalPresentation(fromInterstitialController: InterstitialController) -> UIViewController?Undocumented
+Called when an ad is about to be presented.
Undocumented
+Called when an ad has been dismissed.
Undocumented
+Called when the ad causes the app to leave.
Undocumented
+Called when an ad is clicked.
Undocumented
+Requests an ad using the provided bid response.
Undocumented
+Displays the ad using the provided view controller.
Undocumented
+Checks if the ad unit is ready to show an ad.
Undocumented
+Notifies the delegate that an ad has been successfully received.
Undocumented
+Notifies the delegate that the ad failed to load.
Undocumented
+Notifies the delegate that an ad is about to be presented.
Undocumented
+Notifies the delegate that an ad has been dismissed.
Undocumented
+Notifies the delegate that the app is about to leave due to an ad.
Undocumented
+Notifies the delegate that an ad has been clicked.
Undocumented
+Sets the loading delegate for the event handler.
Undocumented
+Sets the interaction delegate for the event handler.
Undocumented
+Shows the ad from the provided view controller.
Undocumented
+Tracks an impression for the ad.
Undocumented
+Contains information about bid.
Undocumented
+The result code of the bid request
Undocumented
+Targeting keywords associated with the bid
Undocumented
+The expiration time of the bid
Undocumented
+The cache ID for native ads
Undocumented
+Events related to the bid
Undocumented
+Initializes a new BidInfo instance with the specified parameters.
Swift
-public init(resultCode: ResultCode, targetingKeywords: [String : String]? = nil, exp: Double? = nil,
+ public init(resultCode: ResultCode, targetingKeywords: [String : String]? = nil, exp: Double? = nil,
nativeAdCacheId: String? = nil, events: [String: String] = [:])
+
+ resultCode
+
+ |
+
+
+
+ The result code of the bid request. + |
+
+
+ targetingKeywords
+
+ |
+
+
+
+ Optional targeting keywords associated with the bid. + |
+
+
+ exp
+
+ |
+
+
+
+ Optional expiration time of the bid. + |
+
+
+ nativeAdCacheId
+
+ |
+
+
+
+ Optional cache ID for native ads. + |
+
+
+ events
+
+ |
+
+
+
+ Optional dictionary of events related to the bid. + |
+
Undocumented
+Retrieves the expiration time of the bid as an NSNumber.
Undocumented
+Native context subtype asset.
Undocumented
+Represents a general context type.
Undocumented
+Represents an article context type.
Undocumented
+Represents a video context type.
Undocumented
+Represents an audio context type.
Undocumented
+Represents an image context type.
Undocumented
+Represents a user-generated content context type.
Undocumented
+Represents a social media context type.
Undocumented
+Represents an email context type.
Undocumented
+Represents a chat or instant messaging context type.
Undocumented
+Represents a product selling context type.
Undocumented
+Represents an App Store context type.
Undocumented
+Represents a review site context type.
Undocumented
+Represents a custom context type.
Undocumented
+Native context type asset.
Undocumented
+Represents a content context type.
Undocumented
+Represents a social media context type.
Undocumented
+Represents a product context type.
Undocumented
+Represents a custom context type.
Undocumented
+Native event tracking type.
Undocumented
+Represents image-based event tracking.
Undocumented
+Represents JavaScript-based event tracking.
Undocumented
+Represents a custom event tracking method.
Undocumented
+Class representing different event types.