catalogs

Creates, updates, deletes, gets or lists a catalogs resource.

Overview

Name	catalogs
Type	Resource
Id	google.recommendationengine.catalogs

Fields

The following fields are returned by SELECT queries:

projects_locations_catalogs_list

Successful response

Name	Datatype	Description
name	string	The fully qualified resource name of the catalog.
catalogItemLevelConfig	object	Required. The catalog item level configuration. (id: GoogleCloudRecommendationengineV1beta1CatalogItemLevelConfig)
defaultEventStoreId	string	Required. The ID of the default event store.
displayName	string	Required. The catalog display name.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
projects_locations_catalogs_list	select	projectsId, locationsId	pageSize, pageToken	Lists all the catalog configurations associated with the project.
projects_locations_catalogs_patch	update	projectsId, locationsId, catalogsId	updateMask	Updates the catalog configuration.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
catalogsId	string
locationsId	string
projectsId	string
pageSize	integer (int32)
pageToken	string
updateMask	string (google-fieldmask)

SELECT examples

projects_locations_catalogs_list

Lists all the catalog configurations associated with the project.

SELECT
name,
catalogItemLevelConfig,
defaultEventStoreId,
displayName
FROM google.recommendationengine.catalogs
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}';

UPDATE examples

projects_locations_catalogs_patch

Updates the catalog configuration.

UPDATE google.recommendationengine.catalogs
SET 
data__name = '{{ name }}',
data__displayName = '{{ displayName }}',
data__defaultEventStoreId = '{{ defaultEventStoreId }}',
data__catalogItemLevelConfig = '{{ catalogItemLevelConfig }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND catalogsId = '{{ catalogsId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
catalogItemLevelConfig,
defaultEventStoreId,
displayName;