View Source GoogleApi.Content.V21.Model.Promotion (google_api_content v0.61.1)

The Promotions feature is currently in alpha and is not yet publicly available via Content API for Shopping. This documentation is provided for reference only may be subject to change. Represents a promotion. See the following articles for more details. Promotions feed specification Local promotions feed specification * Promotions on Buy on Google product data specification

Attributes

  • longTitle (type: String.t, default: nil) - Long title for the promotion.
  • genericRedemptionCode (type: String.t, default: nil) - Generic redemption code for the promotion. To be used with the above field.
  • moneyOffAmount (type: GoogleApi.Content.V21.Model.PriceAmount.t, default: nil) - The money off amount offered in the promotion.
  • freeGiftItemId (type: String.t, default: nil) - Free gift item id for the promotion.
  • itemGroupIdExclusion (type: list(String.t), default: nil) - Product filter by item group id exclusion for the promotion.
  • offerType (type: String.t, default: nil) - Required. Type of the promotion.
  • productType (type: list(String.t), default: nil) - Product filter by product type for the promotion.
  • itemGroupId (type: list(String.t), default: nil) - Product filter by item group id for the promotion.
  • productApplicability (type: String.t, default: nil) - Required. Applicability of the promotion to either all products or only specific products.
  • freeGiftValue (type: GoogleApi.Content.V21.Model.PriceAmount.t, default: nil) - Free gift value for the promotion.
  • promotionId (type: String.t, default: nil) - Required. The user provided promotion id to uniquely identify the promotion.
  • freeGiftDescription (type: String.t, default: nil) - Free gift description for the promotion.
  • percentOff (type: integer(), default: nil) - The percentage discount offered in the promotion.
  • moneyBudget (type: GoogleApi.Content.V21.Model.PriceAmount.t, default: nil) - Promotion cost cap of the promotion.
  • couponValueType (type: String.t, default: nil) - Required. Coupon value type for the promotion.
  • itemId (type: list(String.t), default: nil) - Product filter by item id for the promotion.
  • minimumPurchaseAmount (type: GoogleApi.Content.V21.Model.PriceAmount.t, default: nil) - Minimum purchase amount for the promotion.
  • promotionDestinationIds (type: list(String.t), default: nil) - Destination ID for the promotion.
  • shippingServiceNames (type: list(String.t), default: nil) - Shipping service names for thse promotion.
  • promotionEffectiveTimePeriod (type: GoogleApi.Content.V21.Model.TimePeriod.t, default: nil) - Required. TimePeriod representation of the promotion effective dates.
  • promotionDisplayDates (type: String.t, default: nil) - String representation of the promotion display dates.
  • promotionEffectiveDates (type: String.t, default: nil) - Required. String representation of the promotion effective dates.
  • itemIdExclusion (type: list(String.t), default: nil) - Product filter by item id exclusion for the promotion.
  • brand (type: list(String.t), default: nil) - Product filter by brand for the promotion.
  • minimumPurchaseQuantity (type: integer(), default: nil) - Minimum purchase quantity for the promotion.
  • limitValue (type: GoogleApi.Content.V21.Model.PriceAmount.t, default: nil) - Maximum purchase value for the promotion.
  • orderLimit (type: integer(), default: nil) - Order limit for the promotion.
  • brandExclusion (type: list(String.t), default: nil) - Product filter by brand exclusion for the promotion.
  • productTypeExclusion (type: list(String.t), default: nil) - Product filter by product type exclusion for the promotion.
  • promotionDisplayTimePeriod (type: GoogleApi.Content.V21.Model.TimePeriod.t, default: nil) - TimePeriod representation of the promotion display dates.
  • id (type: String.t, default: nil) - Required. 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 will have a value of "online", "in_store", or "online_in_store".
  • contentLanguage (type: String.t, default: nil) - Required. The content language used as part of the unique identifier.
  • limitQuantity (type: integer(), default: nil) - Maximum purchase quantity for the promotion.
  • getThisQuantityDiscounted (type: integer(), default: nil) - The number of items discounted in the promotion.
  • redemptionChannel (type: list(String.t), default: nil) - Required. Redemption channel for the promotion. At least one channel is required.
  • targetCountry (type: String.t, default: nil) - Required. The target country used as part of the unique identifier.

Link to this section Summary

Functions

Unwrap a decoded JSON object into its complex fields.

Link to this section Types

Specs

t() :: %GoogleApi.Content.V21.Model.Promotion{
  brand: [String.t()] | nil,
  brandExclusion: [String.t()] | nil,
  contentLanguage: String.t() | nil,
  couponValueType: String.t() | nil,
  freeGiftDescription: String.t() | nil,
  freeGiftItemId: String.t() | nil,
  freeGiftValue: GoogleApi.Content.V21.Model.PriceAmount.t() | nil,
  genericRedemptionCode: String.t() | nil,
  getThisQuantityDiscounted: integer() | nil,
  id: String.t() | nil,
  itemGroupId: [String.t()] | nil,
  itemGroupIdExclusion: [String.t()] | nil,
  itemId: [String.t()] | nil,
  itemIdExclusion: [String.t()] | nil,
  limitQuantity: integer() | nil,
  limitValue: GoogleApi.Content.V21.Model.PriceAmount.t() | nil,
  longTitle: String.t() | nil,
  minimumPurchaseAmount: GoogleApi.Content.V21.Model.PriceAmount.t() | nil,
  minimumPurchaseQuantity: integer() | nil,
  moneyBudget: GoogleApi.Content.V21.Model.PriceAmount.t() | nil,
  moneyOffAmount: GoogleApi.Content.V21.Model.PriceAmount.t() | nil,
  offerType: String.t() | nil,
  orderLimit: integer() | nil,
  percentOff: integer() | nil,
  productApplicability: String.t() | nil,
  productType: [String.t()] | nil,
  productTypeExclusion: [String.t()] | nil,
  promotionDestinationIds: [String.t()] | nil,
  promotionDisplayDates: String.t() | nil,
  promotionDisplayTimePeriod: GoogleApi.Content.V21.Model.TimePeriod.t() | nil,
  promotionEffectiveDates: String.t() | nil,
  promotionEffectiveTimePeriod:
    GoogleApi.Content.V21.Model.TimePeriod.t() | nil,
  promotionId: String.t() | nil,
  redemptionChannel: [String.t()] | nil,
  shippingServiceNames: [String.t()] | nil,
  targetCountry: String.t() | nil
}

Link to this section Functions

Specs

decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.