Equativ provides an OpenRTB API for suppliers which is able to receive OpenRTB bid requests. Equativ then runs an auction for each request so Equativ’s demand partners can bid on the opportunity. This guide contains the bid response specification.
BidResponse object
OpenRTB field
Data type
Description
cur
STRING
The bid currency using ISO-4217 alphabetic codes; default value: USD.
ext
DICTIONARY
An extension containing the feedback_token required for the feedback signal used for optimization of the bidding strategy towards DSPs.
id
INTEGER
The ID of the corresponding bid request.
nbr
STRING
The reason for not bidding.
seatbid
OBJECT ARRAY
A list of seatbid objects.
bidresponse.ext object
OpenRTB field
Data type
Description
dealtype
STRING
Defines the type of deal; possible values: GuaranteedDeal, AuctionPackage, DirectDeal, PrivateAuction; not sent in case of open auctions
feedback_token
STRING
A unique identifier of the bid referring to the feedback_token field of the ext.bid_feedback object of the bid request; sent only in case the feature is activated
impression_tracking_url
STRING
An array of impression pixels. If activated, Equativ pushes its impression pixel (along with the burl of Equativ’s demand partners) in this array of pixels to be triggered in order to reduce impression discrepancies. This feature is for banner inventory and available upon request only.
An array of bid objects; each bid object relates to an imp object in the bid request. If supported by an exchange, one imp object can have multiple bid objects.
seat
STRING
The ID of the bidder seat on whose behalf this bid is made.
Bid object
OpenRTB field
Data type
Description
adomain
STRING ARRAY
The advertiser’s primary/top-level domain for block list 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.
adm
STRING
The actual ad markup.
XHTML in case of a response to a banner object
VAST XML in case of a response to a video object
burl
STRING
Activated at the request of the caller only when relevant circumstances apply, such as 3D in-game inventory. A billing notice URL called by the exchange when a winning bid becomes billable based on exchange-specific business policy (typically delivered, viewed, etc.).
cid
STRING
The campaign ID or similar that appears within the ad markup.
crid
STRING
The creative ID for the purpose of reporting content issues or defects. It can be used as a reference to a creative ID that is posted with an exchange.
dealid
STRING
A reference to a deal that was sold by Equativ to a buying partner.
ext
OBJECT
A placeholder for exchange-specific extensions to OpenRTB.
h
INTEGER
The height of the creative in device independent pixels (DIPS).
id
STRING
The ID for the bid object chosen by the bidder, for tracking and debugging purposes. Useful when multiple bids are submitted for a single impression for a given seat.
impid
STRING
The ID of the imp object to which this bid applies.
lurl
STRING
The loss notification URL containing the macros ${AUCTION_MIN_TO_WIN} and ${AUCTION_LOSS} which represent the winning price of the auction.
mtype
INTEGER
The type of the creative markup so that it can properly be associated with the right sub-object of the BidRequest.Imp. Values:
1 - Banner
2 - Video
3 - Audio
4 - Native
nurl
STRING
The win notification URL containing the macro ${AUCTION_MIN_TO_WIN} which represents the second price of an auction.
price
FLOAT
The bid price as a CPM. Although the data type of this value is FLOAT, OpenRTB strongly recommends using INTEGER math for accounting to avoid rounding errors.
w
INTEGER
The width of the creative in device independent pixels (DIPS).
bid.ext object
OpenRTB field
Data type
Description
dsa
OBJECT
The DSA transparency information
ext.dsa object
OpenRTB field
Data type
Description
adrender
INTEGER
A flag to indicate that buyer/advertiser will render their own DSA transparency information inside the creative.
0 - buyer/advertiser will not render
1 - buyer/advertiser will render
behalf
STRING
The advertiser transparency: Free UNICODE text string with a name of whose behalf the ad is displayed. Maximum 100 characters.
paid
STRING
The advertiser transparency: Free UNICODE text string of who paid for the ad. Must always be included even if it's the same as what is listed in the behalf attribute. Maximum 100 characters.
transparency
OBJECT ARRAY
An array of objects of the entities that applied user parameters and the parameters they applied.
dsa.transparency object
OpenRTB field
Data type
Description
domain
STRING
The domain of the entity that applied user parameters.
dsaparams
INTEGER ARRAY
An array of buy-side applied user parameter targeting (using the list provided by DSA Transparency Taskforce). Include support for multiple vendors who may add their own user-targeting parameters.
