Table of Contents


Overview

OpenRTB is the standardized language of communication between SSPs and DSPs. It is used as the format of requests and responses when conducting bids in real-time using a near-instantaneous online auction. OpenRTB also allows for targeting based on precise demographics, whereas traditional buying and selling is often more broadly targeted.

Freewheel's Programmatic module communicates with DSPs using the OpenRTB protocol as defined by the IAB, either version 2.2, 2.5, or 2.6 (depending on specific DSP configurations).

This documents explains what values Freewheel passes for the different fields in the OpenRTB specification for bid requests (as well as values FreeWheel consumes in the OpenRTB bid responses), whether the value can be set by clients, and the logic for setting the values. In case of questions, please reach out to your MRM account team.

Any fields not listed in the tables below are not supported by FreeWheel

Bid Response Object

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

FieldLogicDescriptionFrequency of Field
idThe original ID provided in the bid request.

ID of the bid request to which this is a response.

Required
seatbidSee seat bid object

Array of seatbid objects; 1+ required if a bid is to be made.

See seat bid object

Required
bidid

There is no validation against this field. However, this field will be used as a component to generate a uniqueId field in the ad response.

Bidder-generated response ID to assist with logging/tracking.

Optional
cur

Bid currency using ISO-4217 alpha codes. Must be one of the allowed currencies specified in the bid request.

Required

Seat Bid Object

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

FieldLogicDescriptionFrequency of Field
bidSee bid object

Array of 1+ Bid objects each related to an impression. Multiple bids can relate to the same impression.

See bid object

Required
seat

FreeWheel will validate the buyer list configured on open exchange as well as deals for the bid request.

ID of the buyer seat (e.g., advertiser, agency) on whose behalf this bid is made. 

  1. If bid request specifies specific seat(s) in wseat field, the returned seat here should be in the original wseat list. Otherwise the bid will be filtered out. 
  2. If bid request specifies empty wseat field, it means any seat can bid into that deal or impression in Open Auction. 

Optional but highly recommended

Bid Object

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

FieldLogicDescriptionFrequency of Field
id


Bidder generated bid ID to assist with logging/tracking.

If not present, FreeWheel will filter out the bid.

Required
impidID must be matched to the ID of the imp object in the bid request.

ID of the Imp object in the related bid request. 

Required
priceBidding price of the bid. FreeWheel will check against with open exchange or deals' pricing set up.

Bid price expressed as CPM although the actual transaction is for a unit impression only. 

Required
adid

Used as a component to generate External ID (dspid:cid:adid:crid) of the programmatic creative. If the DSP sends an empty value for this field, then adid will use 0 when generating the External ID for the programmatic creative.

A unique ID of the ad from the bidder.

Optional but highly recommended
nurl

FreeWheel will ping nurl pixel when the bid won (/selected).

Win notice URL called by the exchange if the bid wins (not indicative of a delivered, viewed, or billable ad).

Optional
adm

Ad markup in VAST XML format.

Convey ad markup.

Required
adomain

FreeWheel only uses the first domain to detect advertiser/industry/brand information for the programmatic creative.

Advertiser domain for block list checking (e.g., “ford.com”). This can be an array in the case of rotating creatives. FreeWheel only uses the first domain.Optional but highly recommended
lurl (v2.5)

FreeWheel will ping lurl pixel when the bid loses in ad decisioning. 

Loss notice URL called by FreeWheel when a bid is known to have been lost.

FreeWheel supports the ${AUCTION_LOSS} macro (OpenRTB2.5 only). Code supported (IAB compliant):

INTERNAL_ERROR(1),(tick)
INVALID_BID_RESPONSE(3),(tick)
INVALID_DEAL_ID(4),(tick)
MISSING_MARKUP(7),
MISSING_CREATIVE_ID(8),(tick)
MISSING_BID_PRICE(9),(tick)
BID_WAS_BELOW_DEAL_FLOOR(101),
CREATIVE_FILTERED_GENERAL(200),(tick)

CREATIVE_FILTERED_PENDING(201),(tick)

CREATIVE_FILTERED_DISAPPROVED_BY_EXCHANGE(202),(tick)
CREATIVE_FILTERED_INCORRECT_CREATIVE_FORMAT(204),(tick)
CREATIVE_FILTERED_NOT_SECURE(207),(tick)
CREATIVE_FILTERED_ANIMATION_TOO_LONG(212)(tick)

Optional
cid

Used as a component to generate External ID (dspid:cid:adid:crid) of the programmatic creative. If the DSP sends an empty value for this field, then cid will use 0 when generating the External ID for the programmatic creative.

Campaign ID of the ad.

Optional but highly recommended
crid

Used as a component to generate External ID (dspid:cid:adid:crid) of the programmatic creative. If the DSP sends an empty value for this field, then crid will use 0 when generating the External ID for the programmatic creative.

Creative ID of the ad.

Optional but highly recommended
dealid
  1. If bid request's private_auction is "1", it means only deal is allowed and open exchange is not allowed for this bid request. Every bid in the bid response must contain dealid that matches to the deal ID list in bid request.
  2. If bid request's private_auction is "0", it means both deal and open exchange is allowed for this bid request. 
    1. If the bid doesn't contain dealid, it means the bid is bidding towards open exchange. FreeWheel will validate bid with the open exchange specified in the bid request.
    2. If the bid contain dealid, it means the bid is bidding towards deal in the deal list of the bid request. dealid must match the deal ID list in the bid request.
      1. If the bid contain dealid, however, there is no deal ID at all in the bid request, the bid will be filtered out.

Reference to the deal.id from the bid request if this bid pertains to a private marketplace direct deal. 

Optional



You are evaluating Refined.
Back to Top