Sign in
projects

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

patch/v1beta1/{+name}

Path parameters

namestring required

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

Query parameters

updateMaskstring

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

Request body

descriptionstring

Optional. Catalog item description. UTF-8 encoded string with a length limit of 5 KiB.

titlestring

Required. Catalog item title. UTF-8 encoded string with a length limit of 1 KiB.

tagsstring[]

Optional. Filtering tags associated with the catalog item. Each tag should be a UTF-8 encoded string with a length limit of 1 KiB. This tag can be used for filtering recommendation results by passing the tag as part of the predict request filter.

itemGroupIdstring

Optional. Variant group identifier for prediction results. UTF-8 encoded string with a length limit of 128 bytes. This field must be enabled before it can be used. Learn more.

idstring

Required. Catalog item identifier. UTF-8 encoded string with a length limit of 128 bytes. This id must be unique among all catalog items within the same catalog. It should also be used when logging user events in order for the user events to be joined with the Catalog.

languageCodestring

Optional. Deprecated. The model automatically detects the text language. Your catalog can include text in different languages, but duplicating catalog items to provide text in multiple languages can result in degraded model performance.

Response

Successful response

Changes

No recorded changes to this endpoint across all 1 revision of this API.