This Recommendations AI documentation references the Recommendations console. We recommend switching to the Retail console and using the Retail documentation, which documents Recommendations AI, the Retail console, and Retail Search.

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

Method: projects.locations.catalogs.patch

Updates the Catalogs.

HTTP request

PATCH https://retail.googleapis.com/v2/{catalog.name=projects/*/locations/*/catalogs/*}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
catalog.name

string

Required. Immutable. The fully qualified resource name of the catalog.

Query parameters

Parameters
updateMask

string (FieldMask format)

Indicates which fields in the provided Catalog to update.

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

Request body

The request body contains an instance of Catalog.

Response body

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

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • retail.catalogs.update

For more information, see the IAM documentation.