Package com.google.ads.googleads.v23.resources

Class AppliedIncentive

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.protobuf.GeneratedMessage.ExtendableMessage<com.google.protobuf.GeneratedMessageV3>
com.google.protobuf.GeneratedMessageV3
com.google.ads.googleads.v23.resources.AppliedIncentive
All Implemented Interfaces:
AppliedIncentiveOrBuilder, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<com.google.protobuf.GeneratedMessageV3>, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
public final class AppliedIncentive extends com.google.protobuf.GeneratedMessageV3 implements AppliedIncentiveOrBuilder
 Represents an applied incentive.
Protobuf type google.ads.googleads.v23.resources.AppliedIncentive
See Also:

  • Field Details

    • RESOURCE_NAME_FIELD_NUMBER

      public static final int RESOURCE_NAME_FIELD_NUMBER
      See Also:

    • COUPON_CODE_FIELD_NUMBER

      public static final int COUPON_CODE_FIELD_NUMBER
      See Also:

    • INCENTIVE_STATE_FIELD_NUMBER

      public static final int INCENTIVE_STATE_FIELD_NUMBER
      See Also:

    • REDEMPTION_DATE_TIME_FIELD_NUMBER

      public static final int REDEMPTION_DATE_TIME_FIELD_NUMBER
      See Also:

    • FULFILLMENT_EXPIRATION_DATE_TIME_FIELD_NUMBER

      public static final int FULFILLMENT_EXPIRATION_DATE_TIME_FIELD_NUMBER
      See Also:

    • REWARD_GRANT_DATE_TIME_FIELD_NUMBER

      public static final int REWARD_GRANT_DATE_TIME_FIELD_NUMBER
      See Also:

    • REWARD_EXPIRATION_DATE_TIME_FIELD_NUMBER

      public static final int REWARD_EXPIRATION_DATE_TIME_FIELD_NUMBER
      See Also:

    • CURRENCY_CODE_FIELD_NUMBER

      public static final int CURRENCY_CODE_FIELD_NUMBER
      See Also:

    • REWARD_AMOUNT_MICROS_FIELD_NUMBER

      public static final int REWARD_AMOUNT_MICROS_FIELD_NUMBER
      See Also:

    • GRANTED_AMOUNT_MICROS_FIELD_NUMBER

      public static final int GRANTED_AMOUNT_MICROS_FIELD_NUMBER
      See Also:

    • REQUIRED_MIN_SPEND_MICROS_FIELD_NUMBER

      public static final int REQUIRED_MIN_SPEND_MICROS_FIELD_NUMBER
      See Also:

    • CURRENT_SPEND_TOWARDS_FULFILLMENT_MICROS_FIELD_NUMBER

      public static final int CURRENT_SPEND_TOWARDS_FULFILLMENT_MICROS_FIELD_NUMBER
      See Also:

    • REWARD_BALANCE_REMAINING_MICROS_FIELD_NUMBER

      public static final int REWARD_BALANCE_REMAINING_MICROS_FIELD_NUMBER
      See Also:

  • 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()
      Overrides:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

    • getResourceName

      public String getResourceName()
       Output only. The resource name of the incentive.
 Incentive resource names have the form:

 `customers/{customer_id}/appliedIncentives/{coupon_code}`
      string resource_name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
      Specified by:
      getResourceName in interface AppliedIncentiveOrBuilder
      Returns:
      The resourceName.

    • getResourceNameBytes

      public com.google.protobuf.ByteString getResourceNameBytes()
       Output only. The resource name of the incentive.
 Incentive resource names have the form:

 `customers/{customer_id}/appliedIncentives/{coupon_code}`
      string resource_name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
      Specified by:
      getResourceNameBytes in interface AppliedIncentiveOrBuilder
      Returns:
      The bytes for resourceName.

    • hasCouponCode

      public boolean hasCouponCode()
       Output only. The coupon code of the incentive.
      optional string coupon_code = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasCouponCode in interface AppliedIncentiveOrBuilder
      Returns:
      Whether the couponCode field is set.

    • getCouponCode

      public String getCouponCode()
       Output only. The coupon code of the incentive.
      optional string coupon_code = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getCouponCode in interface AppliedIncentiveOrBuilder
      Returns:
      The couponCode.

    • getCouponCodeBytes

      public com.google.protobuf.ByteString getCouponCodeBytes()
       Output only. The coupon code of the incentive.
      optional string coupon_code = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getCouponCodeBytes in interface AppliedIncentiveOrBuilder
      Returns:
      The bytes for couponCode.

    • hasIncentiveState

      public boolean hasIncentiveState()
       Output only. The current state of the incentive.
      optional .google.ads.googleads.v23.enums.IncentiveStateEnum.IncentiveState incentive_state = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasIncentiveState in interface AppliedIncentiveOrBuilder
      Returns:
      Whether the incentiveState field is set.

    • getIncentiveStateValue

      public int getIncentiveStateValue()
       Output only. The current state of the incentive.
      optional .google.ads.googleads.v23.enums.IncentiveStateEnum.IncentiveState incentive_state = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getIncentiveStateValue in interface AppliedIncentiveOrBuilder
      Returns:
      The enum numeric value on the wire for incentiveState.

    • getIncentiveState

      public IncentiveStateEnum.IncentiveState getIncentiveState()
       Output only. The current state of the incentive.
      optional .google.ads.googleads.v23.enums.IncentiveStateEnum.IncentiveState incentive_state = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getIncentiveState in interface AppliedIncentiveOrBuilder
      Returns:
      The incentiveState.

    • hasRedemptionDateTime

      public boolean hasRedemptionDateTime()
       Output only. The redemption time of the incentive in "YYYY-MM-DD HH:MM:SS"
 format in UTC.
      optional string redemption_date_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasRedemptionDateTime in interface AppliedIncentiveOrBuilder
      Returns:
      Whether the redemptionDateTime field is set.

    • getRedemptionDateTime

      public String getRedemptionDateTime()
       Output only. The redemption time of the incentive in "YYYY-MM-DD HH:MM:SS"
 format in UTC.
      optional string redemption_date_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getRedemptionDateTime in interface AppliedIncentiveOrBuilder
      Returns:
      The redemptionDateTime.

    • getRedemptionDateTimeBytes

      public com.google.protobuf.ByteString getRedemptionDateTimeBytes()
       Output only. The redemption time of the incentive in "YYYY-MM-DD HH:MM:SS"
 format in UTC.
      optional string redemption_date_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getRedemptionDateTimeBytes in interface AppliedIncentiveOrBuilder
      Returns:
      The bytes for redemptionDateTime.

    • hasFulfillmentExpirationDateTime

      public boolean hasFulfillmentExpirationDateTime()
       Output only. The time by which the incentive's fulfillment requirements
 must be met, in "YYYY-MM-DD HH:MM:SS" format in UTC.
      optional string fulfillment_expiration_date_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasFulfillmentExpirationDateTime in interface AppliedIncentiveOrBuilder
      Returns:
      Whether the fulfillmentExpirationDateTime field is set.

    • getFulfillmentExpirationDateTime

      public String getFulfillmentExpirationDateTime()
       Output only. The time by which the incentive's fulfillment requirements
 must be met, in "YYYY-MM-DD HH:MM:SS" format in UTC.
      optional string fulfillment_expiration_date_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getFulfillmentExpirationDateTime in interface AppliedIncentiveOrBuilder
      Returns:
      The fulfillmentExpirationDateTime.

    • getFulfillmentExpirationDateTimeBytes

      public com.google.protobuf.ByteString getFulfillmentExpirationDateTimeBytes()
       Output only. The time by which the incentive's fulfillment requirements
 must be met, in "YYYY-MM-DD HH:MM:SS" format in UTC.
      optional string fulfillment_expiration_date_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getFulfillmentExpirationDateTimeBytes in interface AppliedIncentiveOrBuilder
      Returns:
      The bytes for fulfillmentExpirationDateTime.

    • hasRewardGrantDateTime

      public boolean hasRewardGrantDateTime()
       Output only. The time when the reward was granted in "YYYY-MM-DD HH:MM:SS"
 format in UTC. This field is not set if the reward has not been granted.
      optional string reward_grant_date_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasRewardGrantDateTime in interface AppliedIncentiveOrBuilder
      Returns:
      Whether the rewardGrantDateTime field is set.

    • getRewardGrantDateTime

      public String getRewardGrantDateTime()
       Output only. The time when the reward was granted in "YYYY-MM-DD HH:MM:SS"
 format in UTC. This field is not set if the reward has not been granted.
      optional string reward_grant_date_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getRewardGrantDateTime in interface AppliedIncentiveOrBuilder
      Returns:
      The rewardGrantDateTime.

    • getRewardGrantDateTimeBytes

      public com.google.protobuf.ByteString getRewardGrantDateTimeBytes()
       Output only. The time when the reward was granted in "YYYY-MM-DD HH:MM:SS"
 format in UTC. This field is not set if the reward has not been granted.
      optional string reward_grant_date_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getRewardGrantDateTimeBytes in interface AppliedIncentiveOrBuilder
      Returns:
      The bytes for rewardGrantDateTime.

    • hasRewardExpirationDateTime

      public boolean hasRewardExpirationDateTime()
       Output only. The time when the granted reward expires in "YYYY-MM-DD
 HH:MM:SS" format in UTC. This field is not set if the reward has not been
 granted.
      optional string reward_expiration_date_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasRewardExpirationDateTime in interface AppliedIncentiveOrBuilder
      Returns:
      Whether the rewardExpirationDateTime field is set.

    • getRewardExpirationDateTime

      public String getRewardExpirationDateTime()
       Output only. The time when the granted reward expires in "YYYY-MM-DD
 HH:MM:SS" format in UTC. This field is not set if the reward has not been
 granted.
      optional string reward_expiration_date_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getRewardExpirationDateTime in interface AppliedIncentiveOrBuilder
      Returns:
      The rewardExpirationDateTime.

    • getRewardExpirationDateTimeBytes

      public com.google.protobuf.ByteString getRewardExpirationDateTimeBytes()
       Output only. The time when the granted reward expires in "YYYY-MM-DD
 HH:MM:SS" format in UTC. This field is not set if the reward has not been
 granted.
      optional string reward_expiration_date_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getRewardExpirationDateTimeBytes in interface AppliedIncentiveOrBuilder
      Returns:
      The bytes for rewardExpirationDateTime.

    • hasCurrencyCode

      public boolean hasCurrencyCode()
       Output only. The currency code for all monetary amounts (for example,
 "USD").
      optional string currency_code = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasCurrencyCode in interface AppliedIncentiveOrBuilder
      Returns:
      Whether the currencyCode field is set.

    • getCurrencyCode

      public String getCurrencyCode()
       Output only. The currency code for all monetary amounts (for example,
 "USD").
      optional string currency_code = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getCurrencyCode in interface AppliedIncentiveOrBuilder
      Returns:
      The currencyCode.

    • getCurrencyCodeBytes

      public com.google.protobuf.ByteString getCurrencyCodeBytes()
       Output only. The currency code for all monetary amounts (for example,
 "USD").
      optional string currency_code = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getCurrencyCodeBytes in interface AppliedIncentiveOrBuilder
      Returns:
      The bytes for currencyCode.

    • hasRewardAmountMicros

      public boolean hasRewardAmountMicros()
       Output only. The maximum potential reward amount in micros for the
 incentive.
      optional int64 reward_amount_micros = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasRewardAmountMicros in interface AppliedIncentiveOrBuilder
      Returns:
      Whether the rewardAmountMicros field is set.

    • getRewardAmountMicros

      public long getRewardAmountMicros()
       Output only. The maximum potential reward amount in micros for the
 incentive.
      optional int64 reward_amount_micros = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getRewardAmountMicros in interface AppliedIncentiveOrBuilder
      Returns:
      The rewardAmountMicros.

    • hasGrantedAmountMicros

      public boolean hasGrantedAmountMicros()
       Output only. The amount of the reward granted in micros.
 This field is not set if the reward has not been granted.
      optional int64 granted_amount_micros = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasGrantedAmountMicros in interface AppliedIncentiveOrBuilder
      Returns:
      Whether the grantedAmountMicros field is set.

    • getGrantedAmountMicros

      public long getGrantedAmountMicros()
       Output only. The amount of the reward granted in micros.
 This field is not set if the reward has not been granted.
      optional int64 granted_amount_micros = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getGrantedAmountMicros in interface AppliedIncentiveOrBuilder
      Returns:
      The grantedAmountMicros.

    • hasRequiredMinSpendMicros

      public boolean hasRequiredMinSpendMicros()
       Output only. The minimum amount that must be spent to fulfill the coupon
 requirements, in micros.
      optional int64 required_min_spend_micros = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasRequiredMinSpendMicros in interface AppliedIncentiveOrBuilder
      Returns:
      Whether the requiredMinSpendMicros field is set.

    • getRequiredMinSpendMicros

      public long getRequiredMinSpendMicros()
       Output only. The minimum amount that must be spent to fulfill the coupon
 requirements, in micros.
      optional int64 required_min_spend_micros = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getRequiredMinSpendMicros in interface AppliedIncentiveOrBuilder
      Returns:
      The requiredMinSpendMicros.

    • hasCurrentSpendTowardsFulfillmentMicros

      public boolean hasCurrentSpendTowardsFulfillmentMicros()
       Output only. The current amount spent towards the fulfillment requirements,
 in micros.
      optional int64 current_spend_towards_fulfillment_micros = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasCurrentSpendTowardsFulfillmentMicros in interface AppliedIncentiveOrBuilder
      Returns:
      Whether the currentSpendTowardsFulfillmentMicros field is set.

    • getCurrentSpendTowardsFulfillmentMicros

      public long getCurrentSpendTowardsFulfillmentMicros()
       Output only. The current amount spent towards the fulfillment requirements,
 in micros.
      optional int64 current_spend_towards_fulfillment_micros = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getCurrentSpendTowardsFulfillmentMicros in interface AppliedIncentiveOrBuilder
      Returns:
      The currentSpendTowardsFulfillmentMicros.

    • hasRewardBalanceRemainingMicros

      public boolean hasRewardBalanceRemainingMicros()
       Output only. The remaining balance of the granted reward in micros.
 This field is not set if the reward has not been granted.
      optional int64 reward_balance_remaining_micros = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasRewardBalanceRemainingMicros in interface AppliedIncentiveOrBuilder
      Returns:
      Whether the rewardBalanceRemainingMicros field is set.

    • getRewardBalanceRemainingMicros

      public long getRewardBalanceRemainingMicros()
       Output only. The remaining balance of the granted reward in micros.
 This field is not set if the reward has not been granted.
      optional int64 reward_balance_remaining_micros = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getRewardBalanceRemainingMicros in interface AppliedIncentiveOrBuilder
      Returns:
      The rewardBalanceRemainingMicros.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.ExtendableMessage<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.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static AppliedIncentive.Builder newBuilder()

    • newBuilder

      public static AppliedIncentive.Builder newBuilder(AppliedIncentive prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static AppliedIncentive getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<AppliedIncentive> 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.GeneratedMessage

    • getDefaultInstanceForType

      public AppliedIncentive getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<com.google.protobuf.GeneratedMessageV3>
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder