Vertex AI Search for retail is being renamed to Vertex AI Search for commerce. We're updating content to reflect the new branding.

REST Resource: projects.locations.catalogs

Resource: Catalog

The catalog configuration.

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

Fields

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.

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 Product s allowed to be ingested into the catalog. Acceptable values are:

primary (default): You can ingest Product s of all types. When ingesting a Product , its type will default to Product.Type.PRIMARY if unset.
variant (incompatible with Retail Search): You can only ingest Product.Type.VARIANT Product s. This means Product.primary_product_id cannot be empty.

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 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 Product levels for more details.

Methods
`completeQuery`	Completes the specified prefix with keyword suggestions.
`exportAnalyticsMetrics`	Exports analytics metrics.
`getAttributesConfig`	Gets an `AttributesConfig` .
`getCompletionConfig`	Gets a `CompletionConfig` .
`getConversationalSearchCustomizationConfig`	Returns the conversational search customization config for a given catalog.
`getDefaultBranch`	Get which branch is currently default branch set by `CatalogService.SetDefaultBranch` method under a specified parent catalog.
`getGenerativeQuestionFeature`	Manages overal generative question feature state -- enables toggling feature on and off.
`list`	Lists all the `Catalog` s associated with the project.
`patch`	Updates the `Catalog` s.
`setDefaultBranch`	Set a specified branch id as default branch.
`updateAttributesConfig`	Updates the `AttributesConfig` .
`updateCompletionConfig`	Updates the `CompletionConfig` s.
`updateConversationalSearchCustomizationConfig`	Updates the conversational search customization config for a given catalog.
`updateGenerativeQuestion`	Allows management of individual questions.
`updateGenerativeQuestionFeature`	Manages overal generative question feature state -- enables toggling feature on and off.

REST Resource: projects.locations.catalogs

Resource: Catalog

ProductLevelConfig

Methods

`completeQuery`

`exportAnalyticsMetrics`

`getAttributesConfig`

`getCompletionConfig`

`getConversationalSearchCustomizationConfig`

`getDefaultBranch`

`getGenerativeQuestionFeature`

`list`

`patch`

`setDefaultBranch`

`updateAttributesConfig`

`updateCompletionConfig`

`updateConversationalSearchCustomizationConfig`

`updateGenerativeQuestion`

`updateGenerativeQuestionFeature`

REST Resource: projects.locations.catalogs Stay organized with collections Save and categorize content based on your preferences.

Resource: Catalog

ProductLevelConfig

Methods

REST Resource: projects.locations.catalogs