Enum AdxExt.BidRequestExt.FrequencyCappingScope

  • All Implemented Interfaces:
    com.google.protobuf.Internal.EnumLite, com.google.protobuf.ProtocolMessageEnum, Serializable, Comparable<AdxExt.BidRequestExt.FrequencyCappingScope>
    Enclosing class:
    AdxExt.BidRequestExt

    public static enum AdxExt.BidRequestExt.FrequencyCappingScope
    extends Enum<AdxExt.BidRequestExt.FrequencyCappingScope>
    implements com.google.protobuf.ProtocolMessageEnum
     Experimental feature; may be subject to change. See
     https://support.google.com/authorizedbuyers/answer/10890762 for more
     information.
     Describes the scope of frequency cap enforcement available for this
     request. Frequency caps to be enforced for a bid can be specified in the
     Bid.ext.fcap field.
     
    Protobuf enum com.google.doubleclick.BidRequestExt.FrequencyCappingScope
    • Enum Constant Detail

      • FREQUENCY_CAPPING_SCOPE_UNKNOWN

        public static final AdxExt.BidRequestExt.FrequencyCappingScope FREQUENCY_CAPPING_SCOPE_UNKNOWN
         Default value which should not be used, or which can indicate that
         frequency cap scope could not be reliably determined.
         
        FREQUENCY_CAPPING_SCOPE_UNKNOWN = 0;
      • FREQUENCY_CAPPING_SCOPE_NONE

        public static final AdxExt.BidRequestExt.FrequencyCappingScope FREQUENCY_CAPPING_SCOPE_NONE
         Frequency capping based on bid response specifications is not available
         for this request. A frequency-capped bid for a bid request with no
         frequency cap availability will be filtered prior to the auction.
         
        FREQUENCY_CAPPING_SCOPE_NONE = 1;
      • FREQUENCY_CAPPING_SCOPE_BROWSER

        public static final AdxExt.BidRequestExt.FrequencyCappingScope FREQUENCY_CAPPING_SCOPE_BROWSER
         Frequency capping enforcement is available across multiple sites within
         the same browser.
         
        FREQUENCY_CAPPING_SCOPE_BROWSER = 2;
      • FREQUENCY_CAPPING_SCOPE_DEVICE

        public static final AdxExt.BidRequestExt.FrequencyCappingScope FREQUENCY_CAPPING_SCOPE_DEVICE
         Frequency capping enforcement is available across multiple apps on the
         device, excluding browsers.
         
        FREQUENCY_CAPPING_SCOPE_DEVICE = 3;
      • FREQUENCY_CAPPING_SCOPE_APP

        public static final AdxExt.BidRequestExt.FrequencyCappingScope FREQUENCY_CAPPING_SCOPE_APP
         Frequency capping enforcement is available within a single app.
         
        FREQUENCY_CAPPING_SCOPE_APP = 4;
      • FREQUENCY_CAPPING_SCOPE_SITE

        public static final AdxExt.BidRequestExt.FrequencyCappingScope FREQUENCY_CAPPING_SCOPE_SITE
         Frequency capping enforcement is available within a single site.
         
        FREQUENCY_CAPPING_SCOPE_SITE = 5;
    • Field Detail

      • FREQUENCY_CAPPING_SCOPE_UNKNOWN_VALUE

        public static final int FREQUENCY_CAPPING_SCOPE_UNKNOWN_VALUE
         Default value which should not be used, or which can indicate that
         frequency cap scope could not be reliably determined.
         
        FREQUENCY_CAPPING_SCOPE_UNKNOWN = 0;
        See Also:
        Constant Field Values
      • FREQUENCY_CAPPING_SCOPE_NONE_VALUE

        public static final int FREQUENCY_CAPPING_SCOPE_NONE_VALUE
         Frequency capping based on bid response specifications is not available
         for this request. A frequency-capped bid for a bid request with no
         frequency cap availability will be filtered prior to the auction.
         
        FREQUENCY_CAPPING_SCOPE_NONE = 1;
        See Also:
        Constant Field Values
      • FREQUENCY_CAPPING_SCOPE_BROWSER_VALUE

        public static final int FREQUENCY_CAPPING_SCOPE_BROWSER_VALUE
         Frequency capping enforcement is available across multiple sites within
         the same browser.
         
        FREQUENCY_CAPPING_SCOPE_BROWSER = 2;
        See Also:
        Constant Field Values
      • FREQUENCY_CAPPING_SCOPE_DEVICE_VALUE

        public static final int FREQUENCY_CAPPING_SCOPE_DEVICE_VALUE
         Frequency capping enforcement is available across multiple apps on the
         device, excluding browsers.
         
        FREQUENCY_CAPPING_SCOPE_DEVICE = 3;
        See Also:
        Constant Field Values
      • FREQUENCY_CAPPING_SCOPE_APP_VALUE

        public static final int FREQUENCY_CAPPING_SCOPE_APP_VALUE
         Frequency capping enforcement is available within a single app.
         
        FREQUENCY_CAPPING_SCOPE_APP = 4;
        See Also:
        Constant Field Values
      • FREQUENCY_CAPPING_SCOPE_SITE_VALUE

        public static final int FREQUENCY_CAPPING_SCOPE_SITE_VALUE
         Frequency capping enforcement is available within a single site.
         
        FREQUENCY_CAPPING_SCOPE_SITE = 5;
        See Also:
        Constant Field Values
    • Method Detail

      • values

        public static AdxExt.BidRequestExt.FrequencyCappingScope[] 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 (AdxExt.BidRequestExt.FrequencyCappingScope c : AdxExt.BidRequestExt.FrequencyCappingScope.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static AdxExt.BidRequestExt.FrequencyCappingScope 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 AdxExt.BidRequestExt.FrequencyCappingScope 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 AdxExt.BidRequestExt.FrequencyCappingScope forNumber​(int value)
        Parameters:
        value - The numeric wire value of the corresponding enum entry.
        Returns:
        The enum associated with the given numeric wire value.
      • 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 AdxExt.BidRequestExt.FrequencyCappingScope 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