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

    Connect bidder to Equativ SSP: supported fields

    Table of Contents

    Overview Related documentation About this reference Bid request object Bid response object Native markup request object Native markup response object

    Overview

    This document contains the open RTB 2.6 fields that Equativ supports in integrations with bidders.

    Related documentation

    This document is for the integration of bidders. For inventory supplier integration, see the following documents:

    About this reference 

    In integrations with bidders, Equativ supports the open RTB 2.6 fields listed in this document. A field is either an object, object array, attribute, or attribute array.

    The tables in this document don't contain the data type of each field. Refer to the official openRTB 2.6 specification for details on the data type.

    Within each table in this document, the column of an object or attribute ("First-level field", “Second-level field” etc.) indicates its position within the hierarchy of objects. For example, the second-level field bundle is an attribute of the first-level app object, which is itself a child object of the BidRequest object.

    Bid request object

    First-level field Second-level field Third-level field Fourth-level field Details*
    allimps        
    app bundle      
    app cat      
    app cattax      
    app content cattax    
    app content contentrating    
    app content genre    
    app content language    
    app content livestream    
    app content userrating    
    app domain      
    app ext inventorypartnerdomain    
    app id      
    app keywords      
    app name      
    app pagecat      
    app paid      
    app privacypolicy      
    app publisher      
    app storeurl      
    at        
    badv        
    banner api     For mobile app inventory only.
    banner expdir      
    banner format h    
    banner format w    
    banner format     Enabled when activated openRTB version is >= 2.4.
    banner h      
    banner hmax      
    banner hmin      
    banner mimes     Only text/html is supported as per Supported Display Scenarios.
    banner pos      
    banner topframe      
    banner w      
    banner wmax      
    banner wmin      
    bcat        
    cattax        
    cur        
    device carrier      
    device connectiontype     For mobile device inventory only.
    device devicetype     For mobile device inventory only.
    device dnt      
    device dpidmd5     For mobile app inventory only.
    device dpidsha1     For mobile app inventory only.
    device ext airplane    
    device ext atts    
    device ext batterylevel    
    device ext batterysaver    
    device ext charging    
    device ext darkmode    
    device ext headset    
    device ext ifa_type    
    device ext ifv    
    device ext ringmute    
    device ext truncated_ip    
    device geo accuracy    
    device geo city    
    device geo country    
    device geo ipservice    
    device geo lat    
    device geo lon    
    device geo metro    
    device geo region    
    device geo type    
    device geo utcoffset    
    device geo zip   Equals to unknown when not available.
    device hwv      
    device ifa     For mobile app inventory only.
    device ip      
    device ipv6      
    device js      
    device language      
    device lmt      
    device make     For mobile device inventory only.
    device mccmnc      
    device model     For mobile device inventory only.
    device os     For mobile device inventory only.
    device osv     For mobile device inventory only.
    device ppi      
    device pxratio      
    device sua bitness    
    device sua browsers brand  
    device sua browsers version  
    device sua mobile    
    device sua platform brand  
    device ua      
    ext equativ integrationType    
    ext fcap_scope      
    ext google_query_id      
    ext hb      
    ext network_id      
    ext prebid channel version  
    ext prebid server datacenter  
    ext prebid server externalurl  
    ext prebid server gvlid  
    ext schain complete    
    ext schain nodes asi  
    ext schain nodes hp  
    ext schain nodes rid  
    ext schain nodes sid  
    id        
    imp banner btype    
    imp bidfloor      
    imp bidfloorcur      
    imp clickbrowser      
    imp displaymanager    

    For mobile app inventory only. Indicates the Equativ client-side SDK version that the publisher is using for this ad opportunity. For example, Equativ’s Android 6.9 SDK is indicated as: imp.displaymanager = "Smart"

    imp.displaymanagerver = “6.9”

    Device.os = “Android”
    imp displaymanagerver    

    For mobile app inventory only. Indicates the Equativ client-side SDK version that the publisher is using for this ad opportunity. For example, Equativ’s Android 6.9 SDK is indicated as: imp.displaymanager = "Smart"

    imp.displaymanagerver = "6.9"

    Device.os = "Android"
    imp ext ae    
    imp ext ampad    
    imp ext auction_environment    
    imp ext bidder formatId  
    imp ext bidder networkId  
    imp ext bidder pageId  
    imp ext bidder siteId  
    imp ext billing_id    
    imp ext creative_enforcement_settings policy_enforcement  
    imp ext creative_enforcement_settings publisher_blocks_enforcement  
    imp ext creative_enforcement_settings scan_enforcement  
    imp ext dfp_ad_unit_code    
    imp ext equativ dsp_based_click_url  
    imp ext gpid    
    imp ext open_bidding is_open_bidding  
    imp ext skadn sourceapp  
    imp ext to    
    imp ext wopv    
    imp id      
    imp instl      
    imp metric vendor    
    imp native request    
    imp pmp deal at  
    imp pmp deal bidfloor  
    imp pmp deal bidfloorcur  
    imp pmp deal id  
    imp pmp deal wseat  
    imp pmp private_auction    
    imp rwdd      
    imp secure      
    imp tagid      
    imp video delivery    
    imp video playbackend    
    imp video plcmt    
    imp video skip    
    regs coppa      
    regs ext consent    
    regs ext gdpr    
    regs ext gpp    
    regs ext gpp_sid    
    regs ext us_privacy    
    regs gpp      
    regs gpp_sid      
    site cat      
    site cattax      
    site content cattax    
    site content language    
    site content livestream    
    site domain      
    site ext amp    
    site ext inventorypartnerdomain    
    site ext ntype    
    site ext page_visibility    
    site id      
    site keywords      
    site mobile      
    site name      
    site page      
    site pagecat      
    site publisher id    
    site publisher name    
    site ref      
    source ext omidpn    
    source ext omidpv    
    source ext schain    
    source fd      
    source pchain      
    source schain complete    
    source schain nodes asi  
    source schain nodes hp  
    source schain nodes rid  
    source schain nodes sid  
    source tid      
    tmax        
    user buyeruid      
    user consent      
    user customdata      
    user eids uids atype  
    user ext consent    
    user ext consented_providers_settings consented_providers  
    user ext eids inserter  
    user ext eids mm  
    user ext eids uids.ext.linkType  
    user ext eids uids.ext.pba  
    user ext eids uids.ext.rtiPartner  
    user ext eids uids.ext.stype  
    user ext eids uids.id  
    user ext idage    
    user ext sessionduration    
    user id      
    video api      
    video battr      
    video boxingallowed      
    video companionad      
    video companiontype      
    video h      
    video linearity      
    video maxbitrate      
    video maxduration      
    video mimes      
    video minbitrate      
    video minduration      
    video placement      
    video playbackmethod      
    video pos      
    video protocols      
    video startdelay      
    video w      

    * Fields without any details are supported according to the official openRTB 2.6 specification.

    Bid response object

    First-level field Second-level field Third-level field Details*
    cur     The bid currency. It must match the auction currency announced in the request.
    id      
    nbr      
    seatbid bid adid Optional in openRTB but required for Equativ integration.
    seatbid bid adm

    Banner ads:

    Equativ only supports delivery of ad markup via the adm attribute, instead of delivery via the win notice / nurl attribute. Equativ only supports AdMarkup that is unencoded, or encoded using URL encoding.

    Video ads (VAST):

    Equativ supports both delivery methods via the adm (Inline) and nurl (Wrapper) attributes. Equativ only supports AdMarkup that is unencoded, or encoded using URL encoding.
    seatbid bid adomain

    The 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.

    By default, new adomains will be blocked for approximately 1 minute. Partners can provide Equativ with a list of future adomains to anticipate this delay.

    Optional in openRTB but required for Equativ integration.
    seatbid bid burl

    If a bidder uses burl, then burl must be sent for 100% of bids, otherwise never.

    Optional in openRTB but required for Equativ integration.
    seatbid bid cid Optional in openRTB but required for Equativ integration.
    seatbid bid crid Optional in openRTB but required for Equativ integration.
    seatbid bid dealid Required only in case of a bid on a deal.
    seatbid bid h Optional in openRTB but required for Equativ integration.
    seatbid bid id  
    seatbid bid impid  
    seatbid bid Iurl  
    seatbid bid mtype  
    seatbid bid nurl Optional.
    seatbid bid price  
    seatbid bid w Optional in openRTB but required for Equativ integration.
    seatbid seat   Optional in openRTB but required for Equativ integration.

    * Fields without any details are supported according to the official openRTB 2.6 specification.

    Native markup request object

    First-level field Second-level field Third-level field Fourth-level field Details*
    adunit        
    assets data type len  
    assets id      
    assets img h    
    assets img hmin    
    assets img type    
    assets img w    
    assets img wmin    
    assets required      
    assets title len    
    context        
    eventtrackers event     For impression.
    eventtrackers methods     For js, img.
    layout        
    plcmttype        
    privacy        
    ver        

    * Fields without any details are supported according to the official openRTB 2.6 specification.

    Native markup response object

    First-level field Second-level field Third-level field
    assets data value
    assets id  
    assets img url
    assets link url
    assets title text
    eventtrackers event  
    eventtrackers method url
    imptrackers    
    privacy    
    ver    

    RELATED ARTICLES