Package com.google.openrtb

Class OpenRtb.BidRequest.Imp.Banner

  • All Implemented Interfaces:
    OpenRtb.BidRequest.Imp.BannerOrBuilder, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<OpenRtb.BidRequest.Imp.Banner>, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    Enclosing class:
    OpenRtb.BidRequest.Imp
    public static final class OpenRtb.BidRequest.Imp.Banner
extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<OpenRtb.BidRequest.Imp.Banner>
implements OpenRtb.BidRequest.Imp.BannerOrBuilder
     OpenRTB 2.0: This object represents the most general type of
 impression.  Although the term "banner" may have very specific meaning
 in other contexts, here it can be many things including a simple static
 image, an expandable ad unit, or even in-banner video (refer to the Video
 object in Section 3.2.4 for the more generalized and full featured video
 ad units). An array of Banner objects can also appear within the Video
 to describe optional companion ads defined in the VAST specification.
 The presence of a Banner as a subordinate of the Imp object indicates
 that this impression is offered as a banner type impression.
 At the publisher's discretion, that same impression may also be offered
 as video and/or native by also including as Imp subordinates the Video
 and/or Native objects, respectively. However, any given bid for the
 impression must conform to one of the offered types.
    Protobuf type com.google.openrtb.BidRequest.Imp.Banner
    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

      • hasW

        public boolean hasW()
         Width in device independent pixels (DIPS).
 If no format objects are specified, this is an exact width
 requirement. Otherwise it is a preferred width.
        optional int32 w = 1;
        Specified by:
        hasW in interface OpenRtb.BidRequest.Imp.BannerOrBuilder
        Returns:
        Whether the w field is set.

      • getW

        public int getW()
         Width in device independent pixels (DIPS).
 If no format objects are specified, this is an exact width
 requirement. Otherwise it is a preferred width.
        optional int32 w = 1;
        Specified by:
        getW in interface OpenRtb.BidRequest.Imp.BannerOrBuilder
        Returns:
        The w.

      • hasH

        public boolean hasH()
         Height in device independent pixels (DIPS).
 If no format objects are specified, this is an exact height
 requirement. Otherwise it is a preferred height.
        optional int32 h = 2;
        Specified by:
        hasH in interface OpenRtb.BidRequest.Imp.BannerOrBuilder
        Returns:
        Whether the h field is set.

      • getH

        public int getH()
         Height in device independent pixels (DIPS).
 If no format objects are specified, this is an exact height
 requirement. Otherwise it is a preferred height.
        optional int32 h = 2;
        Specified by:
        getH in interface OpenRtb.BidRequest.Imp.BannerOrBuilder
        Returns:
        The h.

      • getFormatCount

        public int getFormatCount()
         Array of format objects representing the banner sizes permitted.
 If none are specified, then use of the h and w attributes
 is highly recommended.
        repeated .com.google.openrtb.BidRequest.Imp.Banner.Format format = 15;
        Specified by:
        getFormatCount in interface OpenRtb.BidRequest.Imp.BannerOrBuilder

      • hasId

        public boolean hasId()
         Unique identifier for this banner object. Recommended when Banner
 objects are used with a Video object (Section 3.2.4) to represent
 an array of companion ads. Values usually start at 1 and increase
 with each object; should be unique within an impression.
        optional string id = 3;
        Specified by:
        hasId in interface OpenRtb.BidRequest.Imp.BannerOrBuilder
        Returns:
        Whether the id field is set.

      • getId

        public String getId()
         Unique identifier for this banner object. Recommended when Banner
 objects are used with a Video object (Section 3.2.4) to represent
 an array of companion ads. Values usually start at 1 and increase
 with each object; should be unique within an impression.
        optional string id = 3;
        Specified by:
        getId in interface OpenRtb.BidRequest.Imp.BannerOrBuilder
        Returns:
        The id.

      • getIdBytes

        public com.google.protobuf.ByteString getIdBytes()
         Unique identifier for this banner object. Recommended when Banner
 objects are used with a Video object (Section 3.2.4) to represent
 an array of companion ads. Values usually start at 1 and increase
 with each object; should be unique within an impression.
        optional string id = 3;
        Specified by:
        getIdBytes in interface OpenRtb.BidRequest.Imp.BannerOrBuilder
        Returns:
        The bytes for id.

      • hasPos

        public boolean hasPos()
         Ad position on screen.
        optional .com.google.openrtb.AdPosition pos = 4;
        Specified by:
        hasPos in interface OpenRtb.BidRequest.Imp.BannerOrBuilder
        Returns:
        Whether the pos field is set.

      • getBtype

        public OpenRtb.BannerAdType getBtype​(int index)
         Blocked banner ad types.
        repeated .com.google.openrtb.BannerAdType btype = 5 [packed = true];
        Specified by:
        getBtype in interface OpenRtb.BidRequest.Imp.BannerOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The btype at the given index.

      • getBattrCount

        public int getBattrCount()
         Blocked creative attributes.
        repeated .com.google.openrtb.CreativeAttribute battr = 6 [packed = true];
        Specified by:
        getBattrCount in interface OpenRtb.BidRequest.Imp.BannerOrBuilder
        Returns:
        The count of battr.

      • getMimesList

        public com.google.protobuf.ProtocolStringList getMimesList()
         Allowlist of content MIME types supported. Popular MIME types include,
 but are not limited to "image/jpg", "image/gif" and
 "application/x-shockwave-flash".
        repeated string mimes = 7;
        Specified by:
        getMimesList in interface OpenRtb.BidRequest.Imp.BannerOrBuilder
        Returns:
        A list containing the mimes.

      • getMimesCount

        public int getMimesCount()
         Allowlist of content MIME types supported. Popular MIME types include,
 but are not limited to "image/jpg", "image/gif" and
 "application/x-shockwave-flash".
        repeated string mimes = 7;
        Specified by:
        getMimesCount in interface OpenRtb.BidRequest.Imp.BannerOrBuilder
        Returns:
        The count of mimes.

      • getMimes

        public String getMimes​(int index)
         Allowlist of content MIME types supported. Popular MIME types include,
 but are not limited to "image/jpg", "image/gif" and
 "application/x-shockwave-flash".
        repeated string mimes = 7;
        Specified by:
        getMimes in interface OpenRtb.BidRequest.Imp.BannerOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The mimes at the given index.

      • getMimesBytes

        public com.google.protobuf.ByteString getMimesBytes​(int index)
         Allowlist of content MIME types supported. Popular MIME types include,
 but are not limited to "image/jpg", "image/gif" and
 "application/x-shockwave-flash".
        repeated string mimes = 7;
        Specified by:
        getMimesBytes in interface OpenRtb.BidRequest.Imp.BannerOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the mimes at the given index.

      • hasTopframe

        public boolean hasTopframe()
         Specify if the banner is delivered in the top frame (true)
 or in an iframe (false).
        optional bool topframe = 8;
        Specified by:
        hasTopframe in interface OpenRtb.BidRequest.Imp.BannerOrBuilder
        Returns:
        Whether the topframe field is set.

      • getTopframe

        public boolean getTopframe()
         Specify if the banner is delivered in the top frame (true)
 or in an iframe (false).
        optional bool topframe = 8;
        Specified by:
        getTopframe in interface OpenRtb.BidRequest.Imp.BannerOrBuilder
        Returns:
        The topframe.

      • getExpdirCount

        public int getExpdirCount()
         Directions in which the banner may expand.
        repeated .com.google.openrtb.ExpandableDirection expdir = 9 [packed = true];
        Specified by:
        getExpdirCount in interface OpenRtb.BidRequest.Imp.BannerOrBuilder
        Returns:
        The count of expdir.

      • getApiList

        public List<OpenRtb.APIFramework> getApiList()
         List of supported API frameworks for this impression.
 If an API is not explicitly listed, it is assumed not to be supported.
        repeated .com.google.openrtb.APIFramework api = 10 [packed = true];
        Specified by:
        getApiList in interface OpenRtb.BidRequest.Imp.BannerOrBuilder
        Returns:
        A list containing the api.

      • getApiCount

        public int getApiCount()
         List of supported API frameworks for this impression.
 If an API is not explicitly listed, it is assumed not to be supported.
        repeated .com.google.openrtb.APIFramework api = 10 [packed = true];
        Specified by:
        getApiCount in interface OpenRtb.BidRequest.Imp.BannerOrBuilder
        Returns:
        The count of api.

      • getApi

        public OpenRtb.APIFramework getApi​(int index)
         List of supported API frameworks for this impression.
 If an API is not explicitly listed, it is assumed not to be supported.
        repeated .com.google.openrtb.APIFramework api = 10 [packed = true];
        Specified by:
        getApi in interface OpenRtb.BidRequest.Imp.BannerOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The api at the given index.

      • hasVcm

        public boolean hasVcm()
         Relevant only for Banner objects used with a Video object
 (Section 3.2.7) in an array of companion ads. Indicates the
 companion banner rendering mode relative to the associated
 video, where false = concurrent, true = end-card.
        optional bool vcm = 16;
        Specified by:
        hasVcm in interface OpenRtb.BidRequest.Imp.BannerOrBuilder
        Returns:
        Whether the vcm field is set.

      • getVcm

        public boolean getVcm()
         Relevant only for Banner objects used with a Video object
 (Section 3.2.7) in an array of companion ads. Indicates the
 companion banner rendering mode relative to the associated
 video, where false = concurrent, true = end-card.
        optional bool vcm = 16;
        Specified by:
        getVcm in interface OpenRtb.BidRequest.Imp.BannerOrBuilder
        Returns:
        The vcm.

      • hasWmax

        @Deprecated
public boolean hasWmax()
        Deprecated.
        com.google.openrtb.BidRequest.Imp.Banner.wmax is deprecated. See openrtb.proto;l=355
         DEPRECATED in OpenRTB 2.4+. Prefer the field <code>format</code>.
 Maximum width in device independent pixels (DIPS).
        optional int32 wmax = 11 [deprecated = true];
        Specified by:
        hasWmax in interface OpenRtb.BidRequest.Imp.BannerOrBuilder
        Returns:
        Whether the wmax field is set.

      • getWmax

        @Deprecated
public int getWmax()
        Deprecated.
        com.google.openrtb.BidRequest.Imp.Banner.wmax is deprecated. See openrtb.proto;l=355
         DEPRECATED in OpenRTB 2.4+. Prefer the field <code>format</code>.
 Maximum width in device independent pixels (DIPS).
        optional int32 wmax = 11 [deprecated = true];
        Specified by:
        getWmax in interface OpenRtb.BidRequest.Imp.BannerOrBuilder
        Returns:
        The wmax.

      • hasHmax

        @Deprecated
public boolean hasHmax()
        Deprecated.
        com.google.openrtb.BidRequest.Imp.Banner.hmax is deprecated. See openrtb.proto;l=359
         DEPRECATED in OpenRTB 2.4+. Prefer the field <code>format</code>.
 Maximum height in device independent pixels (DIPS).
        optional int32 hmax = 12 [deprecated = true];
        Specified by:
        hasHmax in interface OpenRtb.BidRequest.Imp.BannerOrBuilder
        Returns:
        Whether the hmax field is set.

      • getHmax

        @Deprecated
public int getHmax()
        Deprecated.
        com.google.openrtb.BidRequest.Imp.Banner.hmax is deprecated. See openrtb.proto;l=359
         DEPRECATED in OpenRTB 2.4+. Prefer the field <code>format</code>.
 Maximum height in device independent pixels (DIPS).
        optional int32 hmax = 12 [deprecated = true];
        Specified by:
        getHmax in interface OpenRtb.BidRequest.Imp.BannerOrBuilder
        Returns:
        The hmax.

      • hasWmin

        @Deprecated
public boolean hasWmin()
        Deprecated.
        com.google.openrtb.BidRequest.Imp.Banner.wmin is deprecated. See openrtb.proto;l=363
         DEPRECATED in OpenRTB 2.4+. Prefer the field <code>format</code>.
 Minimum width in device independent pixels (DIPS).
        optional int32 wmin = 13 [deprecated = true];
        Specified by:
        hasWmin in interface OpenRtb.BidRequest.Imp.BannerOrBuilder
        Returns:
        Whether the wmin field is set.

      • getWmin

        @Deprecated
public int getWmin()
        Deprecated.
        com.google.openrtb.BidRequest.Imp.Banner.wmin is deprecated. See openrtb.proto;l=363
         DEPRECATED in OpenRTB 2.4+. Prefer the field <code>format</code>.
 Minimum width in device independent pixels (DIPS).
        optional int32 wmin = 13 [deprecated = true];
        Specified by:
        getWmin in interface OpenRtb.BidRequest.Imp.BannerOrBuilder
        Returns:
        The wmin.

      • hasHmin

        @Deprecated
public boolean hasHmin()
        Deprecated.
        com.google.openrtb.BidRequest.Imp.Banner.hmin is deprecated. See openrtb.proto;l=367
         DEPRECATED in OpenRTB 2.4+. Prefer the field <code>format</code>.
 Minimum height in device independent pixels (DIPS).
        optional int32 hmin = 14 [deprecated = true];
        Specified by:
        hasHmin in interface OpenRtb.BidRequest.Imp.BannerOrBuilder
        Returns:
        Whether the hmin field is set.

      • getHmin

        @Deprecated
public int getHmin()
        Deprecated.
        com.google.openrtb.BidRequest.Imp.Banner.hmin is deprecated. See openrtb.proto;l=367
         DEPRECATED in OpenRTB 2.4+. Prefer the field <code>format</code>.
 Minimum height in device independent pixels (DIPS).
        optional int32 hmin = 14 [deprecated = true];
        Specified by:
        getHmin in interface OpenRtb.BidRequest.Imp.BannerOrBuilder
        Returns:
        The hmin.

      • 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.Imp.Banner>

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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