Important: There is a newer version of this product and documentation. You are currently viewing documentation for the beta version Recommendations AI.

We recommend migrating your recommendations to the GA Retail API (service endpoint https://retail.googleapis.com). The Recommendations Engine beta API (service endpoint https://recommendationengine.googleapis.com) and this documentation set remain available, but they will no longer be updated. See the new documentation:

Method: projects.locations.catalogs.catalogItems.patch

Updates a catalog item. Partial updating is supported. Non-existing items will be created.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. Full resource name of catalog item, such as "projects/*/locations/global/catalogs/default_catalog/catalogItems/some_catalog_item_id".

Authorization requires the following IAM permission on the specified resource name:

  • automlrecommendations.catalogItems.update

Query parameters

Parameters
updateMask

string (FieldMask format)

Optional. Indicates which fields in the provided 'item' to update. If not set, will by default update all fields.

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

Request body

The request body contains an instance of CatalogItem.

Response body

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

Authorization Scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.