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

Interface AppliedIncentiveOrBuilder

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

  • Method Details

    • getResourceName

      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) = { ... }
      Returns:
      The resourceName.

    • getResourceNameBytes

      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) = { ... }
      Returns:
      The bytes for resourceName.

    • hasCouponCode

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

    • getCouponCode

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

    • getCouponCodeBytes

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

    • hasIncentiveState

      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];
      Returns:
      Whether the incentiveState field is set.

    • getIncentiveStateValue

      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];
      Returns:
      The enum numeric value on the wire for incentiveState.

    • getIncentiveState

      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];
      Returns:
      The incentiveState.

    • hasRedemptionDateTime

      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];
      Returns:
      Whether the redemptionDateTime field is set.

    • getRedemptionDateTime

      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];
      Returns:
      The redemptionDateTime.

    • getRedemptionDateTimeBytes

      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];
      Returns:
      The bytes for redemptionDateTime.

    • hasFulfillmentExpirationDateTime

      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];
      Returns:
      Whether the fulfillmentExpirationDateTime field is set.

    • getFulfillmentExpirationDateTime

      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];
      Returns:
      The fulfillmentExpirationDateTime.

    • getFulfillmentExpirationDateTimeBytes

      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];
      Returns:
      The bytes for fulfillmentExpirationDateTime.

    • hasRewardGrantDateTime

      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];
      Returns:
      Whether the rewardGrantDateTime field is set.

    • getRewardGrantDateTime

      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];
      Returns:
      The rewardGrantDateTime.

    • getRewardGrantDateTimeBytes

      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];
      Returns:
      The bytes for rewardGrantDateTime.

    • hasRewardExpirationDateTime

      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];
      Returns:
      Whether the rewardExpirationDateTime field is set.

    • getRewardExpirationDateTime

      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];
      Returns:
      The rewardExpirationDateTime.

    • getRewardExpirationDateTimeBytes

      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];
      Returns:
      The bytes for rewardExpirationDateTime.

    • hasCurrencyCode

      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];
      Returns:
      Whether the currencyCode field is set.

    • getCurrencyCode

      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];
      Returns:
      The currencyCode.

    • getCurrencyCodeBytes

      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];
      Returns:
      The bytes for currencyCode.

    • hasRewardAmountMicros

      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];
      Returns:
      Whether the rewardAmountMicros field is set.

    • getRewardAmountMicros

      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];
      Returns:
      The rewardAmountMicros.

    • hasGrantedAmountMicros

      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];
      Returns:
      Whether the grantedAmountMicros field is set.

    • getGrantedAmountMicros

      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];
      Returns:
      The grantedAmountMicros.

    • hasRequiredMinSpendMicros

      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];
      Returns:
      Whether the requiredMinSpendMicros field is set.

    • getRequiredMinSpendMicros

      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];
      Returns:
      The requiredMinSpendMicros.

    • hasCurrentSpendTowardsFulfillmentMicros

      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];
      Returns:
      Whether the currentSpendTowardsFulfillmentMicros field is set.

    • getCurrentSpendTowardsFulfillmentMicros

      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];
      Returns:
      The currentSpendTowardsFulfillmentMicros.

    • hasRewardBalanceRemainingMicros

      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];
      Returns:
      Whether the rewardBalanceRemainingMicros field is set.

    • getRewardBalanceRemainingMicros

      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];
      Returns:
      The rewardBalanceRemainingMicros.