Banner Object¶
Note
Fields marked with asterisk (*) are optional.
Parameter
|
Type
|
Description
|
---|---|---|
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 |
format* |
array of objects |
An array of format objects, see Format Object, denoting the alternative sizes that may be used for bidding. |
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. |
Banner Object Example¶
{
"banner":{
"w":300,
"h":250,
"pos":1,
"topframe":0,
"btype":[
2,
3
],
"mimes":[
"text/html",
"application/x-shockwave-flash"
],
"format":[
{
"h":50,
"w":300
}
]
}
}