This is the documentation for Recommendations AI only. To try Retail Search and the unified Retail console in the restricted GA phase, contact Cloud sales. If you are not planning to use Retail Search, remain on the Recommendations console until further notice.

If you are using the v1beta version of Recommendations AI, migrate to the Retail API version.

Method: projects.locations.catalogs.branches.products.patch

Updates a Product.

HTTP request


The URL uses gRPC Transcoding syntax.

Path parameters



Immutable. Full resource name of the product, such as projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/productId.

Query parameters


string (FieldMask format)

Indicates which fields in the provided Product to update. The immutable and output only fields are NOT supported. If not set, all supported fields (the fields that are neither immutable nor output only) are updated.

If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned.

This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".



If set to true, and the Product is not found, a new Product will be created. In this situation, updateMask is ignored.

Request body

The request body contains an instance of Product.

Response body

If successful, the response body contains an instance of Product.

Authorization Scopes

Requires the following OAuth scope:


For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • retail.products.update

For more information, see the IAM documentation.