```
public final class Bid

                    
```
A SeatBid object contains one or more Bid objects, each of which relates to a specific impression in the bid request via the impid attribute and constitutes an offer to buy that impression for a given price.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public final class`	`Bid.Extension`

Field Summary

Fields
Modifier and Type	Field	Description
`private String`	`requestId`
`private String`	`winUrl`
`private String`	`billUrl`
`private String`	`lossUrl`
`private String`	`adMarkup`
`private String`	`preloadedAdId`
`private Array<String>`	`advertiserDomains`
`private String`	`bundle`
`private String`	`imageUrl`
`private String`	`campaignId`
`private String`	`creativeId`
`private String`	`tacticId`
`private Array<String>`	`categories`
`private Array<CreativeAttribute>`	`attributes`
`private ApiFramework`	`api`
`private Integer`	`protocol`
`private MediaRating`	`mediaRating`
`private String`	`language`
`private String`	`dealId`
`private Integer`	`width`
`private Integer`	`height`
`private Integer`	`widthRatio`
`private Integer`	`heightRatio`
`private Integer`	`expired`
`private Bid.Extension`	`extension`
`private final String`	`id`
`private final String`	`impressionId`
`private final Float`	`price`

Constructor Summary

Constructors
Constructor	Description
`Bid(String id, String impressionId, Float price)`

Method Summary

Modifier and Type	Method	Description
`final String`	`getRequestId()`
`final Unit`	`setRequestId(String requestId)`
`final String`	`getWinUrl()`	Win notice URL called by the exchange if the bid wins (not necessarily indicative of a delivered, viewed, or billable ad); optional means of serving ad markup.
`final Unit`	`setWinUrl(@SerializedName(value = nurl) String winUrl)`	Win notice URL called by the exchange if the bid wins (not necessarily indicative of a delivered, viewed, or billable ad); optional means of serving ad markup.
`final String`	`getBillUrl()`	Billing notice URL called by the exchange when a winning bid becomes billable based on exchange-specific business policy (e.g., typically delivered, viewed, etc.
`final Unit`	`setBillUrl(@SerializedName(value = burl) String billUrl)`	Billing notice URL called by the exchange when a winning bid becomes billable based on exchange-specific business policy (e.g., typically delivered, viewed, etc.
`final String`	`getLossUrl()`	Loss notice URL called by the exchange when a bid is known to have been lost.
`final Unit`	`setLossUrl(@SerializedName(value = lurl) String lossUrl)`	Loss notice URL called by the exchange when a bid is known to have been lost.
`final String`	`getAdMarkup()`	Optional means of conveying ad markup in case the bid wins; supersedes the win notice if markup is included in both.
`final Unit`	`setAdMarkup(@SerializedName(value = adm) String adMarkup)`	Optional means of conveying ad markup in case the bid wins; supersedes the win notice if markup is included in both.
`final String`	`getPreloadedAdId()`	ID of a preloaded ad to be served if the bid wins.
`final Unit`	`setPreloadedAdId(@SerializedName(value = adid) String preloadedAdId)`	ID of a preloaded ad to be served if the bid wins.
`final Array<String>`	`getAdvertiserDomains()`	Advertiser domain for block list checking (e.g., “ford.com”).
`final Unit`	`setAdvertiserDomains(@SerializedName(value = adomain) Array<String> advertiserDomains)`	Advertiser domain for block list checking (e.g., “ford.com”).
`final String`	`getBundle()`	A platform-specific application identifier intended to be unique to the app and independent of the exchange.
`final Unit`	`setBundle(@SerializedName(value = bundle) String bundle)`	A platform-specific application identifier intended to be unique to the app and independent of the exchange.
`final String`	`getImageUrl()`	URL without cache-busting to an image that is representative of the content of the campaign for ad quality/safety checking.
`final Unit`	`setImageUrl(@SerializedName(value = iurl) String imageUrl)`	URL without cache-busting to an image that is representative of the content of the campaign for ad quality/safety checking.
`final String`	`getCampaignId()`	Campaign ID to assist with ad quality checking; the collection of creatives for which imageUrl should be representative.
`final Unit`	`setCampaignId(@SerializedName(value = cid) String campaignId)`	Campaign ID to assist with ad quality checking; the collection of creatives for which imageUrl should be representative.
`final String`	`getCreativeId()`	Creative ID to assist with ad quality checking.
`final Unit`	`setCreativeId(@SerializedName(value = crid) String creativeId)`	Creative ID to assist with ad quality checking.
`final String`	`getTacticId()`	Tactic ID to enable buyers to label bids for reporting to the exchange the tactic through which their bid was submitted.
`final Unit`	`setTacticId(@SerializedName(value = tactic) String tacticId)`	Tactic ID to enable buyers to label bids for reporting to the exchange the tactic through which their bid was submitted.
`final Array<String>`	`getCategories()`	IAB content categories of the creative.
`final Unit`	`setCategories(@SerializedName(value = cat) Array<String> categories)`	IAB content categories of the creative.
`final Array<CreativeAttribute>`	`getAttributes()`	Set of attributes describing the creative.
`final Unit`	`setAttributes(@SerializedName(value = attr) Array<CreativeAttribute> attributes)`	Set of attributes describing the creative.
`final ApiFramework`	`getApi()`	API required by the markup if applicable.
`final Unit`	`setApi(@SerializedName(value = api) ApiFramework api)`	API required by the markup if applicable.
`final Integer`	`getProtocol()`	Video response protocol of the markup if applicable.
`final Unit`	`setProtocol(@SerializedName(value = protocol) Integer protocol)`	Video response protocol of the markup if applicable.
`final MediaRating`	`getMediaRating()`	Creative media rating per IQG guidelines.
`final Unit`	`setMediaRating(@SerializedName(value = qagmediarating) MediaRating mediaRating)`	Creative media rating per IQG guidelines.
`final String`	`getLanguage()`	Language of the creative using ISO-639-1-alpha-2.
`final Unit`	`setLanguage(@SerializedName(value = language) String language)`	Language of the creative using ISO-639-1-alpha-2.
`final String`	`getDealId()`	Reference to the deal.id from the bid request if this bid pertains to a private marketplace direct deal.
`final Unit`	`setDealId(@SerializedName(value = dealid) String dealId)`	Reference to the deal.id from the bid request if this bid pertains to a private marketplace direct deal.
`final Integer`	`getWidth()`	Width of the creative in device independent pixels (DIPS).
`final Unit`	`setWidth(@SerializedName(value = w) Integer width)`	Width of the creative in device independent pixels (DIPS).
`final Integer`	`getHeight()`	Height of the creative in device independent pixels (DIPS).
`final Unit`	`setHeight(@SerializedName(value = h) Integer height)`	Height of the creative in device independent pixels (DIPS).
`final Integer`	`getWidthRatio()`	Relative width of the creative when expressing size as a ratio.
`final Unit`	`setWidthRatio(@SerializedName(value = wratio) Integer widthRatio)`	Relative width of the creative when expressing size as a ratio.
`final Integer`	`getHeightRatio()`	Relative height of the creative when expressing size as a ratio.
`final Unit`	`setHeightRatio(@SerializedName(value = hratio) Integer heightRatio)`	Relative height of the creative when expressing size as a ratio.
`final Integer`	`getExpired()`	Advisory as to the number of seconds the bidder is willing to wait between the auction and the actual impression.
`final Unit`	`setExpired(@SerializedName(value = epx) Integer expired)`	Advisory as to the number of seconds the bidder is willing to wait between the auction and the actual impression.
`final Bid.Extension`	`getExtension()`	Placeholder for bidder-specific extensions to OpenRTB.
`final Unit`	`setExtension(@SerializedName(value = ext) Bid.Extension extension)`	Placeholder for bidder-specific extensions to OpenRTB.
`final String`	`getId()`	Bidder generated bid ID to assist with logging/tracking.
`final String`	`getImpressionId()`	ID of the Impression object in the related bid request.
`final Float`	`getPrice()`	Bid price expressed as CPM although the actual transaction is for a unit impression only.

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

- Constructor Detail
  - Bid
```
Bid(String id, String impressionId, Float price)
```
- Method Detail
  - getRequestId
```
 final String getRequestId()
```
  - setRequestId
```
 final Unit setRequestId(String requestId)
```
  - getWinUrl
```
 final String getWinUrl()
```
    Win notice URL called by the exchange if the bid wins (not necessarily indicative of a delivered, viewed, or billable ad); optional means of serving ad markup.
  - setWinUrl
```
 final Unit setWinUrl(@SerializedName(value = nurl) String winUrl)
```
    Win notice URL called by the exchange if the bid wins (not necessarily indicative of a delivered, viewed, or billable ad); optional means of serving ad markup.
  - getBillUrl
```
 final String getBillUrl()
```
    Billing notice URL called by the exchange when a winning bid becomes billable based on exchange-specific business policy (e.g., typically delivered, viewed, etc.)
  - setBillUrl
```
 final Unit setBillUrl(@SerializedName(value = burl) String billUrl)
```
    Billing notice URL called by the exchange when a winning bid becomes billable based on exchange-specific business policy (e.g., typically delivered, viewed, etc.)
  - getLossUrl
```
 final String getLossUrl()
```
    Loss notice URL called by the exchange when a bid is known to have been lost.
  - setLossUrl
```
 final Unit setLossUrl(@SerializedName(value = lurl) String lossUrl)
```
    Loss notice URL called by the exchange when a bid is known to have been lost.
  - getAdMarkup
```
 final String getAdMarkup()
```
    Optional means of conveying ad markup in case the bid wins; supersedes the win notice if markup is included in both.
  - setAdMarkup
```
 final Unit setAdMarkup(@SerializedName(value = adm) String adMarkup)
```
    Optional means of conveying ad markup in case the bid wins; supersedes the win notice if markup is included in both.
  - getPreloadedAdId
```
 final String getPreloadedAdId()
```
    ID of a preloaded ad to be served if the bid wins.
  - setPreloadedAdId
```
 final Unit setPreloadedAdId(@SerializedName(value = adid) String preloadedAdId)
```
    ID of a preloaded ad to be served if the bid wins.
  - getAdvertiserDomains
```
 final Array<String> getAdvertiserDomains()
```
    Advertiser domain for block list checking (e.g., “ford.com”). This can be an array of for the case of rotating creatives. Exchanges can mandate that only one domain is allowed.
  - setAdvertiserDomains
```
 final Unit setAdvertiserDomains(@SerializedName(value = adomain) Array<String> advertiserDomains)
```
    Advertiser domain for block list checking (e.g., “ford.com”). This can be an array of for the case of rotating creatives. Exchanges can mandate that only one domain is allowed.
  - getBundle
```
 final String getBundle()
```
    A platform-specific application identifier intended to be unique to the app and independent of the exchange. On Android, this should be a bundle or package name (e.g., com.foo.game). On iOS, it is a numeric ID.
  - setBundle
```
 final Unit setBundle(@SerializedName(value = bundle) String bundle)
```
    A platform-specific application identifier intended to be unique to the app and independent of the exchange. On Android, this should be a bundle or package name (e.g., com.foo.game). On iOS, it is a numeric ID.
  - getImageUrl
```
 final String getImageUrl()
```
    URL without cache-busting to an image that is representative of the content of the campaign for ad quality/safety checking.
  - setImageUrl
```
 final Unit setImageUrl(@SerializedName(value = iurl) String imageUrl)
```
    URL without cache-busting to an image that is representative of the content of the campaign for ad quality/safety checking.
  - getCampaignId
```
 final String getCampaignId()
```
    Campaign ID to assist with ad quality checking; the collection of creatives for which imageUrl should be representative.
  - setCampaignId
```
 final Unit setCampaignId(@SerializedName(value = cid) String campaignId)
```
    Campaign ID to assist with ad quality checking; the collection of creatives for which imageUrl should be representative.
  - getCreativeId
```
 final String getCreativeId()
```
    Creative ID to assist with ad quality checking.
  - setCreativeId
```
 final Unit setCreativeId(@SerializedName(value = crid) String creativeId)
```
    Creative ID to assist with ad quality checking.
  - getTacticId
```
 final String getTacticId()
```
    Tactic ID to enable buyers to label bids for reporting to the exchange the tactic through which their bid was submitted. The specific usage and meaning of the tactic ID should be communicated between buyer and exchanges a priori.
  - setTacticId
```
 final Unit setTacticId(@SerializedName(value = tactic) String tacticId)
```
    Tactic ID to enable buyers to label bids for reporting to the exchange the tactic through which their bid was submitted. The specific usage and meaning of the tactic ID should be communicated between buyer and exchanges a priori.
  - getCategories
```
 final Array<String> getCategories()
```
    IAB content categories of the creative.
  - setCategories
```
 final Unit setCategories(@SerializedName(value = cat) Array<String> categories)
```
    IAB content categories of the creative.
  - getAttributes
```
 final Array<CreativeAttribute> getAttributes()
```
    Set of attributes describing the creative.
  - setAttributes
```
 final Unit setAttributes(@SerializedName(value = attr) Array<CreativeAttribute> attributes)
```
    Set of attributes describing the creative.
  - getApi
```
 final ApiFramework getApi()
```
    API required by the markup if applicable.
  - setApi
```
 final Unit setApi(@SerializedName(value = api) ApiFramework api)
```
    API required by the markup if applicable.
  - getProtocol
```
 final Integer getProtocol()
```
    Video response protocol of the markup if applicable.
  - setProtocol
```
 final Unit setProtocol(@SerializedName(value = protocol) Integer protocol)
```
    Video response protocol of the markup if applicable.
  - getMediaRating
```
 final MediaRating getMediaRating()
```
    Creative media rating per IQG guidelines.
  - setMediaRating
```
 final Unit setMediaRating(@SerializedName(value = qagmediarating) MediaRating mediaRating)
```
    Creative media rating per IQG guidelines.
  - getLanguage
```
 final String getLanguage()
```
    Language of the creative using ISO-639-1-alpha-2. The non- standard code “xx” may also be used if the creative has no linguistic content (e.g., a banner with just a company logo).
  - setLanguage
```
 final Unit setLanguage(@SerializedName(value = language) String language)
```
    Language of the creative using ISO-639-1-alpha-2. The non- standard code “xx” may also be used if the creative has no linguistic content (e.g., a banner with just a company logo).
  - getDealId
```
 final String getDealId()
```
    Reference to the deal.id from the bid request if this bid pertains to a private marketplace direct deal.
  - setDealId
```
 final Unit setDealId(@SerializedName(value = dealid) String dealId)
```
    Reference to the deal.id from the bid request if this bid pertains to a private marketplace direct deal.
  - getWidth
```
 final Integer getWidth()
```
    Width of the creative in device independent pixels (DIPS).
  - setWidth
```
 final Unit setWidth(@SerializedName(value = w) Integer width)
```
    Width of the creative in device independent pixels (DIPS).
  - getHeight
```
 final Integer getHeight()
```
    Height of the creative in device independent pixels (DIPS).
  - setHeight
```
 final Unit setHeight(@SerializedName(value = h) Integer height)
```
    Height of the creative in device independent pixels (DIPS).
  - getWidthRatio
```
 final Integer getWidthRatio()
```
    Relative width of the creative when expressing size as a ratio. Required for Flex Ads.
  - setWidthRatio
```
 final Unit setWidthRatio(@SerializedName(value = wratio) Integer widthRatio)
```
    Relative width of the creative when expressing size as a ratio. Required for Flex Ads.
  - getHeightRatio
```
 final Integer getHeightRatio()
```
    Relative height of the creative when expressing size as a ratio. Required for Flex Ads.
  - setHeightRatio
```
 final Unit setHeightRatio(@SerializedName(value = hratio) Integer heightRatio)
```
    Relative height of the creative when expressing size as a ratio. Required for Flex Ads.
  - getExpired
```
 final Integer getExpired()
```
    Advisory as to the number of seconds the bidder is willing to wait between the auction and the actual impression.
  - setExpired
```
 final Unit setExpired(@SerializedName(value = epx) Integer expired)
```
    Advisory as to the number of seconds the bidder is willing to wait between the auction and the actual impression.
  - getExtension
```
 final Bid.Extension getExtension()
```
    Placeholder for bidder-specific extensions to OpenRTB.
  - setExtension
```
 final Unit setExtension(@SerializedName(value = ext) Bid.Extension extension)
```
    Placeholder for bidder-specific extensions to OpenRTB.
  - getId
```
 final String getId()
```
    Bidder generated bid ID to assist with logging/tracking.
  - getImpressionId
```
 final String getImpressionId()
```
    ID of the Impression object in the related bid request.
  - getPrice
```
 final Float getPrice()
```
    Bid price expressed as CPM although the actual transaction is for a unit impression only.

Class Bid

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Bid

Method Detail

getRequestId

setRequestId

getWinUrl

setWinUrl

getBillUrl

setBillUrl

getLossUrl

setLossUrl

getAdMarkup

setAdMarkup

getPreloadedAdId

setPreloadedAdId

getAdvertiserDomains

setAdvertiserDomains

getBundle

setBundle

getImageUrl

setImageUrl

getCampaignId

setCampaignId

getCreativeId

setCreativeId

getTacticId

setTacticId

getCategories

setCategories

getAttributes

setAttributes

getApi

setApi

getProtocol

setProtocol

getMediaRating

setMediaRating

getLanguage

setLanguage

getDealId

setDealId

getWidth

setWidth

getHeight

setHeight

getWidthRatio

setWidthRatio

getHeightRatio

setHeightRatio

getExpired

setExpired

getExtension

setExtension

getId

getImpressionId

getPrice