Package com.google.openrtb

Enum OpenRtb.AdPosition

  • All Implemented Interfaces:
    com.google.protobuf.Internal.EnumLite, com.google.protobuf.ProtocolMessageEnum, Serializable, Comparable<OpenRtb.AdPosition>
    Enclosing class:
    OpenRtb
    public static enum OpenRtb.AdPosition
extends Enum<OpenRtb.AdPosition>
implements com.google.protobuf.ProtocolMessageEnum
     OpenRTB 2.0: The following table specifies the position of the ad as a
 relative measure of visibility or prominence.
 This OpenRTB table has values derived from the IAB Quality Assurance
 Guidelines (QAG). Practitioners should keep in sync with updates to the
 QAG values as published on IAB.net. Values "3" - "6" apply to apps
 per the mobile addendum to QAG version 1.5.
    Protobuf enum com.google.openrtb.AdPosition

    • Enum Constant Detail

      • ABOVE_THE_FOLD

        public static final OpenRtb.AdPosition ABOVE_THE_FOLD
        ABOVE_THE_FOLD = 1;

      • DEPRECATED_LIKELY_BELOW_THE_FOLD

        @Deprecated
public static final OpenRtb.AdPosition DEPRECATED_LIKELY_BELOW_THE_FOLD
        Deprecated.
         DEPRECATED in OpenRTB 2.1+. No replacement.
 May or may not be immediately visible depending on screen size and
 resolution.
        DEPRECATED_LIKELY_BELOW_THE_FOLD = 2 [deprecated = true];

      • BELOW_THE_FOLD

        public static final OpenRtb.AdPosition BELOW_THE_FOLD
        BELOW_THE_FOLD = 3;

      • HEADER

        public static final OpenRtb.AdPosition HEADER
         [OpenRTB->AdX: SlotVisibility.ABOVE_THE_FOLD]
 Equivalent to
 `sticky_settings.top_horizontal_stickiness` in Authorized
 Buyers RTB protocol.
        HEADER = 4;

      • FOOTER

        public static final OpenRtb.AdPosition FOOTER
         [OpenRTB->AdX: SlotVisibility.ABOVE_THE_FOLD]
 Equivalent to `sticky_settings.bottom_horizontal_stickiness` in Authorized
 Buyers RTB protocol.
        FOOTER = 5;

      • SIDEBAR

        public static final OpenRtb.AdPosition SIDEBAR
         [OpenRTB->AdX: SlotVisibility.ABOVE_THE_FOLD]
 Equivalent to `sticky_settings.vertical_stickiness` in Authorized Buyers
 RTB protocol.
        SIDEBAR = 6;

      • AD_POSITION_FULLSCREEN

        public static final OpenRtb.AdPosition AD_POSITION_FULLSCREEN
         [OpenRTB->AdX: SlotVisibility.ABOVE_THE_FOLD]
        AD_POSITION_FULLSCREEN = 7;

    • Field Detail

      • ABOVE_THE_FOLD_VALUE

        public static final int ABOVE_THE_FOLD_VALUE
        ABOVE_THE_FOLD = 1;
        See Also:
        Constant Field Values

      • DEPRECATED_LIKELY_BELOW_THE_FOLD_VALUE

        @Deprecated
public static final int DEPRECATED_LIKELY_BELOW_THE_FOLD_VALUE
        Deprecated.
         DEPRECATED in OpenRTB 2.1+. No replacement.
 May or may not be immediately visible depending on screen size and
 resolution.
        DEPRECATED_LIKELY_BELOW_THE_FOLD = 2 [deprecated = true];
        See Also:
        Constant Field Values

      • BELOW_THE_FOLD_VALUE

        public static final int BELOW_THE_FOLD_VALUE
        BELOW_THE_FOLD = 3;
        See Also:
        Constant Field Values

      • HEADER_VALUE

        public static final int HEADER_VALUE
         [OpenRTB->AdX: SlotVisibility.ABOVE_THE_FOLD]
 Equivalent to
 `sticky_settings.top_horizontal_stickiness` in Authorized
 Buyers RTB protocol.
        HEADER = 4;
        See Also:
        Constant Field Values

      • FOOTER_VALUE

        public static final int FOOTER_VALUE
         [OpenRTB->AdX: SlotVisibility.ABOVE_THE_FOLD]
 Equivalent to `sticky_settings.bottom_horizontal_stickiness` in Authorized
 Buyers RTB protocol.
        FOOTER = 5;
        See Also:
        Constant Field Values

      • SIDEBAR_VALUE

        public static final int SIDEBAR_VALUE
         [OpenRTB->AdX: SlotVisibility.ABOVE_THE_FOLD]
 Equivalent to `sticky_settings.vertical_stickiness` in Authorized Buyers
 RTB protocol.
        SIDEBAR = 6;
        See Also:
        Constant Field Values

      • AD_POSITION_FULLSCREEN_VALUE

        public static final int AD_POSITION_FULLSCREEN_VALUE
         [OpenRTB->AdX: SlotVisibility.ABOVE_THE_FOLD]
        AD_POSITION_FULLSCREEN = 7;
        See Also:
        Constant Field Values

    • Method Detail

      • values

        public static OpenRtb.AdPosition[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (OpenRtb.AdPosition c : OpenRtb.AdPosition.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static OpenRtb.AdPosition valueOf​(String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        IllegalArgumentException - if this enum type has no constant with the specified name
        NullPointerException - if the argument is null

      • getNumber

        public final int getNumber()
        Specified by:
        getNumber in interface com.google.protobuf.Internal.EnumLite
        Specified by:
        getNumber in interface com.google.protobuf.ProtocolMessageEnum

      • valueOf

        @Deprecated
public static OpenRtb.AdPosition valueOf​(int value)
        Deprecated.
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        value - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        IllegalArgumentException - if this enum type has no constant with the specified name
        NullPointerException - if the argument is null

      • forNumber

        public static OpenRtb.AdPosition forNumber​(int value)
        Parameters:
        value - The numeric wire value of the corresponding enum entry.
        Returns:
        The enum associated with the given numeric wire value.

      • internalGetValueMap

        public static com.google.protobuf.Internal.EnumLiteMap<OpenRtb.AdPosition> internalGetValueMap()

      • getValueDescriptor

        public final com.google.protobuf.Descriptors.EnumValueDescriptor getValueDescriptor()
        Specified by:
        getValueDescriptor in interface com.google.protobuf.ProtocolMessageEnum

      • getDescriptorForType

        public final com.google.protobuf.Descriptors.EnumDescriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.ProtocolMessageEnum

      • getDescriptor

        public static final com.google.protobuf.Descriptors.EnumDescriptor getDescriptor()

      • valueOf

        public static OpenRtb.AdPosition valueOf​(com.google.protobuf.Descriptors.EnumValueDescriptor desc)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        desc - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        IllegalArgumentException - if this enum type has no constant with the specified name
        NullPointerException - if the argument is null