Important: There is a newer version of this product and documentation. You are currently viewing the v1beta1 Recommendations Engine API documentation, which remains available but will no longer be updated.

See Migrating to the Retail API from beta in the new documentation.

Catalog

The catalog configuration. Next ID: 5.

JSON representation
{
  "name": string,
  "displayName": string,
  "defaultEventStoreId": string,
  "catalogItemLevelConfig": {
    object (CatalogItemLevelConfig)
  }
}
Fields
name

string

The fully qualified resource name of the catalog.

displayName

string

Required. The catalog display name.

defaultEventStoreId

string

Required. The ID of the default event store.

catalogItemLevelConfig

object (CatalogItemLevelConfig)

Required. The catalog item level configuration.

CatalogItemLevelConfig

Configures the catalog level that users send events to, and the level at which predictions are made.

JSON representation
{
  "eventItemLevel": enum (CatalogItemLevel),
  "predictItemLevel": enum (CatalogItemLevel)
}
Fields
eventItemLevel

enum (CatalogItemLevel)

Optional. Level of the catalog at which events are uploaded. See https://cloud.google.com/recommendations-ai/docs/catalog#catalog-levels for more details.

predictItemLevel

enum (CatalogItemLevel)

Optional. Level of the catalog at which predictions are made. See https://cloud.google.com/recommendations-ai/docs/catalog#catalog-levels for more details.

CatalogItemLevel

Level of the catalog.

Enums
CATALOG_ITEM_LEVEL_UNSPECIFIED Unknown value - should never be used.
VARIANT Catalog items are at variant level.
MASTER Catalog items are at master level.