This article lists all of the structured data attributes that you can provide in your promotions source.
Optional structured data fields are attributes that provide additional information about your promotion type (for example, 10% off and buy one, get one free). Structured data allows Google to display more detailed information about your shopping ad promotions to customers on mobile devices.
Note: All structured data attributes that you submit must match information in your promotion's promotion title [long_title]. During the review process, Google validates your data. If information does not match the promotion title, Google will edit the structured fields to match the information in the promotion title. If you don't submit the structured data for your promotion, Google attempts to structure your promotion based on the promotion title.
On this page
The coupon value type structured attribute
When included in your promotions source, this optional attribute signals the type of promotion benefit that you're offering, allowing Google to perform a more automated review process, which can expedite your promotion's approval. Structured data also allows Google to display more detailed information about your Shopping ad promotions to customers on mobile devices.
When you use the optional coupon value type [coupon_value_type] attribute, this may require the use of additional attributes, depending on the value that you submit. For example, if you want to submit the money off [money_off] attribute as the value for the coupon value type [coupon_value_type], you must also provide the monetary discount amount of a promotion [money_off_amount] attribute.
This article and the following table show which attributes are required or optional to include in your promotions source depending on the value that you submit for the coupon value type [coupon_value_type].
| Value for the coupon value type | Attributes |
|
No structured data
|
Optional
|
|
Money off
|
Required Monetary discount amount of a promotion Optional Minimum purchase amount |
|
Percentage discount amount
|
Required Percentage discount amount Optional Minimum purchase amount |
|
Buy M get N money off
|
Required
|
|
Buy M get N percent off
|
Required Percentage discount amount |
|
Buy M get money off
|
Required Monetary discount amount of a promotion |
|
Buy M get percent off
|
Required Percentage discount amount |
|
Free gift
|
Required Free gift description Optional Minimum purchase amount |
|
Free gift monetary value
|
Required Free gift monetary value Optional Minimum purchase amount |
|
Free gift item ID
|
Required Free gift item ID Optional Minimum purchase amount |
|
Free standard delivery |
Optional Free delivery type |
|
Free overnight delivery |
Optional Free delivery type |
|
Free two-day delivery |
Optional Free delivery type |
|
Free delivery for delivery services defined in Merchant Center |
No required or optional attributes |
Attribute details
Minimum purchase quantity for promotion[buy_this_quantity]
The minimum purchase quantity required to redeem promotions offering 'Buy M, get N'. This field represents the 'M' value for the offer.
- Example promotion: Buy two, get one free
- Minimum purchase quantity for promotion
[buy_this_quantity]: 2 - Quantity eligible for promotion
[get_this_quantity_discounted]: 1 - Percentage discount amount
[percent_off]: 100
- Minimum purchase quantity for promotion
- Example promotion: Buy 4, get £100 off
- Minimum purchase quantity for promotion
[buy_this_quantity]: 4 - Monetary discount amount of a promotion
[money_off_amount]: 100
- Minimum purchase quantity for promotion
[free_shipping_type]
For promotions offering free delivery, this attribute indicates the type of free delivery offered.
- Valid values
- Free delivery standard
[free_shipping_standard] - Free delivery overnight
[free_shipping_overnight] - Free delivery two day
[free_shipping_two_day]
- Free delivery standard
[free_gift_value]
The monetary value of any gift offered free of charge in the promotion.
- Example (US): 50 USD
- Example (IN): 600 INR
- Example (AU): 20 AUD
- Example (FR/DE): 10 EUR
- Example (GB): 25 GBP
Important: Include currency in this attribute. The price [price] attribute must be formatted correctly. Learn more about price attribute requirements
[free_gift_description]
The description of any gift offered free of charge in the promotion.
Important: The description can not contain more than 100 characters.
[free_gift_item_id]
The product ID for promotion [item_id] of any gift offered free of charge in the promotion.
Important: The product ID for promotion [item_id] will match to the targeting channel [targeting_channel] specified. The ID [id] attribute must be formatted correctly. Learn more about price attribute requirements
[get_this_quantity_discounted]
The quantity discounted once the minimum quantity required to purchase has been met in 'Buy M, get N discounted' promotions. This field represents the 'N' value of the offer.
- Example promotion: Buy two, get third one £5 off
- Quantity eligible for promotion
[get_this_quantity_discounted]: 1 - Minimum purchase quantity for promotion
[buy_this_quantity]: 2 - Percentage discount amount
[percent_off]: 100
- Quantity eligible for promotion
[limit_quantity]
The maximum number of items that can be bought using the promotion.
- Example: 5
Important: Must be an integer.
[limit_value]
The maximum item value allowed for the promotion.
- Example (US): 50.00 USD
Important: Must be a number and specify currency.
[minimum_purchase_amount]
The minimum purchase amount for the promotion to be redeemed.
- Example (US): 20 USD
Important: Promotion sources only support currencies of the specified locales.
[money_off_amount]
The monetary value discounted for fixed discount promotions (for example: £200 off)
Important: Do not include the currency.
[percent_off]
The percent discounted for percentage-based promotions (for example: 10% off).
Important: Do not include the percentage symbol.
[promotion_price]
The promotional sales price of an item or category.
- Example (US): 75.00 USD
Important: Must be a number and specify currency.