- JSON representation
- AgeGroup
- Availability
- Condition
- Gender
- ProductInstallment
- CreditType
- SubscriptionCost
- SubscriptionPeriod
- LoyaltyPoints
- LoyaltyProgram
- ProductDimension
- ProductWeight
- Shipping
- CarrierShipping
- CarrierPriceOption
- CarrierTransitTimeOption
- FreeShippingThreshold
- ShippingWeight
- ShippingDimension
- ShippingBusinessDaysConfig
- HandlingCutoffTime
- SizeSystem
- SizeType
- EnergyEfficiencyClass
- UnitPricingMeasure
- UnitPricingBaseMeasure
- ProductDetail
- PickupMethod
- PickupSla
- Pause
- CloudExportAdditionalProperties
- ProductCertification
- CertificationAuthority
- CertificationName
- StructuredTitle
- DigitalSourceType
- StructuredDescription
- ProductSustainabilityIncentive
- Type
- ProductMinimumOrderValue
- Surface
Product attributes.
You can navigate to specific product attribute groups below:
Building descriptor set for google/shopping/merchant/products/v1main/products_common.proto... Dumping descriptor set... Extracting group names...Alternatively, if you know a part of the name of the field you are looking for, use the text input below to filter for the field:
JSON representation
| JSON representation |
|---|
{ "additionalImageLinks" : [ string ] , "expirationDate" : string , "disclosureDate" : string , "availabilityDate" : string , "gtins" : [ string ] , "price" : { object ( |
additionalImageLinks[]
string
Additional URLs of images of the item.
expirationDate
string (
Timestamp
format)
Date on which the item should expire, as specified upon insertion, in ISO 8601
format. The actual expiration date is exposed in productstatuses
as googleExpirationDate
and might be earlier if expirationDate
is too far in the future.
disclosureDate
string (
Timestamp
format)
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.
availabilityDate
gtins[]
string
Global Trade Item Numbers ( GTIN ) of the item. You can provide up to 10 GTINs.
price
object (
Price
)
Price of the item.
maximumRetailPrice
object (
Price
)
Maximum retail price (MRP) of the item. Applicable to India only.
installment
object (
ProductInstallment
)
Number and amount of installments to pay for an item.
subscriptionCost
object (
SubscriptionCost
)
Number of periods (weeks, months or years) and amount of payment per period for an item with an associated subscription contract.
loyaltyPoints
object (
LoyaltyPoints
)
Loyalty points that users receive after purchasing the item. Japan only.
loyaltyPrograms[]
object (
LoyaltyProgram
)
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.
productTypes[]
string
Categories of the item (formatted as in product data specification ).
salePrice
object (
Price
)
Advertised sale price of the item.
salePriceEffectiveDate
object (
Interval
)
Date range during which the item is on sale, see product data specification .
productHeight
object (
ProductDimension
)
The height of the product in the units provided. The value must be between 0 (exclusive) and 3000 (inclusive).
productLength
object (
ProductDimension
)
The length of the product in the units provided. The value must be between 0 (exclusive) and 3000 (inclusive).
productWidth
object (
ProductDimension
)
The width of the product in the units provided. The value must be between 0 (exclusive) and 3000 (inclusive).
productWeight
object (
ProductWeight
)
The weight of the product in the units provided. The value must be between 0 (exclusive) and 2000 (inclusive).
shipping[]
object (
Shipping
)
Shipping rules.
carrierShipping[]
object (
CarrierShipping
)
Rules for carrier-based shipping.
freeShippingThreshold[]
object (
FreeShippingThreshold
)
Conditions to be met for a product to have free shipping.
shippingWeight
object (
ShippingWeight
)
Weight of the item for shipping.
shippingLength
object (
ShippingDimension
)
Length of the item for shipping.
shippingWidth
object (
ShippingDimension
)
Width of the item for shipping.
shippingHeight
object (
ShippingDimension
)
Height of the item for shipping.
shippingHandlingBusinessDays[]
object (
ShippingBusinessDaysConfig
)
The business days during which orders can be handled. If not provided, Monday to Friday business days will be assumed.
shippingTransitBusinessDays[]
object (
ShippingBusinessDaysConfig
)
The business days during which orders are in transit. If not provided, Monday to Friday business days will be assumed.
handlingCutoffTimes[]
object (
HandlingCutoffTime
)
The handling cutoff times for shipping.
sizeTypes[]
unitPricingMeasure
object (
UnitPricingMeasure
)
The measure and dimension of an item.
unitPricingBaseMeasure
object (
UnitPricingBaseMeasure
)
The preference of the denominator of the unit price.
adsLabels[]
string
Similar to adsGrouping, but only works on CPC.
costOfGoodsSold
object (
Price
)
Cost of goods sold. Used for gross profit reporting.
productDetails[]
object (
ProductDetail
)
Technical specification or additional product details.
productHighlights[]
string
Bullet points describing the most relevant product highlights .
displayAdsSimilarIds[]
string
Advertiser-specified recommendations. For more information, see Display ads attribute specification .
promotionIds[]
string
The unique ID of a promotion.
includedDestinations[]
enum (
DestinationEnum
)
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
.
For more information, see Included destination .
Note: We recommend setting destinations on datasources level for most use cases. Use this field within products to only setup exceptions.
excludedDestinations[]
enum (
DestinationEnum
)
The list of destinations to exclude for this target (corresponds to unchecked check boxes in Merchant Center).
For more information, see Excluded destination .
Note: We recommend setting destinations on datasources level for most use cases. Use this field within products to only setup exceptions.
shoppingAdsExcludedCountries[]
string
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.
lifestyleImageLinks[]
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.
cloudExportAdditionalProperties[]
object (
CloudExportAdditionalProperties
)
Extra fields to export to the Cloud Retail program.
certifications[]
object (
ProductCertification
)
Product Certifications, for example for energy efficiency labeling of products recorded in the EU EPREL database. See the Help Center article for more information.
autoPricingMinPrice
object (
Price
)
A safeguard in the automated discounts and "Dynamic Promotions" ( https://support.google.com/merchants/answer/13949249 ) projects, ensuring that discounts on business offers do not fall below this value, thereby preserving the offer's value and profitability.
sustainabilityIncentives[]
object (
ProductSustainabilityIncentive
)
The list of sustainability incentive programs.
videoLinks[]
string
Optional. A list of video URLs for the item. Use this attribute to provide more visuals for your product beyond your image attributes. See the Help Center article for more information.
minimumOrderValues[]
object (
ProductMinimumOrderValue
)
The minimum value in the cart before a customer can initiate checkout. Supports multiple minimum order values. Different minimum order values can be specified per country, service and surface. Maximum entries: 100.
identifierExists
boolean
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.
isBundle
boolean
Whether the item is a business-defined sub-API. A sub-API is a custom grouping of different products sold by a business for a single price.
title
string
Title of the item.
description
string
Description of the item.
link
string
URL directly linking to your item's page on your online store.
mobileLink
string
URL for the mobile-optimized version of your item's landing page.
canonicalLink
string
URL for the canonical version of your item's landing page.
imageLink
string
URL of an image of the item.
adult
boolean
Set to true if the item is targeted towards adults.
availability
enum (
Availability
)
Availability status of the item.
brand
string
Brand of the item. For example, "Google".
color
string
Color of the item. For example, "red".
googleProductCategory
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.
itemGroupId
string
Shared identifier for all variants of the same product.
material
string
The material of which the item is made. For example, "Leather" or "Cotton".
mpn
string
Manufacturer Part Number ( MPN ) of the item.
pattern
string
The item's pattern . For example, polka dots.
sellOnGoogleQuantity
string ( int64
format)
The quantity of the product that is available for selling on Google. Supported only for online products.
maxHandlingTime
string ( int64
format)
Maximal product handling time (in business days).
minHandlingTime
string ( int64
format)
Minimal product handling time (in business days).
shippingLabel
string
The shipping label of the product, used to group products in account-level shipping rules. Max. 100 characters. For more information, see Shipping label .
returnPolicyLabel
string
The return label of the product, used to group products in account-level return policies. Max. 100 characters. For more information, see Return policy label .
transitTimeLabel
string
The transit time label of the product, used to group product in account-level transit time tables.
size
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
.
sizeSystem
enum (
SizeSystem
)
System in which the size is specified. Recommended for apparel items. For more information, see Size system .
energyEfficiencyClass
enum (
EnergyEfficiencyClass
)
The energy efficiency class as defined in EU directive 2010/30/EU.
minEnergyEfficiencyClass
enum (
EnergyEfficiencyClass
)
The energy efficiency class as defined in EU directive 2010/30/EU.
maxEnergyEfficiencyClass
enum (
EnergyEfficiencyClass
)
The energy efficiency class as defined in EU directive 2010/30/EU.
multipack
string ( int64
format)
The number of identical products in a business-defined multipack.
adsGrouping
string
Used to group items in an arbitrary way. Only for CPA%, discouraged otherwise. For more information, see Display ads attribute .
adsRedirect
string
Allows advertisers to override the item URL when the product is shown within the context of Product ads.
displayAdsId
string
An identifier for an item for dynamic remarketing campaigns.
displayAdsTitle
string
Title of an item for dynamic remarketing campaigns.
displayAdsLink
string
URL directly to your item's landing page for dynamic remarketing campaigns.
displayAdsValue
number
Offer margin for dynamic remarketing campaigns. For more information, see Display ads attribute .
pickupMethod
enum (
PickupMethod
)
The pickup option for the item.
pickupSla
enum (
PickupSla
)
Item store pickup timeline. For more information, see Pickup SLA .
linkTemplate
string
Link template for business hosted local storefront.
mobileLinkTemplate
string
Link template for business hosted local storefront optimized for mobile devices.
customLabel0
string
Custom label 0 for custom grouping of items in a Shopping campaign.
customLabel1
string
Custom label 1 for custom grouping of items in a Shopping campaign.
customLabel2
string
Custom label 2 for custom grouping of items in a Shopping campaign.
customLabel3
string
Custom label 3 for custom grouping of items in a Shopping campaign.
customLabel4
string
Custom label 4 for custom grouping of items in a Shopping campaign.
externalSellerId
string
Required for multi-seller accounts. Use this attribute if you're a marketplace uploading products for various sellers to your multi-seller account.
virtualModelLink
string
URL of the 3D image of the item. See the Help Center article for more information.
structuredTitle
object (
StructuredTitle
)
Structured title, for algorithmically (AI)-generated titles.
structuredDescription
object (
StructuredDescription
)
Structured description, for algorithmically (AI)-generated descriptions.
AgeGroup
Target age group of the item.
| Enums | |
|---|---|
AGE_GROUP_UNSPECIFIED
|
Age group is not specified. |
ADULT
|
Teens or older. |
KIDS
|
5-13 years old. |
TODDLER
|
1-5 years old. |
INFANT
|
3-12 months old. |
NEWBORN
|
0-3 months old. |
Availability
Availability status of the item.
| Enums | |
|---|---|
AVAILABILITY_UNSPECIFIED
|
Availability is not specified. |
IN_STOCK
|
In stock. |
OUT_OF_STOCK
|
Out of stock. |
PREORDER
|
Pre-order. |
LIMITED_AVAILABILITY
|
Limited availability. |
BACKORDER
|
Backorder. |
Condition
Condition or state of the item.
| Enums | |
|---|---|
CONDITION_UNSPECIFIED
|
Default value. This value is unused. |
NEW
|
Brand new, original, unopened packaging. |
USED
|
Previously used, original packaging opened or missing. |
REFURBISHED
|
Professionally restored to working order, comes with a warranty, may or may not have the original packaging. |
Gender
Target gender of the item.
| Enums | |
|---|---|
GENDER_UNSPECIFIED
|
Gender is not specified. |
MALE
|
Male. |
FEMALE
|
Female. |
UNISEX
|
Unisex. |
ProductInstallment
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. |
creditType
|
Type of installment payments. |
annualPercentageRate
|
Optional. Annual percentage rate for |
CreditType
Type of installment payments.
| Enums | |
|---|---|
CREDIT_TYPE_UNSPECIFIED
|
Default value. This value is unused. |
FINANCE
|
Finance. |
LEASE
|
Lease. |
SubscriptionCost
The SubscriptionCost of the product.
| JSON representation |
|---|
{ "period" : enum ( |
| Fields | |
|---|---|
period
|
The type of subscription period. Supported values are: * " |
periodLength
|
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. |
WEEK
|
Indicates that the subscription period is week. |
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. |
pointsValue
|
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 | |
|---|---|
programLabel
|
The label of the loyalty program. This is an internal label that uniquely identifies the relationship between a business 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 business. The corresponding program must be linked to the Merchant Center account. |
tierLabel
|
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. |
cashbackForFutureUse
|
The cashback that can be used for future purchases. |
loyaltyPoints
|
The amount of loyalty points earned on a purchase. |
memberPriceEffectiveDate
|
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. |
shippingLabel
|
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. |
locationId
|
The numeric ID of a location that the shipping rate applies to as defined in the AdWords 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. |
loyaltyProgramLabel
|
Optional. The label of the loyalty program
. Must match one of the program labels set in |
loyaltyTierLabel
|
Optional. The label of the loyalty tier
within the loyalty program. Must match one of the tiers set in the |
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 is received if it happens before the cut-off time. |
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 is received if it happens before the cut-off time. Both |
minTransitTime
|
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. |
maxTransitTime
|
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 |
handlingCutoffTime
|
The handling cutoff time until which an order has to be placed to be processed in the same day. This is a string in format of HHMM (e.g. |
handlingCutoffTimezone
|
Timezone identifier
For example |
CarrierShipping
Carrier-based shipping configuration. Allows for setting shipping speed or shipping cost based on a carrier's provided info.
| JSON representation |
|---|
{ "country" : string , "region" : string , "postalCode" : string , "originPostalCode" : string , "flatPrice" : { object ( |
| Fields | |
|---|---|
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. |
postalCode
|
The postal code range that the shipping rate applies to, represented by a postal code (eg. |
originPostalCode
|
The source location postal code from which this offer ships. Represented only by a full-length postal code. |
flatPrice
|
Fixed shipping price, represented as a number with currency. Cannot be set together with |
carrierPrice
|
Selected carrier to calculate the shipping price from. Select a carrier from the available carriers list
, for example |
carrierPriceFlatAdjustment
|
A flat adjustment on the carrier price. Can be either positive or negative. Cannot be zero. Requires |
carrierPricePercentageAdjustment
|
A percentual adjustment on the carrier price. Can be either positive or negative. Cannot be zero. Requires |
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 is received if it happens before the cut-off time. |
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 is received if it happens before the cut-off time. Both |
fixedMinTransitTime
|
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. |
fixedMaxTransitTime
|
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. Needs to be provided together with |
carrierTransitTime
|
Selected carrier to calculate the shipping speed from. Select a carrier from the available carriers list
, for example |
CarrierPriceOption
Possible carrier where price is coming from.
| Enums | |
|---|---|
CARRIER_PRICE_OPTION_UNSPECIFIED
|
Carrier price option is unspecified. |
AUSTRALIA_POST_REGULAR
|
Australia Post Regular shipping service. |
AUSTRALIA_POST_EXPRESS
|
Australia Post Express shipping service. |
AUSTRALIA_POST_REGULAR_S
|
Australia Post Regular Small shipping service. |
AUSTRALIA_POST_REGULAR_M
|
Australia Post Regular Medium shipping service. |
AUSTRALIA_POST_REGULAR_L
|
Australia Post Regular Large shipping service. |
AUSTRALIA_POST_REGULAR_XL
|
Australia Post Regular XL shipping service. |
AUSTRALIA_POST_EXPRESS_S
|
Australia Post Express Small shipping service. |
AUSTRALIA_POST_EXPRESS_M
|
Australia Post Express Medium shipping service. |
AUSTRALIA_POST_EXPRESS_L
|
Australia Post Express Large shipping service. |
AUSTRALIA_POST_EXPRESS_XL
|
Australia Post Express XL shipping service. |
TNT_ROAD_EXPRESS
|
TNT Road Express shipping service. |
TNT_OVERNIGHT_EXPRESS
|
TNT Overnight Express shipping service. |
TOLL_ROAD_DELIVERY
|
Toll Road Delivery shipping service. |
TOLL_OVERNIGHT_PRIORITY
|
Toll Overnight Priority shipping service. |
DHL_PAKET
|
DHL Paket shipping service. |
DHL_PACKCHEN
|
DHL Packchen shipping service. |
DPD_EXPRESS_12
|
DPD Express 12 shipping service. |
DPD_EXPRESS
|
DPD Express shipping service. |
DPD_CLASSIC_PARCEL
|
DPD Classic Parcel shipping service. |
HERMES_PACKCHEN
|
Hermes Packchen shipping service. |
HERMES_PAKETKLASSE_S
|
Hermes Paketklasse S shipping service. |
HERMES_PAKETKLASSE_M
|
Hermes Paketklasse M shipping service. |
HERMES_PAKETKLASSE_L
|
Hermes Paketklasse L shipping service. |
UPS_EXPRESS
|
UPS Express shipping service. |
UPS_EXPRESS_SAVER
|
UPS Express Saver shipping service. |
UPS_EXPRESS_STANDARD
|
UPS Express Standard shipping service. |
DHL_EXPRESS
|
DHL Express shipping service. |
DHL_EXPRESS_12
|
DHL Express 12 shipping service. |
DPD_NEXT_DAY
|
DPD Next Day shipping service. |
DPD_STANDARD_NEXT_DAY
|
DPD Standard Next Day shipping service. |
DPD_STANDARD_TWO_DAY
|
DPD Standard Two Day shipping service. |
RMG_1ST_CLASS_SMALL
|
RMG 1st Class Small shipping service. |
RMG_1ST_CLASS_MEDIUM
|
RMG 1st Class Medium shipping service. |
RMG_2ND_CLASS_SMALL
|
RMG 2nd Class Small shipping service. |
RMG_2ND_CLASS_MEDIUM
|
RMG 2nd Class Medium shipping service. |
TNT_EXPRESS
|
TNT Express shipping service. |
TNT_EXPRESS_10
|
TNT Express 10 shipping service. |
TNT_EXPRESS_12
|
TNT Express 12 shipping service. |
YODEL_B2C_48HR
|
Yodel B2C 48HR shipping service. |
YODEL_B2C_72HR
|
Yodel B2C 72HR shipping service. |
YODEL_B2C_PACKET
|
Yodel B2C Packet shipping service. |
FEDEX_GROUND
|
FedEx Ground shipping service. |
FEDEX_HOME_DELIVERY
|
FedEx Home Delivery shipping service. |
FEDEX_EXPRESS_SAVER
|
FedEx Express Saver shipping service. |
FEDEX_FIRST_OVERNIGHT
|
FedEx First Overnight shipping service. |
FEDEX_PRIORITY_OVERNIGHT
|
FedEx Priority Overnight shipping service. |
FEDEX_STANDARD_OVERNIGHT
|
FedEx Standard Overnight shipping service. |
FEDEX_2DAY
|
FedEx 2Day shipping service. |
UPS_STANDARD
|
UPS Standard shipping service. |
UPS_2ND_DAY_AIR
|
UPS 2nd Day Air shipping service. |
UPS_2ND_DAY_AM
|
UPS 2nd Day AM shipping service. |
UPS_3_DAY_SELECT
|
UPS 3 Day Select shipping service. |
UPS_GROUND
|
UPS Ground shipping service. |
UPS_NEXT_DAY_AIR
|
UPS Next Day Air shipping service. |
UPS_NEXT_DAY_AIR_EARLY_AM
|
UPS Next Day Air Early AM shipping service. |
UPS_NEXT_DAY_AIR_SAVER
|
UPS Next Day Air Saver shipping service. |
USPS_PRIORITY_MAIL_EXPRESS
|
USPS Priority Mail Express shipping service. |
USPS_MEDIA_MAIL
|
USPS Media Mail shipping service. |
USPS_GROUND_ADVANTAGE_RETAIL
|
USPS Ground Advantage Retail shipping service. |
USPS_PRIORITY_MAIL
|
USPS Priority Mail shipping service. |
USPS_GROUND_ADVANTAGE_COMMERCIAL
|
USPS Ground Advantage Commercial shipping service. |
CarrierTransitTimeOption
Possible carrier where transit time is coming from.
| Enums | |
|---|---|
CARRIER_TRANSIT_TIME_OPTION_UNSPECIFIED
|
Carrier transit time option is unspecified. |
DHL_PAKET
|
DHL Paket shipping service. |
DHL_PACKCHEN
|
DHL Packchen shipping service. |
DHL_EXPRESSEASY
|
DHL Express Easy shipping service. |
DPD_EXPRESS
|
DPD Express shipping service. |
DPD_CLASSIC_PARCEL
|
DPD Classic Parcel shipping service. |
HERMES_HAUSTUR
|
Hermes Haustur shipping service. |
HERMES_PAKETSHOP
|
Hermes Paketshop shipping service. |
GLS_BUSINESS
|
GLS Business shipping service. |
GLS_EXPRESS
|
GLS Express shipping service. |
GLS_PRIVATE
|
GLS Private shipping service. |
COLISSIMO_DOMICILE
|
Colissimo Domicile shipping service. |
DHL_EXPRESS_12AM
|
DHL Express 12 AM shipping service. |
DHL_EXPRESS_9AM
|
DHL Express 9 AM shipping service. |
GEODIS_EXPRESS
|
GEODIS Express shipping service. |
GEODIS_PACK_30
|
GEODIS Pack 30 shipping service. |
GEODIS_SAME_DAY
|
GEODIS Same Day shipping service. |
GEODIS_TOP_24
|
GEODIS Top 24 shipping service. |
TNT_ESSENTIEL_24H
|
TNT Essentiel 24H shipping service. |
TNT_ESSENTIEL_FLEXIBILITE
|
TNT Essentiel Flexibilite shipping service. |
FEDEX_GROUND
|
FedEx Ground shipping service. |
FEDEX_HOME_DELIVERY
|
FedEx Home Delivery shipping service. |
FEDEX_EXPRESS_SAVER
|
FedEx Express Saver shipping service. |
FEDEX_FIRST_OVERNIGHT
|
FedEx First Overnight shipping service. |
FEDEX_PRIORITY_OVERNIGHT
|
FedEx Priority Overnight shipping service. |
FEDEX_STANDARD_OVERNIGHT
|
FedEx Standard Overnight shipping service. |
FEDEX_2DAY
|
FedEx 2Day shipping service. |
UPS_2ND_DAY_AIR
|
UPS 2nd Day Air shipping service. |
UPS_2ND_DAY_AM
|
UPS 2nd Day AM shipping service. |
UPS_3_DAY_SELECT
|
UPS 3 Day Select shipping service. |
UPS_GROUND
|
UPS Ground shipping service. |
UPS_NEXT_DAY_AIR
|
UPS Next Day Air shipping service. |
UPS_NEXT_DAY_AIR_EARLY_AM
|
UPS Next Day Air Early AM shipping service. |
UPS_NEXT_DAY_AIR_SAVER
|
UPS Next Day Air Saver shipping service. |
USPS_PRIORITY_MAIL_EXPRESS
|
USPS Priority Mail Express shipping service. |
USPS_MEDIA_MAIL
|
USPS Media Mail shipping service. |
USPS_GROUND_ADVANTAGE_RETAIL
|
USPS Ground Advantage Retail shipping service. |
USPS_PRIORITY_MAIL
|
USPS Priority Mail shipping service. |
USPS_GROUND_ADVANTAGE_COMMERCIAL
|
USPS Ground Advantage Commercial shipping service. |
USPS_FIRST_CLASS_MAIL
|
USPS First Class Mail shipping service. |
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. |
priceThreshold
|
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. |
ShippingBusinessDaysConfig
The business days during which orders are on their path to fulfillment. If not provided, Monday to Friday business days will be assumed.
| JSON representation |
|---|
{ "country" : string , "businessDays" : string } |
| Fields | |
|---|---|
country
|
The CLDR territory code of the country to which an item will ship. |
businessDays
|
Effective days of the week considered for the delivery time calculation. May not be empty. The more business days included the faster the delivery. Can be set through individual days (e.g. |
HandlingCutoffTime
Configuration for offer or offer-country level shipping handling cutoff time.
| JSON representation |
|---|
{ "country" : string , "cutoffTime" : string , "cutoffTimezone" : string , "disableDeliveryAfterCutoff" : boolean } |
| Fields | |
|---|---|
country
|
The CLDR territory code of the country to which the handling cutoff time applies. |
cutoffTime
|
The handling cutoff time until which an order has to be placed to be processed in the same day. This is a string in format of HHMM (e.g. |
cutoffTimezone
|
Timezone identifier For example 'Europe/Zurich'. If not set, the shipping destination timezone will be used. |
disableDeliveryAfterCutoff
|
This field only applies to same-day delivery. If true, prevents next-day delivery from being shown for this offer after the cutoff time. This field only applies to same-day delivery offers, for merchants who want to explicitly disable it. |
SizeSystem
System in which the size is specified. Recommended for apparel items. For more information, see Size system .
| Enums | |
|---|---|
SIZE_SYSTEM_UNSPECIFIED
|
Unspecified size system. |
AU
|
AU. |
BR
|
BR. |
CN
|
CN. |
DE
|
DE. |
EU
|
EU. |
FR
|
FR. |
IT
|
IT. |
JP
|
JP. |
MEX
|
MEX. |
UK
|
UK. |
US
|
US. |
SizeType
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 Size type .
| Enums | |
|---|---|
SIZE_TYPE_UNSPECIFIED
|
The size type is not specified. |
REGULAR
|
Regular size. |
PETITE
|
Petite size. |
MATERNITY
|
Maternity size. |
BIG
|
Big size. |
TALL
|
Tall size. |
PLUS
|
Plus size. |
EnergyEfficiencyClass
The energy efficiency class as defined in EU directive 2010/30/EU.
| Enums | |
|---|---|
ENERGY_EFFICIENCY_CLASS_UNSPECIFIED
|
The energy efficiency class is unspecified. |
APPP
|
A+++. |
APP
|
A++. |
AP
|
A+. |
A
|
A. |
B
|
B. |
C
|
C. |
D
|
D. |
E
|
E. |
F
|
F. |
G
|
G. |
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 | |
|---|---|
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. |
PickupMethod
The pickup option for the item.
| Enums | |
|---|---|
PICKUP_METHOD_UNSPECIFIED
|
Pickup method is not specified. |
NOT_SUPPORTED
|
The item is not available for store pickup. |
BUY
|
The entire transaction occurs online. |
RESERVE
|
The item is reserved online and the transaction occurs in-store. |
SHIP_TO_STORE
|
The item is purchased online and shipped to a local store for the customer to pick up. |
PickupSla
Item store pickup timeline. For more information, see Pickup SLA .
| Enums | |
|---|---|
PICKUP_SLA_UNSPECIFIED
|
Pickup SLA is not specified. |
SAME_DAY
|
Indicates that the product is available for pickup the same day that the order is placed, subject to cut off times. |
NEXT_DAY
|
Indicates that the product is available for pickup the following day that the order is placed. |
TWO_DAY
|
Indicates that the product will be shipped to a store for a customer to pick up in 2 days. |
THREE_DAY
|
Indicates that the product will be shipped to a store for a customer to pick up in 3 days. |
FOUR_DAY
|
Indicates that the product will be shipped to a store for a customer to pick up in 4 days |
FIVE_DAY
|
Indicates that the product will be shipped to a store for a customer to pick up in 5 days. |
SIX_DAY
|
Indicates that the product will be shipped to a store for a customer to pick up in 6 days. |
MULTI_WEEK
|
Indicates that the product will be shipped to a store for a customer to pick up in one week or more. |
Pause
Publication of this item will be temporarily paused .
| Enums | |
|---|---|
PAUSE_UNSPECIFIED
|
The pause is unspecified. |
ADS
|
You’re currently pausing your product for all ads locations (including Shopping Ads, Display Ads, and local inventory ads). |
ALL
|
You’re currently pausing your product for all Shopping locations (including Shopping Ads, Display Ads, local inventory ads, Buy on Google, and free listings). |
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 | |
|---|---|
textValue[]
|
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. |
intValue[]
|
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. |
floatValue[]
|
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. |
propertyName
|
Name of the given property. For example, "Screen-Resolution" for a TV product. 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. |
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 256B. |
ProductCertification
Product certification , initially introduced for EU energy efficiency labeling compliance using the EU EPREL database.
| JSON representation |
|---|
{ "certificationAuthority" : enum ( |
| Fields | |
|---|---|
certificationAuthority
|
The certification authority. |
certificationName
|
The name of the certification. |
certificationCode
|
The certification code. 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. |
CertificationAuthority
The certification authority.
| Enums | |
|---|---|
CERTIFICATION_AUTHORITY_UNSPECIFIED
|
Certification authority is not specified. |
ADEME
|
For the French CO2 emissions class for vehicles. |
BMWK
|
For the German CO2 emissions classes for vehicles. |
EPA
|
Environment Protection Agency. |
EC
|
European Commission for energy labels in the EU. |
CertificationName
The name of the certification.
| Enums | |
|---|---|
CERTIFICATION_NAME_UNSPECIFIED
|
Certification name is not specified. |
ENERGY_STAR
|
Energy Star. |
ENERGY_STAR_MOST_EFFICIENT
|
Energy Star Most Efficient. |
EPREL
|
Represents energy efficiency certifications in the EU European Registry for Energy Labeling (EPREL) database. |
EU_ECOLABEL
|
EU Ecolabel. |
VEHICLE_ENERGY_EFFICIENCY
|
The overall CO2 class of a vehicle |
VEHICLE_ENERGY_EFFICIENCY_DISCHARGED_BATTERY
|
For the CO2 class of a vehicle with a discharged battery. |
StructuredTitle
Structured title, for algorithmically (AI)-generated titles.
| JSON representation |
|---|
{
"digitalSourceType"
:
enum (
|
| Fields | |
|---|---|
digitalSourceType
|
The digital source type. Following IPTC . |
content
|
The title text Maximum length is 150 characters |
DigitalSourceType
The digital source type. Following IPTC .
| Enums | |
|---|---|
DIGITAL_SOURCE_TYPE_UNSPECIFIED
|
Digital source type is unspecified. |
TRAINED_ALGORITHMIC_MEDIA
|
Text created algorithmically using a model derived from sampled content. |
DEFAULT
|
Text NOT created algorithmically using a model derived from sampled content (the default) |
StructuredDescription
Structured description, for algorithmically (AI)-generated descriptions.
| JSON representation |
|---|
{
"digitalSourceType"
:
enum (
|
| Fields | |
|---|---|
digitalSourceType
|
The digital source type. Following IPTC . |
content
|
The description text Maximum length is 5000 characters |
ProductSustainabilityIncentive
Information regarding sustainability-related incentive programs such as rebates or tax relief.
| JSON representation |
|---|
{ // Union field |
Type
Types of supported sustainability incentive programs.
| Enums | |
|---|---|
TYPE_UNSPECIFIED
|
Unspecified or unknown sustainability incentive type. |
EV_TAX_CREDIT
|
Program offering tax liability reductions for electric vehicles and, in some countries, plug-in hybrids. These reductions can be based on a specific amount or a percentage of the sale price. |
EV_PRICE_DISCOUNT
|
A subsidy program, often called an environmental bonus, provides a purchase grant for electric vehicles and, in some countries, plug-in hybrids. The grant amount may be a fixed sum or a percentage of the sale price. |
ProductMinimumOrderValue
The minimum order value in the cart before the checkout is permitted.
| JSON representation |
|---|
{ "country" : string , "service" : string , "surface" : enum ( |
| Fields | |
|---|---|
country
|
Required. The CLDR territory code of the country to which an item will ship. |
service
|
A free-form description of the service class or delivery speed. This should match the service value set for the Shipping attribute. See |
surface
|
The surface to which the minimum order value applies. Defaults to |
price
|
Required. The minimum cart or basket value before the checkout is permitted. |
Surface
The surface values to which the minimum order value applies.
| Enums | |
|---|---|
SURFACE_UNSPECIFIED
|
Surface is unspecified. |
ONLINE
|
Surface value to indicate online purchases. |
LOCAL
|
Surface value to indicate local purchases. |
ONLINE_LOCAL
|
Surface value to indicate online and local purchases. |

