Skip to main content

products

Overview

Nameproducts
TypeResource
Idgoogledevelopers.content.products

Fields

NameDatatypeDescription
idstringThe 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.
descriptionstringDescription of the item.
mpnstringManufacturer Part Number (MPN) of the item.
subscriptionCostobject
colorstringColor of the item.
isBundlebooleanWhether the item is a merchant-defined bundle. A bundle is a custom grouping of different products sold by a merchant for a single price.
sizeTypestringThe cut of the item. Recommended for apparel items.
costOfGoodsSoldobject
salePriceobject
excludedDestinationsarrayThe 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.
linkstringURL directly linking to your item's page on your website.
sellOnGoogleQuantitystringThe quantity of the product that is available for selling on Google. Supported only for online products.
genderstringTarget gender of the item.
unitPricingMeasureobject
availabilityDatestringThe day a pre-ordered product becomes available for delivery, in ISO 8601 format.
shippingLengthobject
additionalSizeTypestringAdditional cut of the item. Used together with size_type to represent combined size types for apparel items.
priceobject
displayAdsValuenumberOffer margin for dynamic remarketing campaigns.
mobileLinkTemplatestringURL template for merchant hosted local storefront optimized for mobile devices.
customLabel3stringCustom label 3 for custom grouping of items in a Shopping campaign.
adultbooleanShould be set to true if the item is targeted towards adults.
loyaltyPointsobject
minHandlingTimestringMinimal product handling time (in business days).
adsLabelsarraySimilar to ads_grouping, but only works on CPC.
kindstringIdentifies what kind of resource this is. Value: the fixed string "content#product"
customLabel1stringCustom label 1 for custom grouping of items in a Shopping campaign.
maxEnergyEfficiencyClassstringThe energy efficiency class as defined in EU directive 2010/30/EU.
canonicalLinkstringURL for the canonical version of your item's landing page.
minEnergyEfficiencyClassstringThe energy efficiency class as defined in EU directive 2010/30/EU.
googleProductCategorystringGoogle'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.
multipackstringThe number of identical products in a merchant-defined multipack.
productWeightobject
pausestringPublication of this item should be temporarily paused. Acceptable values are: - "ads"
adsRedirectstringAllows advertisers to override the item URL when the product is shown within the context of Product Ads.
unitPricingBaseMeasureobject
materialstringThe material of which the item is made.
adsGroupingstringUsed to group items in an arbitrary way. Only for CPA%, discouraged otherwise.
conditionstringCondition or state of the item.
shippingHeightobject
sizeSystemstringSystem in which the size is specified. Recommended for apparel items.
shoppingAdsExcludedCountriesarrayList 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.
customLabel2stringCustom label 2 for custom grouping of items in a Shopping campaign.
displayAdsIdstringAn identifier for an item for dynamic remarketing campaigns.
sizesarraySize 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).
customAttributesarrayA 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).
transitTimeLabelstringThe transit time label of the product, used to group product in account-level transit time tables.
customLabel4stringCustom label 4 for custom grouping of items in a Shopping campaign.
pickupSlastringItem store pickup timeline. Acceptable values are: - "same day" - "next day" - "2-day" - "3-day" - "4-day" - "5-day" - "6-day" - "7-day" - "multi-week"
titlestringTitle of the item.
imageLinkstringURL of an image of the item.
targetCountrystringRequired. The CLDR territory code for the item's country of sale.
includedDestinationsarrayThe 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.
productLengthobject
itemGroupIdstringShared identifier for all variants of the same product.
availabilitystringAvailability status of the item.
shippingWidthobject
promotionIdsarrayThe unique ID of a promotion.
patternstringThe item's pattern (for example, polka dots).
gtinstringGlobal Trade Item Number (GTIN) of the item.
productWidthobject
shippingWeightobject
displayAdsTitlestringTitle of an item for dynamic remarketing campaigns.
maxHandlingTimestringMaximal product handling time (in business days).
offerIdstringRequired. 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.
installmentobject
additionalImageLinksarrayAdditional URLs of images of the item.
taxCategorystringThe tax category of the product, used to configure detailed tax nexus in account-level tax settings.
customLabel0stringCustom label 0 for custom grouping of items in a Shopping campaign.
productHighlightsarrayBullet points describing the most relevant highlights of a product.
displayAdsLinkstringURL directly to your item's landing page for dynamic remarketing campaigns.
identifierExistsbooleanFalse 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.
linkTemplatestringURL template for merchant hosted local storefront.
taxesarrayTax information.
salePriceEffectiveDatestringDate range during which the item is on sale (see product data specification ).
mobileLinkstringURL for the mobile-optimized version of your item's landing page.
displayAdsSimilarIdsarrayAdvertiser-specified recommendations.
pickupMethodstringThe pick up option for the item. Acceptable values are: - "buy" - "reserve" - "ship to store" - "not supported"
productDetailsarrayTechnical specification or additional product details.
contentLanguagestringRequired. The two-letter ISO 639-1 language code for the item.
shippingLabelstringThe shipping label of the product, used to group product in account-level shipping rules.
expirationDatestringDate 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.
productTypesarrayCategories of the item (formatted as in product data specification).
productHeightobject
feedLabelstringFeed label for the item. Either targetCountry or feedLabel is required.
sourcestringThe source of the offer, that is, how the offer was created. Acceptable values are: - "api" - "crawl" - "feed"
energyEfficiencyClassstringThe energy efficiency class as defined in EU directive 2010/30/EU.
lifestyleImageLinksarrayAdditional 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.
ageGroupstringTarget age group of the item.
channelstringRequired. The item's channel (online or local). Acceptable values are: - "local" - "online"
brandstringBrand of the item.
externalSellerIdstringRequired for multi-seller accounts. Use this attribute if you're a marketplace uploading products for various sellers to your multi-seller account.
shippingarrayShipping rules.

Methods

NameAccessible byRequired ParamsDescription
getSELECTmerchantId, productIdRetrieves a product from your Merchant Center account.
listSELECTmerchantIdLists the products in your Merchant Center account. The response might contain fewer items than specified by maxResults. Rely on nextPageToken to determine if there are more items to be requested.
insertINSERTmerchantIdUploads a product to your Merchant Center account. If an item with the same channel, contentLanguage, offerId, and targetCountry already exists, this method updates that entry.
deleteDELETEmerchantId, productIdDeletes a product from your Merchant Center account.
custombatchEXECRetrieves, inserts, and deletes multiple products in a single request.
updateEXECmerchantId, productIdUpdates an existing product in your Merchant Center account. Only updates attributes provided in the request.