- JSON representation
- Installment
- SubscriptionCost
- SubscriptionPeriod
- LoyaltyPoints
- LoyaltyProgram
- ProductDimension
- ProductWeight
- Shipping
- FreeShippingThreshold
- ShippingWeight
- ShippingDimension
- Tax
- UnitPricingMeasure
- UnitPricingBaseMeasure
- ProductDetail
- CloudExportAdditionalProperties
- Certification
- ProductStructuredTitle
- ProductStructuredDescription
Attributes.
JSON representation |
---|
{ "additionalImageLinks": [ string ], "expirationDate": string, "disclosureDate": string, "availabilityDate": string, "gtin": [ string ], "price": { object ( |
Fields | |
---|---|
additional |
Additional URLs of images of the item. |
expiration |
Date on which the item should expire, as specified upon insertion, in ISO 8601 format. The actual expiration date is exposed in |
disclosure |
The date time when an offer becomes visible in search results across Google’s YouTube surfaces, in ISO 8601 format. See [Disclosure date]( https://support.google.com/merchants/answer/13034208) for more information. |
availability |
The day a pre-ordered product becomes available for delivery, in ISO 8601 format. |
gtin[] |
Global Trade Item Numbers (GTIN) of the item. You can provide up to 10 GTINs. |
price |
Price of the item. |
installment |
Number and amount of installments to pay for an item. |
subscription |
Number of periods (months or years) and amount of payment per period for an item with an associated subscription contract. |
loyalty |
Loyalty points that users receive after purchasing the item. Japan only. |
loyalty |
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. |
product |
Categories of the item (formatted as in product data specification). |
sale |
Advertised sale price of the item. |
sale |
Date range during which the item is on sale (see product data specification). |
product |
The height of the product in the units provided. The value must be between 0 (exclusive) and 3000 (inclusive). |
product |
The length of the product in the units provided. The value must be between 0 (exclusive) and 3000 (inclusive). |
product |
The width of the product in the units provided. The value must be between 0 (exclusive) and 3000 (inclusive). |
product |
The weight of the product in the units provided. The value must be between 0 (exclusive) and 2000 (inclusive). |
shipping[] |
Shipping rules. |
free |
Conditions to be met for a product to have free shipping. |
shipping |
Weight of the item for shipping. |
shipping |
Length of the item for shipping. |
shipping |
Width of the item for shipping. |
shipping |
Height of the item for shipping. |
size |
The cut of the item. It can be used to represent combined size types for apparel items. Maximum two of size types can be provided (see [https://support.google.com/merchants/answer/6324497](size type)). |
taxes[] |
Tax information. |
unit |
The measure and dimension of an item. |
unit |
The preference of the denominator of the unit price. |
ads |
Similar to adsGrouping, but only works on CPC. |
cost |
Cost of goods sold. Used for gross profit reporting. |
product |
Technical specification or additional product details. |
product |
Bullet points describing the most relevant highlights of a product. |
display |
Advertiser-specified recommendations. |
promotion |
The unique ID of a promotion. |
included |
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 |
excluded |
The list of destinations to exclude for this target (corresponds to unchecked check boxes in Merchant Center). |
shopping |
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 data source settings. |
lifestyle |
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. |
cloud |
Extra fields to export to the Cloud Retail program. |
certifications[] |
Product Certifications, for example for energy efficiency labeling of products recorded in the EU EPREL database. See the Help Center article for more information. |
auto |
A safeguard in the "Automated Discounts" (https://support.google.com/merchants/answer/10295759) and "Dynamic Promotions" (https://support.google.com/merchants/answer/13949249) projects, ensuring that discounts on merchants' offers do not fall below this value, thereby preserving the offer's value and profitability. |
identifier |
Set this value to false when the item does not have unique product identifiers appropriate to its category, such as GTIN, MPN, and brand. Defaults to true, if not provided. |
is |
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. |
title |
Title of the item. |
description |
Description of the item. |
link |
URL directly linking to your item's page on your online store. |
mobile |
URL for the mobile-optimized version of your item's landing page. |
canonical |
URL for the canonical version of your item's landing page. |
image |
URL of an image of the item. |
adult |
Set to true if the item is targeted towards adults. |
age |
Target age group of the item. |
availability |
Availability status of the item. |
brand |
Brand of the item. |
color |
Color of the item. |
condition |
Condition or state of the item. |
gender |
Target gender of the item. |
google |
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. |
item |
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). |
sell |
The quantity of the product that is available for selling on Google. Supported only for online products. |
max |
Maximal product handling time (in business days). |
min |
Minimal product handling time (in business days). |
shipping |
The shipping label of the product, used to group product in account-level shipping rules. |
transit |
The transit time label of the product, used to group product in account-level transit time tables. |
size |
Size of the item. Only one value is allowed. For variants with different sizes, insert a separate product for each size with the same |
size |
System in which the size is specified. Recommended for apparel items. |
tax |
The tax category of the product, used to configure detailed tax nexus in account-level tax settings. |
energy |
The energy efficiency class as defined in EU directive 2010/30/EU. |
min |
The energy efficiency class as defined in EU directive 2010/30/EU. |
max |
The energy efficiency class as defined in EU directive 2010/30/EU. |
multipack |
The number of identical products in a merchant-defined multipack. |
ads |
Used to group items in an arbitrary way. Only for CPA%, discouraged otherwise. |
ads |
Allows advertisers to override the item URL when the product is shown within the context of Product ads. |
display |
An identifier for an item for dynamic remarketing campaigns. |
display |
Title of an item for dynamic remarketing campaigns. |
display |
URL directly to your item's landing page for dynamic remarketing campaigns. |
display |
Offer margin for dynamic remarketing campaigns. |
pickup |
The pick up option for the item. |
pickup |
Item store pickup timeline. |
link |
Link template for merchant hosted local storefront. |
mobile |
Link template for merchant hosted local storefront optimized for mobile devices. |
custom |
Custom label 0 for custom grouping of items in a Shopping campaign. |
custom |
Custom label 1 for custom grouping of items in a Shopping campaign. |
custom |
Custom label 2 for custom grouping of items in a Shopping campaign. |
custom |
Custom label 3 for custom grouping of items in a Shopping campaign. |
custom |
Custom label 4 for custom grouping of items in a Shopping campaign. |
external |
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 will be temporarily paused. |
virtual |
URL of the 3D image of the item. See the Help Center article for more information. |
structured |
Structured title, for algorithmically (AI)-generated titles. |
structured |
Structured description, for algorithmically (AI)-generated descriptions. |
Installment
A message that represents installment.
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 |
The up-front down payment amount the buyer has to pay. |
credit |
Type of installment payments. Supported values are: * " |
SubscriptionCost
The SubscriptionCost of the product.
JSON representation |
---|
{ "period": enum ( |
Fields | |
---|---|
period |
The type of subscription period. Supported values are: * " |
period |
The number of subscription periods the buyer has to pay. |
amount |
The amount the buyer has to pay per subscription period. |
SubscriptionPeriod
The subscription period of the product.
Enums | |
---|---|
SUBSCRIPTION_PERIOD_UNSPECIFIED |
Indicates that the subscription period is unspecified. |
MONTH |
Indicates that the subscription period is month. |
YEAR |
Indicates that the subscription period is year. |
LoyaltyPoints
A message that represents loyalty points.
JSON representation |
---|
{ "name": string, "pointsValue": string, "ratio": number } |
Fields | |
---|---|
name |
Name of loyalty points program. It is recommended to limit the name to 12 full-width characters or 24 Roman characters. |
points |
The retailer's loyalty points in absolute value. |
ratio |
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. |
LoyaltyProgram
A message that represents loyalty program.
JSON representation |
---|
{ "programLabel": string, "tierLabel": string, "price": { object ( |
Fields | |
---|---|
program |
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. The label must be provided so that the system can associate the assets below (for example, price and points) with a merchant. The corresponding program must be linked to the merchant account. |
tier |
The label of the tier within the loyalty program. Must match one of the labels within the program. |
price |
The price for members of the given tier, that is, the instant discount price. Must be smaller or equal to the regular price. |
cashback |
The cashback that can be used for future purchases. |
loyalty |
The amount of loyalty points earned on a purchase. |
member |
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. |
shipping |
The label of the shipping benefit. If the field has value, this offer has loyalty shipping benefit. If the field value isn't provided, the item is not eligible for loyalty shipping for the given loyalty tier. |
ProductDimension
The dimension of the product.
JSON representation |
---|
{ "value": number, "unit": string } |
Fields | |
---|---|
value |
Required. The dimension value represented as a number. The value can have a maximum precision of four decimal places. |
unit |
Required. The dimension units. Acceptable values are: * " |
ProductWeight
The weight of the product.
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: * " |
Shipping
The Shipping of the product.
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. See region for more information. |
service |
A free-form description of the service class or delivery speed. |
location |
The numeric ID of a location that the shipping rate applies to as defined in the AdWords API. |
location |
The location where the shipping is applicable, represented by a location group name. |
postal |
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. |
min |
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 is received if it happens before the cut-off time. |
max |
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 is received if it happens before the cut-off time. Both |
min |
Minimum transit time (inclusive) between when the order has shipped and when it is delivered in business days. 0 means that the order is delivered on the same day as it ships. |
max |
Maximum transit time (inclusive) between when the order has shipped and when it is delivered in business days. 0 means that the order is delivered on the same day as it ships. Both |
FreeShippingThreshold
Conditions to be met for a product to have free shipping.
JSON representation |
---|
{
"country": string,
"priceThreshold": {
object ( |
Fields | |
---|---|
country |
The CLDR territory code of the country to which an item will ship. |
price |
The minimum product price for the shipping cost to become free. Represented as a number. |
ShippingWeight
The ShippingWeight of the product.
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. |
ShippingDimension
The ShippingDimension of the product.
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. |
Tax
The Tax of the product.
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. |
tax |
Set to true if tax is charged on shipping. |
location |
The numeric ID of a location that the tax rate applies to as defined in the AdWords API. |
postal |
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*. |
UnitPricingMeasure
The UnitPricingMeasure of the product.
JSON representation |
---|
{ "value": number, "unit": string } |
Fields | |
---|---|
value |
The measure of an item. |
unit |
The unit of the measure. |
UnitPricingBaseMeasure
The UnitPricingBaseMeasure of the product.
JSON representation |
---|
{ "value": string, "unit": string } |
Fields | |
---|---|
value |
The denominator of the unit price. |
unit |
The unit of the denominator. |
ProductDetail
The product details.
JSON representation |
---|
{ "sectionName": string, "attributeName": string, "attributeValue": string } |
Fields | |
---|---|
section |
The section header used to group a set of product details. |
attribute |
The name of the product detail. |
attribute |
The value of the product detail. |
CloudExportAdditionalProperties
Product property for the Cloud Retail API. For example, properties for a TV product could be "Screen-Resolution" or "Screen-Size".
JSON representation |
---|
{ "textValue": [ string ], "intValue": [ string ], "floatValue": [ number ], "propertyName": string, "boolValue": boolean, "minValue": number, "maxValue": number, "unitCode": string } |
Fields | |
---|---|
text |
Text value of the given property. For example, "8K(UHD)" could be a text value for a TV product. Maximum repeatedness of this value is 400. Values are stored in an arbitrary but consistent order. Maximum string size is 256 characters. |
int |
Integer values of the given property. For example, 1080 for a TV product's Screen Resolution. Maximum repeatedness of this value is 400. Values are stored in an arbitrary but consistent order. |
float |
Float values of the given property. For example for a TV product 1.2345. Maximum repeatedness of this value is 400. Values are stored in an arbitrary but consistent order. |
property |
Name of the given property. For example, "Screen-Resolution" for a TV product. Maximum string size is 256 characters. |
bool |
Boolean value of the given property. For example for a TV product, "True" or "False" if the screen is UHD. |
min |
Minimum float value of the given property. For example for a TV product 1.00. |
max |
Maximum float value of the given property. For example for a TV product 100.00. |
unit |
Unit of the given property. For example, "Pixels" for a TV product. Maximum string size is 256B. |
Certification
Product certification, initially introduced for EU energy efficiency labeling compliance using the EU EPREL database.
JSON representation |
---|
{ "certificationAuthority": string, "certificationName": string, "certificationCode": string, "certificationValue": string } |
Fields | |
---|---|
certification |
The certification authority, for example "European_Commission". Maximum length is 2000 characters. |
certification |
The name of the certification, for example "EPREL". Maximum length is 2000 characters. |
certification |
The certification code. Maximum length is 2000 characters. |
certification |
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.
JSON representation |
---|
{ "digitalSourceType": string, "content": string } |
Fields | |
---|---|
digital |
The digital source type, for example "trained_algorithmic_media". Following IPTC. Maximum length is 40 characters. |
content |
The title text Maximum length is 150 characters |
ProductStructuredDescription
Structured description, for algorithmically (AI)-generated descriptions.
JSON representation |
---|
{ "digitalSourceType": string, "content": string } |
Fields | |
---|---|
digital |
The digital source type, for example "trained_algorithmic_media". Following IPTC. Maximum length is 40 characters. |
content |
The description text Maximum length is 5000 characters |