Reference

This page describes the types used to annotate promotional email and their associated properties. These types and properties are included in a promotional email's header as JSON-LD.

See the Preview tool to see an example of the required structure. For more details, see the Email Markup Gettting Started guide.

Organization

The Organization type lets you specify a logo to include in the promotion.

Name Type Description
logo ImageObject or URL The associated logo. See best practices for Logo URL.

DiscountOffer

The DiscountOffer type lets you specify the value of deal as part of the promotion. You can include a discount code and specify dates for which the discount is valid.

Name Type Description
description Text The text on deal badge. See best practices for Deal Badge.
discountCode Text The discount code of the offer. See best practices for Discount Code.
availabilityStarts DateTime The offer is valid from this date and time.
availabilityEnds DateTime The offer is valid up until this date and time. See best practices for Expiration Date.

PromotionCard

The PromotionCard type lets you include the primary image displayed to represent the promotion.

Name Type Description
image ImageObject or URL Single image preview of the email. See best practices for Single image preview.

EmailMessage

The EmailMessage type lets you include alternative annotations for the email.

Name Type Description
subjectLine Text An alternative subject line shown when deal badge or discount code is also displayed. See best practices for Subject Line.