Package com.google.openrtb
Interface OpenRtb.BidResponse.SeatBid.BidOrBuilder
-
- All Superinterfaces:
com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<OpenRtb.BidResponse.SeatBid.Bid>,com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder
- All Known Implementing Classes:
OpenRtb.BidResponse.SeatBid.Bid,OpenRtb.BidResponse.SeatBid.Bid.Builder
- Enclosing class:
- OpenRtb.BidResponse.SeatBid
public static interface OpenRtb.BidResponse.SeatBid.BidOrBuilder extends com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<OpenRtb.BidResponse.SeatBid.Bid>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description StringgetAdid()ID of a preloaded ad to serve if the bid wins.com.google.protobuf.ByteStringgetAdidBytes()ID of a preloaded ad to serve if the bid wins.StringgetAdm()Optional means of conveying ad markup in case the bid wins; supersedes the win notice if markup is included in both.com.google.protobuf.ByteStringgetAdmBytes()Optional means of conveying ad markup in case the bid wins; supersedes the win notice if markup is included in both.OpenRtb.NativeResponsegetAdmNative()Native ad response.OpenRtb.NativeResponseOrBuildergetAdmNativeOrBuilder()Native ad response.OpenRtb.BidResponse.SeatBid.Bid.AdmOneofCasegetAdmOneofCase()StringgetAdomain(int index)Advertiser domain for block list checking (e.g., "ford.com").com.google.protobuf.ByteStringgetAdomainBytes(int index)Advertiser domain for block list checking (e.g., "ford.com").intgetAdomainCount()Advertiser domain for block list checking (e.g., "ford.com").List<String>getAdomainList()Advertiser domain for block list checking (e.g., "ford.com").OpenRtb.APIFrameworkgetApi()API required by the markup if applicable.OpenRtb.CreativeAttributegetAttr(int index)Set of attributes describing the creative.intgetAttrCount()Set of attributes describing the creative.List<OpenRtb.CreativeAttribute>getAttrList()Set of attributes describing the creative.StringgetBundle()A platform-specific application identifier intended to be unique to the app and independent of the exchange.com.google.protobuf.ByteStringgetBundleBytes()A platform-specific application identifier intended to be unique to the app and independent of the exchange.StringgetBurl()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.).com.google.protobuf.ByteStringgetBurlBytes()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.).StringgetCat(int index)IAB content categories of the creative.com.google.protobuf.ByteStringgetCatBytes(int index)IAB content categories of the creative.intgetCatCount()IAB content categories of the creative.List<String>getCatList()IAB content categories of the creative.StringgetCid()Campaign ID to assist with ad quality checking; the collection of creatives for which iurl should be representative.com.google.protobuf.ByteStringgetCidBytes()Campaign ID to assist with ad quality checking; the collection of creatives for which iurl should be representative.StringgetCrid()Creative ID to assist with ad quality checking.com.google.protobuf.ByteStringgetCridBytes()Creative ID to assist with ad quality checking.StringgetDealid()Reference to the deal.id from the bid request if this bid pertains to a private marketplace direct deal.com.google.protobuf.ByteStringgetDealidBytes()Reference to the deal.id from the bid request if this bid pertains to a private marketplace direct deal.intgetExp()Advisory as to the number of seconds the bidder is willing to wait between the auction and the actual impression.intgetH()Height of the creative in device independent pixels (DIPS).intgetHratio()Relative height of the creative when expressing size as a ratio.StringgetId()Bidder generated bid ID to assist with logging/tracking.com.google.protobuf.ByteStringgetIdBytes()Bidder generated bid ID to assist with logging/tracking.StringgetImpid()ID of the Imp object in the related bid request.com.google.protobuf.ByteStringgetImpidBytes()ID of the Imp object in the related bid request.StringgetIurl()URL without cache-busting to an image that is representative of the content of the campaign for ad quality/safety checking.com.google.protobuf.ByteStringgetIurlBytes()URL without cache-busting to an image that is representative of the content of the campaign for ad quality/safety checking.StringgetLanguage()Language of the creative using ISO-639-1-alpha-2.com.google.protobuf.ByteStringgetLanguageBytes()Language of the creative using ISO-639-1-alpha-2.StringgetLurl()Loss notice URL called by the exchange when a bid is known to have been lost.com.google.protobuf.ByteStringgetLurlBytes()Loss notice URL called by the exchange when a bid is known to have been lost.StringgetNurl()Win notice URL called by the exchange if the bid wins; optional means of serving ad markup.com.google.protobuf.ByteStringgetNurlBytes()Win notice URL called by the exchange if the bid wins; optional means of serving ad markup.doublegetPrice()Bid price expressed as CPM although the actual transaction is for a unit impression only.OpenRtb.ProtocolgetProtocol()Video response protocol of the markup if applicable.OpenRtb.QAGMediaRatinggetQagmediarating()Creative media rating per QAG guidelines.StringgetTactic()Tactic ID to enable buyers to label bids for reporting to the exchange the tactic through which their bid was submitted.com.google.protobuf.ByteStringgetTacticBytes()Tactic ID to enable buyers to label bids for reporting to the exchange the tactic through which their bid was submitted.intgetW()Width of the creative in device independent pixels (DIPS).intgetWratio()Relative width of the creative when expressing size as a ratio.booleanhasAdid()ID of a preloaded ad to serve if the bid wins.booleanhasAdm()Optional means of conveying ad markup in case the bid wins; supersedes the win notice if markup is included in both.booleanhasAdmNative()Native ad response.booleanhasApi()API required by the markup if applicable.booleanhasBundle()A platform-specific application identifier intended to be unique to the app and independent of the exchange.booleanhasBurl()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.).booleanhasCid()Campaign ID to assist with ad quality checking; the collection of creatives for which iurl should be representative.booleanhasCrid()Creative ID to assist with ad quality checking.booleanhasDealid()Reference to the deal.id from the bid request if this bid pertains to a private marketplace direct deal.booleanhasExp()Advisory as to the number of seconds the bidder is willing to wait between the auction and the actual impression.booleanhasH()Height of the creative in device independent pixels (DIPS).booleanhasHratio()Relative height of the creative when expressing size as a ratio.booleanhasId()Bidder generated bid ID to assist with logging/tracking.booleanhasImpid()ID of the Imp object in the related bid request.booleanhasIurl()URL without cache-busting to an image that is representative of the content of the campaign for ad quality/safety checking.booleanhasLanguage()Language of the creative using ISO-639-1-alpha-2.booleanhasLurl()Loss notice URL called by the exchange when a bid is known to have been lost.booleanhasNurl()Win notice URL called by the exchange if the bid wins; optional means of serving ad markup.booleanhasPrice()Bid price expressed as CPM although the actual transaction is for a unit impression only.booleanhasProtocol()Video response protocol of the markup if applicable.booleanhasQagmediarating()Creative media rating per QAG guidelines.booleanhasTactic()Tactic ID to enable buyers to label bids for reporting to the exchange the tactic through which their bid was submitted.booleanhasW()Width of the creative in device independent pixels (DIPS).booleanhasWratio()Relative width of the creative when expressing size as a ratio.-
Methods inherited from interface com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder
getDefaultInstanceForType, getExtension, getExtension, getExtension, getExtension, getExtension, getExtension, getExtensionCount, getExtensionCount, getExtensionCount, hasExtension, hasExtension, hasExtension
-
-
-
-
Method Detail
-
hasId
boolean hasId()
Bidder generated bid ID to assist with logging/tracking. REQUIRED by the OpenRTB specification.
required string id = 1;- Returns:
- Whether the id field is set.
-
getId
String getId()
Bidder generated bid ID to assist with logging/tracking. REQUIRED by the OpenRTB specification.
required string id = 1;- Returns:
- The id.
-
getIdBytes
com.google.protobuf.ByteString getIdBytes()
Bidder generated bid ID to assist with logging/tracking. REQUIRED by the OpenRTB specification.
required string id = 1;- Returns:
- The bytes for id.
-
hasImpid
boolean hasImpid()
ID of the Imp object in the related bid request. REQUIRED by the OpenRTB specification.
required string impid = 2;- Returns:
- Whether the impid field is set.
-
getImpid
String getImpid()
ID of the Imp object in the related bid request. REQUIRED by the OpenRTB specification.
required string impid = 2;- Returns:
- The impid.
-
getImpidBytes
com.google.protobuf.ByteString getImpidBytes()
ID of the Imp object in the related bid request. REQUIRED by the OpenRTB specification.
required string impid = 2;- Returns:
- The bytes for impid.
-
hasPrice
boolean hasPrice()
Bid price expressed as CPM although the actual transaction is for a unit impression only. Note that while the type indicates float, integer math is highly recommended when handling currencies (e.g., BigDecimal in Java). REQUIRED by the OpenRTB specification.
required double price = 3;- Returns:
- Whether the price field is set.
-
getPrice
double getPrice()
Bid price expressed as CPM although the actual transaction is for a unit impression only. Note that while the type indicates float, integer math is highly recommended when handling currencies (e.g., BigDecimal in Java). REQUIRED by the OpenRTB specification.
required double price = 3;- Returns:
- The price.
-
hasNurl
boolean hasNurl()
Win notice URL called by the exchange if the bid wins; optional means of serving ad markup.
optional string nurl = 5;- Returns:
- Whether the nurl field is set.
-
getNurl
String getNurl()
Win notice URL called by the exchange if the bid wins; optional means of serving ad markup.
optional string nurl = 5;- Returns:
- The nurl.
-
getNurlBytes
com.google.protobuf.ByteString getNurlBytes()
Win notice URL called by the exchange if the bid wins; optional means of serving ad markup.
optional string nurl = 5;- Returns:
- The bytes for nurl.
-
hasBurl
boolean hasBurl()
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.). Substitution macros (Section 4.4) may be included.
optional string burl = 22;- Returns:
- Whether the burl field is set.
-
getBurl
String getBurl()
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.). Substitution macros (Section 4.4) may be included.
optional string burl = 22;- Returns:
- The burl.
-
getBurlBytes
com.google.protobuf.ByteString getBurlBytes()
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.). Substitution macros (Section 4.4) may be included.
optional string burl = 22;- Returns:
- The bytes for burl.
-
hasLurl
boolean hasLurl()
Loss notice URL called by the exchange when a bid is known to have been lost. Substitution macros (Section 4.4) may be included. Exchange-specific policy may preclude support for loss notices or the disclosure of winning clearing prices resulting in ${AUCTION_PRICE} macros being removed (i.e., replaced with a zero-length string).optional string lurl = 23;- Returns:
- Whether the lurl field is set.
-
getLurl
String getLurl()
Loss notice URL called by the exchange when a bid is known to have been lost. Substitution macros (Section 4.4) may be included. Exchange-specific policy may preclude support for loss notices or the disclosure of winning clearing prices resulting in ${AUCTION_PRICE} macros being removed (i.e., replaced with a zero-length string).optional string lurl = 23;- Returns:
- The lurl.
-
getLurlBytes
com.google.protobuf.ByteString getLurlBytes()
Loss notice URL called by the exchange when a bid is known to have been lost. Substitution macros (Section 4.4) may be included. Exchange-specific policy may preclude support for loss notices or the disclosure of winning clearing prices resulting in ${AUCTION_PRICE} macros being removed (i.e., replaced with a zero-length string).optional string lurl = 23;- Returns:
- The bytes for lurl.
-
hasAdm
boolean hasAdm()
Optional means of conveying ad markup in case the bid wins; supersedes the win notice if markup is included in both. For native ad bids, exactly one of {adm, adm_native} should be used; this is the OpenRTB-compliant field for JSON serialization.string adm = 6;- Returns:
- Whether the adm field is set.
-
getAdm
String getAdm()
Optional means of conveying ad markup in case the bid wins; supersedes the win notice if markup is included in both. For native ad bids, exactly one of {adm, adm_native} should be used; this is the OpenRTB-compliant field for JSON serialization.string adm = 6;- Returns:
- The adm.
-
getAdmBytes
com.google.protobuf.ByteString getAdmBytes()
Optional means of conveying ad markup in case the bid wins; supersedes the win notice if markup is included in both. For native ad bids, exactly one of {adm, adm_native} should be used; this is the OpenRTB-compliant field for JSON serialization.string adm = 6;- Returns:
- The bytes for adm.
-
hasAdmNative
boolean hasAdmNative()
Native ad response. For native ad bids, exactly one of {adm, adm_native} should be used; this is the field used for Protobuf serialization..com.google.openrtb.NativeResponse adm_native = 50;- Returns:
- Whether the admNative field is set.
-
getAdmNative
OpenRtb.NativeResponse getAdmNative()
Native ad response. For native ad bids, exactly one of {adm, adm_native} should be used; this is the field used for Protobuf serialization..com.google.openrtb.NativeResponse adm_native = 50;- Returns:
- The admNative.
-
getAdmNativeOrBuilder
OpenRtb.NativeResponseOrBuilder getAdmNativeOrBuilder()
Native ad response. For native ad bids, exactly one of {adm, adm_native} should be used; this is the field used for Protobuf serialization..com.google.openrtb.NativeResponse adm_native = 50;
-
hasAdid
boolean hasAdid()
ID of a preloaded ad to serve if the bid wins.
optional string adid = 4;- Returns:
- Whether the adid field is set.
-
getAdid
String getAdid()
ID of a preloaded ad to serve if the bid wins.
optional string adid = 4;- Returns:
- The adid.
-
getAdidBytes
com.google.protobuf.ByteString getAdidBytes()
ID of a preloaded ad to serve if the bid wins.
optional string adid = 4;- Returns:
- The bytes for adid.
-
getAdomainList
List<String> getAdomainList()
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.
repeated string adomain = 7;- Returns:
- A list containing the adomain.
-
getAdomainCount
int getAdomainCount()
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.
repeated string adomain = 7;- Returns:
- The count of adomain.
-
getAdomain
String getAdomain(int index)
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.
repeated string adomain = 7;- Parameters:
index- The index of the element to return.- Returns:
- The adomain at the given index.
-
getAdomainBytes
com.google.protobuf.ByteString getAdomainBytes(int index)
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.
repeated string adomain = 7;- Parameters:
index- The index of the value to return.- Returns:
- The bytes of the adomain at the given index.
-
hasBundle
boolean hasBundle()
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.mygame). On iOS, it is a numeric ID.
optional string bundle = 14;- Returns:
- Whether the bundle field is set.
-
getBundle
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.mygame). On iOS, it is a numeric ID.
optional string bundle = 14;- Returns:
- The bundle.
-
getBundleBytes
com.google.protobuf.ByteString getBundleBytes()
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.mygame). On iOS, it is a numeric ID.
optional string bundle = 14;- Returns:
- The bytes for bundle.
-
hasIurl
boolean hasIurl()
URL without cache-busting to an image that is representative of the content of the campaign for ad quality/safety checking.
optional string iurl = 8;- Returns:
- Whether the iurl field is set.
-
getIurl
String getIurl()
URL without cache-busting to an image that is representative of the content of the campaign for ad quality/safety checking.
optional string iurl = 8;- Returns:
- The iurl.
-
getIurlBytes
com.google.protobuf.ByteString getIurlBytes()
URL without cache-busting to an image that is representative of the content of the campaign for ad quality/safety checking.
optional string iurl = 8;- Returns:
- The bytes for iurl.
-
hasCid
boolean hasCid()
Campaign ID to assist with ad quality checking; the collection of creatives for which iurl should be representative.
optional string cid = 9;- Returns:
- Whether the cid field is set.
-
getCid
String getCid()
Campaign ID to assist with ad quality checking; the collection of creatives for which iurl should be representative.
optional string cid = 9;- Returns:
- The cid.
-
getCidBytes
com.google.protobuf.ByteString getCidBytes()
Campaign ID to assist with ad quality checking; the collection of creatives for which iurl should be representative.
optional string cid = 9;- Returns:
- The bytes for cid.
-
hasCrid
boolean hasCrid()
Creative ID to assist with ad quality checking.
optional string crid = 10;- Returns:
- Whether the crid field is set.
-
getCrid
String getCrid()
Creative ID to assist with ad quality checking.
optional string crid = 10;- Returns:
- The crid.
-
getCridBytes
com.google.protobuf.ByteString getCridBytes()
Creative ID to assist with ad quality checking.
optional string crid = 10;- Returns:
- The bytes for crid.
-
hasTactic
boolean hasTactic()
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.
optional string tactic = 24;- Returns:
- Whether the tactic field is set.
-
getTactic
String getTactic()
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.
optional string tactic = 24;- Returns:
- The tactic.
-
getTacticBytes
com.google.protobuf.ByteString getTacticBytes()
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.
optional string tactic = 24;- Returns:
- The bytes for tactic.
-
getCatList
List<String> getCatList()
IAB content categories of the creative.
repeated string cat = 15;- Returns:
- A list containing the cat.
-
getCatCount
int getCatCount()
IAB content categories of the creative.
repeated string cat = 15;- Returns:
- The count of cat.
-
getCat
String getCat(int index)
IAB content categories of the creative.
repeated string cat = 15;- Parameters:
index- The index of the element to return.- Returns:
- The cat at the given index.
-
getCatBytes
com.google.protobuf.ByteString getCatBytes(int index)
IAB content categories of the creative.
repeated string cat = 15;- Parameters:
index- The index of the value to return.- Returns:
- The bytes of the cat at the given index.
-
getAttrList
List<OpenRtb.CreativeAttribute> getAttrList()
Set of attributes describing the creative.
repeated .com.google.openrtb.CreativeAttribute attr = 11 [packed = true];- Returns:
- A list containing the attr.
-
getAttrCount
int getAttrCount()
Set of attributes describing the creative.
repeated .com.google.openrtb.CreativeAttribute attr = 11 [packed = true];- Returns:
- The count of attr.
-
getAttr
OpenRtb.CreativeAttribute getAttr(int index)
Set of attributes describing the creative.
repeated .com.google.openrtb.CreativeAttribute attr = 11 [packed = true];- Parameters:
index- The index of the element to return.- Returns:
- The attr at the given index.
-
hasApi
boolean hasApi()
API required by the markup if applicable.
optional .com.google.openrtb.APIFramework api = 18;- Returns:
- Whether the api field is set.
-
getApi
OpenRtb.APIFramework getApi()
API required by the markup if applicable.
optional .com.google.openrtb.APIFramework api = 18;- Returns:
- The api.
-
hasProtocol
boolean hasProtocol()
Video response protocol of the markup if applicable.
optional .com.google.openrtb.Protocol protocol = 19;- Returns:
- Whether the protocol field is set.
-
getProtocol
OpenRtb.Protocol getProtocol()
Video response protocol of the markup if applicable.
optional .com.google.openrtb.Protocol protocol = 19;- Returns:
- The protocol.
-
hasQagmediarating
boolean hasQagmediarating()
Creative media rating per QAG guidelines.
optional .com.google.openrtb.QAGMediaRating qagmediarating = 20;- Returns:
- Whether the qagmediarating field is set.
-
getQagmediarating
OpenRtb.QAGMediaRating getQagmediarating()
Creative media rating per QAG guidelines.
optional .com.google.openrtb.QAGMediaRating qagmediarating = 20;- Returns:
- The qagmediarating.
-
hasLanguage
boolean hasLanguage()
Language of the creative using ISO-639-1-alpha-2. The nonstandard code "xx" may also be used if the creative has no linguistic content (e.g., a banner with just a company logo).
optional string language = 25;- Returns:
- Whether the language field is set.
-
getLanguage
String getLanguage()
Language of the creative using ISO-639-1-alpha-2. The nonstandard code "xx" may also be used if the creative has no linguistic content (e.g., a banner with just a company logo).
optional string language = 25;- Returns:
- The language.
-
getLanguageBytes
com.google.protobuf.ByteString getLanguageBytes()
Language of the creative using ISO-639-1-alpha-2. The nonstandard code "xx" may also be used if the creative has no linguistic content (e.g., a banner with just a company logo).
optional string language = 25;- Returns:
- The bytes for language.
-
hasDealid
boolean hasDealid()
Reference to the deal.id from the bid request if this bid pertains to a private marketplace direct deal.
optional string dealid = 13;- Returns:
- Whether the dealid field is set.
-
getDealid
String getDealid()
Reference to the deal.id from the bid request if this bid pertains to a private marketplace direct deal.
optional string dealid = 13;- Returns:
- The dealid.
-
getDealidBytes
com.google.protobuf.ByteString getDealidBytes()
Reference to the deal.id from the bid request if this bid pertains to a private marketplace direct deal.
optional string dealid = 13;- Returns:
- The bytes for dealid.
-
hasW
boolean hasW()
Width of the creative in device independent pixels (DIPS).
optional int32 w = 16;- Returns:
- Whether the w field is set.
-
getW
int getW()
Width of the creative in device independent pixels (DIPS).
optional int32 w = 16;- Returns:
- The w.
-
hasH
boolean hasH()
Height of the creative in device independent pixels (DIPS).
optional int32 h = 17;- Returns:
- Whether the h field is set.
-
getH
int getH()
Height of the creative in device independent pixels (DIPS).
optional int32 h = 17;- Returns:
- The h.
-
hasWratio
boolean hasWratio()
Relative width of the creative when expressing size as a ratio. Required for Flex Ads.
optional int32 wratio = 26;- Returns:
- Whether the wratio field is set.
-
getWratio
int getWratio()
Relative width of the creative when expressing size as a ratio. Required for Flex Ads.
optional int32 wratio = 26;- Returns:
- The wratio.
-
hasHratio
boolean hasHratio()
Relative height of the creative when expressing size as a ratio. Required for Flex Ads.
optional int32 hratio = 27;- Returns:
- Whether the hratio field is set.
-
getHratio
int getHratio()
Relative height of the creative when expressing size as a ratio. Required for Flex Ads.
optional int32 hratio = 27;- Returns:
- The hratio.
-
hasExp
boolean hasExp()
Advisory as to the number of seconds the bidder is willing to wait between the auction and the actual impression.
optional int32 exp = 21;- Returns:
- Whether the exp field is set.
-
getExp
int getExp()
Advisory as to the number of seconds the bidder is willing to wait between the auction and the actual impression.
optional int32 exp = 21;- Returns:
- The exp.
-
getAdmOneofCase
OpenRtb.BidResponse.SeatBid.Bid.AdmOneofCase getAdmOneofCase()
-
-