Package com.google.ads.googleads.v18.common

Interface FrequencyCapKeyOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
FrequencyCapKey, FrequencyCapKey.Builder
public interface FrequencyCapKeyOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    FrequencyCapEventTypeEnum.FrequencyCapEventType
    getEventType()
    The type of event that the cap applies to (for example, impression).
    int
    getEventTypeValue()
    The type of event that the cap applies to (for example, impression).
    FrequencyCapLevelEnum.FrequencyCapLevel
    getLevel()
    The level on which the cap is to be applied (for example, ad group ad, ad group).
    int
    getLevelValue()
    The level on which the cap is to be applied (for example, ad group ad, ad group).
    int
    getTimeLength()
    Number of time units the cap lasts.
    FrequencyCapTimeUnitEnum.FrequencyCapTimeUnit
    getTimeUnit()
    Unit of time the cap is defined at (for example, day, week).
    int
    getTimeUnitValue()
    Unit of time the cap is defined at (for example, day, week).
    boolean
    hasTimeLength()
    Number of time units the cap lasts.

    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 Details

    • getLevelValue

      int getLevelValue()
       The level on which the cap is to be applied (for example, ad group ad, ad
 group). The cap is applied to all the entities of this level.
      .google.ads.googleads.v18.enums.FrequencyCapLevelEnum.FrequencyCapLevel level = 1;
      Returns:
      The enum numeric value on the wire for level.

    • getLevel

      FrequencyCapLevelEnum.FrequencyCapLevel getLevel()
       The level on which the cap is to be applied (for example, ad group ad, ad
 group). The cap is applied to all the entities of this level.
      .google.ads.googleads.v18.enums.FrequencyCapLevelEnum.FrequencyCapLevel level = 1;
      Returns:
      The level.

    • getEventTypeValue

      int getEventTypeValue()
       The type of event that the cap applies to (for example, impression).
      .google.ads.googleads.v18.enums.FrequencyCapEventTypeEnum.FrequencyCapEventType event_type = 3;
      Returns:
      The enum numeric value on the wire for eventType.

    • getEventType

      FrequencyCapEventTypeEnum.FrequencyCapEventType getEventType()
       The type of event that the cap applies to (for example, impression).
      .google.ads.googleads.v18.enums.FrequencyCapEventTypeEnum.FrequencyCapEventType event_type = 3;
      Returns:
      The eventType.

    • getTimeUnitValue

      int getTimeUnitValue()
       Unit of time the cap is defined at (for example, day, week).
      .google.ads.googleads.v18.enums.FrequencyCapTimeUnitEnum.FrequencyCapTimeUnit time_unit = 2;
      Returns:
      The enum numeric value on the wire for timeUnit.

    • getTimeUnit

      FrequencyCapTimeUnitEnum.FrequencyCapTimeUnit getTimeUnit()
       Unit of time the cap is defined at (for example, day, week).
      .google.ads.googleads.v18.enums.FrequencyCapTimeUnitEnum.FrequencyCapTimeUnit time_unit = 2;
      Returns:
      The timeUnit.

    • hasTimeLength

      boolean hasTimeLength()
       Number of time units the cap lasts.
      optional int32 time_length = 5;
      Returns:
      Whether the timeLength field is set.

    • getTimeLength

      int getTimeLength()
       Number of time units the cap lasts.
      optional int32 time_length = 5;
      Returns:
      The timeLength.