REST Resource: accounts.products

Resource: Product

The processed product, built from multiple [product inputs][[google.shopping.content.bundles.Products.ProductInput] after applying rules and supplemental data sources. This processed product matches what is shown in your Merchant Center account and in Shopping ads and other surfaces across Google. Each product is built from exactly one primary data source product input, and multiple supplemental data source inputs. After inserting, updating, or deleting a product input, it may take several minutes before the updated processed product can be retrieved.

All fields in the processed product and its sub-messages match the name of their corresponding attribute in the Product data specification with some exceptions.

JSON representation 
{
  "name": string,
  "channel": enum (ChannelEnum),
  "offerId": string,
  "contentLanguage": string,
  "feedLabel": string,
  "dataSource": string,
  "attributes": {
    object (Attributes)
  },
  "customAttributes": [
    {
      object (CustomAttribute)
    }
  ],
  "productStatus": {
    object (ProductStatus)
  },
  "versionNumber": string
}
Fields
name

string

The name of the product. Format: "{product.name=accounts/{account}/products/{product}}"
channel

enum (ChannelEnum)

Output only. The channel of the product.
offerId

string

Output only. Your unique identifier for the product. This is the same for the product input and processed product. Leading and trailing whitespaces are stripped and multiple whitespaces are replaced by a single whitespace upon submission. See the product data specification for details.
contentLanguage

string

Output only. The two-letter ISO 639-1 language code for the product.
feedLabel

string

Output only. The feed label for the product.
dataSource

string

Output only. The primary data source of the product.
attributes

object (Attributes)

Output only. A list of product attributes.
customAttributes[]

object (CustomAttribute)

Output only. A list of custom (merchant-provided) attributes. It can also be used to submit any attribute of the data 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.
productStatus

object (ProductStatus)

Output only. The status of a product, data validation issues, that is, information about a product computed asynchronously.
versionNumber

string (int64 format)

Output only. Represents the existing version (freshness) of the product, which can be used to preserve the right order when multiple updates are done at the same time.

If set, the insertion is prevented when version number is lower than the current version number of the existing product. Re-insertion (for example, product refresh after 30 days) can be performed with the current versionNumber.

Only supported for insertions into primary data sources.

If the operation is prevented, the aborted exception will be thrown.

Attributes

Attributes.

JSON representation 
{
  "additionalImageLinks": [
    string
  ],
  "expirationDate": string,
  "disclosureDate": string,
  "availabilityDate": string,
  "price": {
    object (Price)
  },
  "installment": {
    object (Installment)
  },
  "subscriptionCost": {
    object (SubscriptionCost)
  },
  "loyaltyPoints": {
    object (LoyaltyPoints)
  },
  "loyaltyPrograms": [
    {
      object (LoyaltyProgram)
    }
  ],
  "productTypes": [
    string
  ],
  "salePrice": {
    object (Price)
  },
  "salePriceEffectiveDate": {
    object (Interval)
  },
  "productHeight": {
    object (ProductDimension)
  },
  "productLength": {
    object (ProductDimension)
  },
  "productWidth": {
    object (ProductDimension)
  },
  "productWeight": {
    object (ProductWeight)
  },
  "shipping": [
    {
      object (Shipping)
    }
  ],
  "freeShippingThreshold": [
    {
      object (FreeShippingThreshold)
    }
  ],
  "shippingWeight": {
    object (ShippingWeight)
  },
  "shippingLength": {
    object (ShippingDimension)
  },
  "shippingWidth": {
    object (ShippingDimension)
  },
  "shippingHeight": {
    object (ShippingDimension)
  },
  "sizeTypes": [
    string
  ],
  "taxes": [
    {
      object (Tax)
    }
  ],
  "unitPricingMeasure": {
    object (UnitPricingMeasure)
  },
  "unitPricingBaseMeasure": {
    object (UnitPricingBaseMeasure)
  },
  "adsLabels": [
    string
  ],
  "costOfGoodsSold": {
    object (Price)
  },
  "productDetails": [
    {
      object (ProductDetail)
    }
  ],
  "productHighlights": [
    string
  ],
  "displayAdsSimilarIds": [
    string
  ],
  "promotionIds": [
    string
  ],
  "includedDestinations": [
    string
  ],
  "excludedDestinations": [
    string
  ],
  "shoppingAdsExcludedCountries": [
    string
  ],
  "lifestyleImageLinks": [
    string
  ],
  "cloudExportAdditionalProperties": [
    {
      object (CloudExportAdditionalProperties)
    }
  ],
  "certifications": [
    {
      object (Certification)
    }
  ],
  "autoPricingMinPrice": {
    object (Price)
  },
  "identifierExists": boolean,
  "isBundle": boolean,
  "title": string,
  "description": string,
  "link": string,
  "mobileLink": string,
  "canonicalLink": string,
  "imageLink": string,
  "adult": boolean,
  "ageGroup": string,
  "availability": string,
  "brand": string,
  "color": string,
  "condition": string,
  "gender": string,
  "googleProductCategory": string,
  "gtin": string,
  "itemGroupId": string,
  "material": string,
  "mpn": string,
  "pattern": string,
  "sellOnGoogleQuantity": string,
  "maxHandlingTime": string,
  "minHandlingTime": string,
  "shippingLabel": string,
  "transitTimeLabel": string,
  "size": string,
  "sizeSystem": string,
  "taxCategory": string,
  "energyEfficiencyClass": string,
  "minEnergyEfficiencyClass": string,
  "maxEnergyEfficiencyClass": string,
  "multipack": string,
  "adsGrouping": string,
  "adsRedirect": string,
  "displayAdsId": string,
  "displayAdsTitle": string,
  "displayAdsLink": string,
  "displayAdsValue": number,
  "pickupMethod": string,
  "pickupSla": string,
  "linkTemplate": string,
  "mobileLinkTemplate": string,
  "customLabel0": string,
  "customLabel1": string,
  "customLabel2": string,
  "customLabel3": string,
  "customLabel4": string,
  "externalSellerId": string,
  "pause": string,
  "virtualModelLink": string,
  "structuredTitle": {
    object (ProductStructuredTitle)
  },
  "structuredDescription": {
    object (ProductStructuredDescription)
  }
}
Fields
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]( https://support.google.com/merchants/answer/13034208) for more information.
availabilityDate

string (Timestamp format)

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

object (Price)

Price of the item.
installment

object (Installment)

Number and amount of installments to pay for an item.
subscriptionCost

object (SubscriptionCost)

Number of periods (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.
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.
sizeTypes[]

string

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[]

object (Tax)

Tax information.
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 highlights of a product.
displayAdsSimilarIds[]

string

Advertiser-specified recommendations.
promotionIds[]

string

The unique ID of a promotion.
includedDestinations[]

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.
excludedDestinations[]

string

The list of destinations to exclude for this target (corresponds to unchecked check boxes in Merchant Center).
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.
cloudExportAdditionalProperties[]

object (CloudExportAdditionalProperties)

Extra fields to export to the Cloud Retail program.
certifications[]

object (Certification)

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" (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.
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 merchant-defined bundle. A bundle is a custom grouping of different products sold by a merchant for a single price.
title

string

Title of the item.
description

string

Description of the item.
adult

boolean

Set to true if the item is targeted towards adults.
ageGroup

string

Target age group of the item.
availability

string

Availability status of the item.
brand

string

Brand of the item.
color

string

Color of the item.
condition

string

Condition or state of the item.
gender

string

Target gender of the item.
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.
gtin

string

Global Trade Item Number (GTIN) of the item.
itemGroupId

string

Shared identifier for all variants of the same product.
material

string

The material of which the item is made.
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 product in account-level shipping rules.
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 [https://support.google.com/merchants/answer/6324492](size definition)).
sizeSystem

string

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

string

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

string

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

string

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

string

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

string (int64 format)

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

string

Used to group items in an arbitrary way. Only for CPA%, discouraged otherwise.
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.
displayAdsValue

number

Offer margin for dynamic remarketing campaigns.
pickupMethod

string

The pick up option for the item.
pickupSla

string

Item store pickup timeline.
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.
pause

string

Publication of this item will be temporarily paused.
structuredTitle

object (ProductStructuredTitle)

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

object (ProductStructuredDescription)

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

Installment

A message that represents installment.

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

string (int64 format)

The number of installments the buyer has to pay.
amount

object (Price)

The amount the buyer has to pay per month.
downpayment

object (Price)

The up-front down payment amount the buyer has to pay.
creditType

string

Type of installment payments. Supported values are: * "finance" * "lease"

SubscriptionCost

The SubscriptionCost of the product.

JSON representation 
{
  "period": enum (SubscriptionPeriod),
  "periodLength": string,
  "amount": {
    object (Price)
  }
}
Fields
period

enum (SubscriptionPeriod)

The type of subscription period. Supported values are: * "month" * "year"
periodLength

string (int64 format)

The number of subscription periods the buyer has to pay.
amount

object (Price)

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

string

Name of loyalty points program. It is recommended to limit the name to 12 full-width characters or 24 Roman characters.
pointsValue

string (int64 format)

The retailer's loyalty points in absolute value.
ratio

number

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 (Price)
  },
  "cashbackForFutureUse": {
    object (Price)
  },
  "loyaltyPoints": string
}
Fields
programLabel

string

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

string

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

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

object (Price)

The cashback that can be used for future purchases.
loyaltyPoints

string (int64 format)

The amount of loyalty points earned on a purchase.

ProductDimension

The dimension of the product.

JSON representation 
{
  "value": number,
  "unit": string
}
Fields
value

number

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

string

Required. The dimension units. Acceptable values are: * "in" * "cm"

ProductWeight

The weight of the product.

JSON representation 
{
  "value": number,
  "unit": string
}
Fields
value

number

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

string

Required. The weight unit. Acceptable values are: * "g" * "kg" * "oz" * "lb"

Shipping

The Shipping of the product.

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

object (Price)

Fixed shipping price, represented as a number.
country

string

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

string

The geographic region to which a shipping rate applies. See region for more information.
service

string

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

string (int64 format)

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

string

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

string

The postal code range that the shipping rate applies to, represented by a postal code, a postal code prefix followed by a * wildcard, a range between two postal codes or two postal code prefixes of equal length.
minHandlingTime

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 is received if it happens before the cut-off time. [minHandlingTime][google.shopping.content.bundles.Products.Shipping.min_handling_time] can only be present together with [maxHandlingTime][google.shopping.content.bundles.Products.Shipping.max_handling_time]; but it is not required if [maxHandlingTime][google.shopping.content.bundles.Products.Shipping.max_handling_time] is present.
maxHandlingTime

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 is received if it happens before the cut-off time. Both [maxHandlingTime][google.shopping.content.bundles.Products.Shipping.max_handling_time] and [maxTransitTime][google.shopping.content.bundles.Products.Shipping.max_transit_time] are required if providing shipping speeds. [minHandlingTime][google.shopping.content.bundles.Products.Shipping.min_handling_time] is optional if [maxHandlingTime][google.shopping.content.bundles.Products.Shipping.max_handling_time] is present.
minTransitTime

string (int64 format)

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. [minTransitTime][google.shopping.content.bundles.Products.Shipping.min_transit_time] can only be present together with [maxTransitTime][google.shopping.content.bundles.Products.Shipping.max_transit_time]; but it is not required if [maxTransitTime][google.shopping.content.bundles.Products.Shipping.max_transit_time] is present.
maxTransitTime

string (int64 format)

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 [maxHandlingTime][google.shopping.content.bundles.Products.Shipping.max_handling_time] and [maxTransitTime][google.shopping.content.bundles.Products.Shipping.max_transit_time] are required if providing shipping speeds. [minTransitTime][google.shopping.content.bundles.Products.Shipping.min_transit_time] is optional if [maxTransitTime][google.shopping.content.bundles.Products.Shipping.max_transit_time] is present.

FreeShippingThreshold

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

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

string

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

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

number

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

string

The unit of value.

ShippingDimension

The ShippingDimension of the product.

JSON representation 
{
  "value": number,
  "unit": string
}
Fields
value

number

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

string

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

number

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

string

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

string

The geographic region to which the tax rate applies.
taxShip

boolean

Set to true if tax is charged on shipping.
locationId

string (int64 format)

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

string

The postal code range that the tax rate applies to, represented by a ZIP code, a ZIP code prefix using * wildcard, a range between two ZIP codes or two ZIP code prefixes of equal length. Examples: 94114, 94*, 94002-95460, 94*-95*.

UnitPricingMeasure

The UnitPricingMeasure of the product.

JSON representation 
{
  "value": number,
  "unit": string
}
Fields
value

number

The measure of an item.
unit

string

The unit of the measure.

UnitPricingBaseMeasure

The UnitPricingBaseMeasure of the product.

JSON representation 
{
  "value": string,
  "unit": string
}
Fields
value

string (int64 format)

The denominator of the unit price.
unit

string

The unit of the denominator.

ProductDetail

The product details.

JSON representation 
{
  "sectionName": string,
  "attributeName": string,
  "attributeValue": string
}
Fields
sectionName

string

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

string

The name of the product detail.
attributeValue

string

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
textValue[]

string

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[]

string (int64 format)

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[]

number

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

string

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

boolean

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

number

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

number

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

string

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
certificationAuthority

string

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

string

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

string

The certification code. Maximum length is 2000 characters.
certificationValue

string

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
digitalSourceType

string

The digital source type, for example "trained_algorithmic_media". Following IPTC. Maximum length is 40 characters.
content

string

The title text Maximum length is 150 characters

ProductStructuredDescription

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

JSON representation 
{
  "digitalSourceType": string,
  "content": string
}
Fields
digitalSourceType

string

The digital source type, for example "trained_algorithmic_media". Following IPTC. Maximum length is 40 characters.
content

string

The description text Maximum length is 5000 characters

ProductStatus

The status of a product, data validation issues, that is, information about a product computed asynchronously.

JSON representation 
{
  "destinationStatuses": [
    {
      object (DestinationStatus)
    }
  ],
  "itemLevelIssues": [
    {
      object (ItemLevelIssue)
    }
  ],
  "creationDate": string,
  "lastUpdateDate": string,
  "googleExpirationDate": string
}
Fields
destinationStatuses[]

object (DestinationStatus)

The intended destinations for the product.
itemLevelIssues[]

object (ItemLevelIssue)

A list of all issues associated with the product.
creationDate

string (Timestamp format)

Date on which the item has been created, in ISO 8601 format.
lastUpdateDate

string (Timestamp format)

Date on which the item has been last updated, in ISO 8601 format.
googleExpirationDate

string (Timestamp format)

Date on which the item expires, in ISO 8601 format.

DestinationStatus

The destination status of the product status.

JSON representation 
{
  "reportingContext": enum (ReportingContextEnum),
  "approvedCountries": [
    string
  ],
  "pendingCountries": [
    string
  ],
  "disapprovedCountries": [
    string
  ]
}
Fields
reportingContext

enum (ReportingContextEnum)

The name of the reporting context.
approvedCountries[]

string

List of country codes (ISO 3166-1 alpha-2) where the offer is approved.
pendingCountries[]

string

List of country codes (ISO 3166-1 alpha-2) where the offer is pending approval.
disapprovedCountries[]

string

List of country codes (ISO 3166-1 alpha-2) where the offer is disapproved.

ItemLevelIssue

The ItemLevelIssue of the product status.

JSON representation 
{
  "code": string,
  "severity": enum (Severity),
  "resolution": string,
  "attribute": string,
  "reportingContext": enum (ReportingContextEnum),
  "description": string,
  "detail": string,
  "documentation": string,
  "applicableCountries": [
    string
  ]
}
Fields
code

string

The error code of the issue.
severity

enum (Severity)

How this issue affects serving of the offer.
resolution

string

Whether the issue can be resolved by the merchant.
attribute

string

The attribute's name, if the issue is caused by a single attribute.
reportingContext

enum (ReportingContextEnum)

The reporting context the issue applies to.
description

string

A short issue description in English.
detail

string

A detailed issue description in English.
documentation

string

The URL of a web page to help with resolving this issue.
applicableCountries[]

string

List of country codes (ISO 3166-1 alpha-2) where issue applies to the offer.

Severity

How the issue affects the serving of the product.

Enums
SEVERITY_UNSPECIFIED Not specified.
NOT_IMPACTED This issue represents a warning and does not have a direct affect on the product.
DEMOTED The product is demoted and most likely have limited performance in search results
DISAPPROVED Issue disapproves the product.

Methods

get

 Retrieves the processed product from your Merchant Center account.

list

 Lists the processed products in your Merchant Center account.