Package com.google.openrtb

Interface OpenRtb.BidResponseOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      String getBidid()
      Bidder generated response ID to assist with logging/tracking.
      com.google.protobuf.ByteString getBididBytes()
      Bidder generated response ID to assist with logging/tracking.
      String getCur()
      Bid currency using ISO-4217 alpha codes.
      com.google.protobuf.ByteString getCurBytes()
      Bid currency using ISO-4217 alpha codes.
      String getCustomdata()
      Optional feature to allow a bidder to set data in the exchange's cookie.
      com.google.protobuf.ByteString getCustomdataBytes()
      Optional feature to allow a bidder to set data in the exchange's cookie.
      String getId()
      ID of the bid request to which this is a response.
      com.google.protobuf.ByteString getIdBytes()
      ID of the bid request to which this is a response.
      OpenRtb.NoBidReason getNbr()
      Reason for not bidding.
      OpenRtb.BidResponse.SeatBid getSeatbid​(int index)
      Array of seatbid objects; 1+ required if a bid is to be made.
      int getSeatbidCount()
      Array of seatbid objects; 1+ required if a bid is to be made.
      List<OpenRtb.BidResponse.SeatBid> getSeatbidList()
      Array of seatbid objects; 1+ required if a bid is to be made.
      OpenRtb.BidResponse.SeatBidOrBuilder getSeatbidOrBuilder​(int index)
      Array of seatbid objects; 1+ required if a bid is to be made.
      List<? extends OpenRtb.BidResponse.SeatBidOrBuilder> getSeatbidOrBuilderList()
      Array of seatbid objects; 1+ required if a bid is to be made.
      boolean hasBidid()
      Bidder generated response ID to assist with logging/tracking.
      boolean hasCur()
      Bid currency using ISO-4217 alpha codes.
      boolean hasCustomdata()
      Optional feature to allow a bidder to set data in the exchange's cookie.
      boolean hasId()
      ID of the bid request to which this is a response.
      boolean hasNbr()
      Reason for not bidding.

      • Methods inherited from interface com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder

        getDefaultInstanceForType, getExtension, getExtension, getExtension, getExtension, getExtension, getExtension, getExtensionCount, getExtensionCount, getExtensionCount, hasExtension, hasExtension, hasExtension

      • Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

        isInitialized

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

    • Method Detail

      • hasId

        boolean hasId()
         ID of the bid request to which this is a response.
 REQUIRED by the OpenRTB specification.
        required string id = 1;
        Returns:
        Whether the id field is set.

      • getId

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

      • getIdBytes

        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;
        Returns:
        The bytes for id.

      • getSeatbidList

        List<OpenRtb.BidResponse.SeatBid> getSeatbidList()
         Array of seatbid objects; 1+ required if a bid is to be made.
        repeated .com.google.openrtb.BidResponse.SeatBid seatbid = 2;

      • getSeatbid

        OpenRtb.BidResponse.SeatBid getSeatbid​(int index)
         Array of seatbid objects; 1+ required if a bid is to be made.
        repeated .com.google.openrtb.BidResponse.SeatBid seatbid = 2;

      • getSeatbidCount

        int getSeatbidCount()
         Array of seatbid objects; 1+ required if a bid is to be made.
        repeated .com.google.openrtb.BidResponse.SeatBid seatbid = 2;

      • getSeatbidOrBuilderList

        List<? extends OpenRtb.BidResponse.SeatBidOrBuilder> getSeatbidOrBuilderList()
         Array of seatbid objects; 1+ required if a bid is to be made.
        repeated .com.google.openrtb.BidResponse.SeatBid seatbid = 2;

      • getSeatbidOrBuilder

        OpenRtb.BidResponse.SeatBidOrBuilder getSeatbidOrBuilder​(int index)
         Array of seatbid objects; 1+ required if a bid is to be made.
        repeated .com.google.openrtb.BidResponse.SeatBid seatbid = 2;

      • hasBidid

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

      • getBidid

        String getBidid()
         Bidder generated response ID to assist with logging/tracking.
        optional string bidid = 3;
        Returns:
        The bidid.

      • getBididBytes

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

      • hasCur

        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;
        Returns:
        Whether the cur field is set.

      • getCur

        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;
        Returns:
        The cur.

      • getCurBytes

        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;
        Returns:
        The bytes for cur.

      • hasCustomdata

        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;
        Returns:
        Whether the customdata field is set.

      • getCustomdata

        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;
        Returns:
        The customdata.

      • getCustomdataBytes

        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;
        Returns:
        The bytes for customdata.

      • hasNbr

        boolean hasNbr()
         Reason for not bidding.
        optional .com.google.openrtb.NoBidReason nbr = 6;
        Returns:
        Whether the nbr field is set.

      • getNbr

        OpenRtb.NoBidReason getNbr()
         Reason for not bidding.
        optional .com.google.openrtb.NoBidReason nbr = 6;
        Returns:
        The nbr.