REST Resource: products

{
  "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 (Price)
  },
  "salePrice": {
    object (Price)
  },
  "salePriceEffectiveDate": string,
  "productHeight": {
    object (ProductDimension)
  },
  "productLength": {
    object (ProductDimension)
  },
  "productWidth": {
    object (ProductDimension)
  },
  "productWeight": {
    object (ProductWeight)
  },
  "shipping": [
    {
      object (ProductShipping)
    }
  ],
  "freeShippingThreshold": [
    {
      object (FreeShippingThreshold)
    }
  ],
  "shippingWeight": {
    object (ProductShippingWeight)
  },
  "sizes": [
    string
  ],
  "taxes": [
    {
      object (ProductTax)
    }
  ],
  "customAttributes": [
    {
      object (CustomAttribute)
    }
  ],
  "identifierExists": boolean,
  "installment": {
    object (Installment)
  },
  "loyaltyProgram": {
    object (LoyaltyProgram)
  },
  "loyaltyPrograms": [
    {
      object (LoyaltyProgram)
    }
  ],
  "multipack": string,
  "customLabel0": string,
  "customLabel1": string,
  "customLabel2": string,
  "customLabel3": string,
  "customLabel4": string,
  "isBundle": boolean,
  "mobileLink": string,
  "availabilityDate": string,
  "shippingLabel": string,
  "unitPricingMeasure": {
    object (ProductUnitPricingMeasure)
  },
  "unitPricingBaseMeasure": {
    object (ProductUnitPricingBaseMeasure)
  },
  "shippingLength": {
    object (ProductShippingDimension)
  },
  "shippingWidth": {
    object (ProductShippingDimension)
  },
  "shippingHeight": {
    object (ProductShippingDimension)
  },
  "displayAdsId": string,
  "displayAdsSimilarIds": [
    string
  ],
  "displayAdsTitle": string,
  "displayAdsLink": string,
  "displayAdsValue": number,
  "sellOnGoogleQuantity": string,
  "promotionIds": [
    string
  ],
  "maxHandlingTime": string,
  "minHandlingTime": string,
  "costOfGoodsSold": {
    object (Price)
  },
  "autoPricingMinPrice": {
    object (Price)
  },
  "source": string,
  "includedDestinations": [
    string
  ],
  "excludedDestinations": [
    string
  ],
  "adsGrouping": string,
  "adsLabels": [
    string
  ],
  "adsRedirect": string,
  "productTypes": [
    string
  ],
  "ageGroup": string,
  "availability": string,
  "condition": string,
  "gender": string,
  "sizeSystem": string,
  "sizeType": string,
  "additionalSizeType": string,
  "energyEfficiencyClass": string,
  "minEnergyEfficiencyClass": string,
  "maxEnergyEfficiencyClass": string,
  "taxCategory": string,
  "transitTimeLabel": string,
  "shoppingAdsExcludedCountries": [
    string
  ],
  "pickupMethod": string,
  "pickupSla": string,
  "linkTemplate": string,
  "mobileLinkTemplate": string,
  "productDetails": [
    {
      object (ProductProductDetail)
    }
  ],
  "productHighlights": [
    string
  ],
  "subscriptionCost": {
    object (ProductSubscriptionCost)
  },
  "canonicalLink": string,
  "externalSellerId": string,
  "pause": string,
  "virtualModelLink": string,
  "cloudExportAdditionalProperties": [
    {
      object (CloudExportAdditionalProperties)
    }
  ],
  "certifications": [
    {
      object (ProductCertification)
    }
  ],
  "structuredTitle": {
    object (ProductStructuredTitle)
  },
  "structuredDescription": {
    object (ProductStructuredDescription)
  }
}

string

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.

string

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.

string

Title of the item.

string

Description of the item.

string

URL directly linking to your item's page on your website.

string

URL of an image of the item.

string

Additional URLs of images of the item.

string

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.

string

Required. The two-letter ISO 639-1 language code for the item.

string

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

string

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 (-).

string

Required. The item's channel (online or local).

Acceptable values are:

• "local"
• "online"

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.

string

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.

boolean

Should be set to true if the item is targeted towards adults.

string

Identifies what kind of resource this is. Value: the fixed string "content#product"

string

Brand of the item.

string

Color of the item.

string

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.

string

Global Trade Item Number (GTIN) of the item.

string

Shared identifier for all variants of the same product.

string

The material of which the item is made.

string

Manufacturer Part Number (MPN) of the item.

string

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

object (Price)

Price of the item.

object (Price)

Advertised sale price of the item.

string

Date range during which the item is on sale (see product data specification).

object (ProductDimension)

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

object (ProductDimension)

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

object (ProductDimension)

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

object (ProductWeight)

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

object (ProductShipping)

Shipping rules.

object (FreeShippingThreshold)

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

object (ProductShippingWeight)

Weight of the item for shipping.

string

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).

object (ProductTax)

Tax information.

object (CustomAttribute)

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).

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.

object (Installment)

Number and amount of installments to pay for an item.

object (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.

object (LoyaltyProgram)

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.

string (int64 format)

The number of identical products in a merchant-defined multipack.

string

Custom label 0 for custom grouping of items in a Shopping campaign.

string

Custom label 1 for custom grouping of items in a Shopping campaign.

string

Custom label 2 for custom grouping of items in a Shopping campaign.

string

Custom label 3 for custom grouping of items in a Shopping campaign.

string

Custom label 4 for custom grouping of items in a Shopping campaign.

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.

string

URL for the mobile-optimized version of your item's landing page.

string

The day a pre-ordered product becomes available for delivery, in ISO 8601 format.

string

The shipping label of the product, used to group product in account-level shipping rules.

object (ProductUnitPricingMeasure)

The measure and dimension of an item.

object (ProductUnitPricingBaseMeasure)

The preference of the denominator of the unit price.

object (ProductShippingDimension)

Length of the item for shipping.

object (ProductShippingDimension)

Width of the item for shipping.

object (ProductShippingDimension)

Height of the item for shipping.

string

An identifier for an item for dynamic remarketing campaigns.

string

Advertiser-specified recommendations.

string

Title of an item for dynamic remarketing campaigns.

string

URL directly to your item's landing page for dynamic remarketing campaigns.

number

Offer margin for dynamic remarketing campaigns.

string (int64 format)

The quantity of the product that is available for selling on Google. Supported only for online products.

string

The unique ID of a promotion.

string (int64 format)

Maximal product handling time (in business days).

string (int64 format)

Minimal product handling time (in business days).

object (Price)

Cost of goods sold. Used for gross profit reporting.

object (Price)

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.

string

Output only. The source of the offer, that is, how the offer was created.

Acceptable values are:

• "api"
• "crawl"
• "feed"

string

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.

string

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.

string

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

string

Similar to adsGrouping, but only works on CPC.

string

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

string

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

string

Target age group of the item.

string

Availability status of the item.

string

Condition or state of the item.

string

Target gender of the item.

string

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

string

The cut of the item. Recommended for apparel items.

string

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

string

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

string

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

string

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

string

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

string

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

string

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.

string

The pick up option for the item.

Acceptable values are:

• "buy"
• "reserve"
• "ship to store"
• "not supported"

string

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"

string

URL template for merchant hosted local storefront.

string

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

object (ProductProductDetail)

Technical specification or additional product details.

string

Bullet points describing the most relevant highlights of a product.

object (ProductSubscriptionCost)

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

string

URL for the canonical version of your item's landing page.

string

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

string

Publication of this item should be temporarily paused.

Acceptable values are:

• "ads"

string

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

object (CloudExportAdditionalProperties)

Extra fields to export to the Cloud Retail program.

object (ProductCertification)

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

object (ProductStructuredTitle)

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

object (ProductStructuredDescription)

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

{
  "value": number,
  "unit": string
}

number

Required. The length value represented as a number. The value can have a maximum precision of four decimal places.

string

Required. The length units.

Acceptable values are:

• "in"
• "cm"

{
  "value": number,
  "unit": string
}

number

Required. The weight represented as a number. The weight can have a maximum precision of four decimal places.

string

Required. The weight unit.

Acceptable values are:

• "g"
• "kg"
• "oz"
• "lb"

{
  "price": {
    object (Price)
  },
  "country": string,
  "region": string,
  "service": string,
  "locationId": string,
  "locationGroupName": string,
  "postalCode": string,
  "minHandlingTime": string,
  "maxHandlingTime": string,
  "minTransitTime": string,
  "maxTransitTime": string
}

object (Price)

Fixed shipping price, represented as a number.

string

The CLDR territory code of the country to which an item will ship.

string

The geographic region to which a shipping rate applies.

string

A free-form description of the service class or delivery speed.

string (int64 format)

The numeric ID of a location that the shipping rate applies to as defined in the Google Ads API.

string

The location where the shipping is applicable, represented by a location group name.

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.

string (int64 format)

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.

string (int64 format)

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.

string (int64 format)

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.

string (int64 format)

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.

{
  "country": string,
  "priceThreshold": {
    object (Price)
  }
}

string

Required. The CLDR territory code of the country to which an item will ship.

object (Price)

Required. The minimum product price for the shipping cost to become free. Represented as a number.

{
  "value": number,
  "unit": string
}

number

The weight of the product used to calculate the shipping cost of the item.

string

The unit of value.

{
  "rate": number,
  "country": string,
  "region": string,
  "taxShip": boolean,
  "locationId": string,
  "postalCode": string
}

number

The percentage of tax rate that applies to the item price.

string

The country within which the item is taxed, specified as a CLDR territory code.

string

The geographic region to which the tax rate applies.

boolean

Should be set to true if tax is charged on shipping.

string (int64 format)

The numeric ID of a location that the tax rate applies to as defined in the Google Ads API.

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*.

{
  "months": string,
  "amount": {
    object (Price)
  },
  "downpayment": {
    object (Price)
  },
  "creditType": string
}

string (int64 format)

The number of installments the buyer has to pay.

object (Price)

The amount the buyer has to pay per month.

object (Price)

Optional. The initial down payment amount the buyer has to pay.

string

Optional. Type of installment payments.

Supported values are:

• "finance"
• "lease"

{
  "programLabel": string,
  "tierLabel": string,
  "price": {
    object (Price)
  },
  "cashbackForFutureUse": {
    object (Price)
  },
  "loyaltyPoints": string,
  "memberPriceEffectiveDate": string,
  "shippingLabel": string
}

string

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.

string

Required. The label of the tier within the loyalty program. Must match one of the labels within the program.

object (Price)

Optional. The price for members of the given tier (instant discount price). Must be smaller or equal to the regular price.

object (Price)

Optional. The cashback that can be used for future purchases.

string (int64 format)

Optional. The amount of loyalty points earned on a purchase.

string

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.

string

Optional. The shipping label for the loyalty program. You can use this label to indicate whether this offer has the loyalty shipping benefit. If not specified, the item is not eligible for loyalty shipping for the given loyalty tier.

{
  "value": number,
  "unit": string
}

number

The measure of an item.

string

The unit of the measure.

{
  "value": string,
  "unit": string
}

string (int64 format)

The denominator of the unit price.

string

The unit of the denominator.

{
  "value": number,
  "unit": string
}

number

The dimension of the product used to calculate the shipping cost of the item.

string

The unit of value.

{
  "sectionName": string,
  "attributeName": string,
  "attributeValue": string
}

string

The section header used to group a set of product details.

string

The name of the product detail.

string

The value of the product detail.

{
  "period": string,
  "periodLength": string,
  "amount": {
    object (Price)
  }
}

string

The type of subscription period.

• "month"
• "year"

string (int64 format)

The number of subscription periods the buyer has to pay.

object (Price)

The amount the buyer has to pay per subscription period.

{
  "propertyName": string,
  "textValue": [
    string
  ],
  "boolValue": boolean,
  "intValue": [
    string
  ],
  "floatValue": [
    number
  ],
  "minValue": number,
  "maxValue": number,
  "unitCode": string
}

string

Name of the given property. For example, "Screen-Resolution" for a TV product. Maximum string size is 256 characters.

string

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.

boolean

Boolean value of the given property. For example for a TV product, "True" or "False" if the screen is UHD.

string (int64 format)

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.

number

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.

number

Minimum float value of the given property. For example for a TV product 1.00.

number

Maximum float value of the given property. For example for a TV product 100.00.

string

Unit of the given property. For example, "Pixels" for a TV product. Maximum string size is 256 bytes.

{
  "certificationAuthority": string,
  "certificationName": string,
  "certificationCode": string,
  "certificationValue": string
}

string

The certification authority, for example "European_Commission". Maximum length is 2000 characters.

string

The name of the certification, for example "EPREL". Maximum length is 2000 characters.

string

The certification code, for eaxample "123456". Maximum length is 2000 characters.

string

The certification value (also known as class, level or grade), for example "A+", "C", "gold". Maximum length is 2000 characters.

{
  "digitalSourceType": string,
  "content": string
}

string

Optional. The digital source type.

Acceptable values are:

• "trained_algorithmic_media"
• "default"

string

Required. The title text. Maximum length is 150 characters.

{
  "digitalSourceType": string,
  "content": string
}

string

Optional. The digital source type.

Acceptable values are:

• "trained_algorithmic_media"
• "default"

string

Required. The description text. Maximum length is 5000 characters.