Package com.google.ads.googleads.v21.common

Interface PromotionAssetOrBuilder

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

  • Method Details

    • getPromotionTarget

      String getPromotionTarget()
       Required. A freeform description of what the promotion is targeting.
      string promotion_target = 1 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The promotionTarget.

    • getPromotionTargetBytes

      com.google.protobuf.ByteString getPromotionTargetBytes()
       Required. A freeform description of what the promotion is targeting.
      string promotion_target = 1 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The bytes for promotionTarget.

    • getDiscountModifierValue

      int getDiscountModifierValue()
       A modifier for qualification of the discount.
      .google.ads.googleads.v21.enums.PromotionExtensionDiscountModifierEnum.PromotionExtensionDiscountModifier discount_modifier = 2;
      Returns:
      The enum numeric value on the wire for discountModifier.

    • getDiscountModifier

      PromotionExtensionDiscountModifierEnum.PromotionExtensionDiscountModifier getDiscountModifier()
       A modifier for qualification of the discount.
      .google.ads.googleads.v21.enums.PromotionExtensionDiscountModifierEnum.PromotionExtensionDiscountModifier discount_modifier = 2;
      Returns:
      The discountModifier.

    • getRedemptionStartDate

      String getRedemptionStartDate()
       Start date of when the promotion is eligible to be redeemed, in yyyy-MM-dd
 format.
      string redemption_start_date = 7;
      Returns:
      The redemptionStartDate.

    • getRedemptionStartDateBytes

      com.google.protobuf.ByteString getRedemptionStartDateBytes()
       Start date of when the promotion is eligible to be redeemed, in yyyy-MM-dd
 format.
      string redemption_start_date = 7;
      Returns:
      The bytes for redemptionStartDate.

    • getRedemptionEndDate

      String getRedemptionEndDate()
       Last date of when the promotion is eligible to be redeemed, in yyyy-MM-dd
 format.
      string redemption_end_date = 8;
      Returns:
      The redemptionEndDate.

    • getRedemptionEndDateBytes

      com.google.protobuf.ByteString getRedemptionEndDateBytes()
       Last date of when the promotion is eligible to be redeemed, in yyyy-MM-dd
 format.
      string redemption_end_date = 8;
      Returns:
      The bytes for redemptionEndDate.

    • getOccasionValue

      int getOccasionValue()
       The occasion the promotion was intended for.
 If an occasion is set, the redemption window will need to fall within the
 date range associated with the occasion.
      .google.ads.googleads.v21.enums.PromotionExtensionOccasionEnum.PromotionExtensionOccasion occasion = 9;
      Returns:
      The enum numeric value on the wire for occasion.

    • getOccasion

      PromotionExtensionOccasionEnum.PromotionExtensionOccasion getOccasion()
       The occasion the promotion was intended for.
 If an occasion is set, the redemption window will need to fall within the
 date range associated with the occasion.
      .google.ads.googleads.v21.enums.PromotionExtensionOccasionEnum.PromotionExtensionOccasion occasion = 9;
      Returns:
      The occasion.

    • getLanguageCode

      String getLanguageCode()
       The language of the promotion.
 Represented as BCP 47 language tag.
      string language_code = 10;
      Returns:
      The languageCode.

    • getLanguageCodeBytes

      com.google.protobuf.ByteString getLanguageCodeBytes()
       The language of the promotion.
 Represented as BCP 47 language tag.
      string language_code = 10;
      Returns:
      The bytes for languageCode.

    • getStartDate

      String getStartDate()
       Start date of when this asset is effective and can begin serving, in
 yyyy-MM-dd format.
      string start_date = 11;
      Returns:
      The startDate.

    • getStartDateBytes

      com.google.protobuf.ByteString getStartDateBytes()
       Start date of when this asset is effective and can begin serving, in
 yyyy-MM-dd format.
      string start_date = 11;
      Returns:
      The bytes for startDate.

    • getEndDate

      String getEndDate()
       Last date of when this asset is effective and still serving, in yyyy-MM-dd
 format.
      string end_date = 12;
      Returns:
      The endDate.

    • getEndDateBytes

      com.google.protobuf.ByteString getEndDateBytes()
       Last date of when this asset is effective and still serving, in yyyy-MM-dd
 format.
      string end_date = 12;
      Returns:
      The bytes for endDate.

    • getAdScheduleTargetsList

      List<AdScheduleInfo> getAdScheduleTargetsList()
       List of non-overlapping schedules specifying all time intervals for which
 the asset may serve. There can be a maximum of 6 schedules per day, 42 in
 total.
      repeated .google.ads.googleads.v21.common.AdScheduleInfo ad_schedule_targets = 13;

    • getAdScheduleTargets

      AdScheduleInfo getAdScheduleTargets(int index)
       List of non-overlapping schedules specifying all time intervals for which
 the asset may serve. There can be a maximum of 6 schedules per day, 42 in
 total.
      repeated .google.ads.googleads.v21.common.AdScheduleInfo ad_schedule_targets = 13;

    • getAdScheduleTargetsCount

      int getAdScheduleTargetsCount()
       List of non-overlapping schedules specifying all time intervals for which
 the asset may serve. There can be a maximum of 6 schedules per day, 42 in
 total.
      repeated .google.ads.googleads.v21.common.AdScheduleInfo ad_schedule_targets = 13;

    • getAdScheduleTargetsOrBuilderList

      List<? extends AdScheduleInfoOrBuilder> getAdScheduleTargetsOrBuilderList()
       List of non-overlapping schedules specifying all time intervals for which
 the asset may serve. There can be a maximum of 6 schedules per day, 42 in
 total.
      repeated .google.ads.googleads.v21.common.AdScheduleInfo ad_schedule_targets = 13;

    • getAdScheduleTargetsOrBuilder

      AdScheduleInfoOrBuilder getAdScheduleTargetsOrBuilder(int index)
       List of non-overlapping schedules specifying all time intervals for which
 the asset may serve. There can be a maximum of 6 schedules per day, 42 in
 total.
      repeated .google.ads.googleads.v21.common.AdScheduleInfo ad_schedule_targets = 13;

    • getTermsAndConditionsText

      String getTermsAndConditionsText()
       Terms and conditions of the promotion.
      string terms_and_conditions_text = 14;
      Returns:
      The termsAndConditionsText.

    • getTermsAndConditionsTextBytes

      com.google.protobuf.ByteString getTermsAndConditionsTextBytes()
       Terms and conditions of the promotion.
      string terms_and_conditions_text = 14;
      Returns:
      The bytes for termsAndConditionsText.

    • getTermsAndConditionsUri

      String getTermsAndConditionsUri()
       URI to the terms and conditions of the promotion.
      string terms_and_conditions_uri = 15;
      Returns:
      The termsAndConditionsUri.

    • getTermsAndConditionsUriBytes

      com.google.protobuf.ByteString getTermsAndConditionsUriBytes()
       URI to the terms and conditions of the promotion.
      string terms_and_conditions_uri = 15;
      Returns:
      The bytes for termsAndConditionsUri.

    • hasPercentOff

      boolean hasPercentOff()
       Percentage off discount in the promotion. 1,000,000 = 100%.
 Either this or money_amount_off is required.
      int64 percent_off = 3;
      Returns:
      Whether the percentOff field is set.

    • getPercentOff

      long getPercentOff()
       Percentage off discount in the promotion. 1,000,000 = 100%.
 Either this or money_amount_off is required.
      int64 percent_off = 3;
      Returns:
      The percentOff.

    • hasMoneyAmountOff

      boolean hasMoneyAmountOff()
       Money amount off for discount in the promotion.
 Either this or percent_off is required.
      .google.ads.googleads.v21.common.Money money_amount_off = 4;
      Returns:
      Whether the moneyAmountOff field is set.

    • getMoneyAmountOff

      Money getMoneyAmountOff()
       Money amount off for discount in the promotion.
 Either this or percent_off is required.
      .google.ads.googleads.v21.common.Money money_amount_off = 4;
      Returns:
      The moneyAmountOff.

    • getMoneyAmountOffOrBuilder

      MoneyOrBuilder getMoneyAmountOffOrBuilder()
       Money amount off for discount in the promotion.
 Either this or percent_off is required.
      .google.ads.googleads.v21.common.Money money_amount_off = 4;

    • hasPromotionCode

      boolean hasPromotionCode()
       A code the user should use in order to be eligible for the promotion.
      string promotion_code = 5;
      Returns:
      Whether the promotionCode field is set.

    • getPromotionCode

      String getPromotionCode()
       A code the user should use in order to be eligible for the promotion.
      string promotion_code = 5;
      Returns:
      The promotionCode.

    • getPromotionCodeBytes

      com.google.protobuf.ByteString getPromotionCodeBytes()
       A code the user should use in order to be eligible for the promotion.
      string promotion_code = 5;
      Returns:
      The bytes for promotionCode.

    • hasOrdersOverAmount

      boolean hasOrdersOverAmount()
       The amount the total order needs to be for the user to be eligible for
 the promotion.
      .google.ads.googleads.v21.common.Money orders_over_amount = 6;
      Returns:
      Whether the ordersOverAmount field is set.

    • getOrdersOverAmount

      Money getOrdersOverAmount()
       The amount the total order needs to be for the user to be eligible for
 the promotion.
      .google.ads.googleads.v21.common.Money orders_over_amount = 6;
      Returns:
      The ordersOverAmount.

    • getOrdersOverAmountOrBuilder

      MoneyOrBuilder getOrdersOverAmountOrBuilder()
       The amount the total order needs to be for the user to be eligible for
 the promotion.
      .google.ads.googleads.v21.common.Money orders_over_amount = 6;

    • hasPromotionBarcodeInfo

      boolean hasPromotionBarcodeInfo()
       Barcode info used to generate promotion barcode for user to be eligible
 for the promotion.
      .google.ads.googleads.v21.common.PromotionBarcodeInfo promotion_barcode_info = 16;
      Returns:
      Whether the promotionBarcodeInfo field is set.

    • getPromotionBarcodeInfo

      PromotionBarcodeInfo getPromotionBarcodeInfo()
       Barcode info used to generate promotion barcode for user to be eligible
 for the promotion.
      .google.ads.googleads.v21.common.PromotionBarcodeInfo promotion_barcode_info = 16;
      Returns:
      The promotionBarcodeInfo.

    • getPromotionBarcodeInfoOrBuilder

      PromotionBarcodeInfoOrBuilder getPromotionBarcodeInfoOrBuilder()
       Barcode info used to generate promotion barcode for user to be eligible
 for the promotion.
      .google.ads.googleads.v21.common.PromotionBarcodeInfo promotion_barcode_info = 16;

    • hasPromotionQrCodeInfo

      boolean hasPromotionQrCodeInfo()
       QR code info used to generate promotion QR code for user to be eligible
 for the promotion.
      .google.ads.googleads.v21.common.PromotionQrCodeInfo promotion_qr_code_info = 17;
      Returns:
      Whether the promotionQrCodeInfo field is set.

    • getPromotionQrCodeInfo

      PromotionQrCodeInfo getPromotionQrCodeInfo()
       QR code info used to generate promotion QR code for user to be eligible
 for the promotion.
      .google.ads.googleads.v21.common.PromotionQrCodeInfo promotion_qr_code_info = 17;
      Returns:
      The promotionQrCodeInfo.

    • getPromotionQrCodeInfoOrBuilder

      PromotionQrCodeInfoOrBuilder getPromotionQrCodeInfoOrBuilder()
       QR code info used to generate promotion QR code for user to be eligible
 for the promotion.
      .google.ads.googleads.v21.common.PromotionQrCodeInfo promotion_qr_code_info = 17;

    • getDiscountTypeCase

      PromotionAsset.DiscountTypeCase getDiscountTypeCase()

    • getPromotionTriggerCase

      PromotionAsset.PromotionTriggerCase getPromotionTriggerCase()