Package com.google.doubleclick

Interface AdxExt.BidExt.FrequencyCapOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      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.
      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.
      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.
      int getTimeRange()
      The length of the time window, in units specified by time_unit, for which the frequency cap applies.
      AdxExt.BidExt.FrequencyCap.TimeUnit getTimeUnit()
      The unit of time used to specify the time window for which a frequency cap applies.
      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.
      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.
      boolean hasTimeRange()
      The length of the time window, in units specified by time_unit, for which the frequency cap applies.
      boolean hasTimeUnit()
      The unit of time used to specify the time window for which a frequency cap applies.

      • Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

        isInitialized

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

    • Method Detail

      • hasFcapId

        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;
        Returns:
        Whether the fcapId field is set.

      • getFcapId

        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;
        Returns:
        The fcapId.

      • getFcapIdBytes

        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;
        Returns:
        The bytes for fcapId.

      • hasTimeUnit

        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;
        Returns:
        Whether the timeUnit field is set.

      • getTimeUnit

        AdxExt.BidExt.FrequencyCap.TimeUnit getTimeUnit()
         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:
        The timeUnit.

      • hasTimeRange

        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];
        Returns:
        Whether the timeRange field is set.

      • getTimeRange

        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];
        Returns:
        The timeRange.

      • hasMaxImp

        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;
        Returns:
        Whether the maxImp field is set.

      • getMaxImp

        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;
        Returns:
        The maxImp.