Class Promotion

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

Inheritance

object

Promotion

Implements

IDirectResponseSchema

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Google.Apis.ShoppingContent.v2_1.Data

Assembly: Google.Apis.ShoppingContent.v2_1.dll

Syntax

public class Promotion : IDirectResponseSchema

Properties

Brand

Product filter by brand for the promotion.

Declaration

[JsonProperty("brand")]
public virtual IList<string> Brand { get; set; }

Property Value

Type	Description
IList<string>

BrandExclusion

Product filter by brand exclusion for the promotion.

Declaration

[JsonProperty("brandExclusion")]
public virtual IList<string> BrandExclusion { get; set; }

Property Value

Type	Description
IList<string>

ContentLanguage

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.

Declaration

[JsonProperty("contentLanguage")]
public virtual string ContentLanguage { get; set; }

Property Value

Type	Description
string

CouponValueType

Required. Coupon value type for the promotion.

Declaration

[JsonProperty("couponValueType")]
public virtual string CouponValueType { get; set; }

Property Value

Type	Description
string

ETag

The ETag of the item.

Declaration

public virtual string ETag { get; set; }

Property Value

Type	Description
string

FreeGiftDescription

Free gift description for the promotion.

Declaration

[JsonProperty("freeGiftDescription")]
public virtual string FreeGiftDescription { get; set; }

Property Value

Type	Description
string

FreeGiftItemId

Free gift item ID for the promotion.

Declaration

[JsonProperty("freeGiftItemId")]
public virtual string FreeGiftItemId { get; set; }

Property Value

Type	Description
string

FreeGiftValue

Free gift value for the promotion.

Declaration

[JsonProperty("freeGiftValue")]
public virtual PriceAmount FreeGiftValue { get; set; }

Property Value

Type	Description
PriceAmount

GenericRedemptionCode

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

Declaration

[JsonProperty("genericRedemptionCode")]
public virtual string GenericRedemptionCode { get; set; }

Property Value

Type	Description
string

GetThisQuantityDiscounted

The number of items discounted in the promotion.

Declaration

[JsonProperty("getThisQuantityDiscounted")]
public virtual int? GetThisQuantityDiscounted { get; set; }

Property Value

Type	Description
int?

Id

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".

Declaration

[JsonProperty("id")]
public virtual string Id { get; set; }

Property Value

Type	Description
string

ItemGroupId

Product filter by item group ID for the promotion.

Declaration

[JsonProperty("itemGroupId")]
public virtual IList<string> ItemGroupId { get; set; }

Property Value

Type	Description
IList<string>

ItemGroupIdExclusion

Product filter by item group ID exclusion for the promotion.

Declaration

[JsonProperty("itemGroupIdExclusion")]
public virtual IList<string> ItemGroupIdExclusion { get; set; }

Property Value

Type	Description
IList<string>

ItemId

Product filter by item ID for the promotion.

Declaration

[JsonProperty("itemId")]
public virtual IList<string> ItemId { get; set; }

Property Value

Type	Description
IList<string>

ItemIdExclusion

Product filter by item ID exclusion for the promotion.

Declaration

[JsonProperty("itemIdExclusion")]
public virtual IList<string> ItemIdExclusion { get; set; }

Property Value

Type	Description
IList<string>

LimitQuantity

Maximum purchase quantity for the promotion.

Declaration

[JsonProperty("limitQuantity")]
public virtual int? LimitQuantity { get; set; }

Property Value

Type	Description
int?

LimitValue

Maximum purchase value for the promotion.

Declaration

[JsonProperty("limitValue")]
public virtual PriceAmount LimitValue { get; set; }

Property Value

Type	Description
PriceAmount

LongTitle

Required. Long title for the promotion.

Declaration

[JsonProperty("longTitle")]
public virtual string LongTitle { get; set; }

Property Value

Type	Description
string

MinimumPurchaseAmount

Minimum purchase amount for the promotion.

Declaration

[JsonProperty("minimumPurchaseAmount")]
public virtual PriceAmount MinimumPurchaseAmount { get; set; }

Property Value

Type	Description
PriceAmount

MinimumPurchaseQuantity

Minimum purchase quantity for the promotion.

Declaration

[JsonProperty("minimumPurchaseQuantity")]
public virtual int? MinimumPurchaseQuantity { get; set; }

Property Value

Type	Description
int?

MoneyBudget

Cost cap for the promotion.

Declaration

[JsonProperty("moneyBudget")]
public virtual PriceAmount MoneyBudget { get; set; }

Property Value

Type	Description
PriceAmount

MoneyOffAmount

The money off amount offered in the promotion.

Declaration

[JsonProperty("moneyOffAmount")]
public virtual PriceAmount MoneyOffAmount { get; set; }

Property Value

Type	Description
PriceAmount

OfferType

Required. Type of the promotion.

Declaration

[JsonProperty("offerType")]
public virtual string OfferType { get; set; }

Property Value

Type	Description
string

OrderLimit

Order limit for the promotion.

Declaration

[JsonProperty("orderLimit")]
public virtual int? OrderLimit { get; set; }

Property Value

Type	Description
int?

PercentOff

The percentage discount offered in the promotion.

Declaration

[JsonProperty("percentOff")]
public virtual int? PercentOff { get; set; }

Property Value

Type	Description
int?

ProductApplicability

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

Declaration

[JsonProperty("productApplicability")]
public virtual string ProductApplicability { get; set; }

Property Value

Type	Description
string

ProductType

Product filter by product type for the promotion.

Declaration

[JsonProperty("productType")]
public virtual IList<string> ProductType { get; set; }

Property Value

Type	Description
IList<string>

ProductTypeExclusion

Product filter by product type exclusion for the promotion.

Declaration

[JsonProperty("productTypeExclusion")]
public virtual IList<string> ProductTypeExclusion { get; set; }

Property Value

Type	Description
IList<string>

PromotionDestinationIds

Destination ID for the promotion.

Declaration

[JsonProperty("promotionDestinationIds")]
public virtual IList<string> PromotionDestinationIds { get; set; }

Property Value

Type	Description
IList<string>

PromotionDisplayDates

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

Declaration

[JsonProperty("promotionDisplayDates")]
public virtual string PromotionDisplayDates { get; set; }

Property Value

Type	Description
string

PromotionDisplayTimePeriod

TimePeriod representation of the promotion's display dates.

Declaration

[JsonProperty("promotionDisplayTimePeriod")]
public virtual TimePeriod PromotionDisplayTimePeriod { get; set; }

Property Value

Type	Description
TimePeriod

PromotionEffectiveDates

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

Declaration

[JsonProperty("promotionEffectiveDates")]
public virtual string PromotionEffectiveDates { get; set; }

Property Value

Type	Description
string

PromotionEffectiveTimePeriod

Required. TimePeriod representation of the promotion's effective dates.

Declaration

[JsonProperty("promotionEffectiveTimePeriod")]
public virtual TimePeriod PromotionEffectiveTimePeriod { get; set; }

Property Value

Type	Description
TimePeriod

PromotionId

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

Declaration

[JsonProperty("promotionId")]
public virtual string PromotionId { get; set; }

Property Value

Type	Description
string

PromotionStatus

Output only. The current status of the promotion.

Declaration

[JsonProperty("promotionStatus")]
public virtual PromotionPromotionStatus PromotionStatus { get; set; }

Property Value

Type	Description
PromotionPromotionStatus

PromotionUrl

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.

Declaration

[JsonProperty("promotionUrl")]
public virtual string PromotionUrl { get; set; }

Property Value

Type	Description
string

RedemptionChannel

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

Declaration

[JsonProperty("redemptionChannel")]
public virtual IList<string> RedemptionChannel { get; set; }

Property Value

Type	Description
IList<string>

ShippingServiceNames

Shipping service names for the promotion.

Declaration

[JsonProperty("shippingServiceNames")]
public virtual IList<string> ShippingServiceNames { get; set; }

Property Value

Type	Description
IList<string>

StoreApplicability

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.

Declaration

[JsonProperty("storeApplicability")]
public virtual string StoreApplicability { get; set; }

Property Value

Type	Description
string

StoreCode

Store codes to include for the promotion.

Declaration

[JsonProperty("storeCode")]
public virtual IList<string> StoreCode { get; set; }

Property Value

Type	Description
IList<string>

StoreCodeExclusion

Store codes to exclude for the promotion.

Declaration

[JsonProperty("storeCodeExclusion")]
public virtual IList<string> StoreCodeExclusion { get; set; }

Property Value

Type	Description
IList<string>

TargetCountry

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.

Declaration

[JsonProperty("targetCountry")]
public virtual string TargetCountry { get; set; }

Property Value

Type	Description
string

Implements

IDirectResponseSchema