Caution: As of January 2021, this documentation for the Recommendations Engine API beta is no longer updated. The beta API remains available but does not receive updates.

The GA version of this product, Retail API, is documented here: Retail documentation

If you need to switch to Retail API, see Migrate to the Retail API from beta in the GA documentation.

Method: projects.locations.catalogs.patch

Updates the catalog configuration.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters

Parameters
`catalog.name`	`string` The fully qualified resource name of the catalog.

catalog.name

string

The fully qualified resource name of the catalog.

Query parameters

Parameters

Parameters
`updateMask`	`string (FieldMask format)` Optional. Indicates which fields in the provided 'catalog' to update. If not set, will only update the catalogItemLevelConfig field. Currently only fields that can be updated are catalogItemLevelConfig. This is a comma-separated list of fully qualified names of fields. Example: `"user.displayName,photo"`.

updateMask

string (FieldMask format)

Optional. Indicates which fields in the provided 'catalog' to update. If not set, will only update the catalogItemLevelConfig field. Currently only fields that can be updated are catalogItemLevelConfig.

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.