This is the documentation for Recommendations AI, Retail Search, and the new Retail console. To use Retail Search in the restricted GA phase, contact Cloud sales.

If you are only using Recommendations AI, remain on the Recommendations console and refer to the Recommendations AI documentation.

REST Resource: projects.locations.catalogs

Resource: Catalog

The catalog configuration.

JSON representation
{
  "name": string,
  "displayName": string,
  "productLevelConfig": {
    object (ProductLevelConfig)
  }
}
Fields
name

string

Required. Immutable. The fully qualified resource name of the catalog.

displayName

string

Required. Immutable. The catalog display name.

This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.

productLevelConfig

object (ProductLevelConfig)

Required. The product level configuration.

ProductLevelConfig

Configures what level the product should be uploaded with regards to how users will be send events and how predictions will be made.

JSON representation
{
  "ingestionProductType": string,
  "merchantCenterProductIdField": string
}
Fields
ingestionProductType

string

The type of Products allowed to be ingested into the catalog. Acceptable values are:

If this field is set to an invalid value other than these, an INVALID_ARGUMENT error is returned.

If this field is variant and merchantCenterProductIdField is itemGroupId, an INVALID_ARGUMENT error is returned.

See Using product levels for more details.

merchantCenterProductIdField

string

Which field of Merchant Center Product should be imported as Product.id. Acceptable values are:

  • offerId (default): Import offerId as the product ID.
  • itemGroupId: Import itemGroupId as the product ID. Notice that Retail API will choose one item from the ones with the same itemGroupId, and use it to represent the item group.

If this field is set to an invalid value other than these, an INVALID_ARGUMENT error is returned.

If this field is itemGroupId and ingestionProductType is variant, an INVALID_ARGUMENT error is returned.

See Using product levels for more details.

Methods

completeQuery

Completes the specified prefix with keyword suggestions.

getDefaultBranch

Get which branch is currently default branch set by CatalogService.SetDefaultBranch method under a specified parent catalog.

list

Lists all the Catalogs associated with the project.

patch

Updates the Catalogs.

setDefaultBranch

Set a specified branch id as default branch.