GOgoogle
promotions

GET /{merchantId}/promotions/{id}

Retrieves a promotion from your Merchant Center account.

Request

  • Base URL
    https://shoppingcontent.googleapis.com/content/v2.1
  • Auth
    OAuth 2 and OAuth 2
    Implicithttps://accounts.google.com/o/oauth2/auth
    Scopeshttps://www.googleapis.com/auth/content
    Authorization codehttps://accounts.google.com/o/oauth2/auth
    Token URLhttps://accounts.google.com/o/oauth2/token
    Scopeshttps://www.googleapis.com/auth/content
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Path parameters

merchantIdstring required

Required. The ID of the account that contains the collection.

idstring required

Required. REST ID of the promotion to retrieve.

Response

Successful response

productApplicability'PRODUCT_APPLICABILITY_UNSPECIFIED' | 'ALL_PRODUCTS' | 'SPECIFIC_PRODUCTS'

Required. Applicability of the promotion to either all products or only specific products.

itemIdExclusionstring[]

Product filter by item ID exclusion for the promotion.

brandExclusionstring[]

Product filter by brand exclusion for the promotion.

longTitlestring

Required. Long title for the promotion.

limitQuantityinteger

Maximum purchase quantity for the promotion.

storeApplicability'STORE_APPLICABILITY_UNSPECIFIED' | 'ALL_STORES' | 'SPECIFIC_STORES'

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 INVALID_ARGUMENT error is thrown if store_applicability is set to ALL_STORES and store_code or score_code_exclusion is set to a value.

contentLanguagestring

Required. The content language used as part of the unique identifier. en content language is available for all target countries. fr content language is available for CA and FR target countries. de content language is available for DE target country. nl content language is available for NL target country. it content language is available for IT target country. pt content language is available for BR target country. ja content language is available for JP target country. ko content language is available for KR target country.

itemGroupIdstring[]

Product filter by item group ID for the promotion.

itemGroupIdExclusionstring[]

Product filter by item group ID exclusion for the promotion.

targetCountrystring

Required. The target country used as part of the unique identifier. Can be AU, CA, DE, FR, GB, IN, US, BR, ES, NL, JP, IT or KR.

promotionEffectiveDatesstring

String representation of the promotion effective dates. Deprecated. Use promotion_effective_time_period instead.

promotionUrlstring

URL to the page on the merchant's site where the promotion shows. Local 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.

idstring

Output only. The REST promotion ID to uniquely identify the promotion. Content API methods that operate on promotions take this as their promotionId parameter. The REST ID for a promotion is of the form channel:contentLanguage:targetCountry:promotionId The channel field has a value of "online", "in_store", or "online_in_store".

shippingServiceNamesstring[]

Shipping service names for the promotion.

productTypestring[]

Product filter by product type for the promotion.

brandstring[]

Product filter by brand for the promotion.

percentOffinteger

The percentage discount offered in the promotion.

promotionDisplayDatesstring

String representation of the promotion display dates. Deprecated. Use promotion_display_time_period instead.

promotionDestinationIdsstring[]

Destination ID for the promotion.

freeGiftItemIdstring

Free gift item ID for the promotion.

storeCodestring[]

Store codes to include for the promotion.

itemIdstring[]

Product filter by item ID for the promotion.

genericRedemptionCodestring

Generic redemption code for the promotion. To be used with the offerType field.

redemptionChannelstring[]

Required. Redemption channel for the promotion. At least one channel is required.

minimumPurchaseQuantityinteger

Minimum purchase quantity for the promotion.

orderLimitinteger

Order limit for the promotion.

customRedemptionRestrictionstring

The custom redemption restriction for the promotion. If the redemption_restriction field is set to CUSTOM, this field must be set.

getThisQuantityDiscountedinteger

The number of items discounted in the promotion.

storeCodeExclusionstring[]

Store codes to exclude for the promotion.

redemptionRestriction'REDEMPTION_RESTRICTION_UNSPECIFIED' | 'SUBSCRIBE_AND_SAVE' | 'FIRST_ORDER' | 'SIGN_UP_FOR_EMAIL' | 'SIGN_UP_FOR_TEXT' | 'FORMS_OF_PAYMENT' | 'CUSTOM'

The redemption restriction for the promotion.

freeGiftDescriptionstring

Free gift description for the promotion.

offerType'OFFER_TYPE_UNSPECIFIED' | 'NO_CODE' | 'GENERIC_CODE'

Required. Type of the promotion.

productTypeExclusionstring[]

Product filter by product type exclusion for the promotion.

couponValueType'COUPON_VALUE_TYPE_UNSPECIFIED' | 'MONEY_OFF' | 'PERCENT_OFF' | 'BUY_M_GET_N_MONEY_OFF' | 'BUY_M_GET_N_PERCENT_OFF' | 'BUY_M_GET_MONEY_OFF' | 'BUY_M_GET_PERCENT_OFF' | 'FREE_GIFT' | 'FREE_GIFT_WITH_VALUE' | 'FREE_GIFT_WITH_ITEM_ID' | 'FREE_SHIPPING_STANDARD' | 'FREE_SHIPPING_OVERNIGHT' | 'FREE_SHIPPING_TWO_DAY'

Required. Coupon value type for the promotion.

promotionIdstring

Required. The user provided promotion ID to uniquely identify the promotion.

Changes

No recorded changes to this operation across all 1 revision of this API.