Package com.google.doubleclick

Class AdxExt.BidExt.FrequencyCap.Builder

  • All Implemented Interfaces:
    AdxExt.BidExt.FrequencyCapOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
    Enclosing class:
    AdxExt.BidExt.FrequencyCap
    public static final class AdxExt.BidExt.FrequencyCap.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<AdxExt.BidExt.FrequencyCap.Builder>
implements AdxExt.BidExt.FrequencyCapOrBuilder
     Experimental feature; may be subject to change. See
 https://support.google.com/authorizedbuyers/answer/10890762 for more
 information.
 Specifies frequency capping to be applied to the bid. Impressions for each
 user are capped at the level specified by fcap_id. A bid will not
 participate in the auction if an additional impression for the user would
 violate any of the specified caps. Multiple frequency caps can be specified
 for the same fcap_id.
 A bid is filtered before the auction if the frequency cap is malformed.
 Instances where the cap is malformed include:
  - fcap_id is empty or is very long
  - max_mpressions or time_range are non-positive
  - there are a large number of frequency caps for a single bid
  - time_unit is not specified
 Note that if a subsequent bid with the same fcap_id uses a different
 duration (represented by time_unit and time_range) then impressions counted
 against the old frequency cap will not count against the new one and vice
 versa.
    Protobuf type com.google.doubleclick.BidExt.FrequencyCap

    • Method Detail

      • 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.Builder<AdxExt.BidExt.FrequencyCap.Builder>

      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<AdxExt.BidExt.FrequencyCap.Builder>

      • getDefaultInstanceForType

        public AdxExt.BidExt.FrequencyCap getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

      • build

        public AdxExt.BidExt.FrequencyCap build()
        Specified by:
        build in interface com.google.protobuf.Message.Builder
        Specified by:
        build in interface com.google.protobuf.MessageLite.Builder

      • buildPartial

        public AdxExt.BidExt.FrequencyCap buildPartial()
        Specified by:
        buildPartial in interface com.google.protobuf.Message.Builder
        Specified by:
        buildPartial in interface com.google.protobuf.MessageLite.Builder

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<AdxExt.BidExt.FrequencyCap.Builder>

      • mergeFrom

        public AdxExt.BidExt.FrequencyCap.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                             throws IOException
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<AdxExt.BidExt.FrequencyCap.Builder>
        Throws:
        IOException

      • hasFcapId

        public boolean hasFcapId()
         An ID that can represent a bidder's use-case for frequency capping; for
 example, it could represent their campaign, ad, line item, etc. It should
 not contain any user-specific information or identifiers and should not
 be longer than 64 characters.
        optional string fcap_id = 1;
        Specified by:
        hasFcapId in interface AdxExt.BidExt.FrequencyCapOrBuilder
        Returns:
        Whether the fcapId field is set.

      • getFcapId

        public String getFcapId()
         An ID that can represent a bidder's use-case for frequency capping; for
 example, it could represent their campaign, ad, line item, etc. It should
 not contain any user-specific information or identifiers and should not
 be longer than 64 characters.
        optional string fcap_id = 1;
        Specified by:
        getFcapId in interface AdxExt.BidExt.FrequencyCapOrBuilder
        Returns:
        The fcapId.

      • getFcapIdBytes

        public com.google.protobuf.ByteString getFcapIdBytes()
         An ID that can represent a bidder's use-case for frequency capping; for
 example, it could represent their campaign, ad, line item, etc. It should
 not contain any user-specific information or identifiers and should not
 be longer than 64 characters.
        optional string fcap_id = 1;
        Specified by:
        getFcapIdBytes in interface AdxExt.BidExt.FrequencyCapOrBuilder
        Returns:
        The bytes for fcapId.

      • setFcapId

        public AdxExt.BidExt.FrequencyCap.Builder setFcapId​(String value)
         An ID that can represent a bidder's use-case for frequency capping; for
 example, it could represent their campaign, ad, line item, etc. It should
 not contain any user-specific information or identifiers and should not
 be longer than 64 characters.
        optional string fcap_id = 1;
        Parameters:
        value - The fcapId to set.
        Returns:
        This builder for chaining.

      • clearFcapId

        public AdxExt.BidExt.FrequencyCap.Builder clearFcapId()
         An ID that can represent a bidder's use-case for frequency capping; for
 example, it could represent their campaign, ad, line item, etc. It should
 not contain any user-specific information or identifiers and should not
 be longer than 64 characters.
        optional string fcap_id = 1;
        Returns:
        This builder for chaining.

      • setFcapIdBytes

        public AdxExt.BidExt.FrequencyCap.Builder setFcapIdBytes​(com.google.protobuf.ByteString value)
         An ID that can represent a bidder's use-case for frequency capping; for
 example, it could represent their campaign, ad, line item, etc. It should
 not contain any user-specific information or identifiers and should not
 be longer than 64 characters.
        optional string fcap_id = 1;
        Parameters:
        value - The bytes for fcapId to set.
        Returns:
        This builder for chaining.

      • hasTimeUnit

        public boolean hasTimeUnit()
         The unit of time used to specify the time window for which a frequency
 cap applies.
        optional .com.google.doubleclick.BidExt.FrequencyCap.TimeUnit time_unit = 2;
        Specified by:
        hasTimeUnit in interface AdxExt.BidExt.FrequencyCapOrBuilder
        Returns:
        Whether the timeUnit field is set.

      • setTimeUnit

        public AdxExt.BidExt.FrequencyCap.Builder setTimeUnit​(AdxExt.BidExt.FrequencyCap.TimeUnit value)
         The unit of time used to specify the time window for which a frequency
 cap applies.
        optional .com.google.doubleclick.BidExt.FrequencyCap.TimeUnit time_unit = 2;
        Parameters:
        value - The timeUnit to set.
        Returns:
        This builder for chaining.

      • clearTimeUnit

        public AdxExt.BidExt.FrequencyCap.Builder clearTimeUnit()
         The unit of time used to specify the time window for which a frequency
 cap applies.
        optional .com.google.doubleclick.BidExt.FrequencyCap.TimeUnit time_unit = 2;
        Returns:
        This builder for chaining.

      • hasTimeRange

        public boolean hasTimeRange()
         The length of the time window, in units specified by time_unit, for which
 the frequency cap applies. For instance, if time_unit=WEEK and
 time_range=3, then capping is applied for a three week period. If the
 time_unit=INDEFINITE, this will be ignored.
        optional int32 time_range = 3 [default = 1];
        Specified by:
        hasTimeRange in interface AdxExt.BidExt.FrequencyCapOrBuilder
        Returns:
        Whether the timeRange field is set.

      • getTimeRange

        public int getTimeRange()
         The length of the time window, in units specified by time_unit, for which
 the frequency cap applies. For instance, if time_unit=WEEK and
 time_range=3, then capping is applied for a three week period. If the
 time_unit=INDEFINITE, this will be ignored.
        optional int32 time_range = 3 [default = 1];
        Specified by:
        getTimeRange in interface AdxExt.BidExt.FrequencyCapOrBuilder
        Returns:
        The timeRange.

      • setTimeRange

        public AdxExt.BidExt.FrequencyCap.Builder setTimeRange​(int value)
         The length of the time window, in units specified by time_unit, for which
 the frequency cap applies. For instance, if time_unit=WEEK and
 time_range=3, then capping is applied for a three week period. If the
 time_unit=INDEFINITE, this will be ignored.
        optional int32 time_range = 3 [default = 1];
        Parameters:
        value - The timeRange to set.
        Returns:
        This builder for chaining.

      • clearTimeRange

        public AdxExt.BidExt.FrequencyCap.Builder clearTimeRange()
         The length of the time window, in units specified by time_unit, for which
 the frequency cap applies. For instance, if time_unit=WEEK and
 time_range=3, then capping is applied for a three week period. If the
 time_unit=INDEFINITE, this will be ignored.
        optional int32 time_range = 3 [default = 1];
        Returns:
        This builder for chaining.

      • hasMaxImp

        public boolean hasMaxImp()
         The maximum number of impressions allowed to be shown to a user for
 the provided frequency_cap_id within the time window described by
 time_unit and time_range.
        optional int32 max_imp = 4;
        Specified by:
        hasMaxImp in interface AdxExt.BidExt.FrequencyCapOrBuilder
        Returns:
        Whether the maxImp field is set.

      • getMaxImp

        public int getMaxImp()
         The maximum number of impressions allowed to be shown to a user for
 the provided frequency_cap_id within the time window described by
 time_unit and time_range.
        optional int32 max_imp = 4;
        Specified by:
        getMaxImp in interface AdxExt.BidExt.FrequencyCapOrBuilder
        Returns:
        The maxImp.

      • setMaxImp

        public AdxExt.BidExt.FrequencyCap.Builder setMaxImp​(int value)
         The maximum number of impressions allowed to be shown to a user for
 the provided frequency_cap_id within the time window described by
 time_unit and time_range.
        optional int32 max_imp = 4;
        Parameters:
        value - The maxImp to set.
        Returns:
        This builder for chaining.

      • clearMaxImp

        public AdxExt.BidExt.FrequencyCap.Builder clearMaxImp()
         The maximum number of impressions allowed to be shown to a user for
 the provided frequency_cap_id within the time window described by
 time_unit and time_range.
        optional int32 max_imp = 4;
        Returns:
        This builder for chaining.

      • setUnknownFields

        public final AdxExt.BidExt.FrequencyCap.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<AdxExt.BidExt.FrequencyCap.Builder>

      • mergeUnknownFields

        public final AdxExt.BidExt.FrequencyCap.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<AdxExt.BidExt.FrequencyCap.Builder>