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

    • Description

      idThe original ID provided in the bid request.Required
      seatbidSee seat bid objectRequired
      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.

      		Optional
      cur
      		Required

      Seat Bid Object

        • Description

          bidSee bid objectRequired
          seat

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

          Optional but highly recommended

          Bid Object

            • Description

              FieldLogicFrequency of Field
              id


              		Required
              impidID must be matched to the ID of the imp object in the bid request.Required
              priceBidding price of the bid. FreeWheel will check against with open exchange or deals' pricing set up.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.

              		Optional but highly recommended
              nurl

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

              		Optional
              adm

              Ad markup in VAST XML format.

              		Required
              adomain

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

              		Optional but highly recommended
              lurl (v2.5)

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

              		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.

              		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.

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



              You are evaluating Refined.
              Back to Top