open_rtb

Interface OpenRtbProtobuf.BidRequestOrBuilder

All Superinterfaces:

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

All Known Implementing Classes:

OpenRtbProtobuf.BidRequest, OpenRtbProtobuf.BidRequest.Builder

Enclosing class:

OpenRtbProtobuf

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

Method Summary

Modifier and Type	Method and Description
int	getAllimps() 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.
OpenRtbProtobuf.App	getApp() See App Object.
OpenRtbProtobuf.AppOrBuilder	getAppOrBuilder() See App Object.
int	getAt() Auction Type.
String	getBadv(int index) Array of strings of blocked top-level domains of advertisers.
com.google.protobuf.ByteString	getBadvBytes(int index) Array of strings of blocked top-level domains of advertisers.
int	getBadvCount() Array of strings of blocked top-level domains of advertisers.
List<String>	getBadvList() Array of strings of blocked top-level domains of advertisers.
String	getBcat(int index) Blocked Advertiser Categories.
com.google.protobuf.ByteString	getBcatBytes(int index) Blocked Advertiser Categories.
int	getBcatCount() Blocked Advertiser Categories.
List<String>	getBcatList() Blocked Advertiser Categories.
String	getCur(int index) Array of allowed currencies for bids on this bid request using ISO-4217 alphabetic codes.
com.google.protobuf.ByteString	getCurBytes(int index) Array of allowed currencies for bids on this bid request using ISO-4217 alphabetic codes.
int	getCurCount() Array of allowed currencies for bids on this bid request using ISO-4217 alphabetic codes.
List<String>	getCurList() Array of allowed currencies for bids on this bid request using ISO-4217 alphabetic codes.
OpenRtbProtobuf.Device	getDevice() See Device Object.
OpenRtbProtobuf.DeviceOrBuilder	getDeviceOrBuilder() See Device Object.
String	getId() Unique ID of the bid request, provided by the exchange.
com.google.protobuf.ByteString	getIdBytes() Unique ID of the bid request, provided by the exchange.
OpenRtbProtobuf.Impression	getImp(int index) Array of impression objects.
int	getImpCount() Array of impression objects.
List<OpenRtbProtobuf.Impression>	getImpList() Array of impression objects.
OpenRtbProtobuf.ImpressionOrBuilder	getImpOrBuilder(int index) Array of impression objects.
List<? extends OpenRtbProtobuf.ImpressionOrBuilder>	getImpOrBuilderList() Array of impression objects.
OpenRtbProtobuf.Regulations	getRegs() This object is a container for any legal, governmental or industry regulations in force for the request.
OpenRtbProtobuf.RegulationsOrBuilder	getRegsOrBuilder() This object is a container for any legal, governmental or industry regulations in force for the request.
OpenRtbProtobuf.Site	getSite() See Site Object.
OpenRtbProtobuf.SiteOrBuilder	getSiteOrBuilder() See Site Object.
int	getTmax() 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).
OpenRtbProtobuf.User	getUser() See User Object.
OpenRtbProtobuf.UserOrBuilder	getUserOrBuilder() See User Object.
String	getWseat(int index) Array of buyer seats allowed to bid on this auction.
com.google.protobuf.ByteString	getWseatBytes(int index) Array of buyer seats allowed to bid on this auction.
int	getWseatCount() Array of buyer seats allowed to bid on this auction.
List<String>	getWseatList() Array of buyer seats allowed to bid on this auction.
boolean	hasAllimps() 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.
boolean	hasApp() See App Object.
boolean	hasAt() Auction Type.
boolean	hasDevice() See Device Object.
boolean	hasId() Unique ID of the bid request, provided by the exchange.
boolean	hasRegs() This object is a container for any legal, governmental or industry regulations in force for the request.
boolean	hasSite() See Site Object.
boolean	hasTmax() 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).
boolean	hasUser() See User Object.

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

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

optional string id = 1;

getId

String getId()

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

optional string id = 1;

getIdBytes

com.google.protobuf.ByteString getIdBytes()

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

optional string id = 1;

getImpList

List<OpenRtbProtobuf.Impression> getImpList()

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

repeated .open_rtb.Impression imp = 2;

getImp

OpenRtbProtobuf.Impression getImp(int index)

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

repeated .open_rtb.Impression imp = 2;

getImpCount

int getImpCount()

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

repeated .open_rtb.Impression imp = 2;

getImpOrBuilderList

List<? extends OpenRtbProtobuf.ImpressionOrBuilder> getImpOrBuilderList()

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

repeated .open_rtb.Impression imp = 2;

getImpOrBuilder

OpenRtbProtobuf.ImpressionOrBuilder getImpOrBuilder(int index)

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

repeated .open_rtb.Impression imp = 2;

hasSite

boolean hasSite()

 See Site Object. 
 

optional .open_rtb.Site site = 3;

getSite

OpenRtbProtobuf.Site getSite()

 See Site Object. 
 

optional .open_rtb.Site site = 3;

getSiteOrBuilder

OpenRtbProtobuf.SiteOrBuilder getSiteOrBuilder()

 See Site Object. 
 

optional .open_rtb.Site site = 3;

hasApp

boolean hasApp()

 See App Object. 
 

optional .open_rtb.App app = 4;

getApp

OpenRtbProtobuf.App getApp()

 See App Object. 
 

optional .open_rtb.App app = 4;

getAppOrBuilder

OpenRtbProtobuf.AppOrBuilder getAppOrBuilder()

 See App Object. 
 

optional .open_rtb.App app = 4;

hasDevice

boolean hasDevice()

 See Device Object. 
 

optional .open_rtb.Device device = 5;

getDevice

OpenRtbProtobuf.Device getDevice()

 See Device Object. 
 

optional .open_rtb.Device device = 5;

getDeviceOrBuilder

OpenRtbProtobuf.DeviceOrBuilder getDeviceOrBuilder()

 See Device Object. 
 

optional .open_rtb.Device device = 5;

hasUser

boolean hasUser()

 See User Object. 
 

optional .open_rtb.User user = 6;

getUser

OpenRtbProtobuf.User getUser()

 See User Object. 
 

optional .open_rtb.User user = 6;

getUserOrBuilder

OpenRtbProtobuf.UserOrBuilder getUserOrBuilder()

 See User Object. 
 

optional .open_rtb.User user = 6;

hasAt

boolean hasAt()

 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. 
 

optional uint32 at = 7 [default = 2];

getAt

int getAt()

 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. 
 

optional uint32 at = 7 [default = 2];

hasTmax

boolean hasTmax()

 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. 
 

optional uint32 tmax = 8;

getTmax

int getTmax()

 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. 
 

optional uint32 tmax = 8;

getWseatList

List<String> getWseatList()

 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. 
 

repeated string wseat = 9;

getWseatCount

int getWseatCount()

 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. 
 

repeated string wseat = 9;

getWseat

String getWseat(int index)

 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. 
 

repeated string wseat = 9;

getWseatBytes

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

 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. 
 

repeated string wseat = 9;

hasAllimps

boolean hasAllimps()

 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. “0” means the exchange cannot verify, and “1” means that all impressions represent all impressions available. 
 

optional uint32 allimps = 10;

getAllimps

int getAllimps()

 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. “0” means the exchange cannot verify, and “1” means that all impressions represent all impressions available. 
 

optional uint32 allimps = 10;

getCurList

List<String> getCurList()

 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. 
 

repeated string cur = 11;

getCurCount

int getCurCount()

 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. 
 

repeated string cur = 11;

getCur

String getCur(int index)

 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. 
 

repeated string cur = 11;

getCurBytes

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

 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. 
 

repeated string cur = 11;

getBcatList

List<String> getBcatList()

 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 (See Table 6.1 Content Categories) 
 

repeated string bcat = 12;

getBcatCount

int getBcatCount()

 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 (See Table 6.1 Content Categories) 
 

repeated string bcat = 12;

getBcat

String getBcat(int index)

 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 (See Table 6.1 Content Categories) 
 

repeated string bcat = 12;

getBcatBytes

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

 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 (See Table 6.1 Content Categories) 
 

repeated string bcat = 12;

getBadvList

List<String> getBadvList()

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

repeated string badv = 13;

getBadvCount

int getBadvCount()

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

repeated string badv = 13;

getBadv

String getBadv(int index)

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

repeated string badv = 13;

getBadvBytes

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

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

repeated string badv = 13;

hasRegs

boolean hasRegs()

 This object is a container for any legal, governmental or industry regulations in force for the request. 
 

optional .open_rtb.Regulations regs = 14;

getRegs

OpenRtbProtobuf.Regulations getRegs()

 This object is a container for any legal, governmental or industry regulations in force for the request. 
 

optional .open_rtb.Regulations regs = 14;

getRegsOrBuilder

OpenRtbProtobuf.RegulationsOrBuilder getRegsOrBuilder()

 This object is a container for any legal, governmental or industry regulations in force for the request. 
 

optional .open_rtb.Regulations regs = 14;