- Resource: Product
- ProductDimension
- ProductWeight
- ProductShipping
- FreeShippingThreshold
- ProductShippingWeight
- ProductTax
- Installment
- LoyaltyProgram
- ProductUnitPricingMeasure
- ProductUnitPricingBaseMeasure
- ProductShippingDimension
- ProductProductDetail
- ProductSubscriptionCost
- CloudExportAdditionalProperties
- ProductCertification
- ProductStructuredTitle
- ProductStructuredDescription
- Methods
Resource: Product
Product data. After inserting, updating, or deleting a product, it may take several minutes before changes take effect.
JSON representation |
---|
{ "id": string, "offerId": string, "title": string, "description": string, "link": string, "imageLink": string, "additionalImageLinks": [ string ], "lifestyleImageLinks": [ string ], "contentLanguage": string, "targetCountry": string, "feedLabel": string, "channel": string, "expirationDate": string, "disclosureDate": string, "adult": boolean, "kind": string, "brand": string, "color": string, "googleProductCategory": string, "gtin": string, "itemGroupId": string, "material": string, "mpn": string, "pattern": string, "price": { object ( |
Fields | |
---|---|
id |
The REST ID of the product. Content API methods that operate on products take this as their The REST ID for a product has one of the 2 forms channel:contentLanguage:targetCountry: offerId or channel:contentLanguage:feedLabel: offerId. |
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. |
title |
Title of the item. |
description |
Description of the item. |
link |
URL directly linking to your item's page on your website. |
imageLink |
URL of an image of the item. |
additionalImageLinks[] |
Additional URLs of images of the item. |
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. |
contentLanguage |
Required. The two-letter ISO 639-1 language code for the item. |
targetCountry |
Required. The CLDR territory code for the item's country of sale. |
feedLabel |
Feed label for the item. Either |
channel |
Required. The item's channel (online or local). Acceptable values are:
|
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 |
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. |
adult |
Should be set to true if the item is targeted towards adults. |
kind |
Identifies what kind of resource this is. Value: the fixed string " |
brand |
Brand of the item. |
color |
Color of the item. |
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. |
gtin |
Global Trade Item Number (GTIN) of the item. |
itemGroupId |
Shared identifier for all variants of the same product. |
material |
The material of which the item is made. |
mpn |
Manufacturer Part Number (MPN) of the item. |
pattern |
The item's pattern (for example, polka dots). |
price |
Price of the item. |
salePrice |
Advertised sale price of the item. |
salePriceEffectiveDate |
Date range during which the item is on sale (see product data specification). |
productHeight |
The height of the product in the units provided. The value must be between 0 (exclusive) and 3000 (inclusive). |
productLength |
The length of the product in the units provided. The value must be between 0 (exclusive) and 3000 (inclusive). |
productWidth |
The width of the product in the units provided. The value must be between 0 (exclusive) and 3000 (inclusive). |
productWeight |
The weight of the product in the units provided. The value must be between 0 (exclusive) and 2000 (inclusive). |
shipping[] |
Shipping rules. |
freeShippingThreshold[] |
Optional. Conditions to be met for a product to have free shipping. |
shippingWeight |
Weight of the item for shipping. |
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 |
taxes[] |
Tax information. |
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, |
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. |
installment |
Number and amount of installments to pay for an item. |
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. |
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. |
multipack |
The number of identical products in a merchant-defined multipack. |
customLabel0 |
Custom label 0 for custom grouping of items in a Shopping campaign. |
customLabel1 |
Custom label 1 for custom grouping of items in a Shopping campaign. |
customLabel2 |
Custom label 2 for custom grouping of items in a Shopping campaign. |
customLabel3 |
Custom label 3 for custom grouping of items in a Shopping campaign. |
customLabel4 |
Custom label 4 for custom grouping of items in a Shopping campaign. |
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. |
mobileLink |
URL for the mobile-optimized version of your item's landing page. |
availabilityDate |
The day a pre-ordered product becomes available for delivery, in ISO 8601 format. |
shippingLabel |
The shipping label of the product, used to group product in account-level shipping rules. |
unitPricingMeasure |
The measure and dimension of an item. |
unitPricingBaseMeasure |
The preference of the denominator of the unit price. |
shippingLength |
Length of the item for shipping. |
shippingWidth |
Width of the item for shipping. |
shippingHeight |
Height of the item for shipping. |
displayAdsId |
An identifier for an item for dynamic remarketing campaigns. |
displayAdsSimilarIds[] |
Advertiser-specified recommendations. |
displayAdsTitle |
Title of an item for dynamic remarketing campaigns. |
displayAdsLink |
URL directly to your item's landing page for dynamic remarketing campaigns. |
displayAdsValue |
Offer margin for dynamic remarketing campaigns. |
sellOnGoogleQuantity |
The quantity of the product that is available for selling on Google. Supported only for online products. |
promotionIds[] |
The unique ID of a promotion. |
maxHandlingTime |
Maximal product handling time (in business days). |
minHandlingTime |
Minimal product handling time (in business days). |
costOfGoodsSold |
Cost of goods sold. Used for gross profit reporting. |
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. |
source |
Output only. The source of the offer, that is, how the offer was created. Acceptable values are:
|
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[] |
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. |
adsGrouping |
Used to group items in an arbitrary way. Only for CPA%, discouraged otherwise. |
adsLabels[] |
Similar to adsGrouping, but only works on CPC. |
adsRedirect |
Allows advertisers to override the item URL when the product is shown within the context of Product Ads. |
productTypes[] |
Categories of the item (formatted as in product data specification). |
ageGroup |
Target age group of the item. |
availability |
Availability status of the item. |
condition |
Condition or state of the item. |
gender |
Target gender of the item. |
sizeSystem |
System in which the size is specified. Recommended for apparel items. |
sizeType |
The cut of the item. Recommended for apparel items. |
additionalSizeType |
Additional cut of the item. Used together with sizeType to represent combined size types for apparel items. |
energyEfficiencyClass |
The energy efficiency class as defined in EU directive 2010/30/EU. |
minEnergyEfficiencyClass |
The energy efficiency class as defined in EU directive 2010/30/EU. |
maxEnergyEfficiencyClass |
The energy efficiency class as defined in EU directive 2010/30/EU. |
taxCategory |
The tax category of the product, used to configure detailed tax nexus in account-level tax settings. |
transitTimeLabel |
The transit time label of the product, used to group product in account-level transit time tables. |
shoppingAdsExcludedCountries[] |
products.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. |
pickupMethod |
The pick up option for the item. Acceptable values are:
|
pickupSla |
Item store pickup timeline. Acceptable values are:
|
linkTemplate |
URL template for merchant hosted local storefront. |
mobileLinkTemplate |
URL template for merchant hosted local storefront optimized for mobile devices. |
productDetails[] |
Technical specification or additional product details. |
productHighlights[] |
Bullet points describing the most relevant highlights of a product. |
subscriptionCost |
Number of periods (months or years) and amount of payment per period for an item with an associated subscription contract. |
canonicalLink |
URL for the canonical version of your item's landing page. |
externalSellerId |
Required for multi-seller accounts. Use this attribute if you're a marketplace uploading products for various sellers to your multi-seller account. |
pause |
Publication of this item should be temporarily paused. Acceptable values are:
|
virtualModelLink |
URL of the 3D model of the item to provide more visuals. |
cloudExportAdditionalProperties[] |
Extra fields to export to the Cloud Retail program. |
certifications[] |
Product certification, introduced for EU energy efficiency labeling compliance using the EU EPREL database. |
structuredTitle |
Structured title, for algorithmically (AI)-generated titles. |
structuredDescription |
Structured description, for algorithmically (AI)-generated descriptions. |
ProductDimension
JSON representation |
---|
{ "value": number, "unit": string } |
Fields | |
---|---|
value |
Required. The length value represented as a number. The value can have a maximum precision of four decimal places. |
unit |
Required. The length units. Acceptable values are:
|
ProductWeight
JSON representation |
---|
{ "value": number, "unit": string } |
Fields | |
---|---|
value |
Required. The weight represented as a number. The weight can have a maximum precision of four decimal places. |
unit |
Required. The weight unit. Acceptable values are:
|
ProductShipping
JSON representation |
---|
{
"price": {
object ( |
Fields | |
---|---|
price |
Fixed shipping price, represented as a number. |
country |
The CLDR territory code of the country to which an item will ship. |
region |
The geographic region to which a shipping rate applies. |
service |
A free-form description of the service class or delivery speed. |
locationId |
The numeric ID of a location that the shipping rate applies to as defined in the Google Ads API. |
locationGroupName |
The location where the shipping is applicable, represented by a location group name. |
postalCode |
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. |
minHandlingTime |
Minimum handling time (inclusive) between when the order is received and shipped in business days. 0 means that the order is shipped on the same day as it's received if it happens before the cut-off time. minHandlingTime can only be present together with maxHandlingTime; but it's not required if maxHandlingTime is present. |
maxHandlingTime |
Maximum handling time (inclusive) between when the order is received and shipped in business days. 0 means that the order is shipped on the same day as it's received if it happens before the cut-off time. Both maxHandlingTime and maxTransitTime are required if providing shipping speeds. |
minTransitTime |
Minimum transit time (inclusive) between when the order has shipped and when it's delivered in business days. 0 means that the order is delivered on the same day as it ships. minTransitTime can only be present together with maxTransitTime; but it's not required if maxTransitTime is present. |
maxTransitTime |
Maximum transit time (inclusive) between when the order has shipped and when it's delivered in business days. 0 means that the order is delivered on the same day as it ships. Both maxHandlingTime and maxTransitTime are required if providing shipping speeds. |
FreeShippingThreshold
Conditions to be met for a product to have free shipping.
JSON representation |
---|
{
"country": string,
"priceThreshold": {
object ( |
Fields | |
---|---|
country |
Required. The CLDR territory code of the country to which an item will ship. |
priceThreshold |
Required. The minimum product price for the shipping cost to become free. Represented as a number. |
ProductShippingWeight
JSON representation |
---|
{ "value": number, "unit": string } |
Fields | |
---|---|
value |
The weight of the product used to calculate the shipping cost of the item. |
unit |
The unit of value. |
ProductTax
JSON representation |
---|
{ "rate": number, "country": string, "region": string, "taxShip": boolean, "locationId": string, "postalCode": string } |
Fields | |
---|---|
rate |
The percentage of tax rate that applies to the item price. |
country |
The country within which the item is taxed, specified as a CLDR territory code. |
region |
The geographic region to which the tax rate applies. |
taxShip |
Should be set to true if tax is charged on shipping. |
locationId |
The numeric ID of a location that the tax rate applies to as defined in the Google Ads API. |
postalCode |
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*. |
Installment
Details of a monthly installment payment offering. Learn more about installments.
JSON representation |
---|
{ "months": string, "amount": { object ( |
Fields | |
---|---|
months |
The number of installments the buyer has to pay. |
amount |
The amount the buyer has to pay per month. |
downpayment |
Optional. The initial down payment amount the buyer has to pay. |
creditType |
Optional. Type of installment payments. Supported values are:
|
LoyaltyProgram
Allows the setting up of loyalty program benefits (for example price or points). https://support.google.com/merchants/answer/12922446
JSON representation |
---|
{ "programLabel": string, "tierLabel": string, "price": { object ( |
Fields | |
---|---|
programLabel |
Required. The label of the loyalty program. This is an internal label that uniquely identifies the relationship between a merchant entity and a loyalty program entity. It must be provided so that system can associate the assets below (for example, price and points) with a merchant. The corresponding program must be linked to the merchant account. |
tierLabel |
Required. The label of the tier within the loyalty program. Must match one of the labels within the program. |
price |
Optional. The price for members of the given tier (instant discount price). Must be smaller or equal to the regular price. |
cashbackForFutureUse |
Optional. The cashback that can be used for future purchases. |
loyaltyPoints |
Optional. The amount of loyalty points earned on a purchase. |
memberPriceEffectiveDate |
Optional. A date range during which the item is eligible for member price. If not specified, the member price is always applicable. The date range is represented by a pair of ISO 8601 dates separated by a space, comma, or slash. |
ProductUnitPricingMeasure
JSON representation |
---|
{ "value": number, "unit": string } |
Fields | |
---|---|
value |
The measure of an item. |
unit |
The unit of the measure. |
ProductUnitPricingBaseMeasure
JSON representation |
---|
{ "value": string, "unit": string } |
Fields | |
---|---|
value |
The denominator of the unit price. |
unit |
The unit of the denominator. |
ProductShippingDimension
JSON representation |
---|
{ "value": number, "unit": string } |
Fields | |
---|---|
value |
The dimension of the product used to calculate the shipping cost of the item. |
unit |
The unit of value. |
ProductProductDetail
JSON representation |
---|
{ "sectionName": string, "attributeName": string, "attributeValue": string } |
Fields | |
---|---|
sectionName |
The section header used to group a set of product details. |
attributeName |
The name of the product detail. |
attributeValue |
The value of the product detail. |
ProductSubscriptionCost
JSON representation |
---|
{
"period": string,
"periodLength": string,
"amount": {
object ( |
Fields | |
---|---|
period |
The type of subscription period.
|
periodLength |
The number of subscription periods the buyer has to pay. |
amount |
The amount the buyer has to pay per subscription period. |
CloudExportAdditionalProperties
Product property for the Cloud Retail API. For example, properties for a TV product could be "Screen-Resolution" or "Screen-Size".
JSON representation |
---|
{ "propertyName": string, "textValue": [ string ], "boolValue": boolean, "intValue": [ string ], "floatValue": [ number ], "minValue": number, "maxValue": number, "unitCode": string } |
Fields | |
---|---|
propertyName |
Name of the given property. For example, "Screen-Resolution" for a TV product. Maximum string size is 256 characters. |
textValue[] |
Text value of the given property. For example, "8K(UHD)" could be a text value for a TV product. Maximum number of specified values for this field is 400. Values are stored in an arbitrary but consistent order. Maximum string size is 256 characters. |
boolValue |
Boolean value of the given property. For example for a TV product, "True" or "False" if the screen is UHD. |
intValue[] |
Integer values of the given property. For example, 1080 for a screen resolution of a TV product. Maximum number of specified values for this field is 400. Values are stored in an arbitrary but consistent order. |
floatValue[] |
Float values of the given property. For example for a TV product 1.2345. Maximum number of specified values for this field is 400. Values are stored in an arbitrary but consistent order. |
minValue |
Minimum float value of the given property. For example for a TV product 1.00. |
maxValue |
Maximum float value of the given property. For example for a TV product 100.00. |
unitCode |
Unit of the given property. For example, "Pixels" for a TV product. Maximum string size is 256 bytes. |
ProductCertification
Product certification, introduced for EU energy efficiency labeling compliance using the EU EPREL database.
JSON representation |
---|
{ "certificationAuthority": string, "certificationName": string, "certificationCode": string, "certificationValue": string } |
Fields | |
---|---|
certificationAuthority |
The certification authority, for example "European_Commission". Maximum length is 2000 characters. |
certificationName |
The name of the certification, for example "EPREL". Maximum length is 2000 characters. |
certificationCode |
The certification code, for eaxample "123456". Maximum length is 2000 characters. |
certificationValue |
The certification value (also known as class, level or grade), for example "A+", "C", "gold". Maximum length is 2000 characters. |
ProductStructuredTitle
Structured title, for algorithmically (AI)-generated titles. See title for more information.
JSON representation |
---|
{ "digitalSourceType": string, "content": string } |
Fields | |
---|---|
digitalSourceType |
Optional. The digital source type. Acceptable values are:
|
content |
Required. The title text. Maximum length is 150 characters. |
ProductStructuredDescription
Structured description, for algorithmically (AI)-generated descriptions. See description for more information.
JSON representation |
---|
{ "digitalSourceType": string, "content": string } |
Fields | |
---|---|
digitalSourceType |
Optional. The digital source type. Acceptable values are:
|
content |
Required. The description text. Maximum length is 5000 characters. |
Methods |
|
---|---|
|
Retrieves, inserts, and deletes multiple products in a single request. |
|
Deletes a product from your Merchant Center account. |
|
Retrieves a product from your Merchant Center account. |
|
Uploads a product to your Merchant Center account. |
|
Lists the products in your Merchant Center account. |
|
Updates an existing product in your Merchant Center account. |