```
public final class Banner

                    
```
This object represents the most general type of impression. Although the term “banner” may have very specific meaning in other contexts, here it can be many things including a simple static image, an expandable ad unit, or even in-banner video

Field Summary

Fields
Modifier and Type	Field	Description
`private String`	`id`
`private Array<Format>`	`formats`
`private Integer`	`width`
`private Integer`	`height`
`private BannerAdType`	`blocked`
`private Array<CreativeAttribute>`	`attributes`
`private AdPosition`	`position`
`private Array<String>`	`mines`
`private Integer`	`topFrame`
`private Array<ExpandableDirection>`	`expandableDirection`
`private Array<ApiFramework>`	`apis`
`private VideoCompanion`	`videoCompanion`
`private Object`	`extension`

Constructor Summary

Constructors
Constructor	Description
`Banner()`

Method Summary

Modifier and Type	Method	Description
`final String`	`getId()`
`final Unit`	`setId(@SerializedName(value = id) String id)`
`final Array<Format>`	`getFormats()`	Array of format objects representing the banner sizes permitted.
`final Unit`	`setFormats(@SerializedName(value = format) Array<Format> formats)`	Array of format objects representing the banner sizes permitted.
`final Integer`	`getWidth()`	Exact width in device independent pixels (DIPS); recommended if no format objects are specified.
`final Unit`	`setWidth(@SerializedName(value = w) Integer width)`	Exact width in device independent pixels (DIPS); recommended if no format objects are specified.
`final Integer`	`getHeight()`	Exact height in device independent pixels (DIPS); recommended if no format objects are specified.
`final Unit`	`setHeight(@SerializedName(value = h) Integer height)`	Exact height in device independent pixels (DIPS); recommended if no format objects are specified.
`final BannerAdType`	`getBlocked()`	Blocked banner ad types.
`final Unit`	`setBlocked(@SerializedName(value = btype) BannerAdType blocked)`	Blocked banner ad types.
`final Array<CreativeAttribute>`	`getAttributes()`	Blocked creative attributes
`final Unit`	`setAttributes(@SerializedName(value = battr) Array<CreativeAttribute> attributes)`	Blocked creative attributes
`final AdPosition`	`getPosition()`	Ad position on screen.
`final Unit`	`setPosition(@SerializedName(value = pos) AdPosition position)`	Ad position on screen.
`final Array<String>`	`getMines()`	Content MIME types supported.
`final Unit`	`setMines(@SerializedName(value = mines) Array<String> mines)`	Content MIME types supported.
`final Integer`	`getTopFrame()`	Indicates if the banner is in the top frame as opposed to an iframe, where 0 = no, 1 = yes.
`final Unit`	`setTopFrame(@SerializedName(value = topframe) Integer topFrame)`	Indicates if the banner is in the top frame as opposed to an iframe, where 0 = no, 1 = yes.
`final Array<ExpandableDirection>`	`getExpandableDirection()`	Directions in which the banner may expand.
`final Unit`	`setExpandableDirection(@SerializedName(value = expdir) Array<ExpandableDirection> expandableDirection)`	Directions in which the banner may expand.
`final Array<ApiFramework>`	`getApis()`	List of supported ApiFramework for this impression.
`final Unit`	`setApis(@SerializedName(value = api) Array<ApiFramework> apis)`	List of supported ApiFramework for this impression.
`final VideoCompanion`	`getVideoCompanion()`	Relevant only for Banner objects used with a Video object
`final Unit`	`setVideoCompanion(@SerializedName(value = vcm) VideoCompanion videoCompanion)`	Relevant only for Banner objects used with a Video object
`final Object`	`getExtension()`	Placeholder for exchange-specific extensions to OpenRTB.
`final Unit`	`setExtension(@SerializedName(value = ext) Object extension)`	Placeholder for exchange-specific extensions to OpenRTB.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Banner
```
Banner()
```
- Method Detail
  - getId
```
 final String getId()
```
  - setId
```
 final Unit setId(@SerializedName(value = id) String id)
```
  - getFormats
```
 final Array<Format> getFormats()
```
    Array of format objects representing the banner sizes permitted. If none are specified, then use of the h and w attributes is highly recommended.
  - setFormats
```
 final Unit setFormats(@SerializedName(value = format) Array<Format> formats)
```
    Array of format objects representing the banner sizes permitted. If none are specified, then use of the h and w attributes is highly recommended.
  - getWidth
```
 final Integer getWidth()
```
    Exact width in device independent pixels (DIPS); recommended if no format objects are specified.
  - setWidth
```
 final Unit setWidth(@SerializedName(value = w) Integer width)
```
    Exact width in device independent pixels (DIPS); recommended if no format objects are specified.
  - getHeight
```
 final Integer getHeight()
```
    Exact height in device independent pixels (DIPS); recommended if no format objects are specified.
  - setHeight
```
 final Unit setHeight(@SerializedName(value = h) Integer height)
```
    Exact height in device independent pixels (DIPS); recommended if no format objects are specified.
  - getBlocked
```
 final BannerAdType getBlocked()
```
    Blocked banner ad types.
  - setBlocked
```
 final Unit setBlocked(@SerializedName(value = btype) BannerAdType blocked)
```
    Blocked banner ad types.
  - getAttributes
```
 final Array<CreativeAttribute> getAttributes()
```
    Blocked creative attributes
  - setAttributes
```
 final Unit setAttributes(@SerializedName(value = battr) Array<CreativeAttribute> attributes)
```
    Blocked creative attributes
  - getPosition
```
 final AdPosition getPosition()
```
    Ad position on screen.
  - setPosition
```
 final Unit setPosition(@SerializedName(value = pos) AdPosition position)
```
    Ad position on screen.
  - getMines
```
 final Array<String> getMines()
```
    Content MIME types supported. Popular MIME types may include “application/x-shockwave-flash”, “image/jpg”, and “image/gif”.
  - setMines
```
 final Unit setMines(@SerializedName(value = mines) Array<String> mines)
```
    Content MIME types supported. Popular MIME types may include “application/x-shockwave-flash”, “image/jpg”, and “image/gif”.
  - getTopFrame
```
 final Integer getTopFrame()
```
    Indicates if the banner is in the top frame as opposed to an iframe, where 0 = no, 1 = yes.
  - setTopFrame
```
 final Unit setTopFrame(@SerializedName(value = topframe) Integer topFrame)
```
    Indicates if the banner is in the top frame as opposed to an iframe, where 0 = no, 1 = yes.
  - getExpandableDirection
```
 final Array<ExpandableDirection> getExpandableDirection()
```
    Directions in which the banner may expand.
  - setExpandableDirection
```
 final Unit setExpandableDirection(@SerializedName(value = expdir) Array<ExpandableDirection> expandableDirection)
```
    Directions in which the banner may expand.
  - getApis
```
 final Array<ApiFramework> getApis()
```
    List of supported ApiFramework for this impression. If an API is not explicitly listed, it is assumed not to be supported.
  - setApis
```
 final Unit setApis(@SerializedName(value = api) Array<ApiFramework> apis)
```
    List of supported ApiFramework for this impression. If an API is not explicitly listed, it is assumed not to be supported.
  - getVideoCompanion
```
 final VideoCompanion getVideoCompanion()
```
    Relevant only for Banner objects used with a Video object
  - setVideoCompanion
```
 final Unit setVideoCompanion(@SerializedName(value = vcm) VideoCompanion videoCompanion)
```
    Relevant only for Banner objects used with a Video object
  - getExtension
```
 final Object getExtension()
```
    Placeholder for exchange-specific extensions to OpenRTB.
  - setExtension
```
 final Unit setExtension(@SerializedName(value = ext) Object extension)
```
    Placeholder for exchange-specific extensions to OpenRTB.

Class Banner

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Banner

Method Detail

getId

setId

getFormats

setFormats

getWidth

setWidth

getHeight

setHeight

getBlocked

setBlocked

getAttributes

setAttributes

getPosition

setPosition

getMines

setMines

getTopFrame

setTopFrame

getExpandableDirection

setExpandableDirection

getApis

setApis

getVideoCompanion

setVideoCompanion

getExtension

setExtension