Contact support
    • Monetization
    • Developer documentation
    • Connect bidder to Equativ SSP

    Connect bidder to Equativ SSP: supported objects and parameters

    Table of Contents

    Overview Supported objects/parameters - request Bid Request Impression App*** Banner Video Site Publisher Device Geo User PMP Deals displaymanager and displaymanagerver Supported Objects/Parameters - response Bid Response Seat Bid Bid Native Native request Native response

    Overview

    This guide is for Equativ’s demand partners and explains how to use the OpenRTB API, including setup, configuration as well as the supported objects and parameters. This article explains supported bid request and bid response objects and parameters.

    Supported objects/parameters - request

    Fields marked with an * are planned to be supported soon, with ** are only available for mobile devices, with *** are only available in case of a call from a mobile application.

    Bid Request

    • id
    • imp
    • app
    • site
    • device
    • user
    • at
    • tmax
    • cur
    • bcat
    • ext
    • source
    • Regs
      • coppa
      • ext
        • gdpr

    Impression

    • id
    • banner
    • video
    • native
    • tagid
    • bidfloor
    • bidfloorcur,
    • instl
    • pmp
    • secure
    • displaymanager***
    • displaymanagerver***
    • rwdd (for rewarded, as defined in OpenRTB 2.6 final release)

    App***

    • id
    • name
    • bundle
    • storeurl
    • cat
    • pagecat
    • domain
    • Publisher
    • w
    • h
    • format (enabled when activated version is >= 2.4)
      • w
      • h
    • pos
    • mimes
      • Only "text/html" is supported as per Supported Display Scenarios
    • topframe*
    • wmax*
    • wmin*
    • hmax*
    • hmin*
    • expdir*
    • api***

    Video

    • w
    • h
    • protocols
    • maxduration
    • minduration
    • minbitrate
    • maxbitrate
    • linearity
    • mimes
    • startdelay
    • companionad*
    • companiontype*
    • pos
    • battr
    • boxingallowed
    • playbackmethod
    • api
    • placement

    Site

    • id
    • cat
    • name
    • domain
    • pagecat
    • page
    • publisher 

    Publisher

    • id
    • name

    Device

    • dnt
    • ua
    • ip
    • geo
    • dpidsha1***
    • dpidmd5***
    • make**
    • model**
    • os**
    • osv**
    • js*
    • connectiontype**
    • devicetype**
    • carrier**
    • ifa***

    Geo

    • lat
    • lon
    • country
    • region
    • city
    • zip
      • equals to ‘unknown’ when not available
    • type

    User

    • id
    • buyeruid

    PMP

    • private_auction
    • deals

    Deals

    • id
    • bidfloor
    • bidfloorcur
    • wseat
    • at

    displaymanager and displaymanagerver

    For in-app opportunities, the client-side SDK serving the impression is indicated, for example Equativ’s Android 6.9 SDK, as follows:

    imp.displaymanager = "Smart "
imp.displaymanagerver = "6.9"
Device.os = “Android”

    Supported Objects/Parameters - response

    The fields in bold are optional in OpenRTB, but required for Equativ integration

    Bid Response

    • id
    • seatbid
    • cur
      • Bid currency must match that of auction currency announced in request
    • nbr

    Seat Bid

    • seat
    • bid

    Bid

    • id
    • impid
    • price
    • adid / cid / crid
      • Some subset of these IDs must be provided in order to deterministically identify creatives uniquely and repeatedly across auctions
    • w/h
      • Required when bidding on oRTB 2.4/2.5 banner inventory
    • dealid
      • Required only in the case of a bid on a deal
    • Iurl
    • nurl (optional)
    • burl
      • If a bidder uses burl, burl must be sent for 100% of bids, otherwise never.
    • adomain
      • Advertiser’s primary or top-level domain for advertiser checking. This can be a list of domains if there is a rotating creative. However, exchanges may mandate that only one landing domain is allowed.
      • Partners must send a valid primary or top-level domain without slashes, path, query string, etc. See Connect bidder to Equativ SSP: bid request and bid response examples.
      • New adomains will be blocked by default for approximately 1 minute. Partners can provide Equativ with a list of future adomains to anticipate this delay.
    • adm
      • Banner ad
        • At this time, Equativ only supports delivery of ad markup via the adm attribute (instead of delivery via the win notice / nurl attribute). Currently Equativ only supports AdMarkup that is
          • Unencoded, or
          • Encoded using URL encoding.
      • Video ad (VAST)
        • Equativ supports both delivering methods via adm (Inline) and nurl (Wrapper) attributes. Currently Equativ only supports AdMarkup that is
          • Unencoded, or
          • Encoded using URL encoding.
    • mtype

    Native

    Native request

    • ver
    • adunit (1.x)
    • layout (1.x)
    • context (1.2)
      • plcmttype (1.2)
      • eventtrackers (1.2)
    • event (impression)
    • methods (js, img)
    • privacy (1.2)
    • assets
      • title
        • len
      • img
        • type
        • h
        • w
        • hmin
        • wmin
      • data
        • type
        • len
    • id
    • required

    Native response

    • ver
    • assets
      • id
      • title
        • text
      • img
        • url
      • data
        • value
    • link
      • url
    • imptrackers
    • eventtrackers (1.2)
      • event
      • method
      • url
    • privacy (1.2)

    RELATED ARTICLES