Package com.google.doubleclick

Class AdxExt.BidExt.FrequencyCap

  • All Implemented Interfaces:
    AdxExt.BidExt.FrequencyCapOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    Enclosing class:
    AdxExt.BidExt
    public static final class AdxExt.BidExt.FrequencyCap
extends com.google.protobuf.GeneratedMessageV3
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
    See Also:
    Serialized Form

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getUnknownFields

        public final com.google.protobuf.UnknownFieldSet getUnknownFields()
        Specified by:
        getUnknownFields in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getUnknownFields in class com.google.protobuf.GeneratedMessageV3

      • 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

      • 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.

      • 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.

      • 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.

      • 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.

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static AdxExt.BidExt.FrequencyCap parseFrom​(ByteBuffer data)
                                            throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static AdxExt.BidExt.FrequencyCap parseFrom​(ByteBuffer data,
                                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                            throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static AdxExt.BidExt.FrequencyCap parseFrom​(com.google.protobuf.ByteString data)
                                            throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static AdxExt.BidExt.FrequencyCap parseFrom​(com.google.protobuf.ByteString data,
                                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                            throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static AdxExt.BidExt.FrequencyCap parseFrom​(byte[] data)
                                            throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static AdxExt.BidExt.FrequencyCap parseFrom​(byte[] data,
                                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                            throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

        protected AdxExt.BidExt.FrequencyCap.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

        public com.google.protobuf.Parser<AdxExt.BidExt.FrequencyCap> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

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