Class Product
Required product attributes are primarily defined by the products data specification. See the Products Data Specification Help Center article for information. Product data. After inserting, updating, or deleting a product, it may take several minutes before changes take effect.
Inheritance
Implements
Inherited Members
Namespace: Google.Apis.ShoppingContent.v2.Data
Assembly: Google.Apis.ShoppingContent.v2.dll
Syntax
public class Product : IDirectResponseSchema
Properties
AdditionalImageLinks
Additional URLs of images of the item.
Declaration
[JsonProperty("additionalImageLinks")]
public virtual IList<string> AdditionalImageLinks { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Collections.Generic.IList<System.String> |
AdditionalProductTypes
Additional categories of the item (formatted as in products data specification).
Declaration
[JsonProperty("additionalProductTypes")]
public virtual IList<string> AdditionalProductTypes { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Collections.Generic.IList<System.String> |
Adult
Should be set to true if the item is targeted towards adults.
Declaration
[JsonProperty("adult")]
public virtual bool? Adult { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Nullable<System.Boolean> |
AdwordsGrouping
Used to group items in an arbitrary way. Only for CPA%, discouraged otherwise.
Declaration
[JsonProperty("adwordsGrouping")]
public virtual string AdwordsGrouping { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
AdwordsLabels
Similar to adwords_grouping, but only works on CPC.
Declaration
[JsonProperty("adwordsLabels")]
public virtual IList<string> AdwordsLabels { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Collections.Generic.IList<System.String> |
AdwordsRedirect
Allows advertisers to override the item URL when the product is shown within the context of Product Ads.
Declaration
[JsonProperty("adwordsRedirect")]
public virtual string AdwordsRedirect { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
AgeGroup
Target age group of the item. Acceptable values are: - "adult" - "infant" - "kids" - "newborn" -
"toddler" - "youngAdult"
Declaration
[JsonProperty("ageGroup")]
public virtual string AgeGroup { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
Aspects
Deprecated. Do not use.
Declaration
[JsonProperty("aspects")]
public virtual IList<ProductAspect> Aspects { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Collections.Generic.IList<ProductAspect> |
Availability
Availability status of the item. Acceptable values are: - "in stock" - "out of stock" - "preorder"
Declaration
[JsonProperty("availability")]
public virtual string Availability { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
AvailabilityDate
The day a pre-ordered product becomes available for delivery, in ISO 8601 format.
Declaration
[JsonProperty("availabilityDate")]
public virtual string AvailabilityDate { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
Brand
Brand of the item.
Declaration
[JsonProperty("brand")]
public virtual string Brand { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
CanonicalLink
URL for the canonical version of your item's landing page.
Declaration
[JsonProperty("canonicalLink")]
public virtual string CanonicalLink { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
Channel
Required. The item's channel (online or local). Acceptable values are: - "local" - "online"
Declaration
[JsonProperty("channel")]
public virtual string Channel { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
Color
Color of the item.
Declaration
[JsonProperty("color")]
public virtual string Color { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
Condition
Condition or state of the item. Acceptable values are: - "new" - "refurbished" - "used"
Declaration
[JsonProperty("condition")]
public virtual string Condition { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
ContentLanguage
Required. The two-letter ISO 639-1 language code for the item.
Declaration
[JsonProperty("contentLanguage")]
public virtual string ContentLanguage { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
CostOfGoodsSold
Cost of goods sold. Used for gross profit reporting.
Declaration
[JsonProperty("costOfGoodsSold")]
public virtual Price CostOfGoodsSold { get; set; }
Property Value
| Type | Description |
|---|---|
| Price |
CustomAttributes
A list of custom (merchant-provided) attributes. It can also be used for submitting any attribute of the
feed specification in its generic form (e.g., { "name": "size type", "value": "regular" }). This is useful
for submitting attributes not explicitly exposed by the API, such as additional attributes used for Buy on
Google (formerly known as Shopping Actions).
Declaration
[JsonProperty("customAttributes")]
public virtual IList<CustomAttribute> CustomAttributes { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Collections.Generic.IList<CustomAttribute> |
CustomGroups
A list of custom (merchant-provided) custom attribute groups.
Declaration
[JsonProperty("customGroups")]
public virtual IList<CustomGroup> CustomGroups { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Collections.Generic.IList<CustomGroup> |
CustomLabel0
Custom label 0 for custom grouping of items in a Shopping campaign.
Declaration
[JsonProperty("customLabel0")]
public virtual string CustomLabel0 { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
CustomLabel1
Custom label 1 for custom grouping of items in a Shopping campaign.
Declaration
[JsonProperty("customLabel1")]
public virtual string CustomLabel1 { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
CustomLabel2
Custom label 2 for custom grouping of items in a Shopping campaign.
Declaration
[JsonProperty("customLabel2")]
public virtual string CustomLabel2 { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
CustomLabel3
Custom label 3 for custom grouping of items in a Shopping campaign.
Declaration
[JsonProperty("customLabel3")]
public virtual string CustomLabel3 { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
CustomLabel4
Custom label 4 for custom grouping of items in a Shopping campaign.
Declaration
[JsonProperty("customLabel4")]
public virtual string CustomLabel4 { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
Description
Description of the item.
Declaration
[JsonProperty("description")]
public virtual string Description { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
Destinations
Specifies the intended destinations for the product.
Declaration
[JsonProperty("destinations")]
public virtual IList<ProductDestination> Destinations { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Collections.Generic.IList<ProductDestination> |
DisplayAdsId
An identifier for an item for dynamic remarketing campaigns.
Declaration
[JsonProperty("displayAdsId")]
public virtual string DisplayAdsId { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
DisplayAdsLink
URL directly to your item's landing page for dynamic remarketing campaigns.
Declaration
[JsonProperty("displayAdsLink")]
public virtual string DisplayAdsLink { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
DisplayAdsSimilarIds
Advertiser-specified recommendations.
Declaration
[JsonProperty("displayAdsSimilarIds")]
public virtual IList<string> DisplayAdsSimilarIds { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Collections.Generic.IList<System.String> |
DisplayAdsTitle
Title of an item for dynamic remarketing campaigns.
Declaration
[JsonProperty("displayAdsTitle")]
public virtual string DisplayAdsTitle { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
DisplayAdsValue
Offer margin for dynamic remarketing campaigns.
Declaration
[JsonProperty("displayAdsValue")]
public virtual double? DisplayAdsValue { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Nullable<System.Double> |
EnergyEfficiencyClass
The energy efficiency class as defined in EU directive 2010/30/EU. Acceptable values are: - "A" - "A+" -
"A++" - "A+++" - "B" - "C" - "D" - "E" - "F" - "G"
Declaration
[JsonProperty("energyEfficiencyClass")]
public virtual string EnergyEfficiencyClass { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
ETag
The ETag of the item.
Declaration
public virtual string ETag { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
ExpirationDate
Date on which the item should expire, as specified upon insertion, in ISO 8601 format. The actual expiration
date in Google Shopping is exposed in productstatuses as googleExpirationDate and might be earlier if
expirationDate is too far in the future.
Declaration
[JsonProperty("expirationDate")]
public virtual string ExpirationDate { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
Gender
Target gender of the item. Acceptable values are: - "female" - "male" - "unisex"
Declaration
[JsonProperty("gender")]
public virtual string Gender { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
GoogleProductCategory
Google's category of the item (see Google product taxonomy). When querying products, this field will contain the user provided value. There is currently no way to get back the auto assigned google product categories through the API.
Declaration
[JsonProperty("googleProductCategory")]
public virtual string GoogleProductCategory { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
Gtin
Global Trade Item Number (GTIN) of the item.
Declaration
[JsonProperty("gtin")]
public virtual string Gtin { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
Id
The REST ID of the product. Content API methods that operate on products take this as their productId
parameter. The REST ID for a product is of the form channel:contentLanguage: targetCountry: offerId.
Declaration
[JsonProperty("id")]
public virtual string Id { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
IdentifierExists
False when the item does not have unique product identifiers appropriate to its category, such as GTIN, MPN, and brand. Required according to the Unique Product Identifier Rules for all target countries except for Canada.
Declaration
[JsonProperty("identifierExists")]
public virtual bool? IdentifierExists { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Nullable<System.Boolean> |
ImageLink
URL of an image of the item.
Declaration
[JsonProperty("imageLink")]
public virtual string ImageLink { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
Installment
Number and amount of installments to pay for an item.
Declaration
[JsonProperty("installment")]
public virtual Installment Installment { get; set; }
Property Value
| Type | Description |
|---|---|
| Installment |
IsBundle
Whether the item is a merchant-defined bundle. A bundle is a custom grouping of different products sold by a merchant for a single price.
Declaration
[JsonProperty("isBundle")]
public virtual bool? IsBundle { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Nullable<System.Boolean> |
ItemGroupId
Shared identifier for all variants of the same product.
Declaration
[JsonProperty("itemGroupId")]
public virtual string ItemGroupId { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
Kind
Identifies what kind of resource this is. Value: the fixed string "content#product"
Declaration
[JsonProperty("kind")]
public virtual string Kind { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
Link
URL directly linking to your item's page on your website.
Declaration
[JsonProperty("link")]
public virtual string Link { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
LoyaltyPoints
Loyalty points that users receive after purchasing the item. Japan only.
Declaration
[JsonProperty("loyaltyPoints")]
public virtual LoyaltyPoints LoyaltyPoints { get; set; }
Property Value
| Type | Description |
|---|---|
| LoyaltyPoints |
Material
The material of which the item is made.
Declaration
[JsonProperty("material")]
public virtual string Material { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
MaxEnergyEfficiencyClass
The energy efficiency class as defined in EU directive 2010/30/EU. Acceptable values are: - "A" - "A+" -
"A++" - "A+++" - "B" - "C" - "D" - "E" - "F" - "G"
Declaration
[JsonProperty("maxEnergyEfficiencyClass")]
public virtual string MaxEnergyEfficiencyClass { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
MaxHandlingTime
Maximal product handling time (in business days).
Declaration
[JsonProperty("maxHandlingTime")]
public virtual long? MaxHandlingTime { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Nullable<System.Int64> |
MinEnergyEfficiencyClass
The energy efficiency class as defined in EU directive 2010/30/EU. Acceptable values are: - "A" - "A+" -
"A++" - "A+++" - "B" - "C" - "D" - "E" - "F" - "G"
Declaration
[JsonProperty("minEnergyEfficiencyClass")]
public virtual string MinEnergyEfficiencyClass { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
MinHandlingTime
Minimal product handling time (in business days).
Declaration
[JsonProperty("minHandlingTime")]
public virtual long? MinHandlingTime { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Nullable<System.Int64> |
MobileLink
URL for the mobile-optimized version of your item's landing page.
Declaration
[JsonProperty("mobileLink")]
public virtual string MobileLink { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
Mpn
Manufacturer Part Number (MPN) of the item.
Declaration
[JsonProperty("mpn")]
public virtual string Mpn { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
Multipack
The number of identical products in a merchant-defined multipack.
Declaration
[JsonProperty("multipack")]
public virtual long? Multipack { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Nullable<System.Int64> |
OfferId
Required. A unique identifier for the item. Leading and trailing whitespaces are stripped and multiple whitespaces are replaced by a single whitespace upon submission. Only valid unicode characters are accepted. See the products feed specification for details. Note: Content API methods that operate on products take the REST ID of the product, not this identifier.
Declaration
[JsonProperty("offerId")]
public virtual string OfferId { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
OnlineOnly
Deprecated.
Declaration
[JsonProperty("onlineOnly")]
public virtual bool? OnlineOnly { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Nullable<System.Boolean> |
Pattern
The item's pattern (e.g. polka dots).
Declaration
[JsonProperty("pattern")]
public virtual string Pattern { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
Price
Price of the item.
Declaration
[JsonProperty("price")]
public virtual Price Price { get; set; }
Property Value
| Type | Description |
|---|---|
| Price |
ProductType
Your category of the item (formatted as in products data specification).
Declaration
[JsonProperty("productType")]
public virtual string ProductType { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
PromotionIds
The unique ID of a promotion.
Declaration
[JsonProperty("promotionIds")]
public virtual IList<string> PromotionIds { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Collections.Generic.IList<System.String> |
SalePrice
Advertised sale price of the item.
Declaration
[JsonProperty("salePrice")]
public virtual Price SalePrice { get; set; }
Property Value
| Type | Description |
|---|---|
| Price |
SalePriceEffectiveDate
Date range during which the item is on sale (see products data specification ).
Declaration
[JsonProperty("salePriceEffectiveDate")]
public virtual string SalePriceEffectiveDate { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
SellOnGoogleQuantity
The quantity of the product that is available for selling on Google. Supported only for online products.
Declaration
[JsonProperty("sellOnGoogleQuantity")]
public virtual long? SellOnGoogleQuantity { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Nullable<System.Int64> |
Shipping
Shipping rules.
Declaration
[JsonProperty("shipping")]
public virtual IList<ProductShipping> Shipping { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Collections.Generic.IList<ProductShipping> |
ShippingHeight
Height of the item for shipping.
Declaration
[JsonProperty("shippingHeight")]
public virtual ProductShippingDimension ShippingHeight { get; set; }
Property Value
| Type | Description |
|---|---|
| ProductShippingDimension |
ShippingLabel
The shipping label of the product, used to group product in account-level shipping rules.
Declaration
[JsonProperty("shippingLabel")]
public virtual string ShippingLabel { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
ShippingLength
Length of the item for shipping.
Declaration
[JsonProperty("shippingLength")]
public virtual ProductShippingDimension ShippingLength { get; set; }
Property Value
| Type | Description |
|---|---|
| ProductShippingDimension |
ShippingWeight
Weight of the item for shipping.
Declaration
[JsonProperty("shippingWeight")]
public virtual ProductShippingWeight ShippingWeight { get; set; }
Property Value
| Type | Description |
|---|---|
| ProductShippingWeight |
ShippingWidth
Width of the item for shipping.
Declaration
[JsonProperty("shippingWidth")]
public virtual ProductShippingDimension ShippingWidth { get; set; }
Property Value
| Type | Description |
|---|---|
| ProductShippingDimension |
Sizes
Size of the item. Only one value is allowed. For variants with different sizes, insert a separate product
for each size with the same itemGroupId value (see size definition).
Declaration
[JsonProperty("sizes")]
public virtual IList<string> Sizes { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Collections.Generic.IList<System.String> |
SizeSystem
System in which the size is specified. Recommended for apparel items. Acceptable values are: - "AU" -
"BR" - "CN" - "DE" - "EU" - "FR" - "IT" - "JP" - "MEX" - "UK" - "US"
Declaration
[JsonProperty("sizeSystem")]
public virtual string SizeSystem { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
SizeType
The cut of the item. Recommended for apparel items. Acceptable values are: - "big and tall" -
"maternity" - "oversize" - "petite" - "plus" - "regular"
Declaration
[JsonProperty("sizeType")]
public virtual string SizeType { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
Source
The source of the offer, i.e., how the offer was created. Acceptable values are: - "api" - "crawl" -
"feed"
Declaration
[JsonProperty("source")]
public virtual string Source { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
TargetCountry
Required. The CLDR territory code for the item.
Declaration
[JsonProperty("targetCountry")]
public virtual string TargetCountry { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
Taxes
Tax information.
Declaration
[JsonProperty("taxes")]
public virtual IList<ProductTax> Taxes { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Collections.Generic.IList<ProductTax> |
Title
Title of the item.
Declaration
[JsonProperty("title")]
public virtual string Title { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
UnitPricingBaseMeasure
The preference of the denominator of the unit price.
Declaration
[JsonProperty("unitPricingBaseMeasure")]
public virtual ProductUnitPricingBaseMeasure UnitPricingBaseMeasure { get; set; }
Property Value
| Type | Description |
|---|---|
| ProductUnitPricingBaseMeasure |
UnitPricingMeasure
The measure and dimension of an item.
Declaration
[JsonProperty("unitPricingMeasure")]
public virtual ProductUnitPricingMeasure UnitPricingMeasure { get; set; }
Property Value
| Type | Description |
|---|---|
| ProductUnitPricingMeasure |
ValidatedDestinations
Deprecated. The read-only list of intended destinations which passed validation.
Declaration
[JsonProperty("validatedDestinations")]
public virtual IList<string> ValidatedDestinations { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Collections.Generic.IList<System.String> |
Warnings
Read-only warnings.
Declaration
[JsonProperty("warnings")]
public virtual IList<Error> Warnings { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Collections.Generic.IList<Error> |