Class Product

Required product attributes are primarily defined by the product data specification. See the Product 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. The following reference documentation lists the field names in the camelCase casing style while the Products Data Specification lists the names in the snake_case casing style.

Inheritance

object

Product

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 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
IList<string>

AdditionalSizeType

Additional cut of the item. Used together with size_type to represent combined size types for apparel items.

Declaration

[JsonProperty("additionalSizeType")]
public virtual string AdditionalSizeType { get; set; }

Property Value

Type	Description
string

AdsGrouping

Used to group items in an arbitrary way. Only for CPA%, discouraged otherwise.

Declaration

[JsonProperty("adsGrouping")]
public virtual string AdsGrouping { get; set; }

Property Value

Type	Description
string

AdsLabels

Similar to ads_grouping, but only works on CPC.

Declaration

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

Property Value

Type	Description
IList<string>

AdsRedirect

Allows advertisers to override the item URL when the product is shown within the context of Product Ads.

Declaration

[JsonProperty("adsRedirect")]
public virtual string AdsRedirect { get; set; }

Property Value

Type	Description
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
bool?

AgeGroup

Target age group of the item.

Declaration

[JsonProperty("ageGroup")]
public virtual string AgeGroup { get; set; }

Property Value

Type	Description
string

AutoPricingMinPrice

A safeguard in the Automated Discounts and Dynamic Promotions projects, ensuring that discounts on merchants' offers do not fall below this value, thereby preserving the offer's value and profitability.

Declaration

[JsonProperty("autoPricingMinPrice")]
public virtual Price AutoPricingMinPrice { get; set; }

Property Value

Type	Description
Price

Availability

Availability status of the item.

Declaration

[JsonProperty("availability")]
public virtual string Availability { get; set; }

Property Value

Type	Description
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
string

Brand

Brand of the item.

Declaration

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

Property Value

Type	Description
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
string

Certifications

Product certification, introduced for EU energy efficiency labeling compliance using the EU EPREL database.

Declaration

[JsonProperty("certifications")]
public virtual IList<ProductCertification> Certifications { get; set; }

Property Value

Type	Description
IList<ProductCertification>

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
string

CloudExportAdditionalProperties

Extra fields to export to the Cloud Retail program.

Declaration

[JsonProperty("cloudExportAdditionalProperties")]
public virtual IList<CloudExportAdditionalProperties> CloudExportAdditionalProperties { get; set; }

Property Value

Type	Description
IList<CloudExportAdditionalProperties>

Color

Color of the item.

Declaration

[JsonProperty("color")]
public virtual string Color { get; set; }

Property Value

Type	Description
string

Condition

Condition or state of the item.

Declaration

[JsonProperty("condition")]
public virtual string Condition { get; set; }

Property Value

Type	Description
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
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 (for example, { "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
IList<CustomAttribute>

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
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
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
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
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
string

Description

Description of the item.

Declaration

[JsonProperty("description")]
public virtual string Description { get; set; }

Property Value

Type	Description
string

DisclosureDate

The date time when an offer becomes visible in search results across Google’s YouTube surfaces, in ISO 8601 format. See Disclosure date for more information.

Declaration

[JsonProperty("disclosureDate")]
public virtual string DisclosureDate { get; set; }

Property Value

Type	Description
string

DisplayAdsId

An identifier for an item for dynamic remarketing campaigns.

Declaration

[JsonProperty("displayAdsId")]
public virtual string DisplayAdsId { get; set; }

Property Value

Type	Description
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
string

DisplayAdsSimilarIds

Advertiser-specified recommendations.

Declaration

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

Property Value

Type	Description
IList<string>

DisplayAdsTitle

Title of an item for dynamic remarketing campaigns.

Declaration

[JsonProperty("displayAdsTitle")]
public virtual string DisplayAdsTitle { get; set; }

Property Value

Type	Description
string

DisplayAdsValue

Offer margin for dynamic remarketing campaigns.

Declaration

[JsonProperty("displayAdsValue")]
public virtual double? DisplayAdsValue { get; set; }

Property Value

Type	Description
double?

ETag

The ETag of the item.

Declaration

public virtual string ETag { get; set; }

Property Value

Type	Description
string

EnergyEfficiencyClass

The energy efficiency class as defined in EU directive 2010/30/EU.

Declaration

[JsonProperty("energyEfficiencyClass")]
public virtual string EnergyEfficiencyClass { get; set; }

Property Value

Type	Description
string

ExcludedDestinations

The list of destinations to exclude for this target (corresponds to cleared check boxes in Merchant Center). Products that are excluded from all destinations for more than 7 days are automatically deleted.

Declaration

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

Property Value

Type	Description
IList<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
string

ExternalSellerId

Required for multi-seller accounts. Use this attribute if you're a marketplace uploading products for various sellers to your multi-seller account.

Declaration

[JsonProperty("externalSellerId")]
public virtual string ExternalSellerId { get; set; }

Property Value

Type	Description
string

FeedLabel

Feed label for the item. Either targetCountry or feedLabel is required. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-).

Declaration

[JsonProperty("feedLabel")]
public virtual string FeedLabel { get; set; }

Property Value

Type	Description
string

FreeShippingThreshold

Optional. Conditions to be met for a product to have free shipping.

Declaration

[JsonProperty("freeShippingThreshold")]
public virtual IList<FreeShippingThreshold> FreeShippingThreshold { get; set; }

Property Value

Type	Description
IList<FreeShippingThreshold>

Gender

Target gender of the item.

Declaration

[JsonProperty("gender")]
public virtual string Gender { get; set; }

Property Value

Type	Description
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
string

Gtin

Global Trade Item Number (GTIN) of the item.

Declaration

[JsonProperty("gtin")]
public virtual string Gtin { get; set; }

Property Value

Type	Description
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 has one of the 2 forms channel:contentLanguage: targetCountry: offerId or channel:contentLanguage:feedLabel: offerId.

Declaration

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

Property Value

Type	Description
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
bool?

ImageLink

URL of an image of the item.

Declaration

[JsonProperty("imageLink")]
public virtual string ImageLink { get; set; }

Property Value

Type	Description
string

IncludedDestinations

The list of destinations to include for this target (corresponds to checked check boxes in Merchant Center). Default destinations are always included unless provided in excludedDestinations.

Declaration

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

Property Value

Type	Description
IList<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
bool?

ItemGroupId

Shared identifier for all variants of the same product.

Declaration

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

Property Value

Type	Description
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
string

LifestyleImageLinks

Additional URLs of lifestyle images of the item. Used to explicitly identify images that showcase your item in a real-world context. See the Help Center article for more information.

Declaration

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

Property Value

Type	Description
IList<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
string

LinkTemplate

URL template for merchant hosted local storefront.

Declaration

[JsonProperty("linkTemplate")]
public virtual string LinkTemplate { get; set; }

Property Value

Type	Description
string

LoyaltyProgram

Loyalty program information that is used to surface loyalty benefits ( for example, better pricing, points, etc) to the user of this item. This signular field points to the latest uploaded loyalty program info. This field will be deprecated in the coming weeks and should not be used in favor of the plural 'LoyaltyProgram' field below.

Declaration

[JsonProperty("loyaltyProgram")]
public virtual LoyaltyProgram LoyaltyProgram { get; set; }

Property Value

Type	Description
LoyaltyProgram

LoyaltyPrograms

Optional. A list of loyalty program information that is used to surface loyalty benefits (for example, better pricing, points, etc) to the user of this item.

Declaration

[JsonProperty("loyaltyPrograms")]
public virtual IList<LoyaltyProgram> LoyaltyPrograms { get; set; }

Property Value

Type	Description
IList<LoyaltyProgram>

Material

The material of which the item is made.

Declaration

[JsonProperty("material")]
public virtual string Material { get; set; }

Property Value

Type	Description
string

MaxEnergyEfficiencyClass

The energy efficiency class as defined in EU directive 2010/30/EU.

Declaration

[JsonProperty("maxEnergyEfficiencyClass")]
public virtual string MaxEnergyEfficiencyClass { get; set; }

Property Value

Type	Description
string

MaxHandlingTime

Maximal product handling time (in business days).

Declaration

[JsonProperty("maxHandlingTime")]
public virtual long? MaxHandlingTime { get; set; }

Property Value

Type	Description
long?

MinEnergyEfficiencyClass

The energy efficiency class as defined in EU directive 2010/30/EU.

Declaration

[JsonProperty("minEnergyEfficiencyClass")]
public virtual string MinEnergyEfficiencyClass { get; set; }

Property Value

Type	Description
string

MinHandlingTime

Minimal product handling time (in business days).

Declaration

[JsonProperty("minHandlingTime")]
public virtual long? MinHandlingTime { get; set; }

Property Value

Type	Description
long?

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
string

MobileLinkTemplate

URL template for merchant hosted local storefront optimized for mobile devices.

Declaration

[JsonProperty("mobileLinkTemplate")]
public virtual string MobileLinkTemplate { get; set; }

Property Value

Type	Description
string

Mpn

Manufacturer Part Number (MPN) of the item.

Declaration

[JsonProperty("mpn")]
public virtual string Mpn { get; set; }

Property Value

Type	Description
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
long?

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
string

Pattern

The item's pattern (for example, polka dots).

Declaration

[JsonProperty("pattern")]
public virtual string Pattern { get; set; }

Property Value

Type	Description
string

Pause

Publication of this item should be temporarily paused. Acceptable values are: - "ads"

Declaration

[JsonProperty("pause")]
public virtual string Pause { get; set; }

Property Value

Type	Description
string

PickupMethod

The pick up option for the item. Acceptable values are: - "buy" - "reserve" - "ship to store" - "not supported"

Declaration

[JsonProperty("pickupMethod")]
public virtual string PickupMethod { get; set; }

Property Value

Type	Description
string

PickupSla

Item store pickup timeline. Acceptable values are: - "same day" - "next day" - "2-day" - "3-day" - "4-day" - "5-day" - "6-day" - "7-day" - "multi-week"

Declaration

[JsonProperty("pickupSla")]
public virtual string PickupSla { get; set; }

Property Value

Type	Description
string

Price

Price of the item.

Declaration

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

Property Value

Type	Description
Price

ProductDetails

Technical specification or additional product details.

Declaration

[JsonProperty("productDetails")]
public virtual IList<ProductProductDetail> ProductDetails { get; set; }

Property Value

Type	Description
IList<ProductProductDetail>

ProductHeight

The height of the product in the units provided. The value must be between 0 (exclusive) and 3000 (inclusive).

Declaration

[JsonProperty("productHeight")]
public virtual ProductDimension ProductHeight { get; set; }

Property Value

Type	Description
ProductDimension

ProductHighlights

Bullet points describing the most relevant highlights of a product.

Declaration

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

Property Value

Type	Description
IList<string>

ProductLength

The length of the product in the units provided. The value must be between 0 (exclusive) and 3000 (inclusive).

Declaration

[JsonProperty("productLength")]
public virtual ProductDimension ProductLength { get; set; }

Property Value

Type	Description
ProductDimension

ProductTypes

Categories of the item (formatted as in product data specification).

Declaration

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

Property Value

Type	Description
IList<string>

ProductWeight

The weight of the product in the units provided. The value must be between 0 (exclusive) and 2000 (inclusive).

Declaration

[JsonProperty("productWeight")]
public virtual ProductWeight ProductWeight { get; set; }

Property Value

Type	Description
ProductWeight

ProductWidth

The width of the product in the units provided. The value must be between 0 (exclusive) and 3000 (inclusive).

Declaration

[JsonProperty("productWidth")]
public virtual ProductDimension ProductWidth { get; set; }

Property Value

Type	Description
ProductDimension

PromotionIds

The unique ID of a promotion.

Declaration

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

Property Value

Type	Description
IList<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 product data specification ).

Declaration

[JsonProperty("salePriceEffectiveDate")]
public virtual string SalePriceEffectiveDate { get; set; }

Property Value

Type	Description
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
long?

Shipping

Shipping rules.

Declaration

[JsonProperty("shipping")]
public virtual IList<ProductShipping> Shipping { get; set; }

Property Value

Type	Description
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
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

ShoppingAdsExcludedCountries

List of country codes (ISO 3166-1 alpha-2) to exclude the offer from Shopping Ads destination. Countries from this list are removed from countries configured in MC feed settings.

Declaration

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

Property Value

Type	Description
IList<string>

SizeSystem

System in which the size is specified. Recommended for apparel items.

Declaration

[JsonProperty("sizeSystem")]
public virtual string SizeSystem { get; set; }

Property Value

Type	Description
string

SizeType

The cut of the item. Recommended for apparel items.

Declaration

[JsonProperty("sizeType")]
public virtual string SizeType { get; set; }

Property Value

Type	Description
string

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
IList<string>

Source

Output only. The source of the offer, that is, how the offer was created. Acceptable values are: - "api" - "crawl" - "feed"

Declaration

[JsonProperty("source")]
public virtual string Source { get; set; }

Property Value

Type	Description
string

StructuredDescription

Structured description, for algorithmically (AI)-generated descriptions.

Declaration

[JsonProperty("structuredDescription")]
public virtual ProductStructuredDescription StructuredDescription { get; set; }

Property Value

Type	Description
ProductStructuredDescription

StructuredTitle

Structured title, for algorithmically (AI)-generated titles.

Declaration

[JsonProperty("structuredTitle")]
public virtual ProductStructuredTitle StructuredTitle { get; set; }

Property Value

Type	Description
ProductStructuredTitle

SubscriptionCost

Number of periods (months or years) and amount of payment per period for an item with an associated subscription contract.

Declaration

[JsonProperty("subscriptionCost")]
public virtual ProductSubscriptionCost SubscriptionCost { get; set; }

Property Value

Type	Description
ProductSubscriptionCost

SustainabilityIncentives

Optional. The list of sustainability incentive programs.

Declaration

[JsonProperty("sustainabilityIncentives")]
public virtual IList<ProductSustainabilityIncentive> SustainabilityIncentives { get; set; }

Property Value

Type	Description
IList<ProductSustainabilityIncentive>

TargetCountry

Required. The CLDR territory code for the item's country of sale.

Declaration

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

Property Value

Type	Description
string

TaxCategory

The tax category of the product, used to configure detailed tax nexus in account-level tax settings.

Declaration

[JsonProperty("taxCategory")]
public virtual string TaxCategory { get; set; }

Property Value

Type	Description
string

Taxes

Tax information.

Declaration

[JsonProperty("taxes")]
public virtual IList<ProductTax> Taxes { get; set; }

Property Value

Type	Description
IList<ProductTax>

Title

Title of the item.

Declaration

[JsonProperty("title")]
public virtual string Title { get; set; }

Property Value

Type	Description
string

TransitTimeLabel

The transit time label of the product, used to group product in account-level transit time tables.

Declaration

[JsonProperty("transitTimeLabel")]
public virtual string TransitTimeLabel { get; set; }

Property Value

Type	Description
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

VirtualModelLink

URL of the 3D model of the item to provide more visuals.

Declaration

[JsonProperty("virtualModelLink")]
public virtual string VirtualModelLink { get; set; }

Property Value

Type	Description
string

Implements

IDirectResponseSchema