Package com.google.openrtb

Interface OpenRtb.BidRequest.Imp.BannerOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods Deprecated Methods 
      Modifier and Type Method Description
      OpenRtb.APIFramework getApi​(int index)
      List of supported API frameworks for this impression.
      int getApiCount()
      List of supported API frameworks for this impression.
      List<OpenRtb.APIFramework> getApiList()
      List of supported API frameworks for this impression.
      OpenRtb.CreativeAttribute getBattr​(int index)
      Blocked creative attributes.
      int getBattrCount()
      Blocked creative attributes.
      List<OpenRtb.CreativeAttribute> getBattrList()
      Blocked creative attributes.
      OpenRtb.BannerAdType getBtype​(int index)
      Blocked banner ad types.
      int getBtypeCount()
      Blocked banner ad types.
      List<OpenRtb.BannerAdType> getBtypeList()
      Blocked banner ad types.
      OpenRtb.ExpandableDirection getExpdir​(int index)
      Directions in which the banner may expand.
      int getExpdirCount()
      Directions in which the banner may expand.
      List<OpenRtb.ExpandableDirection> getExpdirList()
      Directions in which the banner may expand.
      OpenRtb.BidRequest.Imp.Banner.Format getFormat​(int index)
      Array of format objects representing the banner sizes permitted.
      int getFormatCount()
      Array of format objects representing the banner sizes permitted.
      List<OpenRtb.BidRequest.Imp.Banner.Format> getFormatList()
      Array of format objects representing the banner sizes permitted.
      OpenRtb.BidRequest.Imp.Banner.FormatOrBuilder getFormatOrBuilder​(int index)
      Array of format objects representing the banner sizes permitted.
      List<? extends OpenRtb.BidRequest.Imp.Banner.FormatOrBuilder> getFormatOrBuilderList()
      Array of format objects representing the banner sizes permitted.
      int getH()
      Height in device independent pixels (DIPS).
      int getHmax()
      Deprecated.
      com.google.openrtb.BidRequest.Imp.Banner.hmax is deprecated.
      int getHmin()
      Deprecated.
      com.google.openrtb.BidRequest.Imp.Banner.hmin is deprecated.
      String getId()
      Unique identifier for this banner object.
      com.google.protobuf.ByteString getIdBytes()
      Unique identifier for this banner object.
      String getMimes​(int index)
      Allowlist of content MIME types supported.
      com.google.protobuf.ByteString getMimesBytes​(int index)
      Allowlist of content MIME types supported.
      int getMimesCount()
      Allowlist of content MIME types supported.
      List<String> getMimesList()
      Allowlist of content MIME types supported.
      OpenRtb.AdPosition getPos()
      Ad position on screen.
      boolean getTopframe()
      Specify if the banner is delivered in the top frame (true) or in an iframe (false).
      boolean getVcm()
      Relevant only for Banner objects used with a Video object (Section 3.2.7) in an array of companion ads.
      int getW()
      Width in device independent pixels (DIPS).
      int getWmax()
      Deprecated.
      com.google.openrtb.BidRequest.Imp.Banner.wmax is deprecated.
      int getWmin()
      Deprecated.
      com.google.openrtb.BidRequest.Imp.Banner.wmin is deprecated.
      boolean hasH()
      Height in device independent pixels (DIPS).
      boolean hasHmax()
      Deprecated.
      com.google.openrtb.BidRequest.Imp.Banner.hmax is deprecated.
      boolean hasHmin()
      Deprecated.
      com.google.openrtb.BidRequest.Imp.Banner.hmin is deprecated.
      boolean hasId()
      Unique identifier for this banner object.
      boolean hasPos()
      Ad position on screen.
      boolean hasTopframe()
      Specify if the banner is delivered in the top frame (true) or in an iframe (false).
      boolean hasVcm()
      Relevant only for Banner objects used with a Video object (Section 3.2.7) in an array of companion ads.
      boolean hasW()
      Width in device independent pixels (DIPS).
      boolean hasWmax()
      Deprecated.
      com.google.openrtb.BidRequest.Imp.Banner.wmax is deprecated.
      boolean hasWmin()
      Deprecated.
      com.google.openrtb.BidRequest.Imp.Banner.wmin is deprecated.

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

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

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

        isInitialized

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

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

    • Method Detail

      • hasW

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

      • getW

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

      • hasH

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

      • getH

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

      • getFormatList

        List<OpenRtb.BidRequest.Imp.Banner.Format> getFormatList()
         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;

      • getFormat

        OpenRtb.BidRequest.Imp.Banner.Format getFormat​(int index)
         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;

      • getFormatCount

        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;

      • getFormatOrBuilderList

        List<? extends OpenRtb.BidRequest.Imp.Banner.FormatOrBuilder> getFormatOrBuilderList()
         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;

      • getFormatOrBuilder

        OpenRtb.BidRequest.Imp.Banner.FormatOrBuilder getFormatOrBuilder​(int index)
         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;

      • hasId

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

      • getId

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

      • getIdBytes

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

      • hasPos

        boolean hasPos()
         Ad position on screen.
        optional .com.google.openrtb.AdPosition pos = 4;
        Returns:
        Whether the pos field is set.

      • getPos

        OpenRtb.AdPosition getPos()
         Ad position on screen.
        optional .com.google.openrtb.AdPosition pos = 4;
        Returns:
        The pos.

      • getBtypeList

        List<OpenRtb.BannerAdType> getBtypeList()
         Blocked banner ad types.
        repeated .com.google.openrtb.BannerAdType btype = 5 [packed = true];
        Returns:
        A list containing the btype.

      • getBtypeCount

        int getBtypeCount()
         Blocked banner ad types.
        repeated .com.google.openrtb.BannerAdType btype = 5 [packed = true];
        Returns:
        The count of btype.

      • getBtype

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

      • getBattrList

        List<OpenRtb.CreativeAttribute> getBattrList()
         Blocked creative attributes.
        repeated .com.google.openrtb.CreativeAttribute battr = 6 [packed = true];
        Returns:
        A list containing the battr.

      • getBattrCount

        int getBattrCount()
         Blocked creative attributes.
        repeated .com.google.openrtb.CreativeAttribute battr = 6 [packed = true];
        Returns:
        The count of battr.

      • getBattr

        OpenRtb.CreativeAttribute getBattr​(int index)
         Blocked creative attributes.
        repeated .com.google.openrtb.CreativeAttribute battr = 6 [packed = true];
        Parameters:
        index - The index of the element to return.
        Returns:
        The battr at the given index.

      • getMimesList

        List<String> 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;
        Returns:
        A list containing the mimes.

      • getMimesCount

        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;
        Returns:
        The count of mimes.

      • getMimes

        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;
        Parameters:
        index - The index of the element to return.
        Returns:
        The mimes at the given index.

      • getMimesBytes

        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;
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the mimes at the given index.

      • hasTopframe

        boolean hasTopframe()
         Specify if the banner is delivered in the top frame (true)
 or in an iframe (false).
        optional bool topframe = 8;
        Returns:
        Whether the topframe field is set.

      • getTopframe

        boolean getTopframe()
         Specify if the banner is delivered in the top frame (true)
 or in an iframe (false).
        optional bool topframe = 8;
        Returns:
        The topframe.

      • getExpdirList

        List<OpenRtb.ExpandableDirection> getExpdirList()
         Directions in which the banner may expand.
        repeated .com.google.openrtb.ExpandableDirection expdir = 9 [packed = true];
        Returns:
        A list containing the expdir.

      • getExpdirCount

        int getExpdirCount()
         Directions in which the banner may expand.
        repeated .com.google.openrtb.ExpandableDirection expdir = 9 [packed = true];
        Returns:
        The count of expdir.

      • getExpdir

        OpenRtb.ExpandableDirection getExpdir​(int index)
         Directions in which the banner may expand.
        repeated .com.google.openrtb.ExpandableDirection expdir = 9 [packed = true];
        Parameters:
        index - The index of the element to return.
        Returns:
        The expdir at the given index.

      • getApiList

        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];
        Returns:
        A list containing the api.

      • getApiCount

        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];
        Returns:
        The count of api.

      • getApi

        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];
        Parameters:
        index - The index of the element to return.
        Returns:
        The api at the given index.

      • hasVcm

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

      • getVcm

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

      • hasWmax

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

      • getWmax

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

      • hasHmax

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

      • getHmax

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

      • hasWmin

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

      • getWmin

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

      • hasHmin

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

      • getHmin

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