Class OpenRtb.NativeRequest

  • All Implemented Interfaces:
    OpenRtb.NativeRequestOrBuilder, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<OpenRtb.NativeRequest>, 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.NativeRequest
    extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<OpenRtb.NativeRequest>
    implements OpenRtb.NativeRequestOrBuilder
     OpenRTB Native 1.0: The Native Object defines the native advertising
     opportunity available for bid via this bid request. It must be included
     directly in the impression object if the impression offered for auction
     is a native ad format.
     
    Protobuf type com.google.openrtb.NativeRequest
    See Also:
    Serialized Form
    • 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
      • hasVer

        public boolean hasVer()
         Version of the Native Markup version in use.
         
        optional string ver = 1;
        Specified by:
        hasVer in interface OpenRtb.NativeRequestOrBuilder
        Returns:
        Whether the ver field is set.
      • getVerBytes

        public com.google.protobuf.ByteString getVerBytes()
         Version of the Native Markup version in use.
         
        optional string ver = 1;
        Specified by:
        getVerBytes in interface OpenRtb.NativeRequestOrBuilder
        Returns:
        The bytes for ver.
      • hasContext

        public boolean hasContext()
         The context in which the ad appears.
         RECOMMENDED by the OpenRTB Native specification.
         
        optional .com.google.openrtb.ContextType context = 7;
        Specified by:
        hasContext in interface OpenRtb.NativeRequestOrBuilder
        Returns:
        Whether the context field is set.
      • hasContextsubtype

        public boolean hasContextsubtype()
         A more detailed context in which the ad appears.
         
        optional .com.google.openrtb.ContextSubtype contextsubtype = 8;
        Specified by:
        hasContextsubtype in interface OpenRtb.NativeRequestOrBuilder
        Returns:
        Whether the contextsubtype field is set.
      • hasPlcmttype

        public boolean hasPlcmttype()
         The design/format/layout of the ad unit being offered.
         RECOMMENDED by the OpenRTB Native specification.
         
        optional .com.google.openrtb.PlacementType plcmttype = 9;
        Specified by:
        hasPlcmttype in interface OpenRtb.NativeRequestOrBuilder
        Returns:
        Whether the plcmttype field is set.
      • getPlcmttype

        public OpenRtb.PlacementType getPlcmttype()
         The design/format/layout of the ad unit being offered.
         RECOMMENDED by the OpenRTB Native specification.
         
        optional .com.google.openrtb.PlacementType plcmttype = 9;
        Specified by:
        getPlcmttype in interface OpenRtb.NativeRequestOrBuilder
        Returns:
        The plcmttype.
      • hasPlcmtcnt

        public boolean hasPlcmtcnt()
         The number of identical placements in this Layout.
         
        optional int32 plcmtcnt = 4 [default = 1];
        Specified by:
        hasPlcmtcnt in interface OpenRtb.NativeRequestOrBuilder
        Returns:
        Whether the plcmtcnt field is set.
      • getPlcmtcnt

        public int getPlcmtcnt()
         The number of identical placements in this Layout.
         
        optional int32 plcmtcnt = 4 [default = 1];
        Specified by:
        getPlcmtcnt in interface OpenRtb.NativeRequestOrBuilder
        Returns:
        The plcmtcnt.
      • hasSeq

        public boolean hasSeq()
         0 for the first ad, 1 for the second ad, and so on. Note this would
         generally NOT be used in combination with plcmtcnt - either you are
         auctioning multiple identical placements (in which case
         plcmtcnt>1, seq=0) or you are holding separate auctions for distinct
         items in the feed (in which case plcmtcnt=1, seq>=1).
         
        optional int32 seq = 5 [default = 0];
        Specified by:
        hasSeq in interface OpenRtb.NativeRequestOrBuilder
        Returns:
        Whether the seq field is set.
      • getSeq

        public int getSeq()
         0 for the first ad, 1 for the second ad, and so on. Note this would
         generally NOT be used in combination with plcmtcnt - either you are
         auctioning multiple identical placements (in which case
         plcmtcnt>1, seq=0) or you are holding separate auctions for distinct
         items in the feed (in which case plcmtcnt=1, seq>=1).
         
        optional int32 seq = 5 [default = 0];
        Specified by:
        getSeq in interface OpenRtb.NativeRequestOrBuilder
        Returns:
        The seq.
      • getAssetsCount

        public int getAssetsCount()
         Any bid must comply with the array of elements expressed by the Exchange.
         REQUIRED by the OpenRTB Native specification: at least 1 element.
         
        repeated .com.google.openrtb.NativeRequest.Asset assets = 6;
        Specified by:
        getAssetsCount in interface OpenRtb.NativeRequestOrBuilder
      • getAssets

        public OpenRtb.NativeRequest.Asset getAssets​(int index)
         Any bid must comply with the array of elements expressed by the Exchange.
         REQUIRED by the OpenRTB Native specification: at least 1 element.
         
        repeated .com.google.openrtb.NativeRequest.Asset assets = 6;
        Specified by:
        getAssets in interface OpenRtb.NativeRequestOrBuilder
      • hasAurlsupport

        public boolean hasAurlsupport()
         Whether the supply source / impression supports returning an assetsurl
         instead of an asset object. false or the absence of the field indicates no
         such support.
         
        optional bool aurlsupport = 11;
        Specified by:
        hasAurlsupport in interface OpenRtb.NativeRequestOrBuilder
        Returns:
        Whether the aurlsupport field is set.
      • getAurlsupport

        public boolean getAurlsupport()
         Whether the supply source / impression supports returning an assetsurl
         instead of an asset object. false or the absence of the field indicates no
         such support.
         
        optional bool aurlsupport = 11;
        Specified by:
        getAurlsupport in interface OpenRtb.NativeRequestOrBuilder
        Returns:
        The aurlsupport.
      • hasDurlsupport

        public boolean hasDurlsupport()
         Whether the supply source / impression supports returning a DCO URL
         instead of an asset object. false or the absence of the field indicates no
         such support. Beta feature.
         
        optional bool durlsupport = 12;
        Specified by:
        hasDurlsupport in interface OpenRtb.NativeRequestOrBuilder
        Returns:
        Whether the durlsupport field is set.
      • getDurlsupport

        public boolean getDurlsupport()
         Whether the supply source / impression supports returning a DCO URL
         instead of an asset object. false or the absence of the field indicates no
         such support. Beta feature.
         
        optional bool durlsupport = 12;
        Specified by:
        getDurlsupport in interface OpenRtb.NativeRequestOrBuilder
        Returns:
        The durlsupport.
      • getEventtrackersCount

        public int getEventtrackersCount()
         Specifies what type of event tracking is supported.
         
        repeated .com.google.openrtb.NativeRequest.EventTrackers eventtrackers = 13;
        Specified by:
        getEventtrackersCount in interface OpenRtb.NativeRequestOrBuilder
      • hasPrivacy

        public boolean hasPrivacy()
         Set to true when the native ad supports buyer-specific privacy notice.
         Set to false (or field absent) when the native ad doesn't support custom
         privacy links or if support is unknown.
         RECOMMENDED by the OpenRTB Native specification.
         
        optional bool privacy = 14;
        Specified by:
        hasPrivacy in interface OpenRtb.NativeRequestOrBuilder
        Returns:
        Whether the privacy field is set.
      • getPrivacy

        public boolean getPrivacy()
         Set to true when the native ad supports buyer-specific privacy notice.
         Set to false (or field absent) when the native ad doesn't support custom
         privacy links or if support is unknown.
         RECOMMENDED by the OpenRTB Native specification.
         
        optional bool privacy = 14;
        Specified by:
        getPrivacy in interface OpenRtb.NativeRequestOrBuilder
        Returns:
        The privacy.
      • hasLayout

        @Deprecated
        public boolean hasLayout()
        Deprecated.
        com.google.openrtb.NativeRequest.layout is deprecated. See openrtb.proto;l=1518
         DEPRECATED in OpenRTB Native 1.1, REMOVED in 1.2+.
         Use field <code>plcmttype</code>.
         
        optional .com.google.openrtb.LayoutId layout = 2 [deprecated = true];
        Specified by:
        hasLayout in interface OpenRtb.NativeRequestOrBuilder
        Returns:
        Whether the layout field is set.
      • getLayout

        @Deprecated
        public OpenRtb.LayoutId getLayout()
        Deprecated.
        com.google.openrtb.NativeRequest.layout is deprecated. See openrtb.proto;l=1518
         DEPRECATED in OpenRTB Native 1.1, REMOVED in 1.2+.
         Use field <code>plcmttype</code>.
         
        optional .com.google.openrtb.LayoutId layout = 2 [deprecated = true];
        Specified by:
        getLayout in interface OpenRtb.NativeRequestOrBuilder
        Returns:
        The layout.
      • hasAdunit

        @Deprecated
        public boolean hasAdunit()
        Deprecated.
        com.google.openrtb.NativeRequest.adunit is deprecated. See openrtb.proto;l=1522
         DEPRECATED in OpenRTB Native 1.1, REMOVED in 1.2+.
         Use fields <code>context</code> and <code>contextsubtype</code>.
         
        optional .com.google.openrtb.AdUnitId adunit = 3 [deprecated = true];
        Specified by:
        hasAdunit in interface OpenRtb.NativeRequestOrBuilder
        Returns:
        Whether the adunit field is set.
      • getAdunit

        @Deprecated
        public OpenRtb.AdUnitId getAdunit()
        Deprecated.
        com.google.openrtb.NativeRequest.adunit is deprecated. See openrtb.proto;l=1522
         DEPRECATED in OpenRTB Native 1.1, REMOVED in 1.2+.
         Use fields <code>context</code> and <code>contextsubtype</code>.
         
        optional .com.google.openrtb.AdUnitId adunit = 3 [deprecated = true];
        Specified by:
        getAdunit in interface OpenRtb.NativeRequestOrBuilder
        Returns:
        The adunit.
      • isInitialized

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

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

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

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

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

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

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

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

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