Skip to main content

catalogs_completion_config

Overview

Namecatalogs_completion_config
TypeResource
Idgoogle.retail.catalogs_completion_config

Fields

NameDatatypeDescription
namestringRequired. Immutable. Fully qualified name projects/*/locations/*/catalogs/*/completionConfig
allowlistInputConfigobjectThe input config source for completion data.
autoLearningbooleanIf set to true, the auto learning function is enabled. Auto learning uses user data to generate suggestions using ML techniques. Default value is false. Only after enabling auto learning can users use cloud-retail data in CompleteQueryRequest.
denylistInputConfigobjectThe input config source for completion data.
lastAllowlistImportOperationstringOutput only. Name of the LRO corresponding to the latest allowlist import. Can use GetOperation API to retrieve the latest state of the Long Running Operation.
lastDenylistImportOperationstringOutput only. Name of the LRO corresponding to the latest denylist import. Can use GetOperation API to retrieve the latest state of the Long Running Operation.
lastSuggestionsImportOperationstringOutput only. Name of the LRO corresponding to the latest suggestion terms list import. Can use GetOperation API method to retrieve the latest state of the Long Running Operation.
matchingOrderstringSpecifies the matching order for autocomplete suggestions, e.g., a query consisting of 'sh' with 'out-of-order' specified would suggest "women's shoes", whereas a query of 'red s' with 'exact-prefix' specified would suggest "red shoes". Currently supported values: 'out-of-order' 'exact-prefix' Default value: 'exact-prefix'.
maxSuggestionsintegerThe maximum number of autocomplete suggestions returned per term. Default value is 20. If left unset or set to 0, then will fallback to default value. Value range is 1 to 20.
minPrefixLengthintegerThe minimum number of characters needed to be typed in order to get suggestions. Default value is 2. If left unset or set to 0, then will fallback to default value. Value range is 1 to 20.
suggestionsInputConfigobjectThe input config source for completion data.

Methods

NameAccessible byRequired ParamsDescription
projects_locations_catalogs_get_completion_configSELECTcatalogsId, locationsId, projectsIdGets a CompletionConfig.
projects_locations_catalogs_update_completion_configEXECcatalogsId, locationsId, projectsIdUpdates the CompletionConfigs.