REST Resource: projects.locations.catalogs

Resource: Catalog

The catalog configuration.

JSON representation
{
  "name": string,
  "displayName": string,
  "productLevelConfig": {
    object (ProductLevelConfig)
  },
  "merchantCenterLinkingConfig": {
    object (MerchantCenterLinkingConfig)
  }
}
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.

merchantCenterLinkingConfig

object (MerchantCenterLinkingConfig)

The Merchant Center linking configuration. After a link is added, the data stream from Merchant Center to Cloud Retail will be enabled automatically. The requester must have access to the Merchant Center account in order to make changes to this field.

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 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.

MerchantCenterLinkingConfig

Configures Merchant Center linking. Links contained in the config will be used to sync data from a Merchant Center account to a Cloud Retail branch.

JSON representation
{
  "links": [
    {
      object (MerchantCenterLink)
    }
  ]
}
Fields

MerchantCenterFeedFilter

Merchant Center Feed filter criterion.

JSON representation
{
  "primaryFeedId": string,
  "primaryFeedName": string
}
Fields
primaryFeedId

string (int64 format)

Merchant Center primary feed ID.

primaryFeedName

string

Merchant Center primary feed name. The name is used for the display purposes only.

Methods

completeQuery

Completes the specified prefix with keyword suggestions.

exportAnalyticsMetrics

Exports analytics metrics.

getAttributesConfig

Gets an AttributesConfig.

getCompletionConfig

Gets a CompletionConfig.

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.

updateAttributesConfig

Updates the AttributesConfig.

updateCompletionConfig

Updates the CompletionConfigs.