Attributes
Attributes.
| Fields | |
|---|---|
product_applicability
|
Optional. Applicability of the promotion to either all products or
only specific products
. Exactly one of
|
event_applicability
|
Optional. Event applicability for this promotion. When present, this field indicates you are creating a
sales event
and not a product promotion. Exactly one of
|
offer_type
|
Required. Type of the promotion. Use this attribute to indicate whether or not customers need a coupon code to redeem your promotion. |
generic_redemption_code
|
Optional. Generic redemption code for the promotion. To be used with the
|
long_title
|
Required. Long title for the promotion. |
coupon_value_type
|
Required. The coupon value type attribute to signal the type of promotion that you are running. Depending on type of the selected coupon value some attributes are required . |
promotion_destinations[]
|
Required. The list of destinations (also known as Marketing methods ) where the promotion applies to. If you don't specify a destination by including a supported value in your data source, your promotion will display in Shopping ads and free listings by default.
You may have previously submitted the following values as destinations for your products: Shopping Actions, Surfaces across Google, Local surfaces across Google. To represent these values use
|
item_id_inclusion[]
|
Optional. Product filter by
item ID
for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability
|
brand_inclusion[]
|
Optional. Product filter by brand for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability
|
item_group_id_inclusion[]
|
Optional. Product filter by item group ID for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability [product_applicability] attribute is set to specific_products . |
product_type_inclusion[]
|
Optional. Product filter by product type for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability
|
item_id_exclusion[]
|
Optional. Product filter by
item ID exclusion
for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability
|
brand_exclusion[]
|
Optional. Product filter by
brand exclusion
for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability
|
item_group_id_exclusion[]
|
Optional. Product filter by
item group ID
. The product filter attributes only applies when the products eligible for promotion product applicability
|
product_type_exclusion[]
|
Optional. Product filter by
product type exclusion
for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability
|
minimum_purchase_amount
|
Optional. Minimum purchase amount for the promotion. |
minimum_purchase_quantity
|
|
limit_quantity
|
Optional. Maximum purchase quantity for the promotion. |
limit_value
|
Optional. Maximum product price for promotion. |
percent_off
|
Optional. The percentage discount offered in the promotion. |
money_off_amount
|
Optional. The money off amount offered in the promotion. |
get_this_quantity_discounted
|
Optional. The number of items discounted in the promotion. The attribute is set when
|
free_gift_value
|
Optional. Free gift value for the promotion. |
free_gift_description
|
Optional. Free gift description for the promotion. |
free_gift_item_id
|
Optional. Free gift item ID for the promotion. |
promotion_effective_time_period
|
Required.
|
promotion_display_time_period
|
Optional.
|
store_applicability
|
Optional. Whether the promotion applies to
all stores, or only specified stores
. Local Inventory ads promotions throw an error if no store applicability is included. An
|
store_codes_inclusion[]
|
Optional.
Store codes to include
for the promotion. The store filter attributes only applies when the
Store code (the store ID from your Business Profile) of the physical store the product is sold in. See the Local product inventory data specification for more information. |
store_codes_exclusion[]
|
Optional.
Store codes to exclude
for the promotion. The store filter attributes only applies when the
|
promotion_url
|
Optional. URL to the page on the merchant's site where the promotion shows. Local Inventory ads promotions throw an error if no
|
redemption_restriction
|
Optional. A restriction customers must meet before they can redeem the promotion. |
custom_redemption_restriction
|
Optional. The custom redemption restriction for the promotion. If the
|
max_discount_amount
|
Optional. The maximum monetary discount a customer can receive for the promotion. This field is only supported with the
|
google_product_categories[]
|
Optional. A list of Google product categories for this promotion. Set if
For more details on eligible values for product categories, checkout the
|
audience
|
Optional. This field defines the audience a promotion will be visible to. |
region_id_inclusion[]
|
Optional. A list of
regions
where the promotion is applicable. Must be set if
|
min_money_off_amount
|
Optional. Minimum money off amount for a promotion with
|
max_money_off_amount
|
Optional. Maximum money off amount for a promotion with
|
min_percent_off
|
Optional. Minimum percent off for a promotion with
|
max_percent_off
|
Optional. Maximum percent off for a promotion with
|