open_rtb

Interface OpenRtbProtobuf.BidOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

OpenRtbProtobuf.Bid, OpenRtbProtobuf.Bid.Builder

Enclosing class:

OpenRtbProtobuf

public static interface OpenRtbProtobuf.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.
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.
int	getAttr(int index) Array of creative attributes.
int	getAttrCount() Array of creative attributes.
List<Integer>	getAttrList() Array of creative attributes.
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.
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	getLurl() Sample image URL (without cache busting) for content checking.
com.google.protobuf.ByteString	getLurlBytes() 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	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	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	hasLurl() 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. 
 

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

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

optional string id = 1;

hasImpid

boolean hasImpid()

 ID of the impression object to which this bid applies. 
 

optional string impid = 2;

getImpid

String getImpid()

 ID of the impression object to which this bid applies. 
 

optional string impid = 2;

getImpidBytes

com.google.protobuf.ByteString getImpidBytes()

 ID of the impression object to which this bid applies. 
 

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

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

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

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. 
 

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. 
 

optional string adm = 6;

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;

hasLurl

boolean hasLurl()

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

optional string lurl = 8;

getLurl

String getLurl()

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

optional string lurl = 8;

getLurlBytes

com.google.protobuf.ByteString getLurlBytes()

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

optional string lurl = 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. 
 

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. 
 

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. 
 

optional string crid = 10;

getAttrList

List<Integer> getAttrList()

 Array of creative attributes. See Table 6.3 Creative Attributes. 
 

repeated uint32 attr = 11 [packed = true];

getAttrCount

int getAttrCount()

 Array of creative attributes. See Table 6.3 Creative Attributes. 
 

repeated uint32 attr = 11 [packed = true];

getAttr

int getAttr(int index)

 Array of creative attributes. See Table 6.3 Creative Attributes. 
 

repeated uint32 attr = 11 [packed = true];

hasDealid

boolean hasDealid()

 A unique identifier for the direct deal associated with the bid. If the bid is associated and in response to a dealid in the request object it is _required_ in the response object. 
 

optional string dealid = 12;

getDealid

String getDealid()

 A unique identifier for the direct deal associated with the bid. If the bid is associated and in response to a dealid in the request object it is _required_ in the response object. 
 

optional string dealid = 12;

getDealidBytes

com.google.protobuf.ByteString getDealidBytes()

 A unique identifier for the direct deal associated with the bid. If the bid is associated and in response to a dealid in the request object it is _required_ in the response object. 
 

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 uint32 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 uint32 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 uint32 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 uint32 h = 14;