Class OpenRtb.BidRequest

  • All Implemented Interfaces:
    OpenRtb.BidRequestOrBuilder, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<OpenRtb.BidRequest>, 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.ExtendableMessage<OpenRtb.BidRequest>
    implements OpenRtb.BidRequestOrBuilder
     OpenRTB 2.0: The top-level bid request object contains a globally unique
     bid request or auction ID. This id attribute is required as is at least one
     impression object (Section 3.2.2). Other attributes in this top-level object
     establish rules and restrictions that apply to all impressions being offered.
     There are also several subordinate objects that provide detailed data to
     potential buyers. Among these are the Site and App objects, which describe
     the type of published media in which the impression(s) appear.
     These objects are highly recommended, but only one applies to a given
     bid request depending on whether the media is browser-based web content
     or a non-browser application, respectively.
     
    Protobuf type com.google.openrtb.BidRequest
    See Also:
    Serialized Form
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  OpenRtb.BidRequest.App
      OpenRTB 2.0: This object should be included if the ad supported content is a non-browser application (typically in mobile) as opposed to a website.
      static interface  OpenRtb.BidRequest.AppOrBuilder  
      static class  OpenRtb.BidRequest.Builder
      OpenRTB 2.0: The top-level bid request object contains a globally unique bid request or auction ID.
      static class  OpenRtb.BidRequest.Content
      OpenRTB 2.0: This object describes the content in which the impression will appear, which may be syndicated or non-syndicated content.
      static interface  OpenRtb.BidRequest.ContentOrBuilder  
      static class  OpenRtb.BidRequest.Data
      OpenRTB 2.0: The data and segment objects together allow additional data about the user to be specified.
      static interface  OpenRtb.BidRequest.DataOrBuilder  
      static class  OpenRtb.BidRequest.Device
      OpenRTB 2.0: This object provides information pertaining to the device through which the user is interacting.
      static interface  OpenRtb.BidRequest.DeviceOrBuilder  
      static class  OpenRtb.BidRequest.DistributionchannelOneofCase  
      static class  OpenRtb.BidRequest.Geo
      OpenRTB 2.0: This object encapsulates various methods for specifying a geographic location.
      static interface  OpenRtb.BidRequest.GeoOrBuilder  
      static class  OpenRtb.BidRequest.Imp
      OpenRTB 2.0: This object describes an ad placement or impression being auctioned.
      static interface  OpenRtb.BidRequest.ImpOrBuilder  
      static class  OpenRtb.BidRequest.Producer
      OpenRTB 2.0: This object defines the producer of the content in which the ad will be shown.
      static interface  OpenRtb.BidRequest.ProducerOrBuilder  
      static class  OpenRtb.BidRequest.Publisher
      OpenRTB 2.0: This object describes the publisher of the media in which the ad will be displayed.
      static interface  OpenRtb.BidRequest.PublisherOrBuilder  
      static class  OpenRtb.BidRequest.Regs
      OpenRTB 2.2: This object contains any legal, governmental, or industry regulations that apply to the request.
      static interface  OpenRtb.BidRequest.RegsOrBuilder  
      static class  OpenRtb.BidRequest.Site
      OpenRTB 2.0: This object should be included if the ad supported content is a website as opposed to a non-browser application.
      static interface  OpenRtb.BidRequest.SiteOrBuilder  
      static class  OpenRtb.BidRequest.Source
      OpenRTB 2.5: This object describes the nature and behavior of the entity that is the source of the bid request upstream from the exchange.
      static interface  OpenRtb.BidRequest.SourceOrBuilder  
      static class  OpenRtb.BidRequest.User
      OpenRTB 2.0: This object contains information known or derived about the human user of the device (i.e., the audience for advertising).
      static interface  OpenRtb.BidRequest.UserOrBuilder  
      • 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 Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(Object obj)  
      boolean getAllimps()
      Flag to indicate if Exchange can verify that the impressions offered represent all of the impressions available in context (e.g., all on the web page, all video spots such as pre/mid/post roll) to support road-blocking.
      OpenRtb.BidRequest.App getApp()
      Details via an App object (Section 3.2.7) about the publisher's app (non-browser applications).
      OpenRtb.BidRequest.AppOrBuilder getAppOrBuilder()
      Details via an App object (Section 3.2.7) about the publisher's app (non-browser applications).
      OpenRtb.AuctionType getAt()
      Auction type, where 1 = First Price, 2 = Second Price Plus.
      String getBadv​(int index)
      Block list of advertisers by their domains (e.g., "ford.com").
      com.google.protobuf.ByteString getBadvBytes​(int index)
      Block list of advertisers by their domains (e.g., "ford.com").
      int getBadvCount()
      Block list of advertisers by their domains (e.g., "ford.com").
      com.google.protobuf.ProtocolStringList getBadvList()
      Block list of advertisers by their domains (e.g., "ford.com").
      String getBapp​(int index)
      Block list of applications by their platform-specific exchange independent application identifiers.
      com.google.protobuf.ByteString getBappBytes​(int index)
      Block list of applications by their platform-specific exchange independent application identifiers.
      int getBappCount()
      Block list of applications by their platform-specific exchange independent application identifiers.
      com.google.protobuf.ProtocolStringList getBappList()
      Block list of applications by their platform-specific exchange independent application identifiers.
      String getBcat​(int index)
      Blocked advertiser categories using the IAB content categories.
      com.google.protobuf.ByteString getBcatBytes​(int index)
      Blocked advertiser categories using the IAB content categories.
      int getBcatCount()
      Blocked advertiser categories using the IAB content categories.
      com.google.protobuf.ProtocolStringList getBcatList()
      Blocked advertiser categories using the IAB content categories.
      String getBseat​(int index)
      Block list of buyer seats (e.g., advertisers, agencies) restricted from bidding on this impression.
      com.google.protobuf.ByteString getBseatBytes​(int index)
      Block list of buyer seats (e.g., advertisers, agencies) restricted from bidding on this impression.
      int getBseatCount()
      Block list of buyer seats (e.g., advertisers, agencies) restricted from bidding on this impression.
      com.google.protobuf.ProtocolStringList getBseatList()
      Block list of buyer seats (e.g., advertisers, agencies) restricted from bidding on this impression.
      String getCur​(int index)
      Array of allowed currencies for bids on this bid request using ISO-4217 alpha codes.
      com.google.protobuf.ByteString getCurBytes​(int index)
      Array of allowed currencies for bids on this bid request using ISO-4217 alpha codes.
      int getCurCount()
      Array of allowed currencies for bids on this bid request using ISO-4217 alpha codes.
      com.google.protobuf.ProtocolStringList getCurList()
      Array of allowed currencies for bids on this bid request using ISO-4217 alpha codes.
      static OpenRtb.BidRequest getDefaultInstance()  
      OpenRtb.BidRequest getDefaultInstanceForType()  
      static com.google.protobuf.Descriptors.Descriptor getDescriptor()  
      OpenRtb.BidRequest.Device getDevice()
      Details via a Device object (Section 3.2.11) about the user's device to which the impression will be delivered.
      OpenRtb.BidRequest.DeviceOrBuilder getDeviceOrBuilder()
      Details via a Device object (Section 3.2.11) about the user's device to which the impression will be delivered.
      OpenRtb.BidRequest.DistributionchannelOneofCase getDistributionchannelOneofCase()  
      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.Imp getImp​(int index)
      Array of Imp objects (Section 3.2.2) representing the impressions offered.
      int getImpCount()
      Array of Imp objects (Section 3.2.2) representing the impressions offered.
      List<OpenRtb.BidRequest.Imp> getImpList()
      Array of Imp objects (Section 3.2.2) representing the impressions offered.
      OpenRtb.BidRequest.ImpOrBuilder getImpOrBuilder​(int index)
      Array of Imp objects (Section 3.2.2) representing the impressions offered.
      List<? extends OpenRtb.BidRequest.ImpOrBuilder> getImpOrBuilderList()
      Array of Imp objects (Section 3.2.2) representing the impressions offered.
      com.google.protobuf.Parser<OpenRtb.BidRequest> getParserForType()  
      OpenRtb.BidRequest.Regs getRegs()
      A Regs object (Section 3.2.16) that specifies any industry, legal, or governmental regulations in force for this request.
      OpenRtb.BidRequest.RegsOrBuilder getRegsOrBuilder()
      A Regs object (Section 3.2.16) that specifies any industry, legal, or governmental regulations in force for this request.
      int getSerializedSize()  
      OpenRtb.BidRequest.Site getSite()
      Details via a Site object (Section 3.2.6) about the publisher's website.
      OpenRtb.BidRequest.SiteOrBuilder getSiteOrBuilder()
      Details via a Site object (Section 3.2.6) about the publisher's website.
      OpenRtb.BidRequest.Source getSource()
      A Source object (Section 3.2.2) that provides data about the inventory source and which entity makes the final decision.
      OpenRtb.BidRequest.SourceOrBuilder getSourceOrBuilder()
      A Source object (Section 3.2.2) that provides data about the inventory source and which entity makes the final decision.
      boolean getTest()
      Indicator of test mode in which auctions are not billable, where false = live mode, true = test mode.
      int getTmax()
      Maximum time in milliseconds to submit a bid to avoid timeout.
      com.google.protobuf.UnknownFieldSet getUnknownFields()  
      OpenRtb.BidRequest.User getUser()
      Details via a User object (Section 3.2.13) about the human user of the device; the advertising audience.
      OpenRtb.BidRequest.UserOrBuilder getUserOrBuilder()
      Details via a User object (Section 3.2.13) about the human user of the device; the advertising audience.
      String getWlang​(int index)
      Allowlist of languages for creatives using ISO-639-1-alpha-2.
      com.google.protobuf.ByteString getWlangBytes​(int index)
      Allowlist of languages for creatives using ISO-639-1-alpha-2.
      int getWlangCount()
      Allowlist of languages for creatives using ISO-639-1-alpha-2.
      com.google.protobuf.ProtocolStringList getWlangList()
      Allowlist of languages for creatives using ISO-639-1-alpha-2.
      String getWseat​(int index)
      Allowlist of buyer seats (e.g., advertisers, agencies) that can bid on this impression.
      com.google.protobuf.ByteString getWseatBytes​(int index)
      Allowlist of buyer seats (e.g., advertisers, agencies) that can bid on this impression.
      int getWseatCount()
      Allowlist of buyer seats (e.g., advertisers, agencies) that can bid on this impression.
      com.google.protobuf.ProtocolStringList getWseatList()
      Allowlist of buyer seats (e.g., advertisers, agencies) that can bid on this impression.
      boolean hasAllimps()
      Flag to indicate if Exchange can verify that the impressions offered represent all of the impressions available in context (e.g., all on the web page, all video spots such as pre/mid/post roll) to support road-blocking.
      boolean hasApp()
      Details via an App object (Section 3.2.7) about the publisher's app (non-browser applications).
      boolean hasAt()
      Auction type, where 1 = First Price, 2 = Second Price Plus.
      boolean hasDevice()
      Details via a Device object (Section 3.2.11) about the user's device to which the impression will be delivered.
      int hashCode()  
      boolean hasId()
      Unique ID of the bid request, provided by the exchange.
      boolean hasRegs()
      A Regs object (Section 3.2.16) that specifies any industry, legal, or governmental regulations in force for this request.
      boolean hasSite()
      Details via a Site object (Section 3.2.6) about the publisher's website.
      boolean hasSource()
      A Source object (Section 3.2.2) that provides data about the inventory source and which entity makes the final decision.
      boolean hasTest()
      Indicator of test mode in which auctions are not billable, where false = live mode, true = test mode.
      boolean hasTmax()
      Maximum time in milliseconds to submit a bid to avoid timeout.
      boolean hasUser()
      Details via a User object (Section 3.2.13) about the human user of the device; the advertising audience.
      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)  
      protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)  
      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 OpenRtb.BidRequest parseFrom​(ByteBuffer data)  
      static OpenRtb.BidRequest parseFrom​(ByteBuffer data, 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.ExtendableMessage

        extensionsAreInitialized, extensionsSerializedSize, extensionsSerializedSizeAsMessageSet, getAllFields, getAllFieldsRaw, getExtension, getExtension, getExtension, getExtension, getExtension, getExtension, getExtensionCount, getExtensionCount, getExtensionCount, getExtensionFields, getField, getRepeatedField, getRepeatedFieldCount, hasExtension, hasExtension, hasExtension, hasField, makeExtensionsImmutable, newExtensionWriter, newMessageSetExtensionWriter, parseUnknownField, parseUnknownFieldProto3
      • Methods inherited from class com.google.protobuf.GeneratedMessageV3

        canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getDescriptorForType, getOneofFieldDescriptor, hasOneof, internalGetMapField, isStringEmpty, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, 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, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo
      • Methods inherited from interface com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder

        getExtension, getExtension, getExtension, getExtension, getExtension, getExtension, getExtensionCount, getExtensionCount, getExtensionCount, hasExtension, hasExtension, hasExtension
      • Methods inherited from interface com.google.protobuf.MessageLite

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

        findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof
    • 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()
         Unique ID of the bid request, provided by the exchange.
         REQUIRED by the OpenRTB specification.
         
        required string id = 1;
        Specified by:
        hasId in interface OpenRtb.BidRequestOrBuilder
        Returns:
        Whether the id field is set.
      • getId

        public String getId()
         Unique ID of the bid request, provided by the exchange.
         REQUIRED by the OpenRTB specification.
         
        required string id = 1;
        Specified by:
        getId in interface OpenRtb.BidRequestOrBuilder
        Returns:
        The id.
      • getIdBytes

        public com.google.protobuf.ByteString getIdBytes()
         Unique ID of the bid request, provided by the exchange.
         REQUIRED by the OpenRTB specification.
         
        required string id = 1;
        Specified by:
        getIdBytes in interface OpenRtb.BidRequestOrBuilder
        Returns:
        The bytes for id.
      • getImpCount

        public int getImpCount()
         Array of Imp objects (Section 3.2.2) representing the impressions offered.
         At least 1 Imp object is required.
         
        repeated .com.google.openrtb.BidRequest.Imp imp = 2;
        Specified by:
        getImpCount in interface OpenRtb.BidRequestOrBuilder
      • getImp

        public OpenRtb.BidRequest.Imp getImp​(int index)
         Array of Imp objects (Section 3.2.2) representing the impressions offered.
         At least 1 Imp object is required.
         
        repeated .com.google.openrtb.BidRequest.Imp imp = 2;
        Specified by:
        getImp in interface OpenRtb.BidRequestOrBuilder
      • hasSite

        public boolean hasSite()
         Details via a Site object (Section 3.2.6) about the publisher's website.
         Only applicable and recommended for websites.
         
        .com.google.openrtb.BidRequest.Site site = 3;
        Specified by:
        hasSite in interface OpenRtb.BidRequestOrBuilder
        Returns:
        Whether the site field is set.
      • getSite

        public OpenRtb.BidRequest.Site getSite()
         Details via a Site object (Section 3.2.6) about the publisher's website.
         Only applicable and recommended for websites.
         
        .com.google.openrtb.BidRequest.Site site = 3;
        Specified by:
        getSite in interface OpenRtb.BidRequestOrBuilder
        Returns:
        The site.
      • hasApp

        public boolean hasApp()
         Details via an App object (Section 3.2.7) about the publisher's app
         (non-browser applications). Only applicable and recommended for apps.
         
        .com.google.openrtb.BidRequest.App app = 4;
        Specified by:
        hasApp in interface OpenRtb.BidRequestOrBuilder
        Returns:
        Whether the app field is set.
      • getApp

        public OpenRtb.BidRequest.App getApp()
         Details via an App object (Section 3.2.7) about the publisher's app
         (non-browser applications). Only applicable and recommended for apps.
         
        .com.google.openrtb.BidRequest.App app = 4;
        Specified by:
        getApp in interface OpenRtb.BidRequestOrBuilder
        Returns:
        The app.
      • hasDevice

        public boolean hasDevice()
         Details via a Device object (Section 3.2.11) about the user's
         device to which the impression will be delivered.
         
        optional .com.google.openrtb.BidRequest.Device device = 5;
        Specified by:
        hasDevice in interface OpenRtb.BidRequestOrBuilder
        Returns:
        Whether the device field is set.
      • getDevice

        public OpenRtb.BidRequest.Device getDevice()
         Details via a Device object (Section 3.2.11) about the user's
         device to which the impression will be delivered.
         
        optional .com.google.openrtb.BidRequest.Device device = 5;
        Specified by:
        getDevice in interface OpenRtb.BidRequestOrBuilder
        Returns:
        The device.
      • hasRegs

        public boolean hasRegs()
         A Regs object (Section 3.2.16) that specifies any industry, legal,
         or governmental regulations in force for this request.
         
        optional .com.google.openrtb.BidRequest.Regs regs = 14;
        Specified by:
        hasRegs in interface OpenRtb.BidRequestOrBuilder
        Returns:
        Whether the regs field is set.
      • getRegs

        public OpenRtb.BidRequest.Regs getRegs()
         A Regs object (Section 3.2.16) that specifies any industry, legal,
         or governmental regulations in force for this request.
         
        optional .com.google.openrtb.BidRequest.Regs regs = 14;
        Specified by:
        getRegs in interface OpenRtb.BidRequestOrBuilder
        Returns:
        The regs.
      • hasUser

        public boolean hasUser()
         Details via a User object (Section 3.2.13) about the human
         user of the device; the advertising audience.
         
        optional .com.google.openrtb.BidRequest.User user = 6;
        Specified by:
        hasUser in interface OpenRtb.BidRequestOrBuilder
        Returns:
        Whether the user field is set.
      • getUser

        public OpenRtb.BidRequest.User getUser()
         Details via a User object (Section 3.2.13) about the human
         user of the device; the advertising audience.
         
        optional .com.google.openrtb.BidRequest.User user = 6;
        Specified by:
        getUser in interface OpenRtb.BidRequestOrBuilder
        Returns:
        The user.
      • hasAt

        public boolean hasAt()
         Auction type, where 1 = First Price, 2 = Second Price Plus.
         Exchange-specific auction types can be defined using values > 500.
         
        optional .com.google.openrtb.AuctionType at = 7 [default = SECOND_PRICE];
        Specified by:
        hasAt in interface OpenRtb.BidRequestOrBuilder
        Returns:
        Whether the at field is set.
      • getAt

        public OpenRtb.AuctionType getAt()
         Auction type, where 1 = First Price, 2 = Second Price Plus.
         Exchange-specific auction types can be defined using values > 500.
         
        optional .com.google.openrtb.AuctionType at = 7 [default = SECOND_PRICE];
        Specified by:
        getAt in interface OpenRtb.BidRequestOrBuilder
        Returns:
        The at.
      • hasTmax

        public boolean hasTmax()
         Maximum time in milliseconds to submit a bid to avoid timeout.
         This value is commonly communicated offline.
         
        optional int32 tmax = 8;
        Specified by:
        hasTmax in interface OpenRtb.BidRequestOrBuilder
        Returns:
        Whether the tmax field is set.
      • getTmax

        public int getTmax()
         Maximum time in milliseconds to submit a bid to avoid timeout.
         This value is commonly communicated offline.
         
        optional int32 tmax = 8;
        Specified by:
        getTmax in interface OpenRtb.BidRequestOrBuilder
        Returns:
        The tmax.
      • getWseatList

        public com.google.protobuf.ProtocolStringList getWseatList()
         Allowlist of buyer seats (e.g., advertisers, agencies) that can bid on this
         impression. IDs of seats and knowledge of the buyer's customers to which
         they refer must be coordinated between bidders and the exchange a priori.
         Omission implies no seat restrictions.
         
        repeated string wseat = 9;
        Specified by:
        getWseatList in interface OpenRtb.BidRequestOrBuilder
        Returns:
        A list containing the wseat.
      • getWseatCount

        public int getWseatCount()
         Allowlist of buyer seats (e.g., advertisers, agencies) that can bid on this
         impression. IDs of seats and knowledge of the buyer's customers to which
         they refer must be coordinated between bidders and the exchange a priori.
         Omission implies no seat restrictions.
         
        repeated string wseat = 9;
        Specified by:
        getWseatCount in interface OpenRtb.BidRequestOrBuilder
        Returns:
        The count of wseat.
      • getWseat

        public String getWseat​(int index)
         Allowlist of buyer seats (e.g., advertisers, agencies) that can bid on this
         impression. IDs of seats and knowledge of the buyer's customers to which
         they refer must be coordinated between bidders and the exchange a priori.
         Omission implies no seat restrictions.
         
        repeated string wseat = 9;
        Specified by:
        getWseat in interface OpenRtb.BidRequestOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The wseat at the given index.
      • getWseatBytes

        public com.google.protobuf.ByteString getWseatBytes​(int index)
         Allowlist of buyer seats (e.g., advertisers, agencies) that can bid on this
         impression. IDs of seats and knowledge of the buyer's customers to which
         they refer must be coordinated between bidders and the exchange a priori.
         Omission implies no seat restrictions.
         
        repeated string wseat = 9;
        Specified by:
        getWseatBytes in interface OpenRtb.BidRequestOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the wseat at the given index.
      • hasAllimps

        public boolean hasAllimps()
         Flag to indicate if Exchange can verify that the impressions offered
         represent all of the impressions available in context (e.g., all on the
         web page, all video spots such as pre/mid/post roll) to support
         road-blocking. false = no or unknown, true = yes, the impressions offered
         represent all that are available.
         
        optional bool allimps = 10 [default = false];
        Specified by:
        hasAllimps in interface OpenRtb.BidRequestOrBuilder
        Returns:
        Whether the allimps field is set.
      • getAllimps

        public boolean getAllimps()
         Flag to indicate if Exchange can verify that the impressions offered
         represent all of the impressions available in context (e.g., all on the
         web page, all video spots such as pre/mid/post roll) to support
         road-blocking. false = no or unknown, true = yes, the impressions offered
         represent all that are available.
         
        optional bool allimps = 10 [default = false];
        Specified by:
        getAllimps in interface OpenRtb.BidRequestOrBuilder
        Returns:
        The allimps.
      • getCurList

        public com.google.protobuf.ProtocolStringList getCurList()
         Array of allowed currencies for bids on this bid request using ISO-4217
         alpha codes. Recommended only if the exchange accepts multiple currencies.
         
        repeated string cur = 11;
        Specified by:
        getCurList in interface OpenRtb.BidRequestOrBuilder
        Returns:
        A list containing the cur.
      • getCurCount

        public int getCurCount()
         Array of allowed currencies for bids on this bid request using ISO-4217
         alpha codes. Recommended only if the exchange accepts multiple currencies.
         
        repeated string cur = 11;
        Specified by:
        getCurCount in interface OpenRtb.BidRequestOrBuilder
        Returns:
        The count of cur.
      • getCur

        public String getCur​(int index)
         Array of allowed currencies for bids on this bid request using ISO-4217
         alpha codes. Recommended only if the exchange accepts multiple currencies.
         
        repeated string cur = 11;
        Specified by:
        getCur in interface OpenRtb.BidRequestOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The cur at the given index.
      • getCurBytes

        public com.google.protobuf.ByteString getCurBytes​(int index)
         Array of allowed currencies for bids on this bid request using ISO-4217
         alpha codes. Recommended only if the exchange accepts multiple currencies.
         
        repeated string cur = 11;
        Specified by:
        getCurBytes in interface OpenRtb.BidRequestOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the cur at the given index.
      • getBcatList

        public com.google.protobuf.ProtocolStringList getBcatList()
         Blocked advertiser categories using the IAB content categories.
         Refer to enum ContentCategory.
         
        repeated string bcat = 12;
        Specified by:
        getBcatList in interface OpenRtb.BidRequestOrBuilder
        Returns:
        A list containing the bcat.
      • getBcatCount

        public int getBcatCount()
         Blocked advertiser categories using the IAB content categories.
         Refer to enum ContentCategory.
         
        repeated string bcat = 12;
        Specified by:
        getBcatCount in interface OpenRtb.BidRequestOrBuilder
        Returns:
        The count of bcat.
      • getBcat

        public String getBcat​(int index)
         Blocked advertiser categories using the IAB content categories.
         Refer to enum ContentCategory.
         
        repeated string bcat = 12;
        Specified by:
        getBcat in interface OpenRtb.BidRequestOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The bcat at the given index.
      • getBcatBytes

        public com.google.protobuf.ByteString getBcatBytes​(int index)
         Blocked advertiser categories using the IAB content categories.
         Refer to enum ContentCategory.
         
        repeated string bcat = 12;
        Specified by:
        getBcatBytes in interface OpenRtb.BidRequestOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the bcat at the given index.
      • getBadvList

        public com.google.protobuf.ProtocolStringList getBadvList()
         Block list of advertisers by their domains (e.g., "ford.com").
         
        repeated string badv = 13;
        Specified by:
        getBadvList in interface OpenRtb.BidRequestOrBuilder
        Returns:
        A list containing the badv.
      • getBadvCount

        public int getBadvCount()
         Block list of advertisers by their domains (e.g., "ford.com").
         
        repeated string badv = 13;
        Specified by:
        getBadvCount in interface OpenRtb.BidRequestOrBuilder
        Returns:
        The count of badv.
      • getBadv

        public String getBadv​(int index)
         Block list of advertisers by their domains (e.g., "ford.com").
         
        repeated string badv = 13;
        Specified by:
        getBadv in interface OpenRtb.BidRequestOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The badv at the given index.
      • getBadvBytes

        public com.google.protobuf.ByteString getBadvBytes​(int index)
         Block list of advertisers by their domains (e.g., "ford.com").
         
        repeated string badv = 13;
        Specified by:
        getBadvBytes in interface OpenRtb.BidRequestOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the badv at the given index.
      • getBappList

        public com.google.protobuf.ProtocolStringList getBappList()
         Block list of applications by their platform-specific exchange
         independent application identifiers. On Android, these should
         be bundle or package names (e.g., com.foo.mygame).
         On iOS, these are numeric IDs.
         
        repeated string bapp = 16;
        Specified by:
        getBappList in interface OpenRtb.BidRequestOrBuilder
        Returns:
        A list containing the bapp.
      • getBappCount

        public int getBappCount()
         Block list of applications by their platform-specific exchange
         independent application identifiers. On Android, these should
         be bundle or package names (e.g., com.foo.mygame).
         On iOS, these are numeric IDs.
         
        repeated string bapp = 16;
        Specified by:
        getBappCount in interface OpenRtb.BidRequestOrBuilder
        Returns:
        The count of bapp.
      • getBapp

        public String getBapp​(int index)
         Block list of applications by their platform-specific exchange
         independent application identifiers. On Android, these should
         be bundle or package names (e.g., com.foo.mygame).
         On iOS, these are numeric IDs.
         
        repeated string bapp = 16;
        Specified by:
        getBapp in interface OpenRtb.BidRequestOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The bapp at the given index.
      • getBappBytes

        public com.google.protobuf.ByteString getBappBytes​(int index)
         Block list of applications by their platform-specific exchange
         independent application identifiers. On Android, these should
         be bundle or package names (e.g., com.foo.mygame).
         On iOS, these are numeric IDs.
         
        repeated string bapp = 16;
        Specified by:
        getBappBytes in interface OpenRtb.BidRequestOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the bapp at the given index.
      • hasTest

        public boolean hasTest()
         Indicator of test mode in which auctions are not billable,
         where false = live mode, true = test mode.
         
        optional bool test = 15 [default = false];
        Specified by:
        hasTest in interface OpenRtb.BidRequestOrBuilder
        Returns:
        Whether the test field is set.
      • getTest

        public boolean getTest()
         Indicator of test mode in which auctions are not billable,
         where false = live mode, true = test mode.
         
        optional bool test = 15 [default = false];
        Specified by:
        getTest in interface OpenRtb.BidRequestOrBuilder
        Returns:
        The test.
      • getBseatList

        public com.google.protobuf.ProtocolStringList getBseatList()
         Block list of buyer seats (e.g., advertisers, agencies) restricted
         from bidding on this impression. IDs of seats and knowledge
         of the buyer's customers to which they refer must be
         coordinated between bidders and the exchange a priori.
         At most, only one of wseat and bseat should be used in the
         same request. Omission of both implies no seat restrictions.
         
        repeated string bseat = 17;
        Specified by:
        getBseatList in interface OpenRtb.BidRequestOrBuilder
        Returns:
        A list containing the bseat.
      • getBseatCount

        public int getBseatCount()
         Block list of buyer seats (e.g., advertisers, agencies) restricted
         from bidding on this impression. IDs of seats and knowledge
         of the buyer's customers to which they refer must be
         coordinated between bidders and the exchange a priori.
         At most, only one of wseat and bseat should be used in the
         same request. Omission of both implies no seat restrictions.
         
        repeated string bseat = 17;
        Specified by:
        getBseatCount in interface OpenRtb.BidRequestOrBuilder
        Returns:
        The count of bseat.
      • getBseat

        public String getBseat​(int index)
         Block list of buyer seats (e.g., advertisers, agencies) restricted
         from bidding on this impression. IDs of seats and knowledge
         of the buyer's customers to which they refer must be
         coordinated between bidders and the exchange a priori.
         At most, only one of wseat and bseat should be used in the
         same request. Omission of both implies no seat restrictions.
         
        repeated string bseat = 17;
        Specified by:
        getBseat in interface OpenRtb.BidRequestOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The bseat at the given index.
      • getBseatBytes

        public com.google.protobuf.ByteString getBseatBytes​(int index)
         Block list of buyer seats (e.g., advertisers, agencies) restricted
         from bidding on this impression. IDs of seats and knowledge
         of the buyer's customers to which they refer must be
         coordinated between bidders and the exchange a priori.
         At most, only one of wseat and bseat should be used in the
         same request. Omission of both implies no seat restrictions.
         
        repeated string bseat = 17;
        Specified by:
        getBseatBytes in interface OpenRtb.BidRequestOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the bseat at the given index.
      • getWlangList

        public com.google.protobuf.ProtocolStringList getWlangList()
         Allowlist of languages for creatives using ISO-639-1-alpha-2.
         Omission implies no specific restrictions, but buyers would be
         advised to consider language attribute in the Device and/or
         Content objects if available.
         
        repeated string wlang = 18;
        Specified by:
        getWlangList in interface OpenRtb.BidRequestOrBuilder
        Returns:
        A list containing the wlang.
      • getWlangCount

        public int getWlangCount()
         Allowlist of languages for creatives using ISO-639-1-alpha-2.
         Omission implies no specific restrictions, but buyers would be
         advised to consider language attribute in the Device and/or
         Content objects if available.
         
        repeated string wlang = 18;
        Specified by:
        getWlangCount in interface OpenRtb.BidRequestOrBuilder
        Returns:
        The count of wlang.
      • getWlang

        public String getWlang​(int index)
         Allowlist of languages for creatives using ISO-639-1-alpha-2.
         Omission implies no specific restrictions, but buyers would be
         advised to consider language attribute in the Device and/or
         Content objects if available.
         
        repeated string wlang = 18;
        Specified by:
        getWlang in interface OpenRtb.BidRequestOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The wlang at the given index.
      • getWlangBytes

        public com.google.protobuf.ByteString getWlangBytes​(int index)
         Allowlist of languages for creatives using ISO-639-1-alpha-2.
         Omission implies no specific restrictions, but buyers would be
         advised to consider language attribute in the Device and/or
         Content objects if available.
         
        repeated string wlang = 18;
        Specified by:
        getWlangBytes in interface OpenRtb.BidRequestOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the wlang at the given index.
      • hasSource

        public boolean hasSource()
         A Source object (Section 3.2.2) that provides data about the
         inventory source and which entity makes the final decision.
         
        optional .com.google.openrtb.BidRequest.Source source = 19;
        Specified by:
        hasSource in interface OpenRtb.BidRequestOrBuilder
        Returns:
        Whether the source field is set.
      • getSource

        public OpenRtb.BidRequest.Source getSource()
         A Source object (Section 3.2.2) that provides data about the
         inventory source and which entity makes the final decision.
         
        optional .com.google.openrtb.BidRequest.Source source = 19;
        Specified by:
        getSource in interface OpenRtb.BidRequestOrBuilder
        Returns:
        The source.
      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3.ExtendableMessage<OpenRtb.BidRequest>
      • 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.BidRequest parseFrom​(ByteBuffer data)
                                            throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

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

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

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

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

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

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

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

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

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