open_rtb

Class OpenRtbProtobuf.BidResponse

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

open_rtb.OpenRtbProtobuf.BidResponse

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable, OpenRtbProtobuf.BidResponseOrBuilder

Enclosing class:

OpenRtbProtobuf

public static final class OpenRtbProtobuf.BidResponse
extends com.google.protobuf.GeneratedMessageV3
implements OpenRtbProtobuf.BidResponseOrBuilder

 4.3.1 Bid Response Object
The top-level bid response object is defined below. The “id” attribute is a reflection of the bid request ID for logging purposes. Similarly, “bidid” is an optional response tracking ID for bidders. If specified, it can be included in the subsequent win notice call if the bidder wins. At least one “seatbid” object is required, which contains a bid on at least one impression. Other attributes are optional since an exchange may establish default values.
No-Bids on all impressions should be indicated as a HTTP 204 response. For no-bids on specific impressions, the bidder should omit these from the bid response. 
 

Protobuf type open_rtb.BidResponse

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OpenRtbProtobuf.BidResponse.Builder 4.3.1 Bid Response Object The top-level bid response object is defined below.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

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	BIDID_FIELD_NUMBER
static int	CUR_FIELD_NUMBER
static int	CUSTOMDATA_FIELD_NUMBER
static int	ID_FIELD_NUMBER
static int	NBR_FIELD_NUMBER
static com.google.protobuf.Parser<OpenRtbProtobuf.BidResponse>	PARSER Deprecated.
static int	SEATBID_FIELD_NUMBER

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getBidid() Bid response ID to assist tracking for bidders.
com.google.protobuf.ByteString	getBididBytes() Bid response ID to assist tracking for bidders.
String	getCur() Bid currency using ISO-4217 alphabetic codes; default is “USD”.
com.google.protobuf.ByteString	getCurBytes() Bid currency using ISO-4217 alphabetic codes; default is “USD”.
String	getCustomdata() This is an optional feature, which allows a bidder to set data in the exchange’s cookie.
com.google.protobuf.ByteString	getCustomdataBytes() This is an optional feature, which allows a bidder to set data in the exchange’s cookie.
static OpenRtbProtobuf.BidResponse	getDefaultInstance()
OpenRtbProtobuf.BidResponse	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
String	getId() ID of the bid request.
com.google.protobuf.ByteString	getIdBytes() ID of the bid request.
int	getNbr() Reason for not bidding.
com.google.protobuf.Parser<OpenRtbProtobuf.BidResponse>	getParserForType()
OpenRtbProtobuf.SeatBid	getSeatbid(int index) Array of seatbid objects.
int	getSeatbidCount() Array of seatbid objects.
List<OpenRtbProtobuf.SeatBid>	getSeatbidList() Array of seatbid objects.
OpenRtbProtobuf.SeatBidOrBuilder	getSeatbidOrBuilder(int index) Array of seatbid objects.
List<? extends OpenRtbProtobuf.SeatBidOrBuilder>	getSeatbidOrBuilderList() Array of seatbid objects.
int	getSerializedSize()
com.google.protobuf.UnknownFieldSet	getUnknownFields()
boolean	hasBidid() Bid response ID to assist tracking for bidders.
boolean	hasCur() Bid currency using ISO-4217 alphabetic codes; default is “USD”.
boolean	hasCustomdata() This is an optional feature, which allows a bidder to set data in the exchange’s cookie.
int	hashCode()
boolean	hasId() ID of the bid request.
boolean	hasNbr() Reason for not bidding.
boolean	isInitialized()
static OpenRtbProtobuf.BidResponse.Builder	newBuilder()
static OpenRtbProtobuf.BidResponse.Builder	newBuilder(OpenRtbProtobuf.BidResponse prototype)
OpenRtbProtobuf.BidResponse.Builder	newBuilderForType()
static OpenRtbProtobuf.BidResponse	parseDelimitedFrom(InputStream input)
static OpenRtbProtobuf.BidResponse	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static OpenRtbProtobuf.BidResponse	parseFrom(byte[] data)
static OpenRtbProtobuf.BidResponse	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static OpenRtbProtobuf.BidResponse	parseFrom(com.google.protobuf.ByteString data)
static OpenRtbProtobuf.BidResponse	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static OpenRtbProtobuf.BidResponse	parseFrom(com.google.protobuf.CodedInputStream input)
static OpenRtbProtobuf.BidResponse	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static OpenRtbProtobuf.BidResponse	parseFrom(InputStream input)
static OpenRtbProtobuf.BidResponse	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<OpenRtbProtobuf.BidResponse>	parser()
OpenRtbProtobuf.BidResponse.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

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

SEATBID_FIELD_NUMBER

public static final int SEATBID_FIELD_NUMBER

See Also:

Constant Field Values

BIDID_FIELD_NUMBER

public static final int BIDID_FIELD_NUMBER

See Also:

Constant Field Values

CUR_FIELD_NUMBER

public static final int CUR_FIELD_NUMBER

See Also:

Constant Field Values

CUSTOMDATA_FIELD_NUMBER

public static final int CUSTOMDATA_FIELD_NUMBER

See Also:

Constant Field Values

NBR_FIELD_NUMBER

public static final int NBR_FIELD_NUMBER

See Also:

Constant Field Values

PARSER

@Deprecated
public static final com.google.protobuf.Parser<OpenRtbProtobuf.BidResponse> 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()

hasId

public boolean hasId()

 ID of the bid request. 
 

optional string id = 1;

Specified by:

hasId in interface OpenRtbProtobuf.BidResponseOrBuilder

getId

public String getId()

 ID of the bid request. 
 

optional string id = 1;

Specified by:

getId in interface OpenRtbProtobuf.BidResponseOrBuilder

getIdBytes

public com.google.protobuf.ByteString getIdBytes()

 ID of the bid request. 
 

optional string id = 1;

Specified by:

getIdBytes in interface OpenRtbProtobuf.BidResponseOrBuilder

getSeatbidList

public List<OpenRtbProtobuf.SeatBid> getSeatbidList()

 Array of seatbid objects. 
 

repeated .open_rtb.SeatBid seatbid = 2;

Specified by:

getSeatbidList in interface OpenRtbProtobuf.BidResponseOrBuilder

getSeatbidOrBuilderList

public List<? extends OpenRtbProtobuf.SeatBidOrBuilder> getSeatbidOrBuilderList()

 Array of seatbid objects. 
 

repeated .open_rtb.SeatBid seatbid = 2;

Specified by:

getSeatbidOrBuilderList in interface OpenRtbProtobuf.BidResponseOrBuilder

getSeatbidCount

public int getSeatbidCount()

 Array of seatbid objects. 
 

repeated .open_rtb.SeatBid seatbid = 2;

Specified by:

getSeatbidCount in interface OpenRtbProtobuf.BidResponseOrBuilder

getSeatbid

public OpenRtbProtobuf.SeatBid getSeatbid(int index)

 Array of seatbid objects. 
 

repeated .open_rtb.SeatBid seatbid = 2;

Specified by:

getSeatbid in interface OpenRtbProtobuf.BidResponseOrBuilder

getSeatbidOrBuilder

public OpenRtbProtobuf.SeatBidOrBuilder getSeatbidOrBuilder(int index)

 Array of seatbid objects. 
 

repeated .open_rtb.SeatBid seatbid = 2;

Specified by:

getSeatbidOrBuilder in interface OpenRtbProtobuf.BidResponseOrBuilder

hasBidid

public boolean hasBidid()

 Bid response ID to assist tracking for bidders. This value is chosen by the bidder for cross-reference. 
 

optional string bidid = 3;

Specified by:

hasBidid in interface OpenRtbProtobuf.BidResponseOrBuilder

getBidid

public String getBidid()

 Bid response ID to assist tracking for bidders. This value is chosen by the bidder for cross-reference. 
 

optional string bidid = 3;

Specified by:

getBidid in interface OpenRtbProtobuf.BidResponseOrBuilder

getBididBytes

public com.google.protobuf.ByteString getBididBytes()

 Bid response ID to assist tracking for bidders. This value is chosen by the bidder for cross-reference. 
 

optional string bidid = 3;

Specified by:

getBididBytes in interface OpenRtbProtobuf.BidResponseOrBuilder

hasCur

public boolean hasCur()

 Bid currency using ISO-4217 alphabetic codes; default is “USD”. 
 

optional string cur = 4 [default = "USD"];

Specified by:

hasCur in interface OpenRtbProtobuf.BidResponseOrBuilder

getCur

public String getCur()

 Bid currency using ISO-4217 alphabetic codes; default is “USD”. 
 

optional string cur = 4 [default = "USD"];

Specified by:

getCur in interface OpenRtbProtobuf.BidResponseOrBuilder

getCurBytes

public com.google.protobuf.ByteString getCurBytes()

 Bid currency using ISO-4217 alphabetic codes; default is “USD”. 
 

optional string cur = 4 [default = "USD"];

Specified by:

getCurBytes in interface OpenRtbProtobuf.BidResponseOrBuilder

hasCustomdata

public boolean hasCustomdata()

 This is an optional feature, which allows a bidder to set data in the exchange’s cookie. The string may be in base85 cookie safe characters, and be in any format. This may be useful for storing user features. Note: Proper JSON encoding must be used to include “escaped” quotation marks. 
 

optional string customdata = 5;

Specified by:

hasCustomdata in interface OpenRtbProtobuf.BidResponseOrBuilder

getCustomdata

public String getCustomdata()

 This is an optional feature, which allows a bidder to set data in the exchange’s cookie. The string may be in base85 cookie safe characters, and be in any format. This may be useful for storing user features. Note: Proper JSON encoding must be used to include “escaped” quotation marks. 
 

optional string customdata = 5;

Specified by:

getCustomdata in interface OpenRtbProtobuf.BidResponseOrBuilder

getCustomdataBytes

public com.google.protobuf.ByteString getCustomdataBytes()

 This is an optional feature, which allows a bidder to set data in the exchange’s cookie. The string may be in base85 cookie safe characters, and be in any format. This may be useful for storing user features. Note: Proper JSON encoding must be used to include “escaped” quotation marks. 
 

optional string customdata = 5;

Specified by:

getCustomdataBytes in interface OpenRtbProtobuf.BidResponseOrBuilder

hasNbr

public boolean hasNbr()

 Reason for not bidding. See Table 6.19 No-Bid Reason Codes. 
 

optional uint32 nbr = 6;

Specified by:

hasNbr in interface OpenRtbProtobuf.BidResponseOrBuilder

getNbr

public int getNbr()

 Reason for not bidding. See Table 6.19 No-Bid Reason Codes. 
 

optional uint32 nbr = 6;

Specified by:

getNbr in interface OpenRtbProtobuf.BidResponseOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static OpenRtbProtobuf.BidResponse parseFrom(com.google.protobuf.ByteString data)
                                             throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static OpenRtbProtobuf.BidResponse parseFrom(com.google.protobuf.ByteString data,
                                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                             throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static OpenRtbProtobuf.BidResponse parseFrom(byte[] data)
                                             throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static OpenRtbProtobuf.BidResponse parseFrom(byte[] data,
                                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                             throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static OpenRtbProtobuf.BidResponse parseFrom(InputStream input)
                                             throws IOException

Throws:

IOException

parseFrom

public static OpenRtbProtobuf.BidResponse parseFrom(InputStream input,
                                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                             throws IOException

Throws:

IOException

parseDelimitedFrom

public static OpenRtbProtobuf.BidResponse parseDelimitedFrom(InputStream input)
                                                      throws IOException

Throws:

IOException

parseDelimitedFrom

public static OpenRtbProtobuf.BidResponse parseDelimitedFrom(InputStream input,
                                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                      throws IOException

Throws:

IOException

parseFrom

public static OpenRtbProtobuf.BidResponse parseFrom(com.google.protobuf.CodedInputStream input)
                                             throws IOException

Throws:

IOException

parseFrom

public static OpenRtbProtobuf.BidResponse parseFrom(com.google.protobuf.CodedInputStream input,
                                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                             throws IOException

Throws:

IOException

newBuilderForType

public OpenRtbProtobuf.BidResponse.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static OpenRtbProtobuf.BidResponse.Builder newBuilder()

newBuilder

public static OpenRtbProtobuf.BidResponse.Builder newBuilder(OpenRtbProtobuf.BidResponse prototype)

toBuilder

public OpenRtbProtobuf.BidResponse.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

getDefaultInstance

public static OpenRtbProtobuf.BidResponse getDefaultInstance()

parser

public static com.google.protobuf.Parser<OpenRtbProtobuf.BidResponse> parser()

getParserForType

public com.google.protobuf.Parser<OpenRtbProtobuf.BidResponse> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public OpenRtbProtobuf.BidResponse getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder