Openrtb.BidRequest (Beeswax API 2017-02-13 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite
- - com.google.protobuf.AbstractMessage
  - - com.google.protobuf.GeneratedMessageV3
    - - com.beeswax.openrtb.Openrtb.BidRequest

All Implemented Interfaces:

Openrtb.BidRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

Enclosing class:

Openrtb
```
public static final class Openrtb.BidRequest
extends com.google.protobuf.GeneratedMessageV3
implements Openrtb.BidRequestOrBuilder
```
```
 OpenRTB 3.3.1: The top-level bid request object.
 
```
Protobuf type openrtb.BidRequest
See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Openrtb.BidRequest.App` OpenRTB 3.3.6: should be included if the ad supported content is part of a mobile application (as opposed to a mobile website).
`static interface`	`Openrtb.BidRequest.AppOrBuilder`
`static class`	`Openrtb.BidRequest.Builder` OpenRTB 3.3.1: The top-level bid request object.
`static class`	`Openrtb.BidRequest.Content` OpenRTB 3.3.7: describes the content of a site or app.
`static interface`	`Openrtb.BidRequest.ContentOrBuilder`
`static class`	`Openrtb.BidRequest.Data` OpenRTB 3.3.13: The data and segment objects together allow data about the user to be passed to bidders in the bid request.
`static interface`	`Openrtb.BidRequest.DataOrBuilder`
`static class`	`Openrtb.BidRequest.Device` OpenRTB 3.3.10: Provides information pertaining to the device including its hardware, platform, location, and carrier.
`static interface`	`Openrtb.BidRequest.DeviceOrBuilder`
`static class`	`Openrtb.BidRequest.Geo` OpenRTB 3.3.11: describes the current geographic location of the Device (e.g., based on IP address or GPS), or the home geo of the User (e.g., based on registration data).
`static interface`	`Openrtb.BidRequest.GeoOrBuilder`
`static class`	`Openrtb.BidRequest.Impression` OpenRTB 3.3.2: describes the ad position or impression being auctioned.
`static interface`	`Openrtb.BidRequest.ImpressionOrBuilder`
`static class`	`Openrtb.BidRequest.Producer` OpenRTB 3.3.9: describes the producer of content object, which might be different from the publisher of the content of the page.
`static interface`	`Openrtb.BidRequest.ProducerOrBuilder`
`static class`	`Openrtb.BidRequest.Publisher` OpenRTB 3.3.8: describes the publisher of a site or app.
`static interface`	`Openrtb.BidRequest.PublisherOrBuilder`
`static class`	`Openrtb.BidRequest.Regulations` OpenRTB 3.3.15: Legal, governmental, or industry regulations that apply to the request.
`static interface`	`Openrtb.BidRequest.RegulationsOrBuilder`
`static class`	`Openrtb.BidRequest.Site` OpenRTB 3.3.5: should be included if the ad supported content is part of a website (as opposed to an application).
`static interface`	`Openrtb.BidRequest.SiteOrBuilder`
`static class`	`Openrtb.BidRequest.User` OpenRTB 3.3.12: contains information known or derived about the human user of the device.
`static interface`	`Openrtb.BidRequest.UserOrBuilder`

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALLIMPS_FIELD_NUMBER`
`static int`	`APP_FIELD_NUMBER`
`static int`	`AT_FIELD_NUMBER`
`static int`	`BADV_FIELD_NUMBER`
`static int`	`BCAT_FIELD_NUMBER`
`static int`	`CUR_FIELD_NUMBER`
`static int`	`DEVICE_FIELD_NUMBER`
`static int`	`EXT_FIELD_NUMBER`
`static int`	`ID_FIELD_NUMBER`
`static int`	`IMP_FIELD_NUMBER`
`static com.google.protobuf.Parser<Openrtb.BidRequest>`	`PARSER` Deprecated.
`static int`	`REGS_FIELD_NUMBER`
`static int`	`SITE_FIELD_NUMBER`
`static int`	`TEST_FIELD_NUMBER`
`static int`	`TMAX_FIELD_NUMBER`
`static int`	`USER_FIELD_NUMBER`
`static int`	`WSEAT_FIELD_NUMBER`

Fields inherited from class com.google.protobuf.GeneratedMessageV3
alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage
memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`OpenrtbCommon.Flag`	`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.
`Openrtb.BidRequest.App`	`getApp()` Information pertaining to a mobile application.
`Openrtb.BidRequest.AppOrBuilder`	`getAppOrBuilder()` Information pertaining to a mobile application.
`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.
`com.google.protobuf.ProtocolStringList`	`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.
`com.google.protobuf.ProtocolStringList`	`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.
`com.google.protobuf.ProtocolStringList`	`getCurList()` Array of allowed currencies for bids on this bid request using ISO-4217 alphabetic codes.
`static Openrtb.BidRequest`	`getDefaultInstance()`
`Openrtb.BidRequest`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`Openrtb.BidRequest.Device`	`getDevice()` Information pertaining to the device.
`Openrtb.BidRequest.DeviceOrBuilder`	`getDeviceOrBuilder()` Information pertaining to the device.
`Extension.BidRequestExtensions`	`getExt()` `optional .openrtb.BidRequestExtensions ext = 1000;`
`Extension.BidRequestExtensionsOrBuilder`	`getExtOrBuilder()` `optional .openrtb.BidRequestExtensions ext = 1000;`
`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.
`Openrtb.BidRequest.Impression`	`getImp(int index)` Multiple impression auctions may be specified in a single bid request.
`int`	`getImpCount()` Multiple impression auctions may be specified in a single bid request.
`List<Openrtb.BidRequest.Impression>`	`getImpList()` Multiple impression auctions may be specified in a single bid request.
`Openrtb.BidRequest.ImpressionOrBuilder`	`getImpOrBuilder(int index)` Multiple impression auctions may be specified in a single bid request.
`List<? extends Openrtb.BidRequest.ImpressionOrBuilder>`	`getImpOrBuilderList()` Multiple impression auctions may be specified in a single bid request.
`com.google.protobuf.Parser<Openrtb.BidRequest>`	`getParserForType()`
`Openrtb.BidRequest.Regulations`	`getRegs()` Container for any legal, governmental or industry regulations in force for the request.
`Openrtb.BidRequest.RegulationsOrBuilder`	`getRegsOrBuilder()` Container for any legal, governmental or industry regulations in force for the request.
`int`	`getSerializedSize()`
`Openrtb.BidRequest.Site`	`getSite()` Information pertaining to a website.
`Openrtb.BidRequest.SiteOrBuilder`	`getSiteOrBuilder()` Information pertaining to a website.
`boolean`	`getTest()` Indicator of test mode in which auctions are not billable, where 0 = live mode, 1 = test mode.
`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).
`com.google.protobuf.UnknownFieldSet`	`getUnknownFields()`
`Openrtb.BidRequest.User`	`getUser()` Information known or derived about the human user of the device.
`Openrtb.BidRequest.UserOrBuilder`	`getUserOrBuilder()` Information known or derived about the human user of the device.
`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.
`com.google.protobuf.ProtocolStringList`	`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()` Information pertaining to a mobile application.
`boolean`	`hasAt()` Auction Type.
`boolean`	`hasDevice()` Information pertaining to the device.
`boolean`	`hasExt()` `optional .openrtb.BidRequestExtensions ext = 1000;`
`int`	`hashCode()`
`boolean`	`hasId()` Unique ID of the bid request, provided by the exchange.
`boolean`	`hasRegs()` Container for any legal, governmental or industry regulations in force for the request.
`boolean`	`hasSite()` Information pertaining to a website.
`boolean`	`hasTest()` Indicator of test mode in which auctions are not billable, where 0 = live mode, 1 = test mode.
`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()` Information known or derived about the human user of the device.
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`static Openrtb.BidRequest.Builder`	`newBuilder()`
`static Openrtb.BidRequest.Builder`	`newBuilder(Openrtb.BidRequest prototype)`
`Openrtb.BidRequest.Builder`	`newBuilderForType()`
`protected Openrtb.BidRequest.Builder`	`newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)`
`static Openrtb.BidRequest`	`parseDelimitedFrom(InputStream input)`
`static Openrtb.BidRequest`	`parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static Openrtb.BidRequest`	`parseFrom(byte[] data)`
`static Openrtb.BidRequest`	`parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static Openrtb.BidRequest`	`parseFrom(com.google.protobuf.ByteString data)`
`static Openrtb.BidRequest`	`parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static Openrtb.BidRequest`	`parseFrom(com.google.protobuf.CodedInputStream input)`
`static Openrtb.BidRequest`	`parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static Openrtb.BidRequest`	`parseFrom(InputStream input)`
`static Openrtb.BidRequest`	`parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static com.google.protobuf.Parser<Openrtb.BidRequest>`	`parser()`
`Openrtb.BidRequest.Builder`	`toBuilder()`
`void`	`writeTo(com.google.protobuf.CodedOutputStream output)`

Methods inherited from class com.google.protobuf.GeneratedMessageV3
computeStringSize, computeStringSizeNoTag, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, makeExtensionsImmutable, newBuilderForType, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite
addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail
- ID_FIELD_NUMBER
```
public static final int ID_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- IMP_FIELD_NUMBER
```
public static final int IMP_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- SITE_FIELD_NUMBER
```
public static final int SITE_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- APP_FIELD_NUMBER
```
public static final int APP_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- DEVICE_FIELD_NUMBER
```
public static final int DEVICE_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- USER_FIELD_NUMBER
```
public static final int USER_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- TEST_FIELD_NUMBER
```
public static final int TEST_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- AT_FIELD_NUMBER
```
public static final int AT_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- TMAX_FIELD_NUMBER
```
public static final int TMAX_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- WSEAT_FIELD_NUMBER
```
public static final int WSEAT_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- ALLIMPS_FIELD_NUMBER
```
public static final int ALLIMPS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- CUR_FIELD_NUMBER
```
public static final int CUR_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- BCAT_FIELD_NUMBER
```
public static final int BCAT_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- BADV_FIELD_NUMBER
```
public static final int BADV_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- REGS_FIELD_NUMBER
```
public static final int REGS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- EXT_FIELD_NUMBER
```
public static final int EXT_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- PARSER
```
@Deprecated
public static final com.google.protobuf.Parser<Openrtb.BidRequest> PARSER
```
  Deprecated.

Method Detail

getUnknownFields
```
public final com.google.protobuf.UnknownFieldSet getUnknownFields()
```
Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable
```
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
```
Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

hasId

public boolean hasId()

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

required string id = 1;

Specified by:: hasId in interface Openrtb.BidRequestOrBuilder

getId

public String getId()

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

required string id = 1;

Specified by:: getId in interface Openrtb.BidRequestOrBuilder

getIdBytes

public com.google.protobuf.ByteString getIdBytes()

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

required string id = 1;

Specified by:: getIdBytes in interface Openrtb.BidRequestOrBuilder