Class Attributes

Attributes.

Inheritance
object
Attributes
Implements
Inherited Members
Namespace: Google.Shopping.Merchant.Promotions.V1Beta
Assembly: Google.Shopping.Merchant.Promotions.V1Beta.dll
Syntax
public sealed class Attributes : IMessage<Attributes>, IEquatable<Attributes>, IDeepCloneable<Attributes>, IBufferMessage, IMessage

Constructors

Attributes()

Declaration
public Attributes()

Attributes(Attributes)

Declaration
public Attributes(Attributes other)
Parameters
Type Name Description
Attributes other

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
public RepeatedField<string> BrandExclusion { get; }
Property Value
Type Description
RepeatedField<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
public RepeatedField<string> BrandInclusion { get; }
Property Value
Type Description
RepeatedField<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
public CouponValueType CouponValueType { get; set; }
Property Value
Type Description
CouponValueType

FreeGiftDescription

Optional. Free gift description for the promotion.

Declaration
public string FreeGiftDescription { get; set; }
Property Value
Type Description
string

FreeGiftItemId

Optional. Free gift item ID for the promotion.

Declaration
public string FreeGiftItemId { get; set; }
Property Value
Type Description
string

FreeGiftValue

Optional. Free gift value for the promotion.

Declaration
public 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
public 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
public 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
public RepeatedField<string> ItemGroupIdExclusion { get; }
Property Value
Type Description
RepeatedField<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
public RepeatedField<string> ItemGroupIdInclusion { get; }
Property Value
Type Description
RepeatedField<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
public RepeatedField<string> ItemIdExclusion { get; }
Property Value
Type Description
RepeatedField<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
public RepeatedField<string> ItemIdInclusion { get; }
Property Value
Type Description
RepeatedField<string>

LimitQuantity

Optional. Maximum purchase quantity for the promotion.

Declaration
public long LimitQuantity { get; set; }
Property Value
Type Description
long

LimitValue

Optional. Maximum product price for promotion.

Declaration
public Price LimitValue { get; set; }
Property Value
Type Description
Price

LongTitle

Required. Long title for the promotion.

Declaration
public string LongTitle { get; set; }
Property Value
Type Description
string

MinimumPurchaseAmount

Optional. Minimum purchase amount for the promotion.

Declaration
public Price MinimumPurchaseAmount { get; set; }
Property Value
Type Description
Price

MinimumPurchaseQuantity

Optional. Minimum purchase quantity for the promotion.

Declaration
public long MinimumPurchaseQuantity { get; set; }
Property Value
Type Description
long

MoneyOffAmount

Optional. The money off amount offered in the promotion.

Declaration
public 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
public OfferType OfferType { get; set; }
Property Value
Type Description
OfferType

PercentOff

Optional. The percentage discount offered in the promotion.

Declaration
public long PercentOff { get; set; }
Property Value
Type Description
long

ProductApplicability

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

Declaration
public ProductApplicability ProductApplicability { get; set; }
Property Value
Type Description
ProductApplicability

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
public RepeatedField<string> ProductTypeExclusion { get; }
Property Value
Type Description
RepeatedField<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
public RepeatedField<string> ProductTypeInclusion { get; }
Property Value
Type Description
RepeatedField<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
public RepeatedField<Destination.Types.DestinationEnum> PromotionDestinations { get; }
Property Value
Type Description
RepeatedField<Destination.Types.DestinationEnum>

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
public 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
public 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
public 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
public StoreApplicability StoreApplicability { get; set; }
Property Value
Type Description
StoreApplicability

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
public RepeatedField<string> StoreCodesExclusion { get; }
Property Value
Type Description
RepeatedField<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
public RepeatedField<string> StoreCodesInclusion { get; }
Property Value
Type Description
RepeatedField<string>