com.beeswax.openrtb

Interface Openrtb.BidRequestOrBuilder

All Superinterfaces:

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

All Known Implementing Classes:

Openrtb.BidRequest, Openrtb.BidRequest.Builder

Enclosing class:

Openrtb

public static interface Openrtb.BidRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
OpenrtbCommon.Flag	getAllimps() optional .openrtb.Flag allimps = 10 [default = NO];
Openrtb.BidRequest.App	getApp() optional .openrtb.BidRequest.App app = 4;
Openrtb.BidRequest.AppOrBuilder	getAppOrBuilder() optional .openrtb.BidRequest.App app = 4;
int	getAt() optional int32 at = 7 [default = 2];
String	getBadv(int index) repeated string badv = 13;
com.google.protobuf.ByteString	getBadvBytes(int index) repeated string badv = 13;
int	getBadvCount() repeated string badv = 13;
com.google.protobuf.ProtocolStringList	getBadvList() repeated string badv = 13;
String	getBcat(int index) repeated string bcat = 12;
com.google.protobuf.ByteString	getBcatBytes(int index) repeated string bcat = 12;
int	getBcatCount() repeated string bcat = 12;
com.google.protobuf.ProtocolStringList	getBcatList() repeated string bcat = 12;
String	getCur(int index) repeated string cur = 11;
com.google.protobuf.ByteString	getCurBytes(int index) repeated string cur = 11;
int	getCurCount() repeated string cur = 11;
com.google.protobuf.ProtocolStringList	getCurList() repeated string cur = 11;
Openrtb.BidRequest.Device	getDevice() optional .openrtb.BidRequest.Device device = 5;
Openrtb.BidRequest.DeviceOrBuilder	getDeviceOrBuilder() optional .openrtb.BidRequest.Device device = 5;
Extension.BidRequestExtensions	getExt() optional .openrtb.BidRequestExtensions ext = 1000;
Extension.BidRequestExtensionsOrBuilder	getExtOrBuilder() optional .openrtb.BidRequestExtensions ext = 1000;
String	getId() required string id = 1;
com.google.protobuf.ByteString	getIdBytes() required string id = 1;
Openrtb.BidRequest.Impression	getImp(int index) repeated .openrtb.BidRequest.Impression imp = 2;
int	getImpCount() repeated .openrtb.BidRequest.Impression imp = 2;
List<Openrtb.BidRequest.Impression>	getImpList() repeated .openrtb.BidRequest.Impression imp = 2;
Openrtb.BidRequest.ImpressionOrBuilder	getImpOrBuilder(int index) repeated .openrtb.BidRequest.Impression imp = 2;
List<? extends Openrtb.BidRequest.ImpressionOrBuilder>	getImpOrBuilderList() repeated .openrtb.BidRequest.Impression imp = 2;
Openrtb.BidRequest.Regulations	getRegs() optional .openrtb.BidRequest.Regulations regs = 14;
Openrtb.BidRequest.RegulationsOrBuilder	getRegsOrBuilder() optional .openrtb.BidRequest.Regulations regs = 14;
Openrtb.BidRequest.Site	getSite() optional .openrtb.BidRequest.Site site = 3;
Openrtb.BidRequest.SiteOrBuilder	getSiteOrBuilder() optional .openrtb.BidRequest.Site site = 3;
boolean	getTest() optional bool test = 15 [default = false];
int	getTmax() optional int32 tmax = 8;
Openrtb.BidRequest.User	getUser() optional .openrtb.BidRequest.User user = 6;
Openrtb.BidRequest.UserOrBuilder	getUserOrBuilder() optional .openrtb.BidRequest.User user = 6;
String	getWseat(int index) repeated string wseat = 9;
com.google.protobuf.ByteString	getWseatBytes(int index) repeated string wseat = 9;
int	getWseatCount() repeated string wseat = 9;
com.google.protobuf.ProtocolStringList	getWseatList() repeated string wseat = 9;
boolean	hasAllimps() optional .openrtb.Flag allimps = 10 [default = NO];
boolean	hasApp() optional .openrtb.BidRequest.App app = 4;
boolean	hasAt() optional int32 at = 7 [default = 2];
boolean	hasDevice() optional .openrtb.BidRequest.Device device = 5;
boolean	hasExt() optional .openrtb.BidRequestExtensions ext = 1000;
boolean	hasId() required string id = 1;
boolean	hasRegs() optional .openrtb.BidRequest.Regulations regs = 14;
boolean	hasSite() optional .openrtb.BidRequest.Site site = 3;
boolean	hasTest() optional bool test = 15 [default = false];
boolean	hasTmax() optional int32 tmax = 8;
boolean	hasUser() optional .openrtb.BidRequest.User user = 6;

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()

required string id = 1;

 Unique ID of the bid request, provided by the exchange.
 

getId

String getId()

required string id = 1;

 Unique ID of the bid request, provided by the exchange.
 

getIdBytes

com.google.protobuf.ByteString getIdBytes()

required string id = 1;

 Unique ID of the bid request, provided by the exchange.
 

getImpList

List<Openrtb.BidRequest.Impression> getImpList()

repeated .openrtb.BidRequest.Impression imp = 2;

 Multiple impression auctions may be specified in a single bid request.
 At least one impression is required for a valid bid request.
 

getImp

Openrtb.BidRequest.Impression getImp(int index)

repeated .openrtb.BidRequest.Impression imp = 2;

 Multiple impression auctions may be specified in a single bid request.
 At least one impression is required for a valid bid request.
 

getImpCount

int getImpCount()

repeated .openrtb.BidRequest.Impression imp = 2;

 Multiple impression auctions may be specified in a single bid request.
 At least one impression is required for a valid bid request.
 

getImpOrBuilderList

List<? extends Openrtb.BidRequest.ImpressionOrBuilder> getImpOrBuilderList()

repeated .openrtb.BidRequest.Impression imp = 2;

 Multiple impression auctions may be specified in a single bid request.
 At least one impression is required for a valid bid request.
 

getImpOrBuilder

Openrtb.BidRequest.ImpressionOrBuilder getImpOrBuilder(int index)

repeated .openrtb.BidRequest.Impression imp = 2;

 Multiple impression auctions may be specified in a single bid request.
 At least one impression is required for a valid bid request.
 

hasSite

boolean hasSite()

optional .openrtb.BidRequest.Site site = 3;

 Information pertaining to a website.
 

getSite

Openrtb.BidRequest.Site getSite()

optional .openrtb.BidRequest.Site site = 3;

 Information pertaining to a website.
 

getSiteOrBuilder

Openrtb.BidRequest.SiteOrBuilder getSiteOrBuilder()

optional .openrtb.BidRequest.Site site = 3;

 Information pertaining to a website.
 

hasApp

boolean hasApp()

optional .openrtb.BidRequest.App app = 4;

 Information pertaining to a mobile application.
 

getApp

Openrtb.BidRequest.App getApp()

optional .openrtb.BidRequest.App app = 4;

 Information pertaining to a mobile application.
 

getAppOrBuilder

Openrtb.BidRequest.AppOrBuilder getAppOrBuilder()

optional .openrtb.BidRequest.App app = 4;

 Information pertaining to a mobile application.
 

hasDevice

boolean hasDevice()

optional .openrtb.BidRequest.Device device = 5;

 Information pertaining to the device.
 

getDevice

Openrtb.BidRequest.Device getDevice()

optional .openrtb.BidRequest.Device device = 5;

 Information pertaining to the device.
 

getDeviceOrBuilder

Openrtb.BidRequest.DeviceOrBuilder getDeviceOrBuilder()

optional .openrtb.BidRequest.Device device = 5;

 Information pertaining to the device.
 

hasUser

boolean hasUser()

optional .openrtb.BidRequest.User user = 6;

 Information known or derived about the human user of the device.
 

getUser

Openrtb.BidRequest.User getUser()

optional .openrtb.BidRequest.User user = 6;

 Information known or derived about the human user of the device.
 

getUserOrBuilder

Openrtb.BidRequest.UserOrBuilder getUserOrBuilder()

optional .openrtb.BidRequest.User user = 6;

 Information known or derived about the human user of the device.
 

hasTest

boolean hasTest()

optional bool test = 15 [default = false];

 Indicator of test mode in which auctions are not billable,
 where 0 = live mode, 1 = test mode.
 

getTest

boolean getTest()

optional bool test = 15 [default = false];

 Indicator of test mode in which auctions are not billable,
 where 0 = live mode, 1 = test mode.
 

hasAt

boolean hasAt()

optional int32 at = 7 [default = 2];

 Auction Type. If “1”, then first price auction. If “2”, then second price
 auction.
 Additional auction types can be defined as per the exchange’s business
 rules.
 Exchange specific rules should be numbered over 500.
 

getAt

int getAt()

optional int32 at = 7 [default = 2];

 Auction Type. If “1”, then first price auction. If “2”, then second price
 auction.
 Additional auction types can be defined as per the exchange’s business
 rules.
 Exchange specific rules should be numbered over 500.
 

hasTmax

boolean hasTmax()

optional int32 tmax = 8;

 Maximum amount of time in milliseconds to submit a bid (e.g., 120 means the
 bidder has 120ms to submit a bid before the auction is complete). If this
 value never changes across an exchange, then the exchange can supply this
 information offline.
 

getTmax

int getTmax()

optional int32 tmax = 8;

 Maximum amount of time in milliseconds to submit a bid (e.g., 120 means the
 bidder has 120ms to submit a bid before the auction is complete). If this
 value never changes across an exchange, then the exchange can supply this
 information offline.
 

getWseatList

com.google.protobuf.ProtocolStringList getWseatList()

repeated string wseat = 9;

 Array of buyer seats allowed to bid on this auction. Seats are an optional
 feature of exchange. For example, [“4”,”34”,”82”,”A45”] indicates that only
 advertisers using these exchange seats are allowed to bid on the
 impressions in this auction.
 

getWseatCount

int getWseatCount()

repeated string wseat = 9;

 Array of buyer seats allowed to bid on this auction. Seats are an optional
 feature of exchange. For example, [“4”,”34”,”82”,”A45”] indicates that only
 advertisers using these exchange seats are allowed to bid on the
 impressions in this auction.
 

getWseat

String getWseat(int index)

repeated string wseat = 9;

 Array of buyer seats allowed to bid on this auction. Seats are an optional
 feature of exchange. For example, [“4”,”34”,”82”,”A45”] indicates that only
 advertisers using these exchange seats are allowed to bid on the
 impressions in this auction.
 

getWseatBytes

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

repeated string wseat = 9;

 Array of buyer seats allowed to bid on this auction. Seats are an optional
 feature of exchange. For example, [“4”,”34”,”82”,”A45”] indicates that only
 advertisers using these exchange seats are allowed to bid on the
 impressions in this auction.
 

hasAllimps

boolean hasAllimps()

optional .openrtb.Flag allimps = 10 [default = NO];

 Flag to indicate whether Exchange can verify that all impressions offered
 represent all of the impressions available in context (e.g., all
 impressions available on the web page; all impressions available for a
 video [pre, mid and postroll spots], etc.) to support road-blocking. A true
 value should only be passed if the exchange is aware of all impressions in
 context for the publisher. NO means the exchange cannot verify, and YES
 means that all impressions represent all impressions available.
 

getAllimps

OpenrtbCommon.Flag getAllimps()

optional .openrtb.Flag allimps = 10 [default = NO];

 Flag to indicate whether Exchange can verify that all impressions offered
 represent all of the impressions available in context (e.g., all
 impressions available on the web page; all impressions available for a
 video [pre, mid and postroll spots], etc.) to support road-blocking. A true
 value should only be passed if the exchange is aware of all impressions in
 context for the publisher. NO means the exchange cannot verify, and YES
 means that all impressions represent all impressions available.
 

getCurList

com.google.protobuf.ProtocolStringList getCurList()

repeated string cur = 11;

 Array of allowed currencies for bids on this bid request using ISO-4217 alphabetic codes.
 If only one currency is used by the exchange, this parameter is not required.
 

getCurCount

int getCurCount()

repeated string cur = 11;

 Array of allowed currencies for bids on this bid request using ISO-4217 alphabetic codes.
 If only one currency is used by the exchange, this parameter is not required.
 

getCur

String getCur(int index)

repeated string cur = 11;

 Array of allowed currencies for bids on this bid request using ISO-4217 alphabetic codes.
 If only one currency is used by the exchange, this parameter is not required.
 

getCurBytes

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

repeated string cur = 11;

 Array of allowed currencies for bids on this bid request using ISO-4217 alphabetic codes.
 If only one currency is used by the exchange, this parameter is not required.
 

getBcatList

com.google.protobuf.ProtocolStringList getBcatList()

repeated string bcat = 12;

 Blocked Advertiser Categories. Note that there is no existing categorization / taxonomy of
 advertiser industries. However, as a substitute exchanges may decide to use IAB categories
 as an approximation.
 

getBcatCount

int getBcatCount()

repeated string bcat = 12;

 Blocked Advertiser Categories. Note that there is no existing categorization / taxonomy of
 advertiser industries. However, as a substitute exchanges may decide to use IAB categories
 as an approximation.
 

getBcat

String getBcat(int index)

repeated string bcat = 12;

 Blocked Advertiser Categories. Note that there is no existing categorization / taxonomy of
 advertiser industries. However, as a substitute exchanges may decide to use IAB categories
 as an approximation.
 

getBcatBytes

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

repeated string bcat = 12;

 Blocked Advertiser Categories. Note that there is no existing categorization / taxonomy of
 advertiser industries. However, as a substitute exchanges may decide to use IAB categories
 as an approximation.
 

getBadvList

com.google.protobuf.ProtocolStringList getBadvList()

repeated string badv = 13;

 Array of strings of blocked top-level domains of advertisers.
 For example, {“company1.com”, “company2.com”}.
 

getBadvCount

int getBadvCount()

repeated string badv = 13;

 Array of strings of blocked top-level domains of advertisers.
 For example, {“company1.com”, “company2.com”}.
 

getBadv

String getBadv(int index)

repeated string badv = 13;

 Array of strings of blocked top-level domains of advertisers.
 For example, {“company1.com”, “company2.com”}.
 

getBadvBytes

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

repeated string badv = 13;

 Array of strings of blocked top-level domains of advertisers.
 For example, {“company1.com”, “company2.com”}.
 

hasRegs

boolean hasRegs()

optional .openrtb.BidRequest.Regulations regs = 14;

 Container for any legal, governmental or industry regulations in force for the request.
 

getRegs

Openrtb.BidRequest.Regulations getRegs()

optional .openrtb.BidRequest.Regulations regs = 14;

 Container for any legal, governmental or industry regulations in force for the request.
 

getRegsOrBuilder

Openrtb.BidRequest.RegulationsOrBuilder getRegsOrBuilder()

optional .openrtb.BidRequest.Regulations regs = 14;

 Container for any legal, governmental or industry regulations in force for the request.
 

hasExt

boolean hasExt()

optional .openrtb.BidRequestExtensions ext = 1000;

getExt

Extension.BidRequestExtensions getExt()

optional .openrtb.BidRequestExtensions ext = 1000;

getExtOrBuilder

Extension.BidRequestExtensionsOrBuilder getExtOrBuilder()

optional .openrtb.BidRequestExtensions ext = 1000;