@swamp/gcp/retail
v2026.04.23.1
Google Cloud retail infrastructure models
Repository
https://github.com/systeminit/swamp-extensions
Labels
gcpgoogle-cloudretailcloudinfrastructure
Contents
Quality score
Verified by SwampHow well-documented and verifiable this extension is.
Grade A
- Has README or module doc2/2earned
- README has a code example1/1earned
- README is substantive1/1earned
- Most symbols documented1/1earned
- No slow types1/1earned
- Has description1/1earned
- At least one platform tag (or universal)1/1earned
- Two or more platform tags (or universal)1/1earned
- License declared1/1earned
- Verified public repository2/2earned
Install
$ swamp extension pull @swamp/gcp/retailcatalogs_controls.tsv2026.04.23.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| displayName? | string | Required. The human readable control display name. Used in Retail UI. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is thrown. |
| name? | string | Immutable. Fully qualified name `projects/*/locations/global/catalogs/*/controls/*` |
| rule? | object | Strength of the condition boost, which must be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the item a big promotion. However, it does not necessarily mean that the boosted item will be the top result at all times, nor that other items will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant items. Setting to -1.0 gives the item a big demotion. However, results that are deeply relevant might still be shown. The item will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored. |
| searchSolutionUseCase? | array | Specifies the use case for the control. Affects what condition fields can be set. Only settable by search controls. Will default to SEARCH_SOLUTION_USE_CASE_SEARCH if not specified. Currently only allow one search_solution_use_case per control. |
| solutionTypes? | array | Required. Immutable. The solution types that the control is used for. Currently we support setting only one type of solution at creation time. Only `SOLUTION_TYPE_SEARCH` value is supported at the moment. If no solution type is provided at creation time, will default to SOLUTION_TYPE_SEARCH. |
| controlId? | string | Required. The ID to use for the Control, which will become the final component of the Control's resource name. This value should be 4-63 characters, and valid characters are /a-z-_/. |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
createCreate a controls
getGet a controls
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the controls |
updateUpdate controls attributes
deleteDelete the controls
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the controls |
syncSync controls state from GCP
catalogs.tsv2026.04.23.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| 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. |
| name? | string | Required. Immutable. The fully qualified resource name of the catalog. |
| productLevelConfig? | object | 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 merchant_center_product_id_field is `itemGroupId`, an INVALID_ARGUMENT error is returned. See [Product levels](https://cloud.google.com/retail/docs/catalog#product-levels) for more details. |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
getGet a catalogs
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the catalogs |
updateUpdate catalogs attributes
syncSync catalogs state from GCP
complete_querycomplete query
export_analytics_metricsexport analytics metrics
| Argument | Type | Description |
|---|---|---|
| filter? | any | |
| outputConfig? | any |
get_attributes_configget attributes config
get_completion_configget completion config
get_conversational_search_customization_configget conversational search customization config
get_default_branchget default branch
get_generative_question_featureget generative question feature
set_default_branchset default branch
| Argument | Type | Description |
|---|---|---|
| branchId? | any | |
| force? | any | |
| note? | any |
update_attributes_configupdate attributes config
| Argument | Type | Description |
|---|---|---|
| attributeConfigLevel? | any | |
| catalogAttributes? | any | |
| name? | any |
update_completion_configupdate completion config
| Argument | Type | Description |
|---|---|---|
| allowlistInputConfig? | any | |
| autoLearning? | any | |
| denylistInputConfig? | any | |
| lastAllowlistImportOperation? | any | |
| lastDenylistImportOperation? | any | |
| lastSuggestionsImportOperation? | any | |
| matchingOrder? | any | |
| maxSuggestions? | any | |
| minPrefixLength? | any | |
| name? | any | |
| suggestionsInputConfig? | any |
update_conversational_search_customization_configupdate conversational search customization config
| Argument | Type | Description |
|---|---|---|
| catalog? | any | |
| intentClassificationConfig? | any | |
| retailerDisplayName? | any |
update_generative_questionupdate generative question
| Argument | Type | Description |
|---|---|---|
| allowedInConversation? | any | |
| catalog? | any | |
| exampleValues? | any | |
| facet? | any | |
| finalQuestion? | any | |
| frequency? | any | |
| generatedQuestion? | any |
update_generative_question_featureupdate generative question feature
| Argument | Type | Description |
|---|---|---|
| catalog? | any | |
| featureEnabled? | any | |
| minimumProducts? | any |
catalogs_branches_products.tsv2026.04.23.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| attributes? | record | This field is normally ignored unless AttributesConfig.attribute_config_level of the Catalog is set to the deprecated 'PRODUCT_LEVEL_ATTRIBUTE_CONFIG' mode. For information about product-level attribute configuration, see [Configuration modes](https://cloud.google.com/retail/docs/attribute-config#config-modes). If true, custom attribute values are indexed, so that they can be filtered, faceted or boosted in SearchService.Search. This field is ignored in a UserEvent. See SearchRequest.filter, SearchRequest.facet_specs and SearchRequest.boost_spec for more details. |
| audience? | object | The age groups of the audience. Strongly encouraged to use the standard values: "newborn" (up to 3 months old), "infant" (3–12 months old), "toddler" (1–5 years old), "kids" (5–13 years old), "adult" (typically teens or older). At most 5 values are allowed. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Google Merchant Center property [age_group](https://support.google.com/merchants/answer/6324463). Schema.org property [Product.audience.suggestedMinAge](https://schema.org/suggestedMinAge) and [Product.audience.suggestedMaxAge](https://schema.org/suggestedMaxAge). |
| availability? | enum | The online availability of the Product. Default to Availability.IN_STOCK. For primary products with variants set the availability of the primary as Availability.OUT_OF_STOCK and set the true availability at the variant level. This way the primary product will be considered "in stock" as long as it has at least one variant in stock. For primary products with no variants set the true availability at the primary level. Corresponding properties: Google Merchant Center property [availability](https://support.google.com/merchants/answer/6324448). Schema.org property [Offer.availability](https://schema.org/availability). |
| availableQuantity? | number | The available quantity of the item. |
| availableTime? | string | The timestamp when this Product becomes available for SearchService.Search. Note that this is only applicable to Type.PRIMARY and Type.COLLECTION, and ignored for Type.VARIANT. |
| brands? | array | The brands of the product. A maximum of 30 brands are allowed unless overridden through the Google Cloud console. Each brand must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [brand](https://support.google.com/merchants/answer/6324351). Schema.org property [Product.brand](https://schema.org/brand). |
| categories? | array | Optional. Product categories. This field is repeated for supporting one product belonging to several parallel categories. Strongly recommended using the full path for better search / recommendation quality. To represent the full path of category, use the \'>\' sign, with one space on each side, to separate different hierarchies. If \'>\' is part of the category name, replace it with other character(s). For example, if a shoes product belongs to both ["Shoes & Accessories" -> "Shoes"] and ["Sports & Fitness" -> "Athletic Clothing" -> "Shoes"], it could be represented as: "categories": [ "Shoes & Accessories > Shoes", "Sports & Fitness > Athletic Clothing > Shoes" ] Must be set for Type.PRIMARY Product otherwise an INVALID_ARGUMENT error is returned. At most 250 values are allowed per Product unless overridden through the Google Cloud console. Empty values are not allowed. Each value must be a UTF-8 encoded string with a length limit of 5,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property google_product_category. Schema.org property [Product.category] (https://schema.org/category). [mc_google_product_category]: https://support.google.com/merchants/answer/6324436 |
| collectionMemberIds? | array | The id of the collection members when type is Type.COLLECTION. Non-existent product ids are allowed. The type of the members must be either Type.PRIMARY or Type.VARIANT otherwise an INVALID_ARGUMENT error is thrown. Should not set it for other types. A maximum of 1000 values are allowed. Otherwise, an INVALID_ARGUMENT error is return. |
| colorInfo? | object | The standard color families. Strongly recommended to use the following standard color groups: "Red", "Pink", "Orange", "Yellow", "Purple", "Green", "Cyan", "Blue", "Brown", "White", "Gray", "Black" and "Mixed". Normally it is expected to have only 1 color family. May consider using single "Mixed" instead of multiple values. A maximum of 5 values are allowed. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Google Merchant Center property [color](https://support.google.com/merchants/answer/6324487). Schema.org property [Product.color](https://schema.org/color). The colorFamilies field as a system attribute is not a required field but strongly recommended to be specified. Google Search models treat this field as more important than a custom product attribute when specified. |
| conditions? | array | The condition of the product. Strongly encouraged to use the standard values: "new", "refurbished", "used". A maximum of 1 value is allowed per Product. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [condition](https://support.google.com/merchants/answer/6324469). Schema.org property [Offer.itemCondition](https://schema.org/itemCondition). |
| description? | string | Product description. This field must be a UTF-8 encoded string with a length limit of 5,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [description](https://support.google.com/merchants/answer/6324468). Schema.org property [Product.description](https://schema.org/description). |
| expireTime? | string | Note that this field is applied in the following ways: * If the Product is already expired when it is uploaded, this product is not indexed for search. * If the Product is not expired when it is uploaded, only the Type.PRIMARY's and Type.COLLECTION's expireTime is respected, and Type.VARIANT's expireTime is not used. In general, we suggest the users to delete the stale products explicitly, instead of using this field to determine staleness. expire_time must be later than available_time and publish_time, otherwise an INVALID_ARGUMENT error is thrown. Corresponding properties: Google Merchant Center property [expiration_date](https://support.google.com/merchants/answer/6324499). |
| fulfillmentInfo? | array | The IDs for this type, such as the store IDs for FulfillmentInfo.type.pickup-in-store or the region IDs for FulfillmentInfo.type.same-day-delivery. A maximum of 3000 values are allowed. Each value must be a string with a length limit of 30 characters, matching the pattern `[a-zA-Z0-9_-]+`, such as "store1" or "REGION-2". Otherwise, an INVALID_ARGUMENT error is returned. |
| gtin? | string | The Global Trade Item Number (GTIN) of the product. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. This field must be a Unigram. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [gtin](https://support.google.com/merchants/answer/6324461). Schema.org property [Product.isbn](https://schema.org/isbn), [Product.gtin8](https://schema.org/gtin8), [Product.gtin12](https://schema.org/gtin12), [Product.gtin13](https://schema.org/gtin13), or [Product.gtin14](https://schema.org/gtin14). If the value is not a valid GTIN, an INVALID_ARGUMENT error is returned. |
| id? | string | Immutable. Product identifier, which is the final component of name. For example, this field is "id_1", if name is `projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/id_1`. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [id](https://support.google.com/merchants/answer/6324405). Schema.org property [Product.sku](https://schema.org/sku). |
| images? | array | Height of the image in number of pixels. This field must be nonnegative. Otherwise, an INVALID_ARGUMENT error is returned. |
| languageCode? | string | Language of the title/description and other string attributes. Use language tags defined by [BCP 47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). For product prediction, this field is ignored and the model automatically detects the text language. The Product can include text in different languages, but duplicating Products to provide text in multiple languages can result in degraded model performance. For product search this field is in use. It defaults to "en-US" if unset. |
| materials? | array | The material of the product. For example, "leather", "wooden". A maximum of 20 values are allowed. Each value must be a UTF-8 encoded string with a length limit of 200 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [material](https://support.google.com/merchants/answer/6324410). Schema.org property [Product.material](https://schema.org/material). |
| name? | string | Immutable. Full resource name of the product, such as `projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/product_id`. |
| patterns? | array | The pattern or graphic print of the product. For example, "striped", "polka dot", "paisley". A maximum of 20 values are allowed per Product. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [pattern](https://support.google.com/merchants/answer/6324483). Schema.org property [Product.pattern](https://schema.org/pattern). |
| priceInfo? | object | The costs associated with the sale of a particular product. Used for gross profit reporting. * Profit = price - cost Google Merchant Center property [cost_of_goods_sold](https://support.google.com/merchants/answer/9017895). |
| primaryProductId? | string | Variant group identifier. Must be an id, with the same parent branch with this product. Otherwise, an error is thrown. For Type.PRIMARY Products, this field can only be empty or set to the same value as id. For VARIANT Products, this field cannot be empty. A maximum of 2,000 products are allowed to share the same Type.PRIMARY Product. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [item_group_id](https://support.google.com/merchants/answer/6324507). Schema.org property [Product.inProductGroupWithID](https://schema.org/inProductGroupWithID). |
| promotions? | array | Promotion identifier, which is the final component of name. For example, this field is "free_gift", if name is `projects/*/locations/global/catalogs/default_catalog/promotions/free_gift`. The value must be a UTF-8 encoded string with a length limit of 128 characters, and match the pattern: `a-zA-Z*`. For example, id0LikeThis or ID_1_LIKE_THIS. Otherwise, an INVALID_ARGUMENT error is returned. Corresponds to Google Merchant Center property [promotion_id](https://support.google.com/merchants/answer/7050148). |
| publishTime? | string | The timestamp when the product is published by the retailer for the first time, which indicates the freshness of the products. Note that this field is different from available_time, given it purely describes product freshness regardless of when it is available on search and recommendation. |
| rating? | object | The average rating of the Product. The rating is scaled at 1-5. Otherwise, an INVALID_ARGUMENT error is returned. |
| sizes? | array | The size of the product. To represent different size systems or size types, consider using this format: [[[size_system:]size_type:]size_value]. For example, in "US:MENS:M", "US" represents size system; "MENS" represents size type; "M" represents size value. In "GIRLS:27", size system is empty; "GIRLS" represents size type; "27" represents size value. In "32 inches", both size system and size type are empty, while size value is "32 inches". A maximum of 20 values are allowed per Product. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [size](https://support.google.com/merchants/answer/6324492), [size_type](https://support.google.com/merchants/answer/6324497), and [size_system](https://support.google.com/merchants/answer/6324502). Schema.org property [Product.size](https://schema.org/size). |
| tags? | array | Custom tags associated with the product. At most 250 values are allowed per Product. This value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. This tag can be used for filtering recommendation results by passing the tag as part of the PredictRequest.filter. Corresponding properties: Google Merchant Center property [custom_label_0–4](https://support.google.com/merchants/answer/6324473). |
| title? | string | Required. Product title. This field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [title](https://support.google.com/merchants/answer/6324415). Schema.org property [Product.name](https://schema.org/name). |
| ttl? | string | Input only. The TTL (time to live) of the product. Note that this is only applicable to Type.PRIMARY and Type.COLLECTION, and ignored for Type.VARIANT. In general, we suggest the users to delete the stale products explicitly, instead of using this field to determine staleness. If it is set, it must be a non-negative value, and expire_time is set as current timestamp plus ttl. The derived expire_time is returned in the output and ttl is left blank when retrieving the Product. If it is set, the product is not available for SearchService.Search after current timestamp plus ttl. However, the product can still be retrieved by ProductService.GetProduct and ProductService.ListProducts. |
| type? | enum | Immutable. The type of the product. Default to Catalog.product_level_config.ingestion_product_type if unset. |
| uri? | string | Canonical URL directly linking to the product detail page. It is strongly recommended to provide a valid uri for the product, otherwise the service performance could be significantly degraded. This field must be a UTF-8 encoded string with a length limit of 5,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [link](https://support.google.com/merchants/answer/6324416). Schema.org property [Offer.url](https://schema.org/url). |
| productId? | string | Required. The ID to use for the Product, which will become the final component of the Product.name. If the caller does not have permission to create the Product, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. This field must be unique among all Products with the same parent. Otherwise, an ALREADY_EXISTS error is returned. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
createCreate a products
getGet a products
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the products |
updateUpdate products attributes
deleteDelete the products
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the products |
syncSync products state from GCP
add_fulfillment_placesadd fulfillment places
| Argument | Type | Description |
|---|---|---|
| addTime? | any | |
| allowMissing? | any | |
| placeIds? | any | |
| type? | any |
add_local_inventoriesadd local inventories
| Argument | Type | Description |
|---|---|---|
| addMask? | any | |
| addTime? | any | |
| allowMissing? | any | |
| localInventories? | any |
importimport
| Argument | Type | Description |
|---|---|---|
| errorsConfig? | any | |
| inputConfig? | any | |
| notificationPubsubTopic? | any | |
| reconciliationMode? | any | |
| requestId? | any | |
| updateMask? | any |
purgepurge
| Argument | Type | Description |
|---|---|---|
| filter? | any | |
| force? | any |
set_inventoryset inventory
| Argument | Type | Description |
|---|---|---|
| allowMissing? | any | |
| inventory? | any | |
| setMask? | any | |
| setTime? | any |
catalogs_servingconfigs.tsv2026.04.23.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| boostControlIds? | array | Condition boost specifications. If a product matches multiple conditions in the specifications, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 100. Notice that if both ServingConfig.boost_control_ids and SearchRequest.boost_spec are set, the boost conditions from both places are evaluated. If a search request matches multiple boost conditions, the final boost score is equal to the sum of the boost scores from all matched boost conditions. Can only be set if solution_types is SOLUTION_TYPE_SEARCH. |
| displayName? | string | Required. The human readable serving config display name. Used in Retail UI. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. |
| diversityLevel? | string | How much diversity to use in recommendation model results e.g. `medium-diversity` or `high-diversity`. Currently supported values: * `no-diversity` * `low-diversity` * `medium-diversity` * `high-diversity` * `auto-diversity` If not specified, we choose default based on recommendation model type. Default value: `no-diversity`. Can only be set if solution_types is SOLUTION_TYPE_RECOMMENDATION. |
| diversityType? | enum | What kind of diversity to use - data driven or rule based. If unset, the server behavior defaults to RULE_BASED_DIVERSITY. |
| doNotAssociateControlIds? | array | Condition do not associate specifications. If multiple do not associate conditions match, all matching do not associate controls in the list will execute. - Order does not matter. - Maximum number of specifications is 100. Can only be set if solution_types is SOLUTION_TYPE_SEARCH. |
| dynamicFacetSpec? | object | Mode of the DynamicFacet feature. Defaults to Mode.DISABLED if it's unset. |
| enableCategoryFilterLevel? | string | Whether to add additional category filters on the `similar-items` model. If not specified, we enable it by default. Allowed values are: * `no-category-match`: No additional filtering of original results from the model and the customer's filters. * `relaxed-category-match`: Only keep results with categories that match at least one item categories in the PredictRequests's context item. * If customer also sends filters in the PredictRequest, then the results will satisfy both conditions (user given and category match). Can only be set if solution_types is SOLUTION_TYPE_RECOMMENDATION. |
| facetControlIds? | array | Facet specifications for faceted search. If empty, no facets are returned. The ids refer to the ids of Control resources with only the Facet control set. These controls are assumed to be in the same Catalog as the ServingConfig. A maximum of 100 values are allowed. Otherwise, an INVALID_ARGUMENT error is returned. Can only be set if solution_types is SOLUTION_TYPE_SEARCH. |
| filterControlIds? | array | Condition filter specifications. If a product matches multiple conditions in the specifications, filters from these specifications are all applied and combined via the AND operator. Maximum number of specifications is 100. Can only be set if solution_types is SOLUTION_TYPE_SEARCH. |
| ignoreControlIds? | array | Condition ignore specifications. If multiple ignore conditions match, all matching ignore controls in the list will execute. - Order does not matter. - Maximum number of specifications is 100. Can only be set if solution_types is SOLUTION_TYPE_SEARCH. |
| ignoreRecsDenylist? | boolean | When the flag is enabled, the products in the denylist will not be filtered out in the recommendation filtering results. |
| modelId? | string | The id of the model in the same Catalog to use at serving time. Currently only RecommendationModels are supported: https://cloud.google.com/retail/recommendations-ai/docs/create-models Can be changed but only to a compatible model (e.g. others-you-may-like CTR to others-you-may-like CVR). Required when solution_types is SOLUTION_TYPE_RECOMMENDATION. |
| name? | string | Immutable. Fully qualified name `projects/*/locations/global/catalogs/*/servingConfig/*` |
| onewaySynonymsControlIds? | array | Condition oneway synonyms specifications. If multiple oneway synonyms conditions match, all matching oneway synonyms controls in the list will execute. Order of controls in the list will not matter. Maximum number of specifications is 100. Can only be set if solution_types is SOLUTION_TYPE_SEARCH. |
| personalizationSpec? | object | Defaults to Mode.AUTO. |
| priceRerankingLevel? | string | How much price ranking we want in serving results. Price reranking causes product items with a similar recommendation probability to be ordered by price, with the highest-priced items first. This setting could result in a decrease in click-through and conversion rates. Allowed values are: * `no-price-reranking` * `low-price-reranking` * `medium-price-reranking` * `high-price-reranking` If not specified, we choose default based on model type. Default value: `no-price-reranking`. Can only be set if solution_types is SOLUTION_TYPE_RECOMMENDATION. |
| redirectControlIds? | array | Condition redirect specifications. Only the first triggered redirect action is applied, even if multiple apply. Maximum number of specifications is 1000. Can only be set if solution_types is SOLUTION_TYPE_SEARCH. |
| replacementControlIds? | array | Condition replacement specifications. - Applied according to the order in the list. - A previously replaced term can not be re-replaced. - Maximum number of specifications is 100. Can only be set if solution_types is SOLUTION_TYPE_SEARCH. |
| solutionTypes? | array | Required. Immutable. Specifies the solution types that a serving config can be associated with. Currently we support setting only one type of solution. |
| twowaySynonymsControlIds? | array | Condition synonyms specifications. If multiple syonyms conditions match, all matching synonyms control in the list will execute. Order of controls in the list will not matter. Maximum number of specifications is 100. Can only be set if solution_types is SOLUTION_TYPE_SEARCH. |
| servingConfigId? | string | Required. The ID to use for the ServingConfig, which will become the final component of the ServingConfig's resource name. This value should be 4-63 characters, and valid characters are /a-z-_/. |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
createCreate a servingConfigs
getGet a servingConfigs
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the servingConfigs |
updateUpdate servingConfigs attributes
deleteDelete the servingConfigs
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the servingConfigs |
syncSync servingConfigs state from GCP
add_controladd control
| Argument | Type | Description |
|---|---|---|
| controlId? | any |
conversational_searchconversational search
| Argument | Type | Description |
|---|---|---|
| branch? | any | |
| conversationId? | any | |
| conversationalFilteringSpec? | any | |
| pageCategories? | any | |
| query? | any | |
| safetySettings? | any | |
| searchParams? | any | |
| userInfo? | any | |
| userLabels? | any | |
| visitorId? | any |
predictpredict
| Argument | Type | Description |
|---|---|---|
| filter? | any | |
| labels? | any | |
| pageSize? | any | |
| pageToken? | any | |
| params? | any | |
| userEvent? | any | |
| validateOnly? | any |
searchsearch
| Argument | Type | Description |
|---|---|---|
| branch? | any | |
| conversationId? | any | |
| conversationalFilteringSpec? | any | |
| pageCategories? | any | |
| query? | any | |
| safetySettings? | any | |
| searchParams? | any | |
| userInfo? | any | |
| userLabels? | any | |
| visitorId? | any |
catalogs_models.tsv2026.04.23.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| displayName? | string | Required. The display name of the model. Should be human readable, used to display Recommendation Models in the Retail Cloud Console Dashboard. UTF-8 encoded string with limit of 1024 characters. |
| filteringOption? | enum | Optional. If `RECOMMENDATIONS_FILTERING_ENABLED`, recommendation filtering by attributes is enabled for the model. |
| modelFeaturesConfig? | object | Optional. Specifies the context of the model when it is used in predict requests. Can only be set for the `frequently-bought-together` type. If it isn't specified, it defaults to MULTIPLE_CONTEXT_PRODUCTS. |
| name? | string | Required. The fully qualified resource name of the model. Format: `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/models/{model_id}` catalog_id has char limit of 50. recommendation_model_id has char limit of 40. |
| optimizationObjective? | string | Optional. The optimization objective e.g. `cvr`. Currently supported values: `ctr`, `cvr`, `revenue-per-order`. If not specified, we choose default based on model type. Default depends on type of recommendation: `recommended-for-you` => `ctr` `others-you-may-like` => `ctr` `frequently-bought-together` => `revenue_per_order` This field together with optimization_objective describe model metadata to use to control model training and serving. See https://cloud.google.com/retail/docs/models for more details on what the model metadata control and which combination of parameters are valid. For invalid combinations of parameters (e.g. type = `frequently-bought-together` and optimization_objective = `ctr`), you receive an error 400 if you try to create/update a recommendation with this set of knobs. |
| periodicTuningState? | enum | Optional. The state of periodic tuning. The period we use is 3 months - to do a one-off tune earlier use the `TuneModel` method. Default value is `PERIODIC_TUNING_ENABLED`. |
| trainingState? | enum | Optional. The training state that the model is in (e.g. `TRAINING` or `PAUSED`). Since part of the cost of running the service is frequency of training - this can be used to determine when to train model in order to control cost. If not specified: the default value for `CreateModel` method is `TRAINING`. The default value for `UpdateModel` method is to keep the state the same as before. |
| type? | string | Required. The type of model e.g. `home-page`. Currently supported values: `recommended-for-you`, `others-you-may-like`, `frequently-bought-together`, `page-optimization`, `similar-items`, `buy-it-again`, `on-sale-items`, and `recently-viewed`(readonly value). This field together with optimization_objective describe model metadata to use to control model training and serving. See https://cloud.google.com/retail/docs/models for more details on what the model metadata control and which combination of parameters are valid. For invalid combinations of parameters (e.g. type = `frequently-bought-together` and optimization_objective = `ctr`), you receive an error 400 if you try to create/update a recommendation with this set of knobs. |
| dryRun? | string | Optional. Whether to run a dry run to validate the request (without actually creating the model). |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
createCreate a models
getGet a models
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the models |
updateUpdate models attributes
deleteDelete the models
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the models |
syncSync models state from GCP
pausepause
resumeresume
tunetune
catalogs_generativequestions.tsv2026.04.23.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
getGet a generativeQuestions
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the generativeQuestions |
syncSync generativeQuestions state from GCP
2026.04.04.181.2 KBApr 4, 2026
Google Cloud retail infrastructure models
Release Notes
- Updated: catalogs_branches_products
linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64
gcpgoogle-cloudretailcloudinfrastructure
2026.04.03.381.2 KBApr 3, 2026
Google Cloud retail infrastructure models
Release Notes
- Updated: catalogs, catalogs_branches_products, catalogs_controls, catalogs_generativequestions, catalogs_models, catalogs_servingconfigs
linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64
gcpgoogle-cloudretailcloudinfrastructure
2026.04.03.180.4 KBApr 3, 2026
Google Cloud retail infrastructure models
Release Notes
- Updated: catalogs, catalogs_branches_products, catalogs_controls, catalogs_generativequestions, catalogs_models, catalogs_servingconfigs
linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64
gcpgoogle-cloudretailcloudinfrastructure
2026.04.02.280.4 KBApr 2, 2026
Google Cloud retail infrastructure models
Changelog
Models
~methods: +pause, +resume, +tune, -add_control, -conversational_search, -predict, -search
linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64
gcpgoogle-cloudretailcloudinfrastructure
2026.03.27.179.5 KBMar 27, 2026
Google Cloud retail infrastructure models
Release Notes
- Added: catalogs, catalogs_branches_products, catalogs_controls, catalogs_generativequestions, catalogs_models, catalogs_servingconfigs
linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64
gcpgoogle-cloudretailcloudinfrastructure