PromotionAsset

  • A Promotion asset requires specifying a description of what the promotion is targeting.

  • Promotions can offer a discount as either a percentage off or a fixed money amount off.

  • The eligibility for a promotion can be triggered by using a specific promotion code or by exceeding a certain order amount.

  • Promotions have defined redemption start and end dates, which can be tied to a specific occasion.

  • Assets, including promotions, have their own effective start and end dates and can be scheduled to serve during specific time intervals.

A Promotion asset.

Proto definition

Fields

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.

discount_modifier

PromotionExtensionDiscountModifier

A modifier for qualification of the discount.

discount_type

Union field. Discount type, can be percentage off or amount off.

discount_type can be only one of the following:

money_amount_off

Money

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

percent_off

int64

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

end_date

string

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

language_code

string

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

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.

promotion_target

string

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

promotion_trigger

Union field. Promotion trigger. Can be by promotion code or promo by eligible order amount.

promotion_trigger can be only one of the following:

orders_over_amount

Money

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

promotion_code

string

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

redemption_end_date

string

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

redemption_start_date

string

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

start_date

string

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