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

Class FrequencyCapKey

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.google.ads.googleads.v18.common.FrequencyCapKey
All Implemented Interfaces:
FrequencyCapKeyOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
public final class FrequencyCapKey extends com.google.protobuf.GeneratedMessageV3 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.v18.common.FrequencyCapKey
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    FrequencyCapKey.Builder
    A group of fields used as keys for a frequency cap.

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

    com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    EVENT_TYPE_FIELD_NUMBER
     
    static final int
    LEVEL_FIELD_NUMBER
     
    static final int
    TIME_LENGTH_FIELD_NUMBER
     
    static final int
    TIME_UNIT_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessageV3

    alwaysUseFieldBuilders, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    static FrequencyCapKey
    getDefaultInstance()
     
    FrequencyCapKey
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    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).
    com.google.protobuf.Parser<FrequencyCapKey>
    getParserForType()
     
    int
    getSerializedSize()
     
    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).
    int
    hashCode()
     
    boolean
    hasTimeLength()
    Number of time units the cap lasts.
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static FrequencyCapKey.Builder
    newBuilder()
     
    static FrequencyCapKey.Builder
    newBuilder(FrequencyCapKey prototype)
     
    FrequencyCapKey.Builder
    newBuilderForType()
     
    protected FrequencyCapKey.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static FrequencyCapKey
    parseDelimitedFrom(InputStream input)
     
    static FrequencyCapKey
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static FrequencyCapKey
    parseFrom(byte[] data)
     
    static FrequencyCapKey
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static FrequencyCapKey
    parseFrom(com.google.protobuf.ByteString data)
     
    static FrequencyCapKey
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static FrequencyCapKey
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static FrequencyCapKey
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static FrequencyCapKey
    parseFrom(InputStream input)
     
    static FrequencyCapKey
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static FrequencyCapKey
    parseFrom(ByteBuffer data)
     
    static FrequencyCapKey
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<FrequencyCapKey>
    parser()
     
    FrequencyCapKey.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessageV3

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Field Details

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance 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

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

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

    • getEventTypeValue

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

    • getEventType

      public 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;
      Specified by:
      getEventType in interface FrequencyCapKeyOrBuilder
      Returns:
      The eventType.

    • getTimeUnitValue

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

    • getTimeUnit

      public 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;
      Specified by:
      getTimeUnit in interface FrequencyCapKeyOrBuilder
      Returns:
      The timeUnit.

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

    • 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 FrequencyCapKey parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static FrequencyCapKey parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static FrequencyCapKey parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static FrequencyCapKey parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static FrequencyCapKey parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

      public static FrequencyCapKey parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static FrequencyCapKey parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static FrequencyCapKey parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static FrequencyCapKey parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static FrequencyCapKey parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static FrequencyCapKey parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

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

    • newBuilder

      public static FrequencyCapKey.Builder newBuilder()

    • newBuilder

      public static FrequencyCapKey.Builder newBuilder(FrequencyCapKey prototype)

    • toBuilder

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

    • newBuilderForType

      protected FrequencyCapKey.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static FrequencyCapKey getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<FrequencyCapKey> parser()

    • getParserForType

      public com.google.protobuf.Parser<FrequencyCapKey> 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 FrequencyCapKey getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder