Bid Request

format*

array or objects

An array of format objects, see Format Object, denoting the alternative sizes that may be used for bidding. If one of the alternative ad sizes is used in the bid response, then the seatbid.bid.h and seatbid.bid.w fields are required in the bid response.

w

integer

Width of the impression in pixels, for example, 300

h

integer

Height of the impression in pixels, for example 250

battr*

array of integers

Blocked creative attributes as defined in the OpenRTB protocol, for example, [1, 23]

btype*

array of integers

Blocked banner ad types as defined in the OpenRTB protocol, for example, [4, 21]

pos*

integer

Ad Position as defined in the OpenRTB protocol, for example, 1

topframe*

integer

Indicates if the banner is in the top frame as opposed to an iframe.

• 0 = no

• 1 = yes.

mimes*

array of strings

Specifies the content MIME types supported, common MIME types include "text/html", "application/x-shockwave-flash", and "image/gif". For example:

[ "video/mp4", "image/jpg"]

expdir*

array of integers

Possible expansion directions for an expandable ad, for example, [2,5]. This can take the following values:

• 1: Left

• 2: Right

• 3: Up

• 4: Down

• 5: Full screen

If the field is not present, expandable creatives are not allowed.

api*

array of integers

List of supported API frameworks for this impression as defined in the OpenRTB, for example [3, 5]. If an API is not explicitly listed, it is assumed not to be supported.

id*

string

Unique identifier for this banner object. When Banner objects are used with a Video object to represent an array of companion ads. Values usually start at 1 and increase with each object; values unique within an impression.

vcm*

integer

Relevant only for Banner objects used with a Video object in an array of companion ads. Indicates the companion banner rendering mode relative to the associated video, where 0 = concurrent, 1 = end-card.