Package com.google.ads.googleads.v23.common

Class FrequencyCapKey.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<FrequencyCapKey.Builder>
com.google.ads.googleads.v23.common.FrequencyCapKey.Builder
All Implemented Interfaces:
FrequencyCapKeyOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
FrequencyCapKey
public static final class FrequencyCapKey.Builder extends com.google.protobuf.GeneratedMessage.Builder<FrequencyCapKey.Builder> implements FrequencyCapKeyOrBuilder
 A group of fields used as keys for a frequency cap.
 There can be no more than one frequency cap with the same key.
Protobuf type google.ads.googleads.v23.common.FrequencyCapKey

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<FrequencyCapKey.Builder>

    • clear

      public FrequencyCapKey.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessage.Builder<FrequencyCapKey.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.GeneratedMessage.Builder<FrequencyCapKey.Builder>

    • getDefaultInstanceForType

      public FrequencyCapKey getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

    • build

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

    • buildPartial

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

    • mergeFrom

      public FrequencyCapKey.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<FrequencyCapKey.Builder>

    • mergeFrom

      public FrequencyCapKey.Builder mergeFrom(FrequencyCapKey other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.Builder<FrequencyCapKey.Builder>

    • mergeFrom

      public FrequencyCapKey.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<FrequencyCapKey.Builder>
      Throws:
      IOException

    • getLevelValue

      public 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.v23.enums.FrequencyCapLevelEnum.FrequencyCapLevel level = 1;
      Specified by:
      getLevelValue in interface FrequencyCapKeyOrBuilder
      Returns:
      The enum numeric value on the wire for level.

    • setLevelValue

      public FrequencyCapKey.Builder setLevelValue(int value)
       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.v23.enums.FrequencyCapLevelEnum.FrequencyCapLevel level = 1;
      Parameters:
      value - The enum numeric value on the wire for level to set.
      Returns:
      This builder for chaining.

    • getLevel

      public 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.v23.enums.FrequencyCapLevelEnum.FrequencyCapLevel level = 1;
      Specified by:
      getLevel in interface FrequencyCapKeyOrBuilder
      Returns:
      The level.

    • setLevel

      public FrequencyCapKey.Builder setLevel(FrequencyCapLevelEnum.FrequencyCapLevel value)
       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.v23.enums.FrequencyCapLevelEnum.FrequencyCapLevel level = 1;
      Parameters:
      value - The level to set.
      Returns:
      This builder for chaining.

    • clearLevel

      public FrequencyCapKey.Builder clearLevel()
       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.v23.enums.FrequencyCapLevelEnum.FrequencyCapLevel level = 1;
      Returns:
      This builder for chaining.

    • getEventTypeValue

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

    • setEventTypeValue

      public FrequencyCapKey.Builder setEventTypeValue(int value)
       The type of event that the cap applies to (for example, impression).
      .google.ads.googleads.v23.enums.FrequencyCapEventTypeEnum.FrequencyCapEventType event_type = 3;
      Parameters:
      value - The enum numeric value on the wire for eventType to set.
      Returns:
      This builder for chaining.

    • getEventType

      public FrequencyCapEventTypeEnum.FrequencyCapEventType getEventType()
       The type of event that the cap applies to (for example, impression).
      .google.ads.googleads.v23.enums.FrequencyCapEventTypeEnum.FrequencyCapEventType event_type = 3;
      Specified by:
      getEventType in interface FrequencyCapKeyOrBuilder
      Returns:
      The eventType.

    • setEventType

      public FrequencyCapKey.Builder setEventType(FrequencyCapEventTypeEnum.FrequencyCapEventType value)
       The type of event that the cap applies to (for example, impression).
      .google.ads.googleads.v23.enums.FrequencyCapEventTypeEnum.FrequencyCapEventType event_type = 3;
      Parameters:
      value - The eventType to set.
      Returns:
      This builder for chaining.

    • clearEventType

      public FrequencyCapKey.Builder clearEventType()
       The type of event that the cap applies to (for example, impression).
      .google.ads.googleads.v23.enums.FrequencyCapEventTypeEnum.FrequencyCapEventType event_type = 3;
      Returns:
      This builder for chaining.

    • getTimeUnitValue

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

    • setTimeUnitValue

      public FrequencyCapKey.Builder setTimeUnitValue(int value)
       Unit of time the cap is defined at (for example, day, week).
      .google.ads.googleads.v23.enums.FrequencyCapTimeUnitEnum.FrequencyCapTimeUnit time_unit = 2;
      Parameters:
      value - The enum numeric value on the wire for timeUnit to set.
      Returns:
      This builder for chaining.

    • getTimeUnit

      public FrequencyCapTimeUnitEnum.FrequencyCapTimeUnit getTimeUnit()
       Unit of time the cap is defined at (for example, day, week).
      .google.ads.googleads.v23.enums.FrequencyCapTimeUnitEnum.FrequencyCapTimeUnit time_unit = 2;
      Specified by:
      getTimeUnit in interface FrequencyCapKeyOrBuilder
      Returns:
      The timeUnit.

    • setTimeUnit

      public FrequencyCapKey.Builder setTimeUnit(FrequencyCapTimeUnitEnum.FrequencyCapTimeUnit value)
       Unit of time the cap is defined at (for example, day, week).
      .google.ads.googleads.v23.enums.FrequencyCapTimeUnitEnum.FrequencyCapTimeUnit time_unit = 2;
      Parameters:
      value - The timeUnit to set.
      Returns:
      This builder for chaining.

    • clearTimeUnit

      public FrequencyCapKey.Builder clearTimeUnit()
       Unit of time the cap is defined at (for example, day, week).
      .google.ads.googleads.v23.enums.FrequencyCapTimeUnitEnum.FrequencyCapTimeUnit time_unit = 2;
      Returns:
      This builder for chaining.

    • hasTimeLength

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

    • getTimeLength

      public int getTimeLength()
       Number of time units the cap lasts.
      optional int32 time_length = 5;
      Specified by:
      getTimeLength in interface FrequencyCapKeyOrBuilder
      Returns:
      The timeLength.

    • setTimeLength

      public FrequencyCapKey.Builder setTimeLength(int value)
       Number of time units the cap lasts.
      optional int32 time_length = 5;
      Parameters:
      value - The timeLength to set.
      Returns:
      This builder for chaining.

    • clearTimeLength

      public FrequencyCapKey.Builder clearTimeLength()
       Number of time units the cap lasts.
      optional int32 time_length = 5;
      Returns:
      This builder for chaining.