Products: insert

Requires authorization

Uploads 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. Try it now.

Request

HTTP request

POST https://www.googleapis.com/content/v2.1/merchantId/products

Parameters

Parameter name	Value	Description
Path parameters
merchantId	unsigned long	The ID of the account that contains the product. This account cannot be a multi-client account.

Authorization

This request requires authorization with the following scope (read more about authentication and authorization).

Scope
https://www.googleapis.com/auth/content

Request body

In the request body, supply a Products resource with the following properties:

Property name	Value	Description	Notes
Required Properties
channel	string	The item's channel (online or local). Acceptable values are: "local" "online"	writable
contentLanguage	string	The two-letter ISO 639-1 language code for the item.	writable
offerId	string	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.	writable
targetCountry	string	The CLDR territory code for the item.	writable
Optional Properties
additionalImageLinks[]	list	Additional URLs of images of the item.	writable
adsGrouping	string	Used to group items in an arbitrary way. Only for CPA%, discouraged otherwise.	writable
adsLabels[]	list	Similar to ads_grouping, but only works on CPC.	writable
adsRedirect	string	Allows advertisers to override the item URL when the product is shown within the context of Product Ads.	writable
adult	boolean	Set to true if the item is targeted towards adults.	writable
ageGroup	string	Target age group of the item.	writable
availability	string	Availability status of the item.	writable
availabilityDate	string	The day a pre-ordered product becomes available for delivery, in ISO 8601 format.	writable
brand	string	Brand of the item.	writable
color	string	Color of the item.	writable
condition	string	Condition or state of the item.	writable
costOfGoodsSold	nested object	Cost of goods sold. Used for gross profit reporting.	writable
costOfGoodsSold.currency	string	The currency of the price.	writable
costOfGoodsSold.value	string	The price represented as a number.	writable
customAttributes[]	list	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", "type": "text", "value": "regular" }). This is useful for submitting attributes not explicitly exposed by the API.	writable
customAttributes[].groupValues[]	list	Subattributes within this attribute group. Exactly one of value or groupValues must be provided.	writable
customAttributes[].name	string	The name of the attribute. Underscores will be replaced by spaces upon insertion.	writable
customAttributes[].value	string	The value of the attribute.	writable
customLabel0	string	Custom label 0 for custom grouping of items in a Shopping campaign.	writable
customLabel1	string	Custom label 1 for custom grouping of items in a Shopping campaign.	writable
customLabel2	string	Custom label 2 for custom grouping of items in a Shopping campaign.	writable
customLabel3	string	Custom label 3 for custom grouping of items in a Shopping campaign.	writable
customLabel4	string	Custom label 4 for custom grouping of items in a Shopping campaign.	writable
description	string	Description of the item.	writable
displayAdsId	string	An identifier for an item for dynamic remarketing campaigns.	writable
displayAdsLink	string	URL directly to your item's landing page for dynamic remarketing campaigns.	writable
displayAdsSimilarIds[]	list	Advertiser-specified recommendations.	writable
displayAdsTitle	string	Title of an item for dynamic remarketing campaigns.	writable
displayAdsValue	double	Offer margin for dynamic remarketing campaigns.	writable
energyEfficiencyClass	string	The energy efficiency class as defined in EU directive 2010/30/EU.	writable
excludedDestinations[]	list	The list of destinations to exclude for this target (corresponds to unchecked check boxes in Merchant Center).	writable
expirationDate	string	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.	writable
gender	string	Target gender of the item.	writable
googleProductCategory	string	Google's category of the item (see Google product taxonomy).	writable
gtin	string	Global Trade Item Number (GTIN) of the item.	writable
identifierExists	boolean	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.	writable
imageLink	string	URL of an image of the item.	writable
includedDestinations[]	list	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 the excluded_destination field.	writable
installment	nested object	Number and amount of installments to pay for an item. Brazil only.	writable
installment.amount	nested object	The amount the buyer has to pay per month.	writable
installment.amount.currency	string	The currency of the price.	writable
installment.amount.value	string	The price represented as a number.	writable
installment.months	long	The number of installments the buyer has to pay.	writable
isBundle	boolean	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.	writable
itemGroupId	string	Shared identifier for all variants of the same product.	writable
link	string	URL directly linking to your item's page on your website.	writable
loyaltyPoints	nested object	Loyalty points that users receive after purchasing the item. Japan only.	writable
loyaltyPoints.name	string	Name of loyalty points program. It is recommended to limit the name to 12 full-width characters or 24 Roman characters.	writable
loyaltyPoints.pointsValue	long	The retailer's loyalty points in absolute value.	writable
loyaltyPoints.ratio	double	The ratio of a point when converted to currency. Google assumes currency based on Merchant Center settings. If ratio is left out, it defaults to 1.0.	writable
material	string	The material of which the item is made.	writable
maxEnergyEfficiencyClass	string	The energy efficiency class as defined in EU directive 2010/30/EU.	writable
maxHandlingTime	long	Maximal product handling time (in business days).	writable
minEnergyEfficiencyClass	string	The energy efficiency class as defined in EU directive 2010/30/EU.	writable
minHandlingTime	long	Minimal product handling time (in business days).	writable
mobileLink	string	Link to a mobile-optimized version of the landing page.	writable
mpn	string	Manufacturer Part Number (MPN) of the item.	writable
multipack	long	The number of identical products in a merchant-defined multipack.	writable
pattern	string	The item's pattern (e.g. polka dots).	writable
price	nested object	Price of the item.	writable
price.currency	string	The currency of the price.	writable
price.value	string	The price represented as a number.	writable
productTypes[]	list	Categories of the item (formatted as in products feed specification).	writable
promotionIds[]	list	The unique ID of a promotion.	writable
salePrice	nested object	Advertised sale price of the item.	writable
salePrice.currency	string	The currency of the price.	writable
salePrice.value	string	The price represented as a number.	writable
salePriceEffectiveDate	string	Date range during which the item is on sale (see products feed specification).	writable
sellOnGoogleQuantity	long	The quantity of the product that is available for selling on Google. Supported only for online products.	writable
shipping[]	list	Shipping rules.	writable
shipping[].country	string	The CLDR territory code of the country to which an item will ship.	writable
shipping[].locationGroupName	string	The location where the shipping is applicable, represented by a location group name.	writable
shipping[].locationId	long	The numeric ID of a location that the shipping rate applies to as defined in the AdWords API.	writable
shipping[].postalCode	string	The postal code range that the shipping rate applies to, represented by a postal code, a postal code prefix followed by a * wildcard, a range between two postal codes or two postal code prefixes of equal length.	writable
shipping[].price	nested object	Fixed shipping price, represented as a number.	writable
shipping[].price.currency	string	The currency of the price.	writable
shipping[].price.value	string	The price represented as a number.	writable
shipping[].region	string	The geographic region to which a shipping rate applies.	writable
shipping[].service	string	A free-form description of the service class or delivery speed.	writable
shippingHeight	nested object	Height of the item for shipping.	writable
shippingHeight.unit	string	The unit of value.	writable
shippingHeight.value	double	The dimension of the product used to calculate the shipping cost of the item.	writable
shippingLabel	string	The shipping label of the product, used to group product in account-level shipping rules.	writable
shippingLength	nested object	Length of the item for shipping.	writable
shippingLength.unit	string	The unit of value.	writable
shippingLength.value	double	The dimension of the product used to calculate the shipping cost of the item.	writable
shippingWeight	nested object	Weight of the item for shipping.	writable
shippingWeight.unit	string	The unit of value.	writable
shippingWeight.value	double	The weight of the product used to calculate the shipping cost of the item.	writable
shippingWidth	nested object	Width of the item for shipping.	writable
shippingWidth.unit	string	The unit of value.	writable
shippingWidth.value	double	The dimension of the product used to calculate the shipping cost of the item.	writable
sizeSystem	string	System in which the size is specified. Recommended for apparel items.	writable
sizeType	string	The cut of the item. Recommended for apparel items.	writable
sizes[]	list	Size of the item.	writable
taxes[]	list	Tax information.	writable
taxes[].country	string	The country within which the item is taxed, specified as a CLDR territory code.	writable
taxes[].locationId	long	The numeric ID of a location that the tax rate applies to as defined in the AdWords API.	writable
taxes[].postalCode	string	The postal code range that the tax rate applies to, represented by a ZIP code, a ZIP code prefix using * wildcard, a range between two ZIP codes or two ZIP code prefixes of equal length. Examples: 94114, 94*, 94002-95460, 94*-95*.	writable
taxes[].rate	double	The percentage of tax rate that applies to the item price.	writable
taxes[].region	string	The geographic region to which the tax rate applies.	writable
taxes[].taxShip	boolean	Set to true if tax is charged on shipping.	writable
title	string	Title of the item.	writable
unitPricingBaseMeasure	nested object	The preference of the denominator of the unit price.	writable
unitPricingBaseMeasure.unit	string	The unit of the denominator.	writable
unitPricingBaseMeasure.value	long	The denominator of the unit price.	writable
unitPricingMeasure	nested object	The measure and dimension of an item.	writable
unitPricingMeasure.unit	string	The unit of the measure.	writable
unitPricingMeasure.value	double	The measure of an item.	writable

Response

If successful, this method returns a Products resource in the response body.

Try it!

Use the APIs Explorer below to call this method on live data and see the response.