Interface OpenRtb.NativeRequestOrBuilder

    • Method Detail

      • hasVer

        boolean hasVer()
         Version of the Native Markup version in use.
         
        optional string ver = 1;
        Returns:
        Whether the ver field is set.
      • getVer

        String getVer()
         Version of the Native Markup version in use.
         
        optional string ver = 1;
        Returns:
        The ver.
      • getVerBytes

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

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

        OpenRtb.ContextType getContext()
         The context in which the ad appears.
         RECOMMENDED by the OpenRTB Native specification.
         
        optional .com.google.openrtb.ContextType context = 7;
        Returns:
        The context.
      • hasContextsubtype

        boolean hasContextsubtype()
         A more detailed context in which the ad appears.
         
        optional .com.google.openrtb.ContextSubtype contextsubtype = 8;
        Returns:
        Whether the contextsubtype field is set.
      • getContextsubtype

        OpenRtb.ContextSubtype getContextsubtype()
         A more detailed context in which the ad appears.
         
        optional .com.google.openrtb.ContextSubtype contextsubtype = 8;
        Returns:
        The contextsubtype.
      • hasPlcmttype

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

        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;
        Returns:
        The plcmttype.
      • hasPlcmtcnt

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

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

        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];
        Returns:
        Whether the seq field is set.
      • getSeq

        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];
        Returns:
        The seq.
      • getAssetsList

        List<OpenRtb.NativeRequest.Asset> getAssetsList()
         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;
      • getAssets

        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;
      • getAssetsCount

        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;
      • getAssetsOrBuilderList

        List<? extends OpenRtb.NativeRequest.AssetOrBuilder> getAssetsOrBuilderList()
         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;
      • getAssetsOrBuilder

        OpenRtb.NativeRequest.AssetOrBuilder getAssetsOrBuilder​(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;
      • hasAurlsupport

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

        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;
        Returns:
        The aurlsupport.
      • hasDurlsupport

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

        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;
        Returns:
        The durlsupport.
      • getEventtrackersList

        List<OpenRtb.NativeRequest.EventTrackers> getEventtrackersList()
         Specifies what type of event tracking is supported.
         
        repeated .com.google.openrtb.NativeRequest.EventTrackers eventtrackers = 13;
      • getEventtrackers

        OpenRtb.NativeRequest.EventTrackers getEventtrackers​(int index)
         Specifies what type of event tracking is supported.
         
        repeated .com.google.openrtb.NativeRequest.EventTrackers eventtrackers = 13;
      • getEventtrackersCount

        int getEventtrackersCount()
         Specifies what type of event tracking is supported.
         
        repeated .com.google.openrtb.NativeRequest.EventTrackers eventtrackers = 13;
      • getEventtrackersOrBuilderList

        List<? extends OpenRtb.NativeRequest.EventTrackersOrBuilder> getEventtrackersOrBuilderList()
         Specifies what type of event tracking is supported.
         
        repeated .com.google.openrtb.NativeRequest.EventTrackers eventtrackers = 13;
      • getEventtrackersOrBuilder

        OpenRtb.NativeRequest.EventTrackersOrBuilder getEventtrackersOrBuilder​(int index)
         Specifies what type of event tracking is supported.
         
        repeated .com.google.openrtb.NativeRequest.EventTrackers eventtrackers = 13;
      • hasPrivacy

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

        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;
        Returns:
        The privacy.
      • hasLayout

        @Deprecated
        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];
        Returns:
        Whether the layout field is set.
      • getLayout

        @Deprecated
        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];
        Returns:
        The layout.
      • hasAdunit

        @Deprecated
        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];
        Returns:
        Whether the adunit field is set.
      • getAdunit

        @Deprecated
        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];
        Returns:
        The adunit.