Package com.google.openrtb

Class OpenRtb.BidResponse

  • All Implemented Interfaces:
    OpenRtb.BidResponseOrBuilder, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<OpenRtb.BidResponse>, 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.BidResponse
extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<OpenRtb.BidResponse>
implements OpenRtb.BidResponseOrBuilder
     OpenRTB 2.0: This object is the top-level bid response object (i.e., the
 unnamed outer JSON object). 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 at least one bid for an impression. Other attributes are
 optional. To express a "no-bid", the options are to return an empty response
 with HTTP 204. Alternately if the bidder wishes to convey to the exchange a
 reason for not bidding, just a BidResponse object is returned with a
 reason code in the nbr attribute.
    Protobuf type com.google.openrtb.BidResponse
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  OpenRtb.BidResponse.Builder
      OpenRTB 2.0: This object is the top-level bid response object (i.e., the unnamed outer JSON object).
      static class  OpenRtb.BidResponse.SeatBid
      OpenRTB 2.0: A bid response can contain multiple SeatBid objects, each on behalf of a different bidder seat and each containing one or more individual bids.
      static interface  OpenRtb.BidResponse.SeatBidOrBuilder  

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

        com.google.protobuf.GeneratedMessageV3.ExtendableMessage.ExtensionWriter

      • 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, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • 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()
         ID of the bid request to which this is a response.
 REQUIRED by the OpenRTB specification.
        required string id = 1;
        Specified by:
        hasId in interface OpenRtb.BidResponseOrBuilder
        Returns:
        Whether the id field is set.

      • getId

        public String getId()
         ID of the bid request to which this is a response.
 REQUIRED by the OpenRTB specification.
        required string id = 1;
        Specified by:
        getId in interface OpenRtb.BidResponseOrBuilder
        Returns:
        The id.

      • getIdBytes

        public com.google.protobuf.ByteString getIdBytes()
         ID of the bid request to which this is a response.
 REQUIRED by the OpenRTB specification.
        required string id = 1;
        Specified by:
        getIdBytes in interface OpenRtb.BidResponseOrBuilder
        Returns:
        The bytes for id.

      • getSeatbidCount

        public int getSeatbidCount()
         Array of seatbid objects; 1+ required if a bid is to be made.
        repeated .com.google.openrtb.BidResponse.SeatBid seatbid = 2;
        Specified by:
        getSeatbidCount in interface OpenRtb.BidResponseOrBuilder

      • hasBidid

        public boolean hasBidid()
         Bidder generated response ID to assist with logging/tracking.
        optional string bidid = 3;
        Specified by:
        hasBidid in interface OpenRtb.BidResponseOrBuilder
        Returns:
        Whether the bidid field is set.

      • getBidid

        public String getBidid()
         Bidder generated response ID to assist with logging/tracking.
        optional string bidid = 3;
        Specified by:
        getBidid in interface OpenRtb.BidResponseOrBuilder
        Returns:
        The bidid.

      • getBididBytes

        public com.google.protobuf.ByteString getBididBytes()
         Bidder generated response ID to assist with logging/tracking.
        optional string bidid = 3;
        Specified by:
        getBididBytes in interface OpenRtb.BidResponseOrBuilder
        Returns:
        The bytes for bidid.

      • hasCur

        public boolean hasCur()
         Bid currency using ISO-4217 alpha codes. This field will be required
 starting in Q4 2022. If this field is populated and differs from the
 bidding currency, the bid will be filtered. If this field is not populated,
 the currency will be assumed to be the bidding currency. The bidding
 currency is determined by:
 1. The bidder-level currency, if configured in RTB account settings.
 2. Otherwise, the currency of the buyer account indicated by the
 billing ID in the cid field of the bid response.
 3. Otherwise, if cid is not populated in the bid response, the
 currency of the buyer account indicated by the sole billing ID in the
 bid request.
 The currency of the buyer account is set on account creation and can be
 checked by contacting a Technical Account Manager.
        optional string cur = 4;
        Specified by:
        hasCur in interface OpenRtb.BidResponseOrBuilder
        Returns:
        Whether the cur field is set.

      • getCur

        public String getCur()
         Bid currency using ISO-4217 alpha codes. This field will be required
 starting in Q4 2022. If this field is populated and differs from the
 bidding currency, the bid will be filtered. If this field is not populated,
 the currency will be assumed to be the bidding currency. The bidding
 currency is determined by:
 1. The bidder-level currency, if configured in RTB account settings.
 2. Otherwise, the currency of the buyer account indicated by the
 billing ID in the cid field of the bid response.
 3. Otherwise, if cid is not populated in the bid response, the
 currency of the buyer account indicated by the sole billing ID in the
 bid request.
 The currency of the buyer account is set on account creation and can be
 checked by contacting a Technical Account Manager.
        optional string cur = 4;
        Specified by:
        getCur in interface OpenRtb.BidResponseOrBuilder
        Returns:
        The cur.

      • getCurBytes

        public com.google.protobuf.ByteString getCurBytes()
         Bid currency using ISO-4217 alpha codes. This field will be required
 starting in Q4 2022. If this field is populated and differs from the
 bidding currency, the bid will be filtered. If this field is not populated,
 the currency will be assumed to be the bidding currency. The bidding
 currency is determined by:
 1. The bidder-level currency, if configured in RTB account settings.
 2. Otherwise, the currency of the buyer account indicated by the
 billing ID in the cid field of the bid response.
 3. Otherwise, if cid is not populated in the bid response, the
 currency of the buyer account indicated by the sole billing ID in the
 bid request.
 The currency of the buyer account is set on account creation and can be
 checked by contacting a Technical Account Manager.
        optional string cur = 4;
        Specified by:
        getCurBytes in interface OpenRtb.BidResponseOrBuilder
        Returns:
        The bytes for cur.

      • hasCustomdata

        public boolean hasCustomdata()
         Optional feature to allow a bidder to set data in the exchange's cookie.
 The string must be in base85 cookie safe characters and be in any format.
 Proper JSON encoding must be used to include "escaped" quotation marks.
        optional string customdata = 5;
        Specified by:
        hasCustomdata in interface OpenRtb.BidResponseOrBuilder
        Returns:
        Whether the customdata field is set.

      • getCustomdata

        public String getCustomdata()
         Optional feature to allow a bidder to set data in the exchange's cookie.
 The string must be in base85 cookie safe characters and be in any format.
 Proper JSON encoding must be used to include "escaped" quotation marks.
        optional string customdata = 5;
        Specified by:
        getCustomdata in interface OpenRtb.BidResponseOrBuilder
        Returns:
        The customdata.

      • getCustomdataBytes

        public com.google.protobuf.ByteString getCustomdataBytes()
         Optional feature to allow a bidder to set data in the exchange's cookie.
 The string must be in base85 cookie safe characters and be in any format.
 Proper JSON encoding must be used to include "escaped" quotation marks.
        optional string customdata = 5;
        Specified by:
        getCustomdataBytes in interface OpenRtb.BidResponseOrBuilder
        Returns:
        The bytes for customdata.

      • hasNbr

        public boolean hasNbr()
         Reason for not bidding.
        optional .com.google.openrtb.NoBidReason nbr = 6;
        Specified by:
        hasNbr in interface OpenRtb.BidResponseOrBuilder
        Returns:
        Whether the nbr field is set.

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3.ExtendableMessage<OpenRtb.BidResponse>

      • 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 OpenRtb.BidResponse parseFrom​(ByteBuffer data)
                                     throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static OpenRtb.BidResponse parseFrom​(ByteBuffer data,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static OpenRtb.BidResponse parseFrom​(com.google.protobuf.ByteString data)
                                     throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static OpenRtb.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 OpenRtb.BidResponse parseFrom​(byte[] data)
                                     throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static OpenRtb.BidResponse parseFrom​(byte[] data,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static OpenRtb.BidResponse parseFrom​(com.google.protobuf.CodedInputStream input,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws IOException
        Throws:
        IOException

      • newBuilderForType

        public OpenRtb.BidResponse.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public OpenRtb.BidResponse.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected OpenRtb.BidResponse.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

        public com.google.protobuf.Parser<OpenRtb.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 OpenRtb.BidResponse getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<OpenRtb.BidResponse>
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder