NimbusImpression

struct NimbusImpression
extension NimbusImpression : Decodable, Encodable, Equatable, NimbusRequestExtensible

This object describes an ad placement or impression being auctioned. A single bid request can include multiple NimbusImpression objects, a use case for which might be an exchange that supports selling all ad positions on a given page. Each NimbusImpression object has a required ID so that bids can reference them individually. The presence of NimbusImpressionBanner or NimbusImpressionVideo objects subordinate to the NimbusImpression object indicates the type of impression being offered. The publisher can choose one such type which is the typical case or mix them at their discretion. However, any given bid for the impression must conform to one of the offered types. OpenRTB Section 3.2.4

  • id

    A unique identifier for this impression within the context of the bid request (typically, starts with 1 and increments). This is optional as only one NimbusImpression object is currently supported

    Declaration

    Swift

    var id: String?

  • Required if this impression is offered as a banner ad opportunity or is used in the Nimbus hybrid auction

    Declaration

    Swift

    var banner: NimbusBanner?

  • Required if this impression is offered as a video ad opportunity or is used in Nimbus hybrid auction

    Declaration

    Swift

    var video: NimbusVideo?

  • Required if this impression is offered as a native ad opportunity

    Declaration

    Swift

    var native: NimbusNative?

  • Whether the ad is interstitial (and/or fullscreen) or not

    Declaration

    Swift

    var isInterstitial: Bool?

  • Indicates if the impression requires secure HTTPS URL creative assets and markup. If this is omitted, all requests will default to HTTPS

    Declaration

    Swift

    var requiresSecure: Bool?

  • Placeholder for exchange-specific extensions to OpenRTB

    Declaration

    Swift

    var extensions: [String : NimbusCodable]?

  • Initializes a NimbusImpression object

    • id: A unique identifier for this impression within the context of the bid request (typically, starts with 1 and increments). This is optional as only one NimbusImpression object is currently supported
    • banner: Required if this impression is offered as a banner ad opportunity or is used in the Nimbus hybrid auction
    • native: Required if this impression is offered as a native ad opportunity
    • video: Required if this impression is offered as a video ad opportunity or is used in Nimbus hybrid auction
    • isInterstitial: Whether the ad is interstitial (and/or fullscreen) or not
    • bidFloor: Minimum bid for this impression expressed in CPM
    • requiresSecure: Indicates if the impression requires secure HTTPS URL creative assets and markup. If this is omitted, all requests will default to HTTPS

    Declaration

    Swift

    init(id: String? = nil, banner: NimbusBanner? = nil, video: NimbusVideo? = nil, native: NimbusNative? = nil, isInterstitial: Bool? = nil, requiresSecure: Bool? = nil)

    Parameters

    id

    A unique identifier for this impression within the context of the bid request (typically, starts with 1 and increments). This is optional as only one NimbusImpression object is currently supported
    banner

    Required if this impression is offered as a banner ad opportunity or is used in the Nimbus hybrid auction
    video

    Required if this impression is offered as a video ad opportunity or is used in Nimbus hybrid auction
    native

    Required if this impression is offered as a native ad opportunity
    isInterstitial

    Whether the ad is interstitial (and/or fullscreen) or not
    requiresSecure

    Indicates if the impression requires secure HTTPS URL creative assets and markup. If this is omitted, all requests will default to HTTPS

  • Required string identifying the name of the placement that will be displayed on the Nimbus dashboard This maps to imp.ext.position

    Declaration

    Swift

    var position: String? { get set }

  • Returns a Boolean value indicating whether two values are not equal.

    Inequality is the inverse of equality. For any values a and b, a != b implies that a == b is false.

    This is the default implementation of the not-equal-to operator (!=) for any type that conforms to Equatable.

    Declaration

    Swift

    static func != (lhs: Self, rhs: Self) -> Bool

    Parameters

    lhs

    A value to compare.
    rhs

    Another value to compare.