Package com.google.ads.googleads.v10.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 Detail

      • getLevelValue

        int getLevelValue()
         The level on which the cap is to be applied (e.g. ad group ad, ad group).
 The cap is applied to all the entities of this level.
        .google.ads.googleads.v10.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 (e.g. ad group ad, ad group).
 The cap is applied to all the entities of this level.
        .google.ads.googleads.v10.enums.FrequencyCapLevelEnum.FrequencyCapLevel level = 1;
        Returns:
        The level.

      • getEventTypeValue

        int getEventTypeValue()
         The type of event that the cap applies to (e.g. impression).
        .google.ads.googleads.v10.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 (e.g. impression).
        .google.ads.googleads.v10.enums.FrequencyCapEventTypeEnum.FrequencyCapEventType event_type = 3;
        Returns:
        The eventType.

      • getTimeUnitValue

        int getTimeUnitValue()
         Unit of time the cap is defined at (e.g. day, week).
        .google.ads.googleads.v10.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 (e.g. day, week).
        .google.ads.googleads.v10.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.