- Resource: Promotion
- ProductApplicability
- OfferType
- RedemptionChannel
- CouponValueType
- TimePeriod
- StoreApplicability
- PromotionStatus
- DestinationStatus
- State
- PromotionIssue
- Methods
Resource: Promotion
Represents a promotion. See the following articles for more details.
JSON representation |
---|
{ "id": string, "targetCountry": string, "contentLanguage": string, "promotionId": string, "productApplicability": enum ( |
Fields | |
---|---|
id |
Output only. The REST promotion ID to uniquely identify the promotion. Content API methods that operate on promotions take this as their
channel field has a value of "online" , "in_store" , or "online_in_store" .
|
targetCountry |
Required. The target country used as part of the unique identifier. Can be |
contentLanguage |
Required. The content language used as part of the unique identifier. |
promotionId |
Required. The user provided promotion ID to uniquely identify the promotion. |
productApplicability |
Required. Applicability of the promotion to either all products or only specific products. |
offerType |
Required. Type of the promotion. |
longTitle |
Required. Long title for the promotion. |
promotionEffectiveDates |
String representation of the promotion effective dates. Deprecated. Use |
redemptionChannel[] |
Required. Redemption channel for the promotion. At least one channel is required. |
couponValueType |
Required. Coupon value type for the promotion. |
promotionDestinationIds[] |
Destination ID for the promotion. |
itemId[] |
Product filter by item ID for the promotion. |
brand[] |
Product filter by brand for the promotion. |
itemGroupId[] |
Product filter by item group ID for the promotion. |
productType[] |
Product filter by product type for the promotion. |
itemIdExclusion[] |
Product filter by item ID exclusion for the promotion. |
brandExclusion[] |
Product filter by brand exclusion for the promotion. |
itemGroupIdExclusion[] |
Product filter by item group ID exclusion for the promotion. |
productTypeExclusion[] |
Product filter by product type exclusion for the promotion. |
shippingServiceNames[] |
Shipping service names for the promotion. |
promotionEffectiveTimePeriod |
Required. |
storeCode[] |
Store codes to include for the promotion. |
storeCodeExclusion[] |
Store codes to exclude for the promotion. |
promotionStatus |
Output only. The current status of the promotion. |
genericRedemptionCode |
Generic redemption code for the promotion. To be used with the |
promotionDisplayDates |
String representation of the promotion display dates. Deprecated. Use |
minimumPurchaseAmount |
Minimum purchase amount for the promotion. |
minimumPurchaseQuantity |
Minimum purchase quantity for the promotion. |
limitQuantity |
Maximum purchase quantity for the promotion. |
limitValue |
Maximum purchase value for the promotion. |
percentOff |
The percentage discount offered in the promotion. |
moneyOffAmount |
The money off amount offered in the promotion. |
getThisQuantityDiscounted |
The number of items discounted in the promotion. |
freeGiftValue |
Free gift value for the promotion. |
freeGiftDescription |
Free gift description for the promotion. |
freeGiftItemId |
Free gift item ID for the promotion. |
moneyBudget |
Cost cap for the promotion. |
orderLimit |
Order limit for the promotion. |
promotionDisplayTimePeriod |
|
storeApplicability |
Whether the promotion applies to all stores, or only specified stores. Local pos.inventory ads promotions throw an error if no store applicability is included. An INVALID_ARGUMENT error is thrown if storeApplicability is set to ALL_STORES and storeCode or score_code_exclusion is set to a value. |
promotionUrl |
URL to the page on the merchant's site where the promotion shows. Local pos.inventory ads promotions throw an error if no promo url is included. URL is used to confirm that the promotion is valid and can be redeemed. |
ProductApplicability
Which product or list of products the promotion applies to.
Enums | |
---|---|
PRODUCT_APPLICABILITY_UNSPECIFIED |
Which products the promotion applies to is unknown. |
ALL_PRODUCTS |
Applicable to all products. |
SPECIFIC_PRODUCTS |
Applicable to only a single product or list of products. |
OfferType
Offer type of a promotion.
Enums | |
---|---|
OFFER_TYPE_UNSPECIFIED |
Unknown offer type. |
NO_CODE |
Offer type without a code. |
GENERIC_CODE |
Offer type with a code. |
RedemptionChannel
Channel of a promotion.
Enums | |
---|---|
REDEMPTION_CHANNEL_UNSPECIFIED |
Indicates that the channel is unspecified. |
IN_STORE |
Indicates that the channel is in store. |
ONLINE |
Indicates that the channel is online. |
CouponValueType
Coupon value type of a promotion.
Enums | |
---|---|
COUPON_VALUE_TYPE_UNSPECIFIED |
Indicates that the coupon value type is unspecified. |
MONEY_OFF |
Money off coupon value type. |
PERCENT_OFF |
Percent off coupon value type. |
BUY_M_GET_N_MONEY_OFF |
Buy M quantity, get N money off coupon value type. buy_this_quantity and get_this_quantity must be present. moneyOffAmount must also be present. |
BUY_M_GET_N_PERCENT_OFF |
Buy M quantity, get N percent off coupon value type. buy_this_quantity and get_this_quantity must be present. percent_off_percentage must also be present. |
BUY_M_GET_MONEY_OFF |
Buy M quantity, get money off. buy_this_quantity and moneyOffAmount must be present. |
BUY_M_GET_PERCENT_OFF |
Buy M quantity, get money off. buy_this_quantity and percent_off_percentage must be present. |
FREE_GIFT |
Free gift with description only. |
FREE_GIFT_WITH_VALUE |
Free gift with value (description is optional). |
FREE_GIFT_WITH_ITEM_ID |
Free gift with item ID (description is optional). |
FREE_SHIPPING_STANDARD |
Standard free shipping coupon value type. |
FREE_SHIPPING_OVERNIGHT |
Overnight free shipping coupon value type. |
FREE_SHIPPING_TWO_DAY |
Two day free shipping coupon value type. |
TimePeriod
A message that represents a time period.
JSON representation |
---|
{ "startTime": string, "endTime": string } |
Fields | |
---|---|
startTime |
The starting timestamp. |
endTime |
The ending timestamp. |
StoreApplicability
Store codes or list of store codes the promotion applies to. Only for Local inventory ads promotions.
Enums | |
---|---|
STORE_APPLICABILITY_UNSPECIFIED |
Which store codes the promotion applies to is unknown. |
ALL_STORES |
Promotion applies to all stores. |
SPECIFIC_STORES |
Promotion applies to only the specified stores. |
PromotionStatus
The status of the promotion.
JSON representation |
---|
{ "destinationStatuses": [ { object ( |
Fields | |
---|---|
destinationStatuses[] |
The intended destinations for the promotion. |
promotionIssue[] |
A list of issues associated with the promotion. |
creationDate |
Date on which the promotion has been created in ISO 8601 format: Date, time, and offset, for example "2020-01-02T09:00:00+01:00" or "2020-01-02T09:00:00Z" |
lastUpdateDate |
Date on which the promotion status has been last updated in ISO 8601 format: Date, time, and offset, for example "2020-01-02T09:00:00+01:00" or "2020-01-02T09:00:00Z" |
DestinationStatus
The destination status of the promotion.
JSON representation |
---|
{
"destination": string,
"status": enum ( |
Fields | |
---|---|
destination |
The name of the destination. |
status |
The status for the specified destination. |
State
The current state of the promotion.
Enums | |
---|---|
STATE_UNSPECIFIED |
Unknown promotion state. |
IN_REVIEW |
The promotion is under review. |
REJECTED |
The promotion is disapproved |
LIVE |
The promotion is approved and active. |
STOPPED |
The promotion is stopped by merchant. |
EXPIRED |
The promotion is no longer active. |
PENDING |
The promotion is not stopped, and all reviews are approved, but the active date is in the future. |
PromotionIssue
The issue associated with the promotion.
JSON representation |
---|
{ "code": string, "detail": string } |
Fields | |
---|---|
code |
Code of the issue. |
detail |
Explanation of the issue. |
Methods |
|
---|---|
|
Inserts a promotion for your Merchant Center account. |
|
Retrieves a promotion from your Merchant Center account. |
|
List all promotions from your Merchant Center account. |