com.beeswax.openrtb

Interface Openrtb.BidResponse.SeatBid.BidOrBuilder

All Superinterfaces:

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.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
String	getAdid() ID that references the ad to be served if the bid wins.
com.google.protobuf.ByteString	getAdidBytes() ID that references the ad to be served if the bid wins.
String	getAdm() Actual ad markup.
com.google.protobuf.ByteString	getAdmBytes() Actual ad markup.
Openrtb.NativeResponse	getAdmNative() Native ad response.
Openrtb.NativeResponseOrBuilder	getAdmNativeOrBuilder() Native ad response.
String	getAdomain(int index) Advertiser’s primary or top-level domain for advertiser checking.
com.google.protobuf.ByteString	getAdomainBytes(int index) Advertiser’s primary or top-level domain for advertiser checking.
int	getAdomainCount() Advertiser’s primary or top-level domain for advertiser checking.
List<String>	getAdomainList() Advertiser’s primary or top-level domain for advertiser checking.
OpenrtbCommon.CreativeAttribute	getAttr(int index) Array of creative attributes.
int	getAttrCount() Array of creative attributes.
List<OpenrtbCommon.CreativeAttribute>	getAttrList() Array of creative attributes.
String	getBundle() Bundle or package name (e.g., com.foo.mygame) of the app being advertised, if applicable; intended to be a unique ID across exchanges.
com.google.protobuf.ByteString	getBundleBytes() Bundle or package name (e.g., com.foo.mygame) of the app being advertised, if applicable; intended to be a unique ID across exchanges.
String	getCat(int index) IAB content category of the creative.
com.google.protobuf.ByteString	getCatBytes(int index) IAB content category of the creative.
int	getCatCount() IAB content category of the creative.
List<String>	getCatList() IAB content category of the creative.
String	getCid() Campaign ID or similar that appears within the ad markup.
com.google.protobuf.ByteString	getCidBytes() Campaign ID or similar that appears within the ad markup.
String	getCrid() Creative ID for reporting content issues or defects.
com.google.protobuf.ByteString	getCridBytes() Creative ID for reporting content issues or defects.
String	getDealid() A unique identifier for the direct deal associated with the bid.
com.google.protobuf.ByteString	getDealidBytes() A unique identifier for the direct deal associated with the bid.
Extension.BidExtensions	getExt() optional .openrtb.BidExtensions ext = 1000;
Extension.BidExtensionsOrBuilder	getExtOrBuilder() optional .openrtb.BidExtensions ext = 1000;
int	getH() Height of the ad in pixels.
String	getId() ID for the bid object chosen by the bidder for tracking and debugging purposes.
com.google.protobuf.ByteString	getIdBytes() ID for the bid object chosen by the bidder for tracking and debugging purposes.
String	getImpid() ID of the impression object to which this bid applies.
com.google.protobuf.ByteString	getImpidBytes() ID of the impression object to which this bid applies.
String	getIurl() Sample image URL (without cache busting) for content checking.
com.google.protobuf.ByteString	getIurlBytes() Sample image URL (without cache busting) for content checking.
String	getNurl() Win notice URL.
com.google.protobuf.ByteString	getNurlBytes() Win notice URL.
double	getPrice() Bid price in CPM.
int	getW() Width of the ad in pixels.
boolean	hasAdid() ID that references the ad to be served if the bid wins.
boolean	hasAdm() Actual ad markup.
boolean	hasAdmNative() Native ad response.
boolean	hasBundle() Bundle or package name (e.g., com.foo.mygame) of the app being advertised, if applicable; intended to be a unique ID across exchanges.
boolean	hasCid() Campaign ID or similar that appears within the ad markup.
boolean	hasCrid() Creative ID for reporting content issues or defects.
boolean	hasDealid() A unique identifier for the direct deal associated with the bid.
boolean	hasExt() optional .openrtb.BidExtensions ext = 1000;
boolean	hasH() Height of the ad in pixels.
boolean	hasId() ID for the bid object chosen by the bidder for tracking and debugging purposes.
boolean	hasImpid() ID of the impression object to which this bid applies.
boolean	hasIurl() Sample image URL (without cache busting) for content checking.
boolean	hasNurl() Win notice URL.
boolean	hasPrice() Bid price in CPM.
boolean	hasW() Width of the ad in pixels.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

hasId

boolean hasId()

 ID for the bid object chosen by the bidder for tracking and debugging purposes.
 Useful when multiple bids are submitted for a single impression for a given seat.
 

required string id = 1;

getId

String getId()

 ID for the bid object chosen by the bidder for tracking and debugging purposes.
 Useful when multiple bids are submitted for a single impression for a given seat.
 

required string id = 1;

getIdBytes

com.google.protobuf.ByteString getIdBytes()

 ID for the bid object chosen by the bidder for tracking and debugging purposes.
 Useful when multiple bids are submitted for a single impression for a given seat.
 

required string id = 1;

hasImpid

boolean hasImpid()

 ID of the impression object to which this bid applies.
 

required string impid = 2;

getImpid

String getImpid()

 ID of the impression object to which this bid applies.
 

required string impid = 2;

getImpidBytes

com.google.protobuf.ByteString getImpidBytes()

 ID of the impression object to which this bid applies.
 

required string impid = 2;

hasPrice

boolean hasPrice()

 Bid price in CPM. WARNING/Best Practice Note: Although this value is a float,
 OpenRTB strongly suggests using integer math for accounting to avoid rounding errors.
 

required double price = 3;

getPrice

double getPrice()

 Bid price in CPM. WARNING/Best Practice Note: Although this value is a float,
 OpenRTB strongly suggests using integer math for accounting to avoid rounding errors.
 

required double price = 3;

hasAdid

boolean hasAdid()

 ID that references the ad to be served if the bid wins.
 

optional string adid = 4;

getAdid

String getAdid()

 ID that references the ad to be served if the bid wins.
 

optional string adid = 4;

getAdidBytes

com.google.protobuf.ByteString getAdidBytes()

 ID that references the ad to be served if the bid wins.
 

optional string adid = 4;

hasNurl

boolean hasNurl()

 Win notice URL. Note that ad markup is also typically, but not necessarily,
 returned via this URL.
 

optional string nurl = 5;

getNurl

String getNurl()

 Win notice URL. Note that ad markup is also typically, but not necessarily,
 returned via this URL.
 

optional string nurl = 5;

getNurlBytes

com.google.protobuf.ByteString getNurlBytes()

 Win notice URL. Note that ad markup is also typically, but not necessarily,
 returned via this URL.
 

optional string nurl = 5;

hasAdm

boolean hasAdm()

 Actual ad markup. XHTML if a response to a banner object,
 or VAST XML if a response to a video object.
 <p>
 Open Bidder macros are supported for this field.
 

optional string adm = 6;

getAdm

String getAdm()

 Actual ad markup. XHTML if a response to a banner object,
 or VAST XML if a response to a video object.
 <p>
 Open Bidder macros are supported for this field.
 

optional string adm = 6;

getAdmBytes

com.google.protobuf.ByteString getAdmBytes()

 Actual ad markup. XHTML if a response to a banner object,
 or VAST XML if a response to a video object.
 <p>
 Open Bidder macros are supported for this field.
 

optional string adm = 6;

hasAdmNative

boolean hasAdmNative()

 Native ad response.
 You can only set one of adm and adm_native; either will generate the "adm" field in JSON.
 

optional .openrtb.NativeResponse adm_native = 50;

getAdmNative

Openrtb.NativeResponse getAdmNative()

 Native ad response.
 You can only set one of adm and adm_native; either will generate the "adm" field in JSON.
 

optional .openrtb.NativeResponse adm_native = 50;

getAdmNativeOrBuilder

Openrtb.NativeResponseOrBuilder getAdmNativeOrBuilder()

 Native ad response.
 You can only set one of adm and adm_native; either will generate the "adm" field in JSON.
 

optional .openrtb.NativeResponse adm_native = 50;

getAdomainList

List<String> getAdomainList()

 Advertiser’s primary or top-level domain for advertiser checking.
 This can be a list of domains if there is a rotating creative.
 However, exchanges may mandate that only one landing domain is allowed.
 

repeated string adomain = 7;

getAdomainCount

int getAdomainCount()

 Advertiser’s primary or top-level domain for advertiser checking.
 This can be a list of domains if there is a rotating creative.
 However, exchanges may mandate that only one landing domain is allowed.
 

repeated string adomain = 7;

getAdomain

String getAdomain(int index)

 Advertiser’s primary or top-level domain for advertiser checking.
 This can be a list of domains if there is a rotating creative.
 However, exchanges may mandate that only one landing domain is allowed.
 

repeated string adomain = 7;

getAdomainBytes

com.google.protobuf.ByteString getAdomainBytes(int index)

 Advertiser’s primary or top-level domain for advertiser checking.
 This can be a list of domains if there is a rotating creative.
 However, exchanges may mandate that only one landing domain is allowed.
 

repeated string adomain = 7;

hasBundle

boolean hasBundle()

 Bundle or package name (e.g., com.foo.mygame) of the app being advertised, if applicable;
 intended to be a unique ID across exchanges.
 

optional string bundle = 15;

getBundle

String getBundle()

 Bundle or package name (e.g., com.foo.mygame) of the app being advertised, if applicable;
 intended to be a unique ID across exchanges.
 

optional string bundle = 15;

getBundleBytes

com.google.protobuf.ByteString getBundleBytes()

 Bundle or package name (e.g., com.foo.mygame) of the app being advertised, if applicable;
 intended to be a unique ID across exchanges.
 

optional string bundle = 15;

hasIurl

boolean hasIurl()

 Sample image URL (without cache busting) for content checking.
 

optional string iurl = 8;

getIurl

String getIurl()

 Sample image URL (without cache busting) for content checking.
 

optional string iurl = 8;

getIurlBytes

com.google.protobuf.ByteString getIurlBytes()

 Sample image URL (without cache busting) for content checking.
 

optional string iurl = 8;

hasCid

boolean hasCid()

 Campaign ID or similar that appears within the ad markup.
 

optional string cid = 9;

getCid

String getCid()

 Campaign ID or similar that appears within the ad markup.
 

optional string cid = 9;

getCidBytes

com.google.protobuf.ByteString getCidBytes()

 Campaign ID or similar that appears within the ad markup.
 

optional string cid = 9;

hasCrid

boolean hasCrid()

 Creative ID for reporting content issues or defects.
 This could also be used as a reference to a creative ID that is posted with an exchange.
 <p>
 Open Bidder macros are supported for this field.
 

optional string crid = 10;

getCrid

String getCrid()

 Creative ID for reporting content issues or defects.
 This could also be used as a reference to a creative ID that is posted with an exchange.
 <p>
 Open Bidder macros are supported for this field.
 

optional string crid = 10;

getCridBytes

com.google.protobuf.ByteString getCridBytes()

 Creative ID for reporting content issues or defects.
 This could also be used as a reference to a creative ID that is posted with an exchange.
 <p>
 Open Bidder macros are supported for this field.
 

optional string crid = 10;

getCatList

List<String> getCatList()

 IAB content category of the creative.
 

repeated string cat = 16;

getCatCount

int getCatCount()

 IAB content category of the creative.
 

repeated string cat = 16;

getCat

String getCat(int index)

 IAB content category of the creative.
 

repeated string cat = 16;

getCatBytes

com.google.protobuf.ByteString getCatBytes(int index)

 IAB content category of the creative.
 

repeated string cat = 16;

getAttrList

List<OpenrtbCommon.CreativeAttribute> getAttrList()

 Array of creative attributes.
 

repeated .openrtb.CreativeAttribute attr = 11;

getAttrCount

int getAttrCount()

 Array of creative attributes.
 

repeated .openrtb.CreativeAttribute attr = 11;

getAttr

OpenrtbCommon.CreativeAttribute getAttr(int index)

 Array of creative attributes.
 

repeated .openrtb.CreativeAttribute attr = 11;

hasDealid

boolean hasDealid()

 A unique identifier for the direct deal associated with the bid.
 

optional string dealid = 12;

getDealid

String getDealid()

 A unique identifier for the direct deal associated with the bid.
 

optional string dealid = 12;

getDealidBytes

com.google.protobuf.ByteString getDealidBytes()

 A unique identifier for the direct deal associated with the bid.
 

optional string dealid = 12;

hasW

boolean hasW()

 Width of the ad in pixels. If the bid request contained the wmax/hmax and wmin/hmin
 optional fields it is recommended that the response bid contains this field to signal
 the size of ad chosen.
 

optional int32 w = 13;

getW

int getW()

 Width of the ad in pixels. If the bid request contained the wmax/hmax and wmin/hmin
 optional fields it is recommended that the response bid contains this field to signal
 the size of ad chosen.
 

optional int32 w = 13;

hasH

boolean hasH()

 Height of the ad in pixels. If the bid request contained the wmax/hmax and wmin/hmin
 optional fields it is recommended that the response bid contains this field to signal
 the size of ad chosen.
 

optional int32 h = 14;

getH

int getH()

 Height of the ad in pixels. If the bid request contained the wmax/hmax and wmin/hmin
 optional fields it is recommended that the response bid contains this field to signal
 the size of ad chosen.
 

optional int32 h = 14;

hasExt

boolean hasExt()

optional .openrtb.BidExtensions ext = 1000;

getExt

Extension.BidExtensions getExt()

optional .openrtb.BidExtensions ext = 1000;

getExtOrBuilder

Extension.BidExtensionsOrBuilder getExtOrBuilder()

optional .openrtb.BidExtensions ext = 1000;