PrebidRequest

@objcMembers
public class PrebidRequest : NSObject

Class that contains properties and methods to configure Prebid request.

Public properties

  • The position of the ad on the screen.

    Declaration

    Swift

    public var adPosition: AdPosition

SKAdNetwork

  • A flag that determines whether SKOverlay should be supported for interstitials

    Declaration

    Swift

    public var supportSKOverlayForInterstitial: Bool

Internal properties

  • Initializes a new PrebidRequest with the given parameters.

    Declaration

    Swift

    public init(
    bannerParameters: BannerParameters? = nil,
    videoParameters: VideoParameters? = nil,
    nativeParameters: NativeParameters? = nil,
    isInterstitial: Bool = false,
    isRewarded: Bool = false
)

    Parameters

    bannerParameters

    The banner parameters for the ad request.
    videoParameters

    The video parameters for the ad request.
    nativeParameters

    The native parameters for the ad request.
    isInterstitial

    Indicates if the request is for an interstitial ad.
    isRewarded

    Indicates if the request is for a rewarded ad.

GPID

  • Sets the GPID for the ad request.

    Declaration

    Swift

    public func setGPID(_ gpid: String?)

    Parameters

    gpid

    The GPID to set.

Arbitrary ORTB Configuration

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

    Declaration

    Swift

    public func setImpORTBConfig(_ ortbConfig: String?)

    Parameters

    ortbConfig

    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?

  • Sets the global OpenRTB configuration string for the ad unit. It takes precedence over Targeting.setGlobalOrtbConfig.

    Declaration

    Swift

    public func setGlobalORTBConfig(_ ortbConfig: String?)

    Parameters

    ortbConfig

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

  • Returns the global OpenRTB configuration string.

    Declaration

    Swift

    public func getGlobalORTBConfig() -> String?