PromotionAsset

  • A Promotion asset defines the details of a promotion, including what it targets and the discount offered.

  • Promotions can have specific start and end dates for redemption and can be associated with a particular occasion.

  • The discount can be specified as either a percentage off or a fixed money amount off.

  • Eligibility for the promotion can be triggered by a promotion code or by an order exceeding a certain amount.

  • Promotion assets also have start and end dates for when they are effective for serving and can be scheduled to serve during specific time intervals.

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