{ "basePath": "", "documentationLink": "https://developers.google.com/merchant/api", "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", "x32": "http://www.google.com/images/icons/product/search-32.gif" }, "ownerDomain": "google.com", "ownerName": "Google", "fullyEncodeReservedExpansion": true, "kind": "discovery#restDescription", "version_module": true, "description": "Programmatically manage your Merchant Center Accounts.", "id": "merchantapi:products_v1beta", "auth": { "oauth2": { "scopes": { "https://www.googleapis.com/auth/content": { "description": "Manage your product listings and accounts for Google Shopping" } } } }, "version": "products_v1beta", "revision": "20260507", "title": "Merchant API", "batchPath": "batch", "name": "merchantapi", "mtlsRootUrl": "https://merchantapi.mtls.googleapis.com/", "discoveryVersion": "v1", "resources": { "accounts": { "resources": { "products": { "methods": { "get": { "parameterOrder": [ "name" ], "response": { "$ref": "Product" }, "description": "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.", "path": "products/v1beta/{+name}", "parameters": { "name": { "description": "Required. The name of the product. Format: `accounts/{account}/products/{product}` The `{product}` segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the `{product}` segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{product}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123`, the `{product}` segment must be the unpadded base64url encoding of this string, which is `ZW5-VVN-c2t1LzEyMw`. The full resource name for the product would be `accounts/123/products/ZW5-VVN-c2t1LzEyMw`. 2. **Plain Format**: The `{product}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{product}` segment is used to differentiate between the two formats. Note: For calls to the v1beta version, the plain format is `channel~content_language~feed_label~offer_id`, for example: `accounts/123/products/online~en~US~sku123`.", "required": true, "type": "string", "location": "path", "pattern": "^accounts/[^/]+/products/[^/]+$" } }, "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/content" ], "flatPath": "products/v1beta/accounts/{accountsId}/products/{productsId}", "id": "merchantapi.accounts.products.get" }, "list": { "httpMethod": "GET", "path": "products/v1beta/{+parent}/products", "parameters": { "parent": { "pattern": "^accounts/[^/]+$", "description": "Required. The account to list processed products for. Format: `accounts/{account}`", "required": true, "location": "path", "type": "string" }, "pageSize": { "type": "integer", "location": "query", "description": "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.", "format": "int32" }, "pageToken": { "type": "string", "location": "query", "description": "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." } }, "description": "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.", "parameterOrder": [ "parent" ], "response": { "$ref": "ListProductsResponse" }, "id": "merchantapi.accounts.products.list", "flatPath": "products/v1beta/accounts/{accountsId}/products", "scopes": [ "https://www.googleapis.com/auth/content" ] } } }, "productInputs": { "methods": { "insert": { "scopes": [ "https://www.googleapis.com/auth/content" ], "request": { "$ref": "ProductInput" }, "id": "merchantapi.accounts.productInputs.insert", "flatPath": "products/v1beta/accounts/{accountsId}/productInputs:insert", "httpMethod": "POST", "path": "products/v1beta/{+parent}/productInputs:insert", "parameters": { "parent": { "pattern": "^accounts/[^/]+$", "description": "Required. The account where this product will be inserted. Format: `accounts/{account}`", "required": true, "type": "string", "location": "path" }, "dataSource": { "type": "string", "location": "query", "description": "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 [Create a primary data source](/merchant/api/guides/data-sources/api-sources#create-primary-data-source). Only API data sources are supported. Format: `accounts/{account}/dataSources/{datasource}`. For example, `accounts/123456/dataSources/104628`." } }, "description": "[Uploads a product input to your Merchant Center account](/merchant/api/guides/products/add-manage#add_a_product). You must have a products [data source](/merchant/api/guides/data-sources/api-sources#create-primary-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.", "parameterOrder": [ "parent" ], "response": { "$ref": "ProductInput" } }, "patch": { "flatPath": "products/v1beta/accounts/{accountsId}/productInputs/{productInputsId}", "id": "merchantapi.accounts.productInputs.patch", "scopes": [ "https://www.googleapis.com/auth/content" ], "request": { "$ref": "ProductInput" }, "path": "products/v1beta/{+name}", "parameters": { "name": { "type": "string", "location": "path", "description": "Identifier. The name of the product. Format: `accounts/{account}/productInputs/{productinput}` The {productinput} segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the {productinput} segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{productinput}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123`, the `{productinput}` segment must be the unpadded base64url encoding of this string, which is `ZW5-VVN-c2t1LzEyMw`. The full resource name for the product would be `accounts/123/productInputs/ZW5-VVN-c2t1LzEyMw`. 2. **Plain Format**: The `{productinput}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{productinput}` segment is used to differentiate between the two formats.", "required": true, "pattern": "^accounts/[^/]+/productInputs/[^/]+$" }, "updateMask": { "type": "string", "location": "query", "description": "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.", "format": "google-fieldmask" }, "dataSource": { "description": "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`.", "location": "query", "type": "string" } }, "httpMethod": "PATCH", "parameterOrder": [ "name" ], "response": { "$ref": "ProductInput" }, "description": "Updates the existing product input in your Merchant Center account. The name of the product input to update is taken from the `name` field within the `ProductInput` resource. After inserting, updating, or deleting a product input, it may take several minutes before the processed product can be retrieved." }, "delete": { "path": "products/v1beta/{+name}", "parameters": { "name": { "pattern": "^accounts/[^/]+/productInputs/[^/]+$", "description": "Required. The name of the product input to delete. Format: `accounts/{account}/productInputs/{productInput}` The {productInput} segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the {productInput} segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{productInput}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123`, the `{productInput}` segment must be the unpadded base64url encoding of this string, which is `ZW5-VVN-c2t1LzEyMw`. The full resource name for the product would be `accounts/123/productInputs/ZW5-VVN-c2t1LzEyMw`. 2. **Plain Format**: The `{productInput}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{productInput}` segment is used to differentiate between the two formats.", "required": true, "location": "path", "type": "string" }, "dataSource": { "description": "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`.", "type": "string", "location": "query" } }, "httpMethod": "DELETE", "parameterOrder": [ "name" ], "response": { "$ref": "Empty" }, "description": "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.", "scopes": [ "https://www.googleapis.com/auth/content" ], "flatPath": "products/v1beta/accounts/{accountsId}/productInputs/{productInputsId}", "id": "merchantapi.accounts.productInputs.delete" } } } } } }, "baseUrl": "https://merchantapi.googleapis.com/", "protocol": "rest", "rootUrl": "https://merchantapi.googleapis.com/", "parameters": { "callback": { "description": "JSONP", "location": "query", "type": "string" }, "uploadType": { "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", "location": "query", "type": "string" }, "key": { "type": "string", "location": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, "alt": { "enumDescriptions": [ "Responses with Content-Type of application/json", "Media download with context-dependent Content-Type", "Responses with Content-Type of application/x-protobuf" ], "default": "json", "type": "string", "location": "query", "description": "Data format for response.", "enum": [ "json", "media", "proto" ] }, "oauth_token": { "type": "string", "location": "query", "description": "OAuth 2.0 token for the current user." }, "quotaUser": { "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.", "location": "query", "type": "string" }, "prettyPrint": { "type": "boolean", "location": "query", "description": "Returns response with indentations and line breaks.", "default": "true" }, "upload_protocol": { "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", "type": "string", "location": "query" }, "$.xgafv": { "enumDescriptions": [ "v1 error format", "v2 error format" ], "description": "V1 error format.", "enum": [ "1", "2" ], "type": "string", "location": "query" }, "access_token": { "location": "query", "type": "string", "description": "OAuth access token." }, "fields": { "description": "Selector specifying which fields to include in a partial response.", "type": "string", "location": "query" } }, "schemas": { "CustomAttribute": { "id": "CustomAttribute", "description": "A message that represents custom attributes. Exactly one of `value` or `group_values` must not be empty.", "properties": { "value": { "description": "The value of the attribute. If `value` is not empty, `group_values` must be empty.", "type": "string" }, "name": { "description": "The name of the attribute.", "type": "string" }, "groupValues": { "description": "Subattributes within this attribute group. If `group_values` is not empty, `value` must be empty.", "items": { "$ref": "CustomAttribute" }, "type": "array" } }, "type": "object" }, "AutomatedDiscounts": { "id": "AutomatedDiscounts", "description": "Information regarding Automated Discounts.", "properties": { "priorPriceProgressive": { "$ref": "Price", "description": "The price prior to the application of consecutive price reductions. Absent if the information about the prior price of the product is not available." }, "gadPrice": { "description": "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.", "$ref": "Price" }, "priorPrice": { "description": "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.", "$ref": "Price" } }, "type": "object" }, "Tax": { "id": "Tax", "description": "The Tax of the product.", "properties": { "postalCode": { "description": "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*.", "type": "string" }, "region": { "description": "The geographic region to which the tax rate applies.", "type": "string" }, "rate": { "description": "The percentage of tax rate that applies to the item price.", "format": "double", "type": "number" }, "country": { "description": "The country within which the item is taxed, specified as a [CLDR territory code](http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml).", "type": "string" }, "locationId": { "type": "string", "description": "The numeric ID of a location that the tax rate applies to as defined in the [AdWords API](https://developers.google.com/adwords/api/docs/appendix/geotargeting).", "format": "int64" }, "taxShip": { "description": "Set to true if tax is charged on shipping.", "type": "boolean" } }, "type": "object" }, "Empty": { "type": "object", "id": "Empty", "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }", "properties": {} }, "LoyaltyPoints": { "id": "LoyaltyPoints", "description": "A message that represents loyalty points.", "properties": { "pointsValue": { "type": "string", "description": "The retailer's loyalty points in absolute value.", "format": "int64" }, "name": { "description": "Name of loyalty points program. It is recommended to limit the name to 12 full-width characters or 24 Roman characters.", "type": "string" }, "ratio": { "description": "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.", "format": "double", "type": "number" } }, "type": "object" }, "ProductStructuredTitle": { "type": "object", "id": "ProductStructuredTitle", "description": "Structured title, for algorithmically (AI)-generated titles.", "properties": { "content": { "description": "The title text Maximum length is 150 characters", "type": "string" }, "digitalSourceType": { "description": "The digital source type, for example \"trained_algorithmic_media\". Following [IPTC](https://cv.iptc.org/newscodes/digitalsourcetype). Maximum length is 40 characters.", "type": "string" } } }, "Attributes": { "type": "object", "id": "Attributes", "description": "Attributes.", "properties": { "condition": { "description": "[Condition](https://support.google.com/merchants/answer/6324469) or state of the item. For example, \"new\" or \"used\".", "type": "string" }, "mobileLinkTemplate": { "description": "[Link template](https://support.google.com/merchants/answer/13870216) for business hosted local storefront optimized for mobile devices.", "type": "string" }, "customLabel2": { "description": "[Custom label 2](https://support.google.com/merchants/answer/6324473) for custom grouping of items in a Shopping campaign.", "type": "string" }, "canonicalLink": { "description": "URL for the canonical version of your item's landing page.", "type": "string" }, "availabilityDate": { "type": "string", "description": "The day a pre-ordered product becomes available for delivery, in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format.", "format": "google-datetime" }, "productWeight": { "$ref": "ProductWeight", "description": "The weight of the product in the units provided. The value must be between 0 (exclusive) and 2000 (inclusive)." }, "customLabel1": { "description": "[Custom label 1](https://support.google.com/merchants/answer/6324473) for custom grouping of items in a Shopping campaign.", "type": "string" }, "installment": { "$ref": "Installment", "description": "Number and amount of installments to pay for an item." }, "freeShippingThreshold": { "description": "Conditions to be met for a product to have free shipping.", "items": { "$ref": "FreeShippingThreshold" }, "type": "array" }, "sustainabilityIncentives": { "description": "The list of sustainability incentive programs.", "items": { "$ref": "ProductSustainabilityIncentive" }, "type": "array" }, "displayAdsSimilarIds": { "type": "array", "description": "Advertiser-specified recommendations. For more information, see [Display ads attribute specification](https://support.google.com/merchants/answer/6069387).", "items": { "type": "string" } }, "excludedDestinations": { "description": "Destinations also known as [Marketing methods](https://support.google.com/merchants/answer/15130232) selections. The list of destinations to exclude for this target (corresponds to unchecked check boxes in Merchant Center). For more information, see [Excluded destination](https://support.google.com/merchants/answer/6324486). Note: We recommend setting destinations on datasources level for most use cases. Use this field within products to only setup exceptions.", "items": { "type": "string" }, "type": "array" }, "adult": { "description": "Set to true if the item is targeted towards adults.", "type": "boolean" }, "pickupMethod": { "description": "The [pickup](https://support.google.com/merchants/answer/14634021) option for the item.", "type": "string" }, "promotionIds": { "type": "array", "description": "The unique ID of a promotion.", "items": { "type": "string" } }, "additionalImageLinks": { "description": "Additional URLs of images of the item.", "items": { "type": "string" }, "type": "array" }, "expirationDate": { "description": "Date on which the item should expire, as specified upon insertion, in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format. The actual expiration date is exposed in `productstatuses` as [googleExpirationDate](https://support.google.com/merchants/answer/6324499) and might be earlier if `expirationDate` is too far in the future.", "format": "google-datetime", "type": "string" }, "adsLabels": { "description": "Similar to ads_grouping, but only works on CPC.", "items": { "type": "string" }, "type": "array" }, "productDetails": { "type": "array", "description": "Technical specification or additional product details.", "items": { "$ref": "ProductDetail" } }, "taxCategory": { "description": "The [tax category](https://support.google.com/merchants/answer/7569847) of the product.", "deprecated": true, "type": "string" }, "salePrice": { "$ref": "Price", "description": "Advertised sale price of the item." }, "size": { "description": "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](https://support.google.com/merchants/answer/6324492).", "type": "string" }, "costOfGoodsSold": { "$ref": "Price", "description": "Cost of goods sold. Used for gross profit reporting." }, "linkTemplate": { "description": "[Link template](https://support.google.com/merchants/answer/13871172) for business hosted local storefront.", "type": "string" }, "pickupSla": { "description": "Item store pickup timeline. For more information, see [Pickup SLA](https://support.google.com/merchants/answer/14635400).", "type": "string" }, "brand": { "description": "[Brand](https://support.google.com/merchants/answer/6324351) of the item. For example, \"Google\".", "type": "string" }, "customLabel4": { "description": "[Custom label 4](https://support.google.com/merchants/answer/6324473) for custom grouping of items in a Shopping campaign.", "type": "string" }, "adsRedirect": { "description": "Allows advertisers to override the item URL when the product is shown within the context of Product ads.", "type": "string" }, "productLength": { "$ref": "ProductDimension", "description": "The length of the product in the units provided. The value must be between 0 (exclusive) and 3000 (inclusive)." }, "maxHandlingTime": { "type": "string", "description": "Maximal product handling time (in business days).", "format": "int64" }, "shippingWeight": { "$ref": "ShippingWeight", "description": "Weight of the item for shipping." }, "unitPricingMeasure": { "description": "The measure and dimension of an item.", "$ref": "UnitPricingMeasure" }, "isBundle": { "description": "Whether the item is a business-defined sub-API. A [sub-API] (https://support.google.com/merchants/answer/6324449) is a custom grouping of different products sold by a business for a single price.", "type": "boolean" }, "gtins": { "description": "A list of Global Trade Item Numbers ([GTIN](https://support.google.com/merchants/answer/6324461)) of the item. You can provide up to 10 GTINs.", "items": { "type": "string" }, "type": "array" }, "disclosureDate": { "description": "The date time when an offer becomes visible in search results across Google’s YouTube surfaces, in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format. See [Disclosure date](https://support.google.com/merchants/answer/13034208) for more information.", "format": "google-datetime", "type": "string" }, "subscriptionCost": { "description": "Number of periods (weeks, months or years) and amount of payment per period for an item with an associated subscription contract.", "$ref": "SubscriptionCost" }, "price": { "description": "Price of the item.", "$ref": "Price" }, "salePriceEffectiveDate": { "$ref": "Interval", "description": "Date range during which the item is on sale, see [product data specification](https://support.google.com/merchants/answer/7052112#price_and_availability)." }, "identifierExists": { "description": "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.", "type": "boolean" }, "maxEnergyEfficiencyClass": { "description": "The energy efficiency class as defined in EU directive 2010/30/EU.", "type": "string" }, "multipack": { "type": "string", "description": "The number of identical products in a business-defined multipack.", "format": "int64" }, "description": { "description": "Description of the item.", "type": "string" }, "adsGrouping": { "description": "Used to group items in an arbitrary way. Only for CPA, discouraged otherwise. For more information, see [Display ads attribute](https://support.google.com/merchants/answer/6069387).", "type": "string" }, "sellOnGoogleQuantity": { "description": "The quantity of the product that is available for selling on Google. Supported only for online products.", "format": "int64", "type": "string" }, "productHighlights": { "type": "array", "description": "Bullet points describing the most relevant [product highlights](https://support.google.com/merchants/answer/9216100).", "items": { "type": "string" } }, "shoppingAdsExcludedCountries": { "type": "array", "description": "List of country codes [(ISO 3166-1 alpha-2)](https://en.wikipedia.org/wiki/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.", "items": { "type": "string" } }, "productHeight": { "$ref": "ProductDimension", "description": "The height of the product in the units provided. The value must be between 0 (exclusive) and 3000 (inclusive)." }, "displayAdsLink": { "description": "URL directly to your item's landing page for dynamic remarketing campaigns.", "type": "string" }, "productTypes": { "type": "array", "description": "Categories of the item (formatted as in [product data specification](https://support.google.com/merchants/answer/7052112#product_category)).", "items": { "type": "string" } }, "link": { "description": "URL directly linking to your item's page on your online store.", "type": "string" }, "structuredDescription": { "$ref": "ProductStructuredDescription", "description": "Structured description, for algorithmically (AI)-generated descriptions." }, "autoPricingMinPrice": { "$ref": "Price", "description": "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 business offers do not fall below this value, thereby preserving the offer's value and profitability." }, "ageGroup": { "description": "Target [age group](https://support.google.com/merchants/answer/6324463) of the item.", "type": "string" }, "virtualModelLink": { "description": "URL of the 3D image of the item. See the [Help Center article](https://support.google.com/merchants/answer/13674896) for more information.", "type": "string" }, "shippingLength": { "description": "Length of the item for shipping.", "$ref": "ShippingDimension" }, "certifications": { "description": "Product Certifications, for example for energy efficiency labeling of products recorded in the [EU EPREL](https://eprel.ec.europa.eu/screen/home) database. See the [Help Center](https://support.google.com/merchants/answer/13528839) article for more information.", "items": { "$ref": "Certification" }, "type": "array" }, "material": { "description": "The [material](https://support.google.com/merchants/answer/6324410) of which the item is made. For example, \"Leather\" or \"Cotton\".", "type": "string" }, "gtin": { "type": "array", "deprecated": true, "description": "Global Trade Item Numbers ([GTIN](https://support.google.com/merchants/answer/6324461)) of the item. You can provide up to 10 GTINs. Deprecated: Use `gtins` instead.", "items": { "type": "string" } }, "shippingHeight": { "description": "Height of the item for shipping.", "$ref": "ShippingDimension" }, "transitTimeLabel": { "description": "The transit time label of the product, used to group product in account-level transit time tables.", "type": "string" }, "shippingWidth": { "description": "Width of the item for shipping.", "$ref": "ShippingDimension" }, "pattern": { "description": "The item's [pattern](https://support.google.com/merchants/answer/6324483). For example, polka dots.", "type": "string" }, "availability": { "description": "[Availability](https://support.google.com/merchants/answer/6324448) status of the item. For example, \"in_stock\" or \"out_of_stock\".", "type": "string" }, "gender": { "description": "Target [gender](https://support.google.com/merchants/answer/6324479) of the item. For example, \"male\" or \"female\".", "type": "string" }, "mpn": { "description": "Manufacturer Part Number ([MPN](https://support.google.com/merchants/answer/6324482)) of the item.", "type": "string" }, "externalSellerId": { "description": "Required for multi-seller accounts. Use this attribute if you're a marketplace uploading products for various sellers to your multi-seller account.", "type": "string" }, "displayAdsTitle": { "description": "Title of an item for dynamic remarketing campaigns.", "type": "string" }, "loyaltyPrograms": { "description": "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.", "items": { "$ref": "LoyaltyProgram" }, "type": "array" }, "itemGroupId": { "description": "Shared identifier for all variants of the same product.", "type": "string" }, "googleProductCategory": { "description": "Google's category of the item (see [Google product taxonomy](https://support.google.com/merchants/answer/1705911)). 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.", "type": "string" }, "customLabel0": { "description": "[Custom label 0](https://support.google.com/merchants/answer/6324473) for custom grouping of items in a Shopping campaign.", "type": "string" }, "lifestyleImageLinks": { "description": "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](https://support.google.com/merchants/answer/9103186) for more information.", "items": { "type": "string" }, "type": "array" }, "displayAdsValue": { "type": "number", "description": "Offer margin for dynamic remarketing campaigns. For more information, see [Display ads attribute](https://support.google.com/merchants/answer/6069387).", "format": "double" }, "pause": { "description": "Publication of this item will be temporarily [paused](https://support.google.com/merchants/answer/11909930).", "type": "string" }, "minEnergyEfficiencyClass": { "description": "The energy efficiency class as defined in EU directive 2010/30/EU.", "type": "string" }, "structuredTitle": { "description": "Structured title, for algorithmically (AI)-generated titles.", "$ref": "ProductStructuredTitle" }, "taxes": { "deprecated": true, "type": "array", "description": "Tax information.", "items": { "$ref": "Tax" } }, "energyEfficiencyClass": { "description": "The energy efficiency class as defined in EU directive 2010/30/EU.", "type": "string" }, "title": { "description": "Title of the item.", "type": "string" }, "unitPricingBaseMeasure": { "description": "The preference of the denominator of the unit price.", "$ref": "UnitPricingBaseMeasure" }, "displayAdsId": { "description": "An identifier for an item for dynamic remarketing campaigns.", "type": "string" }, "cloudExportAdditionalProperties": { "type": "array", "description": "Extra fields to export to the Cloud Retail program.", "items": { "$ref": "CloudExportAdditionalProperties" } }, "loyaltyPoints": { "$ref": "LoyaltyPoints", "description": "Loyalty points that users receive after purchasing the item. Japan only." }, "mobileLink": { "description": "URL for the mobile-optimized version of your item's landing page.", "type": "string" }, "color": { "description": "[Color](https://support.google.com/merchants/answer/6324487) of the item. For example, \"red\".", "type": "string" }, "includedDestinations": { "description": "Destinations also known as [Marketing methods](https://support.google.com/merchants/answer/15130232) selections. 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](https://support.google.com/merchants/answer/7501026). Note: We recommend setting destinations on datasources level for most use cases. Use this field within products to only setup exceptions.", "items": { "type": "string" }, "type": "array" }, "sizeSystem": { "description": "System in which the size is specified. Recommended for apparel items. For example, \"US\", \"UK\", \"DE\". For more information, see [Size system](https://support.google.com/merchants/answer/6324502).", "type": "string" }, "productWidth": { "$ref": "ProductDimension", "description": "The width of the product in the units provided. The value must be between 0 (exclusive) and 3000 (inclusive)." }, "imageLink": { "description": "URL of an image of the item.", "type": "string" }, "minHandlingTime": { "description": "Minimal product handling time (in business days).", "format": "int64", "type": "string" }, "customLabel3": { "description": "[Custom label 3](https://support.google.com/merchants/answer/6324473) for custom grouping of items in a Shopping campaign.", "type": "string" }, "shipping": { "type": "array", "description": "Shipping rules.", "items": { "$ref": "Shipping" } }, "shippingLabel": { "description": "The shipping label of the product, used to group product in account-level shipping rules.", "type": "string" }, "sizeTypes": { "type": "array", "description": "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](https://support.google.com/merchants/answer/6324497). For example, \"petite\", \"plus size\".", "items": { "type": "string" } }, "maximumRetailPrice": { "description": "Maximum retail price (MRP) of the item. Applicable to India only.", "$ref": "Price" } } }, "UnitPricingBaseMeasure": { "id": "UnitPricingBaseMeasure", "description": "The UnitPricingBaseMeasure of the product.", "properties": { "value": { "description": "The denominator of the unit price.", "format": "int64", "type": "string" }, "unit": { "description": "The unit of the denominator.", "type": "string" } }, "type": "object" }, "ProductSustainabilityIncentive": { "type": "object", "id": "ProductSustainabilityIncentive", "description": "Information regarding sustainability-related incentive programs such as rebates or tax relief.", "properties": { "amount": { "$ref": "Price", "description": "The fixed amount of the incentive." }, "type": { "description": "Sustainability incentive program.", "enumDescriptions": [ "Unspecified or unknown sustainability incentive type.", "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.", "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." ], "enum": [ "TYPE_UNSPECIFIED", "EV_TAX_CREDIT", "EV_PRICE_DISCOUNT" ], "type": "string" }, "percentage": { "description": "The percentage of the sale price that the incentive is applied to.", "format": "double", "type": "number" } } }, "DestinationStatus": { "id": "DestinationStatus", "description": "The destination status of the product status. Equivalent to `StatusPerReportingContext` in Reports API.", "properties": { "approvedCountries": { "description": "List of country codes (ISO 3166-1 alpha-2) where the offer is approved.", "items": { "type": "string" }, "type": "array" }, "pendingCountries": { "description": "List of country codes (ISO 3166-1 alpha-2) where the offer is pending approval.", "items": { "type": "string" }, "type": "array" }, "reportingContext": { "description": "The name of the reporting context.", "enumDeprecated": [ false, false, true, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false ], "enum": [ "REPORTING_CONTEXT_ENUM_UNSPECIFIED", "SHOPPING_ADS", "DISCOVERY_ADS", "DEMAND_GEN_ADS", "DEMAND_GEN_ADS_DISCOVER_SURFACE", "VIDEO_ADS", "DISPLAY_ADS", "LOCAL_INVENTORY_ADS", "VEHICLE_INVENTORY_ADS", "FREE_LISTINGS", "FREE_LISTINGS_UCP_CHECKOUT", "FREE_LOCAL_LISTINGS", "FREE_LOCAL_VEHICLE_LISTINGS", "YOUTUBE_AFFILIATE", "YOUTUBE_SHOPPING", "CLOUD_RETAIL", "LOCAL_CLOUD_RETAIL", "PRODUCT_REVIEWS", "MERCHANT_REVIEWS", "YOUTUBE_CHECKOUT" ], "type": "string", "enumDescriptions": [ "Not specified.", "[Shopping ads](https://support.google.com/merchants/answer/6149970).", "Deprecated: Use `DEMAND_GEN_ADS` instead. [Discovery and Demand Gen ads](https://support.google.com/merchants/answer/13389785).", "[Demand Gen ads](https://support.google.com/merchants/answer/13389785).", "[Demand Gen ads on Discover surface](https://support.google.com/merchants/answer/13389785).", "[Video ads](https://support.google.com/google-ads/answer/6340491).", "[Display ads](https://support.google.com/merchants/answer/6069387).", "[Local inventory ads](https://support.google.com/merchants/answer/3271956).", "[Vehicle inventory ads](https://support.google.com/merchants/answer/11544533).", "[Free product listings](https://support.google.com/merchants/answer/9199328).", "[Free product listings on UCP checkout](https://developers.google.com/merchant/ucp).", "[Free local product listings](https://support.google.com/merchants/answer/9825611).", "[Free local vehicle listings](https://support.google.com/merchants/answer/11544533).", "[Youtube Affiliate](https://support.google.com/youtube/answer/13376398).", "[YouTube Shopping](https://support.google.com/merchants/answer/13478370).", "[Cloud retail](https://cloud.google.com/solutions/retail).", "[Local cloud retail](https://cloud.google.com/solutions/retail).", "[Product Reviews](https://support.google.com/merchants/answer/14620732).", "[Merchant Reviews](https://developers.google.com/merchant-review-feeds).", "YouTube Checkout ." ] }, "disapprovedCountries": { "type": "array", "description": "List of country codes (ISO 3166-1 alpha-2) where the offer is disapproved.", "items": { "type": "string" } } }, "type": "object" }, "Price": { "type": "object", "id": "Price", "description": "The price represented as a number and currency.", "properties": { "amountMicros": { "description": "The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).", "format": "int64", "type": "string" }, "currencyCode": { "description": "The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).", "type": "string" } } }, "SubscriptionCost": { "type": "object", "id": "SubscriptionCost", "description": "The SubscriptionCost of the product.", "properties": { "periodLength": { "description": "The number of subscription periods the buyer has to pay.", "format": "int64", "type": "string" }, "amount": { "description": "The amount the buyer has to pay per subscription period.", "$ref": "Price" }, "period": { "description": "The type of subscription period. Supported values are: * \"`month`\" * \"`year`\" * \"`week`\"", "enumDescriptions": [ "Indicates that the subscription period is unspecified.", "Indicates that the subscription period is month.", "Indicates that the subscription period is year.", "Indicates that the subscription period is week." ], "enum": [ "SUBSCRIPTION_PERIOD_UNSPECIFIED", "MONTH", "YEAR", "WEEK" ], "type": "string" } } }, "LoyaltyProgram": { "type": "object", "id": "LoyaltyProgram", "description": "A message that represents loyalty program.", "properties": { "tierLabel": { "description": "The label of the tier within the loyalty program. Must match one of the labels within the program.", "type": "string" }, "price": { "description": "The price for members of the given tier, that is, the instant discount price. Must be smaller or equal to the regular price.", "$ref": "Price" }, "shippingLabel": { "description": "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.", "type": "string" }, "cashbackForFutureUse": { "description": "The cashback that can be used for future purchases.", "$ref": "Price" }, "memberPriceEffectiveDate": { "description": "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.", "$ref": "Interval" }, "loyaltyPoints": { "type": "string", "description": "The amount of loyalty points earned on a purchase.", "format": "int64" }, "programLabel": { "description": "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.", "type": "string" } } }, "ProductStatus": { "type": "object", "id": "ProductStatus", "description": "The status of a product, data validation issues, that is, information about a product computed asynchronously.", "properties": { "googleExpirationDate": { "description": "Date on which the item expires, in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format.", "format": "google-datetime", "type": "string" }, "creationDate": { "type": "string", "description": "Date on which the item has been created, in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format.", "format": "google-datetime" }, "lastUpdateDate": { "description": "Date on which the item has been last updated, in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format.", "format": "google-datetime", "type": "string" }, "destinationStatuses": { "description": "The intended destinations for the product.", "items": { "$ref": "DestinationStatus" }, "type": "array" }, "itemLevelIssues": { "type": "array", "description": "A list of all issues associated with the product.", "items": { "$ref": "ItemLevelIssue" } } } }, "ProductStatusChangeMessage": { "id": "ProductStatusChangeMessage", "description": "The message that the merchant will receive to notify about product status change event", "properties": { "changes": { "type": "array", "description": "A message to describe the change that happened to the product", "items": { "$ref": "ProductChange" } }, "resource": { "description": "The product name. Format: `accounts/{account}/products/{product}`", "type": "string" }, "managingAccount": { "description": "The account that manages the merchant's account. can be the same as merchant id if it is standalone account. Format : `accounts/{service_provider_id}`", "type": "string" }, "resourceId": { "description": "The product id.", "type": "string" }, "eventTime": { "description": "The time at which the event was generated. If you want to order the notification messages you receive you should rely on this field not on the order of receiving the notifications.", "format": "google-datetime", "type": "string" }, "resourceType": { "description": "The resource that changed, in this case it will always be `Product`.", "enumDescriptions": [ "Unspecified resource", "Resource type : product" ], "enum": [ "RESOURCE_UNSPECIFIED", "PRODUCT" ], "type": "string" }, "expirationTime": { "type": "string", "description": "Optional. The product expiration time. This field will not be set if the notification is sent for a product deletion event.", "format": "google-datetime" }, "account": { "description": "The target account that owns the entity that changed. Format : `accounts/{merchant_id}`", "type": "string" }, "attribute": { "type": "string", "description": "The attribute in the resource that changed, in this case it will be always `Status`.", "enumDescriptions": [ "Unspecified attribute", "Status of the changed entity" ], "enum": [ "ATTRIBUTE_UNSPECIFIED", "STATUS" ] } }, "type": "object" }, "Product": { "type": "object", "id": "Product", "description": "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](https://support.google.com/merchants/answer/7052112) with some exceptions.", "properties": { "base64EncodedName": { "type": "string", "description": "Output only. The **unpadded base64url encoded name** of the product. Format: `accounts/{account}/products/{product}` where the last section `product` is the unpadded base64url encoding of the `content_language~feed_label~offer_id` name. Example: `accounts/123/products/ZW5-VVN-c2t1LzEyMw` for the decoded product name `accounts/123/products/en~US~sku/123`. This field can be used directly as input to the API methods that require the product name to be encoded if it contains special characters, for example [`GetProduct`](https://developers.google.com/merchant/api/reference/rest/products_v1beta/accounts.products/get).", "readOnly": true }, "channel": { "description": "Output only. The [channel](https://support.google.com/merchants/answer/7361332) of the product.", "readOnly": true, "enum": [ "CHANNEL_ENUM_UNSPECIFIED", "ONLINE", "LOCAL" ], "type": "string", "enumDescriptions": [ "Not specified.", "Online product.", "Local product." ] }, "automatedDiscounts": { "$ref": "AutomatedDiscounts", "description": "Output only. The automated discounts information for the product.", "readOnly": true }, "feedLabel": { "type": "string", "description": "Output only. The feed label lets you categorize and identify your products. The maximum allowed characters is 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](//support.google.com/merchants/answer/14994087)", "readOnly": true }, "offerId": { "type": "string", "description": "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](https://support.google.com/merchants/answer/188494#id) for details.", "readOnly": true }, "contentLanguage": { "type": "string", "description": "Output only. The two-letter [ISO 639-1](http://en.wikipedia.org/wiki/ISO_639-1) language code for the product.", "readOnly": true }, "versionNumber": { "type": "string", "description": "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.", "readOnly": true, "format": "int64" }, "name": { "description": "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`.", "type": "string" }, "customAttributes": { "type": "array", "description": "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.", "readOnly": true, "items": { "$ref": "CustomAttribute" } }, "productStatus": { "description": "Output only. The status of a product, data validation issues, that is, information about a product computed asynchronously.", "readOnly": true, "$ref": "ProductStatus" }, "dataSource": { "type": "string", "description": "Output only. The primary data source of the product.", "readOnly": true }, "attributes": { "description": "Output only. A list of product attributes.", "readOnly": true, "$ref": "Attributes" } } }, "CloudExportAdditionalProperties": { "id": "CloudExportAdditionalProperties", "description": "Product property for the Cloud Retail API. For example, properties for a TV product could be \"Screen-Resolution\" or \"Screen-Size\".", "properties": { "intValue": { "type": "array", "description": "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.", "items": { "type": "string", "format": "int64" } }, "minValue": { "description": "Minimum float value of the given property. For example for a TV product 1.00.", "format": "float", "type": "number" }, "boolValue": { "description": "Boolean value of the given property. For example for a TV product, \"True\" or \"False\" if the screen is UHD.", "type": "boolean" }, "textValue": { "description": "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.", "items": { "type": "string" }, "type": "array" }, "floatValue": { "type": "array", "description": "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.", "items": { "type": "number", "format": "float" } }, "propertyName": { "description": "Name of the given property. For example, \"Screen-Resolution\" for a TV product. Maximum string size is 256 characters.", "type": "string" }, "maxValue": { "type": "number", "description": "Maximum float value of the given property. For example for a TV product 100.00.", "format": "float" }, "unitCode": { "description": "Unit of the given property. For example, \"Pixels\" for a TV product. Maximum string size is 256B.", "type": "string" } }, "type": "object" }, "FreeShippingThreshold": { "type": "object", "id": "FreeShippingThreshold", "description": "Conditions to be met for a product to have free shipping.", "properties": { "country": { "description": "The [CLDR territory code](http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml) of the country to which an item will ship.", "type": "string" }, "priceThreshold": { "description": "The minimum product price for the shipping cost to become free. Represented as a number.", "$ref": "Price" } } }, "ShippingDimension": { "id": "ShippingDimension", "description": "The ShippingDimension of the product.", "properties": { "unit": { "description": "The unit of value.", "type": "string" }, "value": { "description": "The dimension of the product used to calculate the shipping cost of the item.", "format": "double", "type": "number" } }, "type": "object" }, "ProductWeight": { "id": "ProductWeight", "description": "The weight of the product.", "properties": { "value": { "type": "number", "description": "Required. The weight represented as a number. The weight can have a maximum precision of four decimal places.", "format": "double" }, "unit": { "description": "Required. The weight unit. Acceptable values are: * \"`g`\" * \"`kg`\" * \"`oz`\" * \"`lb`\"", "type": "string" } }, "type": "object" }, "UnitPricingMeasure": { "id": "UnitPricingMeasure", "description": "The UnitPricingMeasure of the product.", "properties": { "value": { "description": "The measure of an item.", "format": "double", "type": "number" }, "unit": { "description": "The unit of the measure.", "type": "string" } }, "type": "object" }, "ProductDimension": { "type": "object", "id": "ProductDimension", "description": "The dimension of the product.", "properties": { "unit": { "description": "Required. The dimension units. Acceptable values are: * \"`in`\" * \"`cm`\"", "type": "string" }, "value": { "type": "number", "description": "Required. The dimension value represented as a number. The value can have a maximum precision of four decimal places.", "format": "double" } } }, "ListProductsResponse": { "id": "ListProductsResponse", "description": "Response message for the ListProducts method.", "properties": { "products": { "type": "array", "description": "The processed products from the specified account. These are your processed products after applying rules and supplemental data sources.", "items": { "$ref": "Product" } }, "nextPageToken": { "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" } }, "type": "object" }, "ItemLevelIssue": { "id": "ItemLevelIssue", "description": "The ItemLevelIssue of the product status.", "properties": { "documentation": { "description": "The URL of a web page to help with resolving this issue.", "type": "string" }, "attribute": { "description": "The attribute's name, if the issue is caused by a single attribute.", "type": "string" }, "code": { "description": "The error code of the issue.", "type": "string" }, "resolution": { "description": "Whether the issue can be resolved by the business.", "type": "string" }, "reportingContext": { "description": "The reporting context the issue applies to.", "enumDeprecated": [ false, false, true, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false ], "enum": [ "REPORTING_CONTEXT_ENUM_UNSPECIFIED", "SHOPPING_ADS", "DISCOVERY_ADS", "DEMAND_GEN_ADS", "DEMAND_GEN_ADS_DISCOVER_SURFACE", "VIDEO_ADS", "DISPLAY_ADS", "LOCAL_INVENTORY_ADS", "VEHICLE_INVENTORY_ADS", "FREE_LISTINGS", "FREE_LISTINGS_UCP_CHECKOUT", "FREE_LOCAL_LISTINGS", "FREE_LOCAL_VEHICLE_LISTINGS", "YOUTUBE_AFFILIATE", "YOUTUBE_SHOPPING", "CLOUD_RETAIL", "LOCAL_CLOUD_RETAIL", "PRODUCT_REVIEWS", "MERCHANT_REVIEWS", "YOUTUBE_CHECKOUT" ], "type": "string", "enumDescriptions": [ "Not specified.", "[Shopping ads](https://support.google.com/merchants/answer/6149970).", "Deprecated: Use `DEMAND_GEN_ADS` instead. [Discovery and Demand Gen ads](https://support.google.com/merchants/answer/13389785).", "[Demand Gen ads](https://support.google.com/merchants/answer/13389785).", "[Demand Gen ads on Discover surface](https://support.google.com/merchants/answer/13389785).", "[Video ads](https://support.google.com/google-ads/answer/6340491).", "[Display ads](https://support.google.com/merchants/answer/6069387).", "[Local inventory ads](https://support.google.com/merchants/answer/3271956).", "[Vehicle inventory ads](https://support.google.com/merchants/answer/11544533).", "[Free product listings](https://support.google.com/merchants/answer/9199328).", "[Free product listings on UCP checkout](https://developers.google.com/merchant/ucp).", "[Free local product listings](https://support.google.com/merchants/answer/9825611).", "[Free local vehicle listings](https://support.google.com/merchants/answer/11544533).", "[Youtube Affiliate](https://support.google.com/youtube/answer/13376398).", "[YouTube Shopping](https://support.google.com/merchants/answer/13478370).", "[Cloud retail](https://cloud.google.com/solutions/retail).", "[Local cloud retail](https://cloud.google.com/solutions/retail).", "[Product Reviews](https://support.google.com/merchants/answer/14620732).", "[Merchant Reviews](https://developers.google.com/merchant-review-feeds).", "YouTube Checkout ." ] }, "description": { "description": "A short issue description in English.", "type": "string" }, "severity": { "description": "How this issue affects serving of the offer.", "enumDescriptions": [ "Not specified.", "This issue represents a warning and does not have a direct affect on the product.", "The product is demoted and most likely have limited performance in search results", "Issue disapproves the product." ], "enum": [ "SEVERITY_UNSPECIFIED", "NOT_IMPACTED", "DEMOTED", "DISAPPROVED" ], "type": "string" }, "applicableCountries": { "type": "array", "description": "List of country codes (ISO 3166-1 alpha-2) where issue applies to the offer.", "items": { "type": "string" } }, "detail": { "description": "A detailed issue description in English.", "type": "string" } }, "type": "object" }, "ProductChange": { "id": "ProductChange", "description": "The change that happened to the product including old value, new value, country code as the region code and reporting context.", "properties": { "newValue": { "description": "The new value of the changed resource or attribute. If empty, it means that the product was deleted. Will have one of these values : (`approved`, `pending`, `disapproved`, ``)", "type": "string" }, "reportingContext": { "type": "string", "description": "Reporting contexts that have the change (if applicable). Currently this field supports only (`SHOPPING_ADS`, `LOCAL_INVENTORY_ADS`, `YOUTUBE_SHOPPING`, `YOUTUBE_CHECKOUT`, `YOUTUBE_AFFILIATE`) from the enum value [ReportingContextEnum](/merchant/api/reference/rest/Shared.Types/ReportingContextEnum)", "enumDeprecated": [ false, false, true, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false ], "enum": [ "REPORTING_CONTEXT_ENUM_UNSPECIFIED", "SHOPPING_ADS", "DISCOVERY_ADS", "DEMAND_GEN_ADS", "DEMAND_GEN_ADS_DISCOVER_SURFACE", "VIDEO_ADS", "DISPLAY_ADS", "LOCAL_INVENTORY_ADS", "VEHICLE_INVENTORY_ADS", "FREE_LISTINGS", "FREE_LISTINGS_UCP_CHECKOUT", "FREE_LOCAL_LISTINGS", "FREE_LOCAL_VEHICLE_LISTINGS", "YOUTUBE_AFFILIATE", "YOUTUBE_SHOPPING", "CLOUD_RETAIL", "LOCAL_CLOUD_RETAIL", "PRODUCT_REVIEWS", "MERCHANT_REVIEWS", "YOUTUBE_CHECKOUT" ], "enumDescriptions": [ "Not specified.", "[Shopping ads](https://support.google.com/merchants/answer/6149970).", "Deprecated: Use `DEMAND_GEN_ADS` instead. [Discovery and Demand Gen ads](https://support.google.com/merchants/answer/13389785).", "[Demand Gen ads](https://support.google.com/merchants/answer/13389785).", "[Demand Gen ads on Discover surface](https://support.google.com/merchants/answer/13389785).", "[Video ads](https://support.google.com/google-ads/answer/6340491).", "[Display ads](https://support.google.com/merchants/answer/6069387).", "[Local inventory ads](https://support.google.com/merchants/answer/3271956).", "[Vehicle inventory ads](https://support.google.com/merchants/answer/11544533).", "[Free product listings](https://support.google.com/merchants/answer/9199328).", "[Free product listings on UCP checkout](https://developers.google.com/merchant/ucp).", "[Free local product listings](https://support.google.com/merchants/answer/9825611).", "[Free local vehicle listings](https://support.google.com/merchants/answer/11544533).", "[Youtube Affiliate](https://support.google.com/youtube/answer/13376398).", "[YouTube Shopping](https://support.google.com/merchants/answer/13478370).", "[Cloud retail](https://cloud.google.com/solutions/retail).", "[Local cloud retail](https://cloud.google.com/solutions/retail).", "[Product Reviews](https://support.google.com/merchants/answer/14620732).", "[Merchant Reviews](https://developers.google.com/merchant-review-feeds).", "YouTube Checkout ." ] }, "oldValue": { "description": "The old value of the changed resource or attribute. If empty, it means that the product was created. Will have one of these values : (`approved`, `pending`, `disapproved`, ``)", "type": "string" }, "regionCode": { "description": "Countries that have the change (if applicable). Represented in the ISO 3166 format.", "type": "string" } }, "type": "object" }, "ProductStructuredDescription": { "type": "object", "id": "ProductStructuredDescription", "description": "Structured description, for algorithmically (AI)-generated descriptions.", "properties": { "content": { "description": "The description text Maximum length is 5000 characters", "type": "string" }, "digitalSourceType": { "description": "The digital source type, for example \"trained_algorithmic_media\". Following [IPTC](https://cv.iptc.org/newscodes/digitalsourcetype). Maximum length is 40 characters.", "type": "string" } } }, "ShippingWeight": { "id": "ShippingWeight", "description": "The ShippingWeight of the product.", "properties": { "value": { "description": "The weight of the product used to calculate the shipping cost of the item.", "format": "double", "type": "number" }, "unit": { "description": "The unit of value.", "type": "string" } }, "type": "object" }, "Interval": { "id": "Interval", "description": "Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time.", "properties": { "startTime": { "description": "Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.", "format": "google-datetime", "type": "string" }, "endTime": { "type": "string", "description": "Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.", "format": "google-datetime" } }, "type": "object" }, "ProductDetail": { "type": "object", "id": "ProductDetail", "description": "The product details.", "properties": { "sectionName": { "description": "The section header used to group a set of product details.", "type": "string" }, "attributeName": { "description": "The name of the product detail.", "type": "string" }, "attributeValue": { "description": "The value of the product detail.", "type": "string" } } }, "Certification": { "id": "Certification", "description": "Product [certification](https://support.google.com/merchants/answer/13528839), initially introduced for EU energy efficiency labeling compliance using the EU EPREL database.", "properties": { "certificationName": { "description": "The name of the certification, for example \"EPREL\". Maximum length is 2000 characters.", "type": "string" }, "certificationValue": { "description": "The certification value (also known as class, level or grade), for example \"A+\", \"C\", \"gold\". Maximum length is 2000 characters.", "type": "string" }, "certificationAuthority": { "description": "The certification authority, for example \"European_Commission\". Maximum length is 2000 characters.", "type": "string" }, "certificationCode": { "description": "The certification code. Maximum length is 2000 characters.", "type": "string" } }, "type": "object" }, "Installment": { "type": "object", "id": "Installment", "description": "A message that represents installment.", "properties": { "downpayment": { "$ref": "Price", "description": "The up-front down payment amount the buyer has to pay." }, "creditType": { "description": "Type of installment payments. Supported values are: * \"`finance`\" * \"`lease`\"", "type": "string" }, "months": { "type": "string", "description": "The number of installments the buyer has to pay.", "format": "int64" }, "amount": { "$ref": "Price", "description": "The amount the buyer has to pay per month." } } }, "Shipping": { "id": "Shipping", "description": "The Shipping of the product.", "properties": { "minHandlingTime": { "description": "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.", "format": "int64", "type": "string" }, "locationGroupName": { "description": "The location where the shipping is applicable, represented by a location group name.", "type": "string" }, "loyaltyTierLabel": { "description": "Optional. The label of the [loyalty tier](https://support.google.com/merchants/answer/6324484) within the loyalty program. Must match one of the tiers set in the loyalty_programs. When set (in combination with [loyalty_program_label](https://support.google.com/merchants/answer/6324484)), this shipping option is only applicable to loyalty program members of the specified tier.", "type": "string" }, "loyaltyProgramLabel": { "description": "Optional. The label of the [loyalty program](https://support.google.com/merchants/answer/6324484). Must match one of the program labels set in loyalty_programs. When set (in combination with [loyalty_tier_label](https://support.google.com/merchants/answer/6324484)), this shipping option is only applicable to loyalty program members of the specified tier.", "type": "string" }, "maxHandlingTime": { "type": "string", "description": "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.", "format": "int64" }, "maxTransitTime": { "type": "string", "description": "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.", "format": "int64" }, "region": { "description": "The geographic region to which a shipping rate applies. See [region](https://support.google.com/merchants/answer/6324484) for more information.", "type": "string" }, "service": { "description": "A free-form description of the service class or delivery speed.", "type": "string" }, "handlingCutoffTimezone": { "description": "[Timezone identifier](https://developers.google.com/adwords/api/docs/appendix/codes-formats#timezone-ids) For example `Europe/Zurich`. This field only applies if `handling_cutoff_time` is set. If `handling_cutoff_time` is set but this field is not set, the shipping destination timezone will be used. If both fields are not set, the handling cutoff time will default to 8AM PST.", "type": "string" }, "country": { "description": "The [CLDR territory code](http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml) of the country to which an item will ship.", "type": "string" }, "locationId": { "type": "string", "description": "The numeric ID of a location that the shipping rate applies to as defined in the [AdWords API](https://developers.google.com/adwords/api/docs/appendix/geotargeting).", "format": "int64" }, "price": { "description": "Fixed shipping price, represented as a number.", "$ref": "Price" }, "postalCode": { "description": "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.", "type": "string" }, "handlingCutoffTime": { "description": "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. `1530`) for 3:30 PM. If not configured, the cutoff time will be defaulted to 8AM PST and `handling_cutoff_timezone` will be ignored.", "type": "string" }, "minTransitTime": { "type": "string", "description": "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.", "format": "int64" } }, "type": "object" }, "ProductInput": { "type": "object", "id": "ProductInput", "description": "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](/merchant/api/guides/products/overview). Required product input attributes to pass data validation checks are primarily defined in the [Products Data Specification](https://support.google.com/merchants/answer/188494). 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](https://support.google.com/merchants/answer/188494) with [some exceptions](https://support.google.com/merchants/answer/7052112). 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.", "properties": { "base64EncodedProduct": { "description": "Output only. The **unpadded base64url encoded name** of the processed product. Format: `accounts/{account}/products/{product}` where the last section `product` is the unpadded base64url encoding of the `content_language~feed_label~offer_id` name. Example: `accounts/123/products/ZW5-VVN-c2t1LzEyMw` for the decoded product name `accounts/123/products/en~US~sku/123`. This field can be used directly as input to the API methods that require the product name to be encoded if it contains special characters, for example [`GetProduct`](https://developers.google.com/merchant/api/reference/rest/products_v1beta/accounts.products/get).", "readOnly": true, "type": "string" }, "base64EncodedName": { "description": "Output only. The **unpadded base64url encoded name** of the product input. Format: `accounts/{account}/productInputs/{productinput}` where the last section `productinput` is the unpadded base64url encoding of the `content_language~feed_label~offer_id` name. Example: `accounts/123/productInputs/ZW5-VVN-c2t1LzEyMw` for the decoded product input name `accounts/123/productInputs/en~US~sku/123`. This field can be used directly as input to the API methods that require the product input name to be encoded if it contains special characters, for example [`GetProductInput`](https://developers.google.com/merchant/api/reference/rest/products_v1beta/accounts.productInputs/get).", "readOnly": true, "type": "string" }, "channel": { "description": "Immutable. The [channel](https://support.google.com/merchants/answer/7361332) of the product.", "enumDescriptions": [ "Not specified.", "Online product.", "Local product." ], "enum": [ "CHANNEL_ENUM_UNSPECIFIED", "ONLINE", "LOCAL" ], "type": "string" }, "feedLabel": { "description": "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](//support.google.com/merchants/answer/14994087).", "type": "string" }, "offerId": { "description": "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](https://support.google.com/merchants/answer/188494#id) for details.", "type": "string" }, "contentLanguage": { "description": "Required. Immutable. The two-letter [ISO 639-1](http://en.wikipedia.org/wiki/ISO_639-1) language code for the product.", "type": "string" }, "versionNumber": { "description": "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.", "format": "int64", "type": "string" }, "name": { "description": "Identifier. The name of the product. Format: `accounts/{account}/productInputs/{productinput}` The {productinput} segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the {productinput} segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{productinput}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123`, the `{productinput}` segment must be the unpadded base64url encoding of this string, which is `ZW5-VVN-c2t1LzEyMw`. The full resource name for the product would be `accounts/123/productInputs/ZW5-VVN-c2t1LzEyMw`. 2. **Plain Format**: The `{productinput}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{productinput}` segment is used to differentiate between the two formats.", "type": "string" }, "customAttributes": { "type": "array", "description": "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.", "items": { "$ref": "CustomAttribute" } }, "product": { "description": "Output only. The name of the processed product. Format: `accounts/{account}/products/{product}`", "readOnly": true, "type": "string" }, "attributes": { "$ref": "Attributes", "description": "Optional. A list of product attributes." } } } }, "servicePath": "", "canonicalName": "Merchant" }