Class Attributes

Attributes.

Inheritance

object

Attributes

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.Merchant.promotions_v1beta.Data

Assembly: Google.Apis.Merchant.promotions_v1beta.dll

Syntax

public class Attributes : IDirectResponseSchema

Properties

BrandExclusion

Optional. Product filter by brand exclusion 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.

Declaration

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

Property Value

Type	Description
IList<string>

BrandInclusion

Optional. Product filter by brand 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.

Declaration

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

Property Value

Type	Description
IList<string>

CouponValueType

Required. The [coupon value type] (https://support.google.com/merchants/answer/13861986?ref_topic=13773355&sjid=17642868584668136159-NC) attribute to signal the type of promotion that you are running. Depending on type of the selected coupon value some attributes are required.

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

Optional. Free gift description for the promotion.

Declaration

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

Property Value

Type	Description
string

FreeGiftItemId

Optional. Free gift item ID for the promotion.

Declaration

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

Property Value

Type	Description
string

FreeGiftValue

Optional. Free gift value for the promotion.

Declaration

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

Property Value

Type	Description
Price

GenericRedemptionCode

Optional. Generic redemption code for the promotion. To be used with the offerType field and must meet the minimum requirements.

Declaration

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

Property Value

Type	Description
string

GetThisQuantityDiscounted

Optional. The number of items discounted in the promotion. The attribute is set when couponValueType is equal to buy_m_get_n_money_off or buy_m_get_n_percent_off.

Declaration

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

Property Value

Type	Description
long?

ItemGroupIdExclusion

Optional. Product filter by item group ID. The product filter attributes only applies when the products eligible for promotion product applicability product_applicability attribute is set to specific_products. exclusion for the promotion.

Declaration

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

Property Value

Type	Description
IList<string>

ItemGroupIdInclusion

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.

Declaration

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

Property Value

Type	Description
IList<string>

ItemIdExclusion

Optional. Product filter by item ID exclusion 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.

Declaration

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

Property Value

Type	Description
IList<string>

ItemIdInclusion

Optional. Product filter by item 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.

Declaration

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

Property Value

Type	Description
IList<string>

LimitQuantity

Optional. Maximum purchase quantity for the promotion.

Declaration

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

Property Value

Type	Description
long?

LimitValue

Optional. Maximum product price for promotion.

Declaration

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

Property Value

Type	Description
Price

LongTitle

Required. Long title for the promotion.

Declaration

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

Property Value

Type	Description
string

MinimumPurchaseAmount

Optional. Minimum purchase amount for the promotion.

Declaration

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

Property Value

Type	Description
Price

MinimumPurchaseQuantity

Optional. Minimum purchase quantity for the promotion.

Declaration

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

Property Value

Type	Description
long?

MoneyOffAmount

Optional. The money off amount offered in the promotion.

Declaration

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

Property Value

Type	Description
Price

OfferType

Required. Type of the promotion. Use this attribute to indicate whether or not customers need a coupon code to redeem your promotion.

Declaration

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

Property Value

Type	Description
string

PercentOff

Optional. The percentage discount offered in the promotion.

Declaration

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

Property Value

Type	Description
long?

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

ProductTypeExclusion

Optional. Product filter by product type exclusion 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.

Declaration

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

Property Value

Type	Description
IList<string>

ProductTypeInclusion

Optional. Product filter by product type 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.

Declaration

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

Property Value

Type	Description
IList<string>

PromotionDestinations

Required. The list of destinations 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 FREE_LISTINGS, FREE_LOCAL_LISTINGS, LOCAL_INVENTORY_ADS. For more details see Promotion destination

Declaration

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

Property Value

Type	Description
IList<string>

PromotionDisplayTimePeriod

Optional. TimePeriod representation of the promotion's display dates. This attribute specifies the date and time frame when the promotion will be live on Google.com and Shopping ads. If the display time period for promotion promotion_display_time_period attribute is not specified, the promotion effective time period promotion_effective_time_period determines the date and time frame when the promotion will be live on Google.com and Shopping ads.

Declaration

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

Property Value

Type	Description
Interval

PromotionEffectiveTimePeriod

Required. TimePeriod representation of the promotion's effective dates. This attribute specifies that the promotion can be tested on your online store during this time period.

Declaration

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

Property Value

Type	Description
Interval

PromotionUrl

Optional. URL to the page on the merchant's site where the promotion shows. Local Inventory ads promotions throw an error if no promotion_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

StoreApplicability

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

Declaration

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

Property Value

Type	Description
string

StoreCodesExclusion

Optional. Store codes to exclude for the promotion. The store filter attributes only applies when the store_applicability attribute is set to specific_stores.

Declaration

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

Property Value

Type	Description
IList<string>

StoreCodesInclusion

Optional. Store codes to include for the promotion. The store filter attributes only applies when the store_applicability attribute is set to specific_stores. 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.

Declaration

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

Property Value

Type	Description
IList<string>

Implements

IDirectResponseSchema