REST Resource: projects.locations.catalogs

• Resource: Catalog
  • JSON representation
• ProductLevelConfig
  • JSON representation
• MerchantCenterLinkingConfig
  • JSON representation
• MerchantCenterLink
  • JSON representation
• MerchantCenterFeedFilter
  • JSON representation
• Methods

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: primary (default): You can ingest Products 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 Products. 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.

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
links[]	object (MerchantCenterLink) Links between Merchant Center accounts and branches.

MerchantCenterLink

Represents a link between a Merchant Center account and a branch. After a link is established, products from the linked Merchant Center account are streamed to the linked branch.

JSON representation
{ "merchantCenterAccountId": string, "branchId": string, "destinations": [ string ], "regionCode": string, "languageCode": string, "feeds": [ { object (MerchantCenterFeedFilter) } ] }

Fields
merchantCenterAccountId	string (int64 format) Required. The linked Merchant Center account ID. The account must be a standalone account or a sub-account of a MCA.
branchId	string The branch ID (e.g. 0/1/2) within this catalog that products from merchantCenterAccountId are streamed to. When updating this field, an empty value will use the currently configured default branch. However, changing the default branch later on won't change the linked branch here. A single branch ID can only have one linked Merchant Center account ID.
destinations[]	string String representing the destination to import for, all if left empty. List of possible values is given in Included destination. List of allowed string values: "Shopping_ads", "Buy_on_google_listings", "Display_ads", "Local_inventory _ads", "Free_listings", "Free_local_listings" NOTE: The string values are case sensitive.
regionCode	string Region code of offers to accept. 2-letter Uppercase ISO 3166-1 alpha-2 code. List of values can be found here under the region tag. If left blank no region filtering will be performed. Example value: US.
languageCode	string Language of the title/description and other string attributes. Use language tags defined by BCP 47. ISO 639-1. This specifies the language of offers in Merchant Center that will be accepted. If empty no language filtering will be performed. Example value: en.
feeds[]	object (MerchantCenterFeedFilter) Criteria for the Merchant Center feeds to be ingested via the link. All offers will be ingested if the list is empty. Otherwise the offers will be ingested from selected feeds.

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.