PromotionAsset

  • Promotion assets include required fields like promotion_target and allow for specifying discount types such as percent_off or money_amount_off.

  • Promotions can be triggered by a promotion_code, orders_over_amount, or barcode/QR code information.

  • The eligibility and serving dates for a promotion can be defined using redemption_start_date, redemption_end_date, start_date, and end_date.

  • Additional details like discount_modifier, occasion, language_code, ad_schedule_targets, and terms and conditions (terms_and_conditions_text or terms_and_conditions_uri) can be included in a promotion asset.

A Promotion asset.

Fields

promotion_target

string

Required. A freeform description of what the promotion is targeting.

discount_modifier

PromotionExtensionDiscountModifier

A modifier for qualification of the discount.

redemption_start_date

string

Start date of when the promotion is eligible to be redeemed, in yyyy-MM-dd format.

redemption_end_date

string

Last date of when the promotion is eligible to be redeemed, in yyyy-MM-dd format.

occasion

PromotionExtensionOccasion

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.

language_code

string

The language of the promotion. Represented as BCP 47 language tag.

start_date

string

Start date of when this asset is effective and can begin serving, in yyyy-MM-dd format.

end_date

string

Last date of when this asset is effective and still serving, in yyyy-MM-dd format.

ad_schedule_targets[]

AdScheduleInfo

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.

terms_and_conditions_text

string

Terms and conditions of the promotion.

terms_and_conditions_uri

string

URI to the terms and conditions of the promotion.
Union field

discount_type

discount_type. Discount type, can be percentage off or amount off. discount_type can be only one of the following:

percent_off

int64

Percentage off discount in the promotion. 1,000,000 = 100%. Either this or money_amount_off is required.

money_amount_off

Money

Money amount off for discount in the promotion. Either this or percent_off is required.
Union field

promotion_trigger

promotion_trigger. Promotion trigger. Can be by promotion code or promo by eligible order amount. promotion_trigger can be only one of the following:

promotion_code

string

A code the user should use in order to be eligible for the promotion.

orders_over_amount

Money

The amount the total order needs to be for the user to be eligible for the promotion.

promotion_barcode_info

PromotionBarcodeInfo

Barcode info used to generate promotion barcode for user to be eligible for the promotion.

promotion_qr_code_info

PromotionQrCodeInfo

QR code info used to generate promotion QR code for user to be eligible for the promotion.