Package google.shopping.merchant.products.v1

Index

• ProductInputsService (interface)
• ProductsService (interface)
• AgeGroup (enum)
• AutomatedDiscounts (message)
• Availability (enum)
• CertificationAuthority (enum)
• CertificationName (enum)
• CloudExportAdditionalProperties (message)
• Condition (enum)
• CreditType (enum)
• DeleteProductInputRequest (message)
• DigitalSourceType (enum)
• EnergyEfficiencyClass (enum)
• FreeShippingThreshold (message)
• Gender (enum)
• GetProductRequest (message)
• InsertProductInputRequest (message)
• ListProductsRequest (message)
• ListProductsResponse (message)
• LoyaltyPoints (message)
• LoyaltyProgram (message)
• Pause (enum)
• PickupMethod (enum)
• PickupSla (enum)
• Product (message)
• ProductAttributes (message)
• ProductCertification (message)
• ProductDetail (message)
• ProductDimension (message)
• ProductInput (message)
• ProductInstallment (message)
• ProductStatus (message)
• ProductStatus.DestinationStatus (message)
• ProductStatus.ItemLevelIssue (message)
• ProductStatus.ItemLevelIssue.Severity (enum)
• ProductSustainabilityIncentive (message)
• ProductSustainabilityIncentive.Type (enum)
• ProductWeight (message)
• Shipping (message)
• ShippingDimension (message)
• ShippingWeight (message)
• SizeSystem (enum)
• SizeType (enum)
• StructuredDescription (message)
• StructuredTitle (message)
• SubscriptionCost (message)
• SubscriptionPeriod (enum)
• UnitPricingBaseMeasure (message)
• UnitPricingMeasure (message)
• UpdateProductInputRequest (message)

ProductInputsService

Service to use ProductInput resource.

DeleteProductInput

rpc DeleteProductInput(DeleteProductInputRequest) returns (Empty) Deletes a product input from your Merchant Center account. After inserting, updating, or deleting a product input, it may take several minutes before the processed product can be retrieved. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/content For more information, see the OAuth 2.0 Overview.

InsertProductInput

rpc InsertProductInput(InsertProductInputRequest) returns (ProductInput) Uploads a product input to your Merchant Center account. You must have a products data source to be able to insert a product. The unique identifier of the data source is passed as a query parameter in the request URL. If a product input with the same contentLanguage, offerId, and dataSource already exists, then the product input inserted by this method replaces that entry. After inserting, updating, or deleting a product input, it may take several minutes before the processed product can be retrieved. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/content For more information, see the OAuth 2.0 Overview.

UpdateProductInput

rpc UpdateProductInput(UpdateProductInputRequest) returns (ProductInput) Updates the existing product input in your Merchant Center account. After inserting, updating, or deleting a product input, it may take several minutes before the processed product can be retrieved. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/content For more information, see the OAuth 2.0 Overview.

ProductsService

Service to use Product resource.

GetProduct

rpc GetProduct(GetProductRequest) returns (Product) Retrieves the processed product from your Merchant Center account. After inserting, updating, or deleting a product input, it may take several minutes before the updated final product can be retrieved. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/content For more information, see the OAuth 2.0 Overview.

ListProducts

rpc ListProducts(ListProductsRequest) returns (ListProductsResponse) Lists the processed products in your Merchant Center account. The response might contain fewer items than specified by pageSize. Rely on pageToken to determine if there are more items to be requested. After inserting, updating, or deleting a product input, it may take several minutes before the updated processed product can be retrieved. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/content For more information, see the OAuth 2.0 Overview.

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.

AutomatedDiscounts

Information regarding Automated Discounts.

Fields
prior_price	Price The price prior to the application of the first price reduction. Absent if the information about the prior price of the product is not available.
prior_price_progressive	Price The price prior to the application of consecutive price reductions. Absent if the information about the prior price of the product is not available.
gad_price	Price The current sale price for products with a price optimized using Google Automated Discounts (GAD). Absent if the information about the GAD_price of the product is not available.

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.

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.

CloudExportAdditionalProperties

Product property for the Cloud Retail API. For example, properties for a TV product could be "Screen-Resolution" or "Screen-Size".

Fields
text_value[]	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.
int_value[]	int64 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_value[]	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	string Name of the given property. For example, "Screen-Resolution" for a TV product. Maximum string size is 256 characters.
bool_value	bool Boolean value of the given property. For example for a TV product, "True" or "False" if the screen is UHD.
min_value	float Minimum float value of the given property. For example for a TV product 1.00.
max_value	float Maximum float value of the given property. For example for a TV product 100.00.
unit_code	string Unit of the given property. For example, "Pixels" for a TV product. Maximum string size is 256B.

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.

CreditType

Type of installment payments.

Enums
CREDIT_TYPE_UNSPECIFIED	Default value. This value is unused.
FINANCE	Finance.
LEASE	Lease.

DeleteProductInputRequest

Request message for the DeleteProductInput method.

Fields
name	string Required. The name of the product input resource to delete. Format: accounts/{account}/productInputs/{product} where the last section product consists of: content_language~feed_label~offer_id example for product name is accounts/123/productInputs/en~US~sku123.
data_source	string Required. The primary or supplemental data source from which the product input should be deleted. Format: accounts/{account}/dataSources/{datasource}. For example, accounts/123456/dataSources/104628.

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)

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.

FreeShippingThreshold

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

Fields
country	string The CLDR territory code of the country to which an item will ship.
price_threshold	Price The minimum product price for the shipping cost to become free. Represented as a number.

Gender

Target gender of the item.

Enums
GENDER_UNSPECIFIED	Gender is not specified.
MALE	Male.
FEMALE	Female.
UNISEX	Unisex.

GetProductRequest

Request message for the GetProduct method.

Fields

name

string Required. The name of the product to retrieve. Format: accounts/{account}/products/{product} where the last section product consists of: content_language~feed_label~offer_id example for product name is accounts/123/products/en~US~sku123. A legacy local product name would be accounts/123/products/local~en~US~sku123. Note: For calls to the v1beta version, the product section consists of: channel~content_language~feed_label~offer_id, for example: accounts/123/products/online~en~US~sku123.

InsertProductInputRequest

Request message for the InsertProductInput method.

Fields
parent	string Required. The account where this product will be inserted. Format: accounts/{account}
product_input	ProductInput Required. The product input to insert.
data_source	string Required. The primary or supplemental product data source name. If the product already exists and data source provided is different, then the product will be moved to a new data source. For more information, see Overview of Data sources sub-API. Only API data sources are supported. Format: accounts/{account}/dataSources/{datasource}. For example, accounts/123456/dataSources/104628.

ListProductsRequest

Request message for the ListProducts method.

Fields
parent	string Required. The account to list processed products for. Format: accounts/{account}
page_size	int32 The maximum number of products to return. The service may return fewer than this value. The maximum value is 1000; values above 1000 will be coerced to 1000. If unspecified, the default page size of 25 products will be returned.
page_token	string A page token, received from a previous ListProducts call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListProducts must match the call that provided the page token.

ListProductsResponse

Response message for the ListProducts method.

Fields
products[]	Product The processed products from the specified account. These are your processed products after applying rules and supplemental data sources.
next_page_token	string A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

LoyaltyPoints

A message that represents loyalty points.

Fields
name	string Name of loyalty points program. It is recommended to limit the name to 12 full-width characters or 24 Roman characters.
points_value	int64 The retailer's loyalty points in absolute value.
ratio	double 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.

Fields
program_label	string 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.
tier_label	string The label of the tier within the loyalty program. Must match one of the labels within the program.
price	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_for_future_use	Price The cashback that can be used for future purchases.
loyalty_points	int64 The amount of loyalty points earned on a purchase.
member_price_effective_date	Interval 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_label	string 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.

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

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.

Product

The processed product, built from multiple product inputs after applying rules and supplemental data sources. This processed product matches what is shown in your Merchant Center account. 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.

Fields
name	string The name of the product. Format: accounts/{account}/products/{product} where the last section product consists of: content_language~feed_label~offer_id example for product name is accounts/123/products/en~US~sku123. A legacy local product name would be accounts/123/products/local~en~US~sku123. Note: For calls to the v1beta version, the product section consists of: channel~content_language~feed_label~offer_id, for example: accounts/123/products/online~en~US~sku123.
legacy_local	bool Output only. Determines whether the product is only targeting local destinations and whether the product name should be distinguished with a local~ prefix. For example, accounts/123/products/local~en~US~sku123.
offer_id	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.
content_language	string Output only. The two-letter ISO 639-1 language code for the product.
feed_label	string Output only. The feed label lets you categorize and identify your products. The maximum allowed characters is 20 and the supported characters areA-Z, 0-9, hyphen and underscore. The feed label must not include any spaces. For more information, see Using feed labels
data_source	string Output only. The primary data source of the product.
product_attributes	ProductAttributes Output only. A list of strongly-typed product attributes.
custom_attributes[]	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.
product_status	ProductStatus Output only. The status of a product, data validation issues, that is, information about a product computed asynchronously.
automated_discounts	AutomatedDiscounts Output only. The automated discounts information for the product.
version_number	int64 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 version_number. Only supported for insertions into primary data sources. If the operation is prevented, the aborted exception will be thrown.

ProductAttributes

Product attributes.

Fields
additional_image_links[]	string Additional URLs of images of the item.
expiration_date	Timestamp 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.
disclosure_date	Timestamp 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.
availability_date	Timestamp The day a pre-ordered product becomes available for delivery, in ISO 8601 format.
gtins[]	string Global Trade Item Numbers (GTIN) of the item. You can provide up to 10 GTINs.
price	Price Price of the item.
maximum_retail_price	Price Maximum retail price (MRP) of the item. Applicable to India only.
installment	ProductInstallment Number and amount of installments to pay for an item.
subscription_cost	SubscriptionCost Number of periods (months or years) and amount of payment per period for an item with an associated subscription contract.
loyalty_points	LoyaltyPoints Loyalty points that users receive after purchasing the item. Japan only.
loyalty_programs[]	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.
product_types[]	string Categories of the item (formatted as in product data specification).
sale_price	Price Advertised sale price of the item.
sale_price_effective_date	Interval Date range during which the item is on sale, see product data specification.
product_height	ProductDimension The height of the product in the units provided. The value must be between 0 (exclusive) and 3000 (inclusive).
product_length	ProductDimension The length of the product in the units provided. The value must be between 0 (exclusive) and 3000 (inclusive).
product_width	ProductDimension The width of the product in the units provided. The value must be between 0 (exclusive) and 3000 (inclusive).
product_weight	ProductWeight The weight of the product in the units provided. The value must be between 0 (exclusive) and 2000 (inclusive).
shipping[]	Shipping Shipping rules.
free_shipping_threshold[]	FreeShippingThreshold Conditions to be met for a product to have free shipping.
shipping_weight	ShippingWeight Weight of the item for shipping.
shipping_length	ShippingDimension Length of the item for shipping.
shipping_width	ShippingDimension Width of the item for shipping.
shipping_height	ShippingDimension Height of the item for shipping.
size_types[]	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.
unit_pricing_measure	UnitPricingMeasure The measure and dimension of an item.
unit_pricing_base_measure	UnitPricingBaseMeasure The preference of the denominator of the unit price.
ads_labels[]	string Similar to ads_grouping, but only works on CPC.
cost_of_goods_sold	Price Cost of goods sold. Used for gross profit reporting.
product_details[]	ProductDetail Technical specification or additional product details.
product_highlights[]	string Bullet points describing the most relevant product highlights.
display_ads_similar_ids[]	string Advertiser-specified recommendations. For more information, see Display ads attribute specification.
promotion_ids[]	string The unique ID of a promotion.
included_destinations[]	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.
excluded_destinations[]	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.
shopping_ads_excluded_countries[]	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.
lifestyle_image_links[]	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.
cloud_export_additional_properties[]	CloudExportAdditionalProperties Extra fields to export to the Cloud Retail program.
certifications[]	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.
auto_pricing_min_price	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.
sustainability_incentives[]	ProductSustainabilityIncentive The list of sustainability incentive programs.
identifier_exists	bool 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_bundle	bool 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.
mobile_link	string URL for the mobile-optimized version of your item's landing page.
canonical_link	string URL for the canonical version of your item's landing page.
image_link	string URL of an image of the item.
adult	bool Set to true if the item is targeted towards adults.
age_group	AgeGroup Target age group of the item.
availability	Availability Availability status of the item.
brand	string Brand of the item. For example, "Google".
color	string Color of the item. For example, "red".
condition	Condition Condition or state of the item.
gender	Gender Target gender of the item.
google_product_category	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.
item_group_id	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.
sell_on_google_quantity	int64 The quantity of the product that is available for selling on Google. Supported only for online products.
max_handling_time	int64 Maximal product handling time (in business days).
min_handling_time	int64 Minimal product handling time (in business days).
shipping_label	string The shipping label of the product, used to group product in account-level shipping rules.
transit_time_label	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.
size_system	SizeSystem System in which the size is specified. Recommended for apparel items. For more information, see Size system.
energy_efficiency_class	EnergyEfficiencyClass The energy efficiency class as defined in EU directive 2010/30/EU.
min_energy_efficiency_class	EnergyEfficiencyClass The energy efficiency class as defined in EU directive 2010/30/EU.
max_energy_efficiency_class	EnergyEfficiencyClass The energy efficiency class as defined in EU directive 2010/30/EU.
multipack	int64 The number of identical products in a business-defined multipack.
ads_grouping	string Used to group items in an arbitrary way. Only for CPA%, discouraged otherwise. For more information, see Display ads attribute.
ads_redirect	string Allows advertisers to override the item URL when the product is shown within the context of Product ads.
display_ads_id	string An identifier for an item for dynamic remarketing campaigns.
display_ads_title	string Title of an item for dynamic remarketing campaigns.
display_ads_link	string URL directly to your item's landing page for dynamic remarketing campaigns.
display_ads_value	double Offer margin for dynamic remarketing campaigns. For more information, see Display ads attribute.
pickup_method	PickupMethod The pickup option for the item.
pickup_sla	PickupSla Item store pickup timeline. For more information, see Pickup SLA.
link_template	string Link template for business hosted local storefront.
mobile_link_template	string Link template for business hosted local storefront optimized for mobile devices.
custom_label_0	string Custom label 0 for custom grouping of items in a Shopping campaign.
custom_label_1	string Custom label 1 for custom grouping of items in a Shopping campaign.
custom_label_2	string Custom label 2 for custom grouping of items in a Shopping campaign.
custom_label_3	string Custom label 3 for custom grouping of items in a Shopping campaign.
custom_label_4	string Custom label 4 for custom grouping of items in a Shopping campaign.
external_seller_id	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	Pause Publication of this item will be temporarily paused.
virtual_model_link	string URL of the 3D image of the item. See the Help Center article for more information.
structured_title	StructuredTitle Structured title, for algorithmically (AI)-generated titles.
structured_description	StructuredDescription Structured description, for algorithmically (AI)-generated descriptions.

ProductCertification

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

Fields
certification_authority	CertificationAuthority The certification authority.
certification_name	CertificationName The name of the certification.
certification_code	string The certification code. Maximum length is 2000 characters.
certification_value	string The certification value (also known as class, level or grade), for example "A+", "C", "gold". Maximum length is 2000 characters.

ProductDetail

The product details.

Fields
section_name	string The section header used to group a set of product details.
attribute_name	string The name of the product detail.
attribute_value	string The value of the product detail.

ProductDimension

The dimension of the product.

Fields
value	double 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"

ProductInput

This resource represents input data you submit for a product, not the processed product that you see in Merchant Center, in Shopping ads, or across Google surfaces. Product inputs, rules and supplemental data source data are combined to create the processed Product. For more information, see Manage products.

Required product input attributes to pass data validation checks are primarily defined in the Products Data Specification.

The following attributes are required: feedLabel, contentLanguage and offerId.

After inserting, updating, or deleting a product input, it may take several minutes before the processed product can be retrieved.

All fields in the product input and its sub-messages match the English name of their corresponding attribute in the Products Data Specification with some exceptions. The following reference documentation lists the field names in the camelCase casing style while the Products Data Specification lists the names in the snake_case casing style.

Fields
name	string Identifier. The name of the product input. Format: accounts/{account}/productInputs/{productinput} where the last section productinput consists of: content_language~feed_label~offer_id example for product input name is accounts/123/productInputs/en~US~sku123. A legacy local product input name would be accounts/123/productInputs/local~en~US~sku123. Note: For calls to the v1beta version, the productInput section consists of: channel~content_language~feed_label~offer_id, for example: accounts/123/productInputs/online~en~US~sku123.
product	string Output only. The name of the processed product. Format: accounts/{account}/products/{product}
legacy_local	bool Immutable. Determines whether the product is only targeting local destinations and whether the product name should be distinguished with a local~ prefix. For example, accounts/123/productInputs/local~en~US~sku123. If a product that is not legacy_local is already targeting local destinations, creating a legacy_local product with an otherwise matching name will fail.
offer_id	string Required. Immutable. 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 products data specification for details.
content_language	string Required. Immutable. The two-letter ISO 639-1 language code for the product.
feed_label	string Required. Immutable. The feed label that lets you categorize and identify your products. The maximum allowed characters are 20, and the supported characters are A-Z, 0-9, hyphen, and underscore. The feed label must not include any spaces. For more information, see Using feed labels.
product_attributes	ProductAttributes Optional. A list of strongly-typed product attributes.
custom_attributes[]	CustomAttribute Optional. A list of custom (merchant-provided) attributes. It can also be used for submitting 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. Maximum allowed number of characters for each custom attribute is 10240 (represents sum of characters for name and value). Maximum 2500 custom attributes can be set per product, with total size of 102.4kB. Underscores in custom attribute names are replaced by spaces upon insertion.
version_number	int64 Optional. Immutable. 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 version_number. Only supported for insertions into primary data sources. Do not set this field for updates. Do not set this field for insertions into supplemental data sources. If the operation is prevented, the aborted exception will be thrown.

ProductInstallment

A message that represents installment.

Fields
months	int64 The number of installments the buyer has to pay.
amount	Price The amount the buyer has to pay per month.
downpayment	Price The up-front down payment amount the buyer has to pay.
credit_type	CreditType Type of installment payments.

ProductStatus

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

Fields
destination_statuses[]	DestinationStatus The intended destinations for the product.
item_level_issues[]	ItemLevelIssue A list of all issues associated with the product.
creation_date	Timestamp Date on which the item has been created, in ISO 8601 format.
last_update_date	Timestamp Date on which the item has been last updated, in ISO 8601 format.
google_expiration_date	Timestamp Date on which the item expires, in ISO 8601 format.

DestinationStatus

The destination status of the product status.

Fields
reporting_context	ReportingContextEnum The name of the reporting context.
approved_countries[]	string List of country codes (ISO 3166-1 alpha-2) where the offer is approved.
pending_countries[]	string List of country codes (ISO 3166-1 alpha-2) where the offer is pending approval.
disapproved_countries[]	string List of country codes (ISO 3166-1 alpha-2) where the offer is disapproved.

ItemLevelIssue

The ItemLevelIssue of the product status.

Fields
code	string The error code of the issue.
severity	Severity How this issue affects serving of the offer.
resolution	string Whether the issue can be resolved by the business.
attribute	string The attribute's name, if the issue is caused by a single attribute.
reporting_context	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.
applicable_countries[]	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.

ProductSustainabilityIncentive

Information regarding sustainability-related incentive programs such as rebates or tax relief.

Fields
Union field value. Sustainability incentive value. value can be only one of the following:
amount	Price The fixed amount of the incentive.
percentage	double The percentage of the sale price that the incentive is applied to.
type	Type Sustainability incentive program.

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.

ProductWeight

The weight of the product.

Fields
value	double 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.

Fields
price	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.
location_id	int64 The numeric ID of a location that the shipping rate applies to as defined in the AdWords API.
location_group_name	string The location where the shipping is applicable, represented by a location group name.
postal_code	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.
min_handling_time	int64 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 can only be present together with maxHandlingTime; but it is not required if maxHandlingTime is present.
max_handling_time	int64 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 and maxTransitTime are required if providing shipping speeds. minHandlingTime is optional if maxHandlingTime is present.
min_transit_time	int64 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 can only be present together with maxTransitTime; but it is not required if maxTransitTime is present.
max_transit_time	int64 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 and maxTransitTime are required if providing shipping speeds. minTransitTime is optional if maxTransitTime is present.

ShippingDimension

The ShippingDimension of the product.

Fields
value	double The dimension of the product used to calculate the shipping cost of the item.
unit	string The unit of value.

ShippingWeight

The ShippingWeight of the product.

Fields
value	double The weight of the product used to calculate the shipping cost of the item.
unit	string The unit of value.

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.

StructuredDescription

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

Fields
digital_source_type	DigitalSourceType The digital source type. Following IPTC.
content	string The description text Maximum length is 5000 characters

StructuredTitle

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

Fields
digital_source_type	DigitalSourceType The digital source type. Following IPTC.
content	string The title text Maximum length is 150 characters

SubscriptionCost

The SubscriptionCost of the product.

Fields
period	SubscriptionPeriod The type of subscription period. Supported values are: * "month" * "year"
period_length	int64 The number of subscription periods the buyer has to pay.
amount	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.

UnitPricingBaseMeasure

The UnitPricingBaseMeasure of the product.

Fields
value	int64 The denominator of the unit price.
unit	string The unit of the denominator.

UnitPricingMeasure

The UnitPricingMeasure of the product.

Fields
value	double The measure of an item.
unit	string The unit of the measure.

UpdateProductInputRequest

Request message for the UpdateProductInput method. The product (primary input) must exist for the update to succeed. If the update is for a primary product input, the existing primary product input must be from the same data source.

Fields
product_input	ProductInput Required. The product input resource to update. Information you submit will be applied to the processed product as well.
update_mask	FieldMask Optional. The list of product attributes to be updated. If the update mask is omitted, then it is treated as implied field mask equivalent to all fields that are populated (have a non-empty value). Attributes specified in the update mask without a value specified in the body will be deleted from the product. Update mask can only be specified for top level fields in attributes and custom attributes. To specify the update mask for custom attributes you need to add the custom_attribute. prefix. Providing special "*" value for full product replacement is not supported.
data_source	string Required. The primary or supplemental product data source where data_source name identifies the product input to be updated. Only API data sources are supported. Format: accounts/{account}/dataSources/{datasource}. For example, accounts/123456/dataSources/104628.