KEkevel
OpenRTB 2.x

Wrapper for the openrtb2 endpoint that initializes the task local log where we store request

Wrapper for the openrtb2 endpoint that initializes the task local log where we store request and response information. This version of the endpoint is meant for unauthenticated use, e.g. in a web browser. Keeping public/authenticated URLs separate should let us better deal with invalid traffic and maintaining QoS. Note: we aren't yet doing authentication on the other endpoint.

post/openrtb2

Request

  • Base URL
    https://e.relay.bid/x/v1
  • URL
    https://e.relay.bid/x/v1/openrtb2
  • Auth
    API key in header x-relay-secret

Request body

allimpsinteger nullable

Flag to indicate if Exchange can verify that the impressions offered represent all of the impressions available in context (e.g., all on the web page, all video spots such as pre/mid/post roll) to support road-blocking. 0 = no or unknown, 1 = yes, the impressions offered represent all that are available.

atinteger nullable

Auction type, where 1 = First Price, 2 = Second Price Plus. Exchange-specific auction types can be defined using values greater than 500.

badvstring[] nullable

Block list of advertisers by their domains (e.g., “ford.com”).

bappstring[] nullable

Block list of applications by their platform-specific exchangeindependent application identifiers. On Android, these should be bundle or package names (e.g., com.foo.mygame). On iOS, these are numeric IDs.

bcatstring[] nullable

Blocked advertiser categories using the IAB content categories.

bseatstring[] nullable

Block list of buyer seats (e.g., advertisers, agencies) restricted from bidding on this impression. IDs of seats and knowledge of the buyer’s customers to which they refer must be coordinated between bidders and the exchange a priori. At most, only one of wseat and bseat should be used in the same request. Omission of both implies no seat restrictions.

curstring[] nullable

Array of allowed currencies for bids on this bid request using ISO-4217 alpha codes. Recommended only if the exchange accepts multiple currencies.

idstring required

Unique ID of the bid request, provided by the exchange.

testinteger nullable

Indicator of test mode in which auctions are not billable, where 0 = live mode, 1 = test mode.

tmaxinteger nullable

Maximum time in milliseconds the exchange allows for bids to be received including Internet latency to avoid timeout. This value supersedes any a priori guidance from the exchange.

wlangstring[] nullable

White list of languages for creatives using ISO-639-1-alpha-2. Omission implies no specific restrictions, but buyers would be advised to consider language attribute in the Device and/or Content objects if available.

wseatstring[] nullable

White list of buyer seats (e.g., advertisers, agencies) allowed to bid on this impression. IDs of seats and knowledge of the buyer’s customers to which they refer must be coordinated between bidders and the exchange a priori. At most, only one of wseat and bseat should be used in the same request. Omission of both implies no seat restrictions.

Response

Bid received.

bididstring nullable

Bidder generated response ID to assist with logging/tracking.

curstring nullable

Bid currency using ISO-4217 alpha codes.

customdatastring nullable

Optional feature to allow a bidder to set data in the exchange’s cookie. The string must be in base85 cookie safe characters and be in any format. Proper JSON encoding must be used to include “escaped” quotation marks.

extunknown
idstring required

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

nbrinteger nullable

Reason for not bidding.

Changes

No recorded changes to this operation across all 1 revision of this API.