Classes

The following classes are available globally.

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

    See more

    Declaration

    Swift

    @objcMembers
    public class AdUnit : NSObject, DispatcherDelegate
  • A class representing a banner ad unit for original type of integration.

    See more

    Declaration

    Swift

    public class BannerAdUnit : AdUnit, BannerBasedAdUnitProtocol, VideoBasedAdUnitProtocol
  • Represents an instream video ad unit for original type of integration.

    See more

    Declaration

    Swift

    public class InstreamVideoAdUnit : AdUnit, VideoBasedAdUnitProtocol
  • Represents an interstitial ad unit built for original type of integration.

    See more

    Declaration

    Swift

    public class InterstitialAdUnit : AdUnit, BannerBasedAdUnitProtocol, VideoBasedAdUnitProtocol
  • Contains information about bid.

    See more

    Declaration

    Swift

    @objcMembers
    @objc(PBMBidInfo)
    public class BidInfo : NSObject
  • Multiformat ad unit. Built for original API.

    See more

    Declaration

    Swift

    @objcMembers
    public class PrebidAdUnit : NSObject
  • Class that contains properties and methods to configure Prebid request.

    See more

    Declaration

    Swift

    @objcMembers
    public class PrebidRequest : NSObject
  • Native context subtype asset.

    See more

    Declaration

    Swift

    @objcMembers
    public class ContextSubType : SingleContainerInt
  • Native context type asset.

    See more

    Declaration

    Swift

    @objcMembers
    public class ContextType : SingleContainerInt
  • Represents a native ad and handles its various properties and functionalities.

    See more

    Declaration

    Swift

    @objcMembers
    public class NativeAd : NSObject, CacheExpiryDelegate
  • Represents the configuration for a native ad, including markup and version information.

    See more

    Declaration

    Swift

    @objc(PBMNativeAdConfiguration)
    @objcMembers
    public class NativeAdConfiguration : NSObject
  • Represents the markup for a native ad, including assets, tracking URLs, and other metadata.

    See more

    Declaration

    Swift

    @objcMembers
    public class NativeAdMarkup : NSObject, JsonDecodable
  • Represents an asset in the native ad markup, which can be a title, image, data, or link.

    See more

    Declaration

    Swift

    @objcMembers
    public class NativeAdMarkupAsset : NSObject, JsonDecodable
  • Represents a generic native ad asset which could be a title, image, or data.

    See more

    Declaration

    Swift

    public class NativeAsset : NSObject
  • Represents a title asset in a native ad.

    See more

    Declaration

    Swift

    @objcMembers
    public class NativeAssetTitle : NativeAsset
  • Represents an image asset in a native ad.

    See more

    Declaration

    Swift

    @objcMembers
    public class NativeAssetImage : NativeAsset
  • Represents a data asset in a native ad.

    See more

    Declaration

    Swift

    @objcMembers
    public class NativeAssetData : NativeAsset
  • Native image asset type.

    See more

    Declaration

    Swift

    public class ImageAsset : SingleContainerInt
  • Class representing native data elements in the ad markup.

    See more

    Declaration

    Swift

    @objcMembers
    public class NativeData : NSObject, JsonDecodable
  • Class representing an event tracker for native ads.

    See more

    Declaration

    Swift

    @objc
    public class NativeEventTracker : NSObject
  • Class representing different event types.

    See more

    Declaration

    Swift

    public class EventType : SingleContainerInt
  • Native event tracking type.

    See more

    Declaration

    Swift

    public class EventTracking : SingleContainerInt
  • Class representing a response for a native event tracker.

    See more

    Declaration

    Swift

    @objcMembers
    public class NativeEventTrackerResponse : NSObject, JsonDecodable
  • Class representing an image asset in a native ad.

    See more

    Declaration

    Swift

    @objcMembers
    public class NativeImage : NSObject, JsonDecodable
  • Class representing a link in a native ad.

    See more

    Declaration

    Swift

    @objcMembers
    public class NativeLink : NSObject, JsonDecodable
  • Represents a request object for native markup, including details about the ad’s context, placement, and supported features.

    See more

    Declaration

    Swift

    @objc(PBMNativeMarkupRequestObject)
    @objcMembers
    public class NativeMarkupRequestObject : NSObject, NSCopying, PBMJsonCodable
  • A class representing a native request for original type of integration.

    See more

    Declaration

    Swift

    public class NativeRequest : AdUnit
  • Represents the title element in a native ad, including optional text and length.

    See more

    Declaration

    Swift

    @objcMembers
    public class NativeTitle : NSObject, JsonDecodable
  • Represents different types of placements for native ads.

    See more

    Declaration

    Swift

    @objcMembers
    public class PlacementType : SingleContainerInt
  • Describes an OpenRTB banner object

    See more

    Declaration

    Swift

    @objcMembers
    public class BannerParameters : NSObject
  • Represents parameters for a native ad request, including assets, event trackers, and configuration settings.

    See more

    Declaration

    Swift

    @objcMembers
    public class NativeParameters : NSObject
  • A class containing constants related to OpenRTB signals.

    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 more

    Declaration

    Swift

    public class Signals : NSObject
  • Undocumented

    See more

    Declaration

    Swift

    public class SingleContainerInt : NSObject, ExpressibleByIntegerLiteral
  • Describes an OpenRTB video object

    See more

    Declaration

    Swift

    @objcMembers
    public class VideoParameters : NSObject
  • Represents an rewarded ad unit for original type of integration.

    See more

    Declaration

    Swift

    public class RewardedVideoAdUnit : AdUnit, VideoBasedAdUnitProtocol
  • A utility class for handling various ad-related operations and conversions.

    See more

    Declaration

    Swift

    public class Utils : NSObject
  • A deprecated class for handling video ad units.

    See more

    Declaration

    Swift

    @available(*, deprecated, message: "This class is deprecated. Please, use BannerAdUnit with video adFormat.")
    public class VideoAdUnit : AdUnit
  • 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.

    See more

    Declaration

    Swift

    @available(*, deprecated, message: "This class is deprecated. Please, use InterstitialAdUnit with video adFormat.")
    public class VideoInterstitialAdUnit : AdUnit
  • The Prebid class manages the configuration and initialization of the PrebidMobile SDK.

    See more

    Declaration

    Swift

    @objcMembers
    public class Prebid : NSObject
  • 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 more

    Declaration

    Swift

    @objcMembers
    public class Targeting : NSObject
  • Defines the User Id Object from an External Thrid Party Source

    See more

    Declaration

    Swift

    @objcMembers
    public class ExternalUserId : NSObject, NSCoding, NSSecureCoding, JSONConvertible
  • A singleton class that manages the Prebid server URL, including a custom URL.

    See more

    Declaration

    Swift

    @objcMembers
    public class Host : NSObject
  • 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.

    See more

    Declaration

    Swift

    @objcMembers
    public class AdFormat : NSObject, OptionSet
  • 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 more

    Declaration

    Swift

    @objc(PBMVideoControlsConfiguration)
    @objcMembers
    public class VideoControlsConfiguration : NSObject
  • Undocumented

    See more

    Declaration

    Swift

    @objc
    open class DefaultPluginEventDelegate : NSObject, PluginEventDelegate
  • Global singleton responsible to store plugin renderer instances

    See more

    Declaration

    Swift

    @objc
    public class PrebidMobilePluginRegister : NSObject
  • Undocumented

    See more

    Declaration

    Swift

    public class SampleCustomRenderer : NSObject, PrebidMobilePluginRenderer
  • The view that will display the particular banner ad. Built for rendering type of integration.

    See more

    Declaration

    Swift

    public class BannerView: UIView,
                             BannerAdLoaderDelegate,
                             AdLoadFlowControllerDelegate,
                             BannerEventInteractionDelegate,
                             DisplayViewInteractionDelegate
  • A base class for interstitial ad units.

    See more

    Declaration

    Swift

    public class BaseInterstitialAdUnit :
        NSObject,
        PBMInterstitialAdLoaderDelegate,
        AdLoadFlowControllerDelegate,
        InterstitialControllerInteractionDelegate,
        InterstitialEventInteractionDelegate,
        BaseInterstitialAdUnitProtocol
  • Represents an interstitial ad unit. Built for rendering type of integration.

    See more

    Declaration

    Swift

    @objcMembers
    public class InterstitialRenderingAdUnit : BaseInterstitialAdUnit
  • Represents an rewarded ad unit. Built for rendering type of integration.

    See more

    Declaration

    Swift

    @objc
    public class RewardedAdUnit: BaseInterstitialAdUnit,
                                 RewardedEventInteractionDelegate
  • 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

    Declaration

    Swift

    @objcMembers
    public class MediationBannerAdUnit : NSObject
  • Base class for interstitial ads in Mediation API.

    See more

    Declaration

    Swift

    @objcMembers
    public class MediationBaseInterstitialAdUnit : 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.

    See more

    Declaration

    Swift

    @objcMembers
    public class MediationInterstitialAdUnit : MediationBaseInterstitialAdUnit
  • 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

    Declaration

    Swift

    @objcMembers
    public class MediationNativeAdUnit : 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.

    See more

    Declaration

    Swift

    @objcMembers
    public class MediationRewardedAdUnit : MediationBaseInterstitialAdUnit