Prebid

@objcMembers
public class Prebid : NSObject

Undocumented

Public Properties (SDK)


                    
                    
                    bidderNameAppNexus

Undocumented

Declaration

Swift

public static let bidderNameAppNexus: String


                    
                    
                    bidderNameRubiconProject

Undocumented

Declaration

Swift

public static let bidderNameRubiconProject: String

timeoutUpdated
Undocumented
Declaration
Swift

public var timeoutUpdated: Bool
prebidServerAccountId
Undocumented
Declaration
Swift

public var prebidServerAccountId: String
pbsDebug
Undocumented
Declaration
Swift

public var pbsDebug: Bool


                    
                    
                    customHeaders

Undocumented

Declaration

Swift

public var customHeaders: [String : String]


                    
                    
                    storedBidResponses

Undocumented

Declaration

Swift

public var storedBidResponses: [String : String]

shouldAssignNativeAssetID
This property is set by the developer when he is willing to assign the assetID for Native ad.
Declaration
Swift

public var shouldAssignNativeAssetID: Bool
shareGeoLocation
This property is set by the developer when he is willing to share the location for better ad targeting
Declaration
Swift

public var shareGeoLocation: Bool
logLevel
Set the desidered verbosity of the logs
Declaration
Swift

public var logLevel: LogLevel { get set }
externalUserIdArray
Array containing objects that hold External UserId parameters.
Declaration
Swift

public var externalUserIdArray: [ExternalUserId]
shared
Undocumented
Declaration
Swift

public static let shared: Prebid
version
Undocumented
Declaration
Swift

public var version: String { get }
omsdkVersion
Undocumented
Declaration
Swift

public var omsdkVersion: String { get }

Public Properties (Prebid)


                    
                    
                    prebidServerHost

Undocumented

Declaration

Swift

public var prebidServerHost: PrebidHost { get set }


                    
                    
                    customStatusEndpoint

Undocumented

Declaration

Swift

public var customStatusEndpoint: String? { get set }


                    
                    
                    timeoutMillis

Undocumented

Declaration

Swift

public var timeoutMillis: Int { get set }

timeoutMillisDynamic
Undocumented
Declaration
Swift

public var timeoutMillisDynamic: NSNumber?
storedAuctionResponse
Undocumented
Declaration
Swift

public var storedAuctionResponse: String?

Public Properties (SDK)

useCacheForReportingWithRenderingAPI
Undocumented
Declaration
Swift

public var useCacheForReportingWithRenderingAPI: Bool


                    
                    
                    creativeFactoryTimeout

Undocumented

Declaration

Swift

public var creativeFactoryTimeout: TimeInterval


                    
                    
                    creativeFactoryTimeoutPreRenderContent

Undocumented

Declaration

Swift

public var creativeFactoryTimeoutPreRenderContent: TimeInterval

useExternalClickthroughBrowser
Undocumented
Declaration
Swift

public var useExternalClickthroughBrowser: Bool


                    
                    
                    impClickbrowserType

Undocumented

Declaration

Swift

public var impClickbrowserType: ClickbrowserType


                    
                    
                    debugLogFileEnabled

Undocumented

Declaration

Swift

public var debugLogFileEnabled: Bool { get set }


                    
                    
                    locationUpdatesEnabled

Undocumented

Declaration

Swift

public var locationUpdatesEnabled: Bool { get set }

includeWinners
Undocumented
Declaration
Swift

public var includeWinners: Bool
includeBidderKeys
Undocumented
Declaration
Swift

public var includeBidderKeys: Bool

Public Methods


                    
                    
                    setCustomPrebidServer(url:)

Undocumented

Declaration

Swift

public func setCustomPrebidServer(url: String) throws

Stored Bid Response


                    
                    
                    addStoredBidResponse(bidder:responseId:)

Undocumented

Declaration

Swift

public func addStoredBidResponse(bidder: String, responseId: String)

clearStoredBidResponses()
Undocumented
Declaration
Swift

public func clearStoredBidResponses()


                    
                    
                    getStoredBidResponses()

Undocumented

Declaration

Swift

public func getStoredBidResponses() -> [[String : String]]?

Custom Headers


                    
                    
                    addCustomHeader(name:value:)

Undocumented

Declaration

Swift

public func addCustomHeader(name: String, value: String)

clearCustomHeaders()
Undocumented
Declaration
Swift

public func clearCustomHeaders()


                    
                    
                    initializeSDK(_:_:)

Initializes PrebidMobile SDK.

Checks the status of Prebid Server. The customStatusEndpoint property is used as server status endpoint. If customStatusEndpoint property is not provided, the SDK will use default endpoint - host + /status. The host value is obtained from Prebid.shared.prebidServerHost.

Checks the version of GMA SDK. If the version is not supported - logs warning.

Use this SDK initializer if you’re using PrebidMobile with GMA SDK.

Declaration

Swift

public static func initializeSDK(_ gadMobileAdsObject: AnyObject? = nil, _ completion: PrebidInitializationCallback? = nil)

Parameters

`gadMobileAdsObject`	GADMobileAds object
`completion`	returns initialization status and optional error


                    
                    
                    initializeSDK(gadMobileAdsVersion:_:)

Initializes PrebidMobile SDK.

Checks the version of GMA SDK. If the version is not supported - logs warning.

Use this SDK initializer if you’re using PrebidMobile with GMA SDK.

Declaration

Swift

public static func initializeSDK(gadMobileAdsVersion: String? = nil, _ completion: PrebidInitializationCallback? = nil)

Parameters

`gadMobileAdsVersion`	GADMobileAds version string, use `GADGetStringFromVersionNumber(GADMobileAds.sharedInstance().versionNumber)` to get it
`completion`	returns initialization status and optional error


                    
                    
                    initializeSDK(_:)

Initializes PrebidMobile SDK.

Use this SDK initializer if you’re using PrebidMobile without GMA SDK.

Declaration

Swift

public static func initializeSDK(_ completion: PrebidInitializationCallback? = nil)

Parameters


                                completion

returns initialization status and optional error