Package 

Class Format

  • 
public final class Format

    This object represents an allowed size (i.e., height and width combination) or Flex Ad parameters for a banner impression. These are typically used in an array where multiple sizes are permitted. It is recommended that either the w/h pair or the wratio/hratio/wmin set (i.e., for Flex Ads) be specified.

    • Constructor Summary

      Constructors 
      Constructor Description
      Format()

    • Method Summary

      Modifier and Type Method Description
      final Integer getWidth() Width in device independent pixels (DIPS).
      final Unit setWidth(@SerializedName(value = w) Integer width) Width in device independent pixels (DIPS).
      final Integer getHeight() Height in device independent pixels (DIPS).
      final Unit setHeight(@SerializedName(value = h) Integer height) Height in device independent pixels (DIPS).
      final Integer getWidthRatio() Relative width when expressing size as a ratio.
      final Unit setWidthRatio(@SerializedName(value = wratio) Integer widthRatio) Relative width when expressing size as a ratio.
      final Integer getHeightRatio() Relative height when expressing size as a ratio.
      final Unit setHeightRatio(@SerializedName(value = hratio) Integer heightRatio) Relative height when expressing size as a ratio.
      final Integer getWidthMin() The minimum width in device independent pixels (DIPS) at which the ad will be displayed the size is expressed as a ratio.
      final Unit setWidthMin(@SerializedName(value = wmin) Integer widthMin) The minimum width in device independent pixels (DIPS) at which the ad will be displayed the size is expressed as a ratio.
      final Object getExtension() Placeholder for exchange-specific extensions to OpenRTB.
      final Unit setExtension(@SerializedName(value = ext) Object extension) Placeholder for exchange-specific extensions to OpenRTB.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • Format

        Format()

    • Method Detail

      • getWidth

         final Integer getWidth()

        Width in device independent pixels (DIPS).

      • setWidth

         final Unit setWidth(@SerializedName(value = w) Integer width)

        Width in device independent pixels (DIPS).

      • getHeight

         final Integer getHeight()

        Height in device independent pixels (DIPS).

      • setHeight

         final Unit setHeight(@SerializedName(value = h) Integer height)

        Height in device independent pixels (DIPS).

      • setWidthRatio

         final Unit setWidthRatio(@SerializedName(value = wratio) Integer widthRatio)

        Relative width when expressing size as a ratio.

      • setHeightRatio

         final Unit setHeightRatio(@SerializedName(value = hratio) Integer heightRatio)

        Relative height when expressing size as a ratio.

      • getWidthMin

         final Integer getWidthMin()

        The minimum width in device independent pixels (DIPS) at which the ad will be displayed the size is expressed as a ratio.

      • setWidthMin

         final Unit setWidthMin(@SerializedName(value = wmin) Integer widthMin)

        The minimum width in device independent pixels (DIPS) at which the ad will be displayed the size is expressed as a ratio.

      • getExtension

         final Object getExtension()

        Placeholder for exchange-specific extensions to OpenRTB.

      • setExtension

         final Unit setExtension(@SerializedName(value = ext) Object extension)

        Placeholder for exchange-specific extensions to OpenRTB.