retail library

Classes

Control
Creates a Control. If the Control to create already exists, an ALREADY_EXISTS error is returned. Auto-naming is currently not supported for this resource.
ControlArgs
The set of arguments for Control. The set of arguments for Control.
ControlRetailV2alpha
Creates a Control. If the Control to create already exists, an ALREADY_EXISTS error is returned. Auto-naming is currently not supported for this resource.
ControlRetailV2alphaArgs
The set of arguments for Control. The set of arguments for Control.
ControlRetailV2beta
Creates a Control. If the Control to create already exists, an ALREADY_EXISTS error is returned. Auto-naming is currently not supported for this resource.
ControlRetailV2betaArgs
The set of arguments for Control. The set of arguments for Control.
GetControlArgs
Arguments for getControl. Arguments for getControl.
GetControlResult
Result data returned by getControl.
GetControlRetailV2alphaArgs
Arguments for getControl. Arguments for getControl.
GetControlRetailV2alphaResult
Result data returned by getControl.
GetControlRetailV2betaArgs
Arguments for getControl. Arguments for getControl.
GetControlRetailV2betaResult
Result data returned by getControl.
GetModelArgs
Arguments for getModel. Arguments for getModel.
GetModelResult
Result data returned by getModel.
GetModelRetailV2alphaArgs
Arguments for getModel. Arguments for getModel.
GetModelRetailV2alphaResult
Result data returned by getModel.
GetModelRetailV2betaArgs
Arguments for getModel. Arguments for getModel.
GetModelRetailV2betaResult
Result data returned by getModel.
GetProductArgs
Arguments for getProduct. Arguments for getProduct.
GetProductResult
Result data returned by getProduct.
GetProductRetailV2alphaArgs
Arguments for getProduct. Arguments for getProduct.
GetProductRetailV2alphaResult
Result data returned by getProduct.
GetProductRetailV2betaArgs
Arguments for getProduct. Arguments for getProduct.
GetProductRetailV2betaResult
Result data returned by getProduct.
GetServingConfigArgs
Arguments for getServingConfig. Arguments for getServingConfig.
GetServingConfigResult
Result data returned by getServingConfig.
GetServingConfigRetailV2alphaArgs
Arguments for getServingConfig. Arguments for getServingConfig.
GetServingConfigRetailV2alphaResult
Result data returned by getServingConfig.
GetServingConfigRetailV2betaArgs
Arguments for getServingConfig. Arguments for getServingConfig.
GetServingConfigRetailV2betaResult
Result data returned by getServingConfig.
GoogleCloudRetailV2alphaAudience
An intended audience of the Product for whom it's sold.
GoogleCloudRetailV2alphaAudienceResponse
An intended audience of the Product for whom it's sold.
GoogleCloudRetailV2alphaColorInfo
The color information of a Product.
GoogleCloudRetailV2alphaColorInfoResponse
The color information of a Product.
GoogleCloudRetailV2alphaCondition
Metadata that is used to define a condition that triggers an action. A valid condition must specify at least one of 'query_terms' or 'products_filter'. If multiple fields are specified, the condition is met if all the fields are satisfied e.g. if a set of query terms and product_filter are set, then only items matching the product_filter for requests with a query matching the query terms wil get boosted.
GoogleCloudRetailV2alphaConditionQueryTerm
Query terms that we want to match on.
GoogleCloudRetailV2alphaConditionQueryTermResponse
Query terms that we want to match on.
GoogleCloudRetailV2alphaConditionResponse
Metadata that is used to define a condition that triggers an action. A valid condition must specify at least one of 'query_terms' or 'products_filter'. If multiple fields are specified, the condition is met if all the fields are satisfied e.g. if a set of query terms and product_filter are set, then only items matching the product_filter for requests with a query matching the query terms wil get boosted.
GoogleCloudRetailV2alphaConditionTimeRange
Used for time-dependent conditions. Example: Want to have rule applied for week long sale.
GoogleCloudRetailV2alphaConditionTimeRangeResponse
Used for time-dependent conditions. Example: Want to have rule applied for week long sale.
GoogleCloudRetailV2alphaFulfillmentInfo
Fulfillment information, such as the store IDs for in-store pickup or region IDs for different shipping methods.
GoogleCloudRetailV2alphaFulfillmentInfoResponse
Fulfillment information, such as the store IDs for in-store pickup or region IDs for different shipping methods.
GoogleCloudRetailV2alphaImage
Product image. Recommendations AI and Retail Search do not use product images to improve prediction and search results. However, product images can be returned in results, and are shown in prediction or search previews in the console.
GoogleCloudRetailV2alphaImageResponse
Product image. Recommendations AI and Retail Search do not use product images to improve prediction and search results. However, product images can be returned in results, and are shown in prediction or search previews in the console.
GoogleCloudRetailV2alphaInterval
A floating point interval.
GoogleCloudRetailV2alphaIntervalResponse
A floating point interval.
GoogleCloudRetailV2alphaLocalInventoryResponse
The inventory information at a place (e.g. a store) identified by a place ID.
GoogleCloudRetailV2alphaModelFrequentlyBoughtTogetherFeaturesConfig
Additional configs for the frequently-bought-together model type.
GoogleCloudRetailV2alphaModelFrequentlyBoughtTogetherFeaturesConfigResponse
Additional configs for the frequently-bought-together model type.
GoogleCloudRetailV2alphaModelModelFeaturesConfig
Additional model features config.
GoogleCloudRetailV2alphaModelModelFeaturesConfigResponse
Additional model features config.
GoogleCloudRetailV2alphaModelPageOptimizationConfig
The PageOptimizationConfig for model training. This determines how many panels to optimize for, and which serving configs to consider for each panel. The purpose of this model is to optimize which ServingConfig to show on which panels in way that optimizes the visitors shopping journey.
GoogleCloudRetailV2alphaModelPageOptimizationConfigCandidate
A candidate to consider for a given panel. Currently only ServingConfig are valid candidates.
GoogleCloudRetailV2alphaModelPageOptimizationConfigCandidateResponse
A candidate to consider for a given panel. Currently only ServingConfig are valid candidates.
GoogleCloudRetailV2alphaModelPageOptimizationConfigPanel
An individual panel with a list of ServingConfigs to consider for it.
GoogleCloudRetailV2alphaModelPageOptimizationConfigPanelResponse
An individual panel with a list of ServingConfigs to consider for it.
GoogleCloudRetailV2alphaModelPageOptimizationConfigResponse
The PageOptimizationConfig for model training. This determines how many panels to optimize for, and which serving configs to consider for each panel. The purpose of this model is to optimize which ServingConfig to show on which panels in way that optimizes the visitors shopping journey.
GoogleCloudRetailV2alphaModelServingConfigListResponse
Represents an ordered combination of valid serving configs, which can be used for PAGE_OPTIMIZATION recommendations.
GoogleCloudRetailV2alphaPriceInfo
The price information of a Product.
GoogleCloudRetailV2alphaPriceInfoPriceRangeResponse
The price range of all variant Product having the same Product.primary_product_id.
GoogleCloudRetailV2alphaPriceInfoResponse
The price information of a Product.
GoogleCloudRetailV2alphaProductResponse
Product captures all metadata information of items to be recommended or searched.
GoogleCloudRetailV2alphaPromotion
Promotion specification.
GoogleCloudRetailV2alphaPromotionResponse
Promotion specification.
GoogleCloudRetailV2alphaRating
The rating of a Product.
GoogleCloudRetailV2alphaRatingResponse
The rating of a Product.
GoogleCloudRetailV2alphaRule
A rule is a condition-action pair * A condition defines when a rule is to be triggered. * An action specifies what occurs on that trigger. Currently rules only work for controls with SOLUTION_TYPE_SEARCH.
GoogleCloudRetailV2alphaRuleBoostAction
A boost action to apply to results matching condition specified above.
GoogleCloudRetailV2alphaRuleBoostActionResponse
A boost action to apply to results matching condition specified above.
GoogleCloudRetailV2alphaRuleDoNotAssociateAction
Prevents query_term from being associated with specified terms during search. Example: Don't associate "gShoe" and "cheap".
GoogleCloudRetailV2alphaRuleDoNotAssociateActionResponse
Prevents query_term from being associated with specified terms during search. Example: Don't associate "gShoe" and "cheap".
GoogleCloudRetailV2alphaRuleFilterAction
  • Rule Condition: - No Condition.query_terms provided is a global match. - 1 or more Condition.query_terms provided are combined with OR operator. * Action Input: The request query and filter that are applied to the retrieved products, in addition to any filters already provided with the SearchRequest. The AND operator is used to combine the query's existing filters with the filter rule(s). NOTE: May result in 0 results when filters conflict. * Action Result: Filters the returned objects to be ONLY those that passed the filter.
  • GoogleCloudRetailV2alphaRuleFilterActionResponse
  • Rule Condition: - No Condition.query_terms provided is a global match. - 1 or more Condition.query_terms provided are combined with OR operator. * Action Input: The request query and filter that are applied to the retrieved products, in addition to any filters already provided with the SearchRequest. The AND operator is used to combine the query's existing filters with the filter rule(s). NOTE: May result in 0 results when filters conflict. * Action Result: Filters the returned objects to be ONLY those that passed the filter.
  • GoogleCloudRetailV2alphaRuleForceReturnFacetAction
    Force returns an attribute/facet in the request around a certain position or above. * Rule Condition: Must specify non-empty Condition.query_terms (for search only) or Condition.page_categories (for browse only), but can't specify both. * Action Inputs: attribute name, position * Action Result: Will force return a facet key around a certain position or above if the condition is satisfied. Example: Suppose the query is "shoes", the Condition.query_terms is "shoes", the ForceReturnFacetAction.FacetPositionAdjustment.attribute_name is "size" and the ForceReturnFacetAction.FacetPositionAdjustment.position is 8. Two cases: a) The facet key "size" is not already in the top 8 slots, then the facet "size" will appear at a position close to 8. b) The facet key "size" in among the top 8 positions in the request, then it will stay at its current rank.
    GoogleCloudRetailV2alphaRuleForceReturnFacetActionFacetPositionAdjustment
    Each facet position adjustment consists of a single attribute name (i.e. facet key) along with a specified position.
    GoogleCloudRetailV2alphaRuleForceReturnFacetActionFacetPositionAdjustmentResponse
    Each facet position adjustment consists of a single attribute name (i.e. facet key) along with a specified position.
    GoogleCloudRetailV2alphaRuleForceReturnFacetActionResponse
    Force returns an attribute/facet in the request around a certain position or above. * Rule Condition: Must specify non-empty Condition.query_terms (for search only) or Condition.page_categories (for browse only), but can't specify both. * Action Inputs: attribute name, position * Action Result: Will force return a facet key around a certain position or above if the condition is satisfied. Example: Suppose the query is "shoes", the Condition.query_terms is "shoes", the ForceReturnFacetAction.FacetPositionAdjustment.attribute_name is "size" and the ForceReturnFacetAction.FacetPositionAdjustment.position is 8. Two cases: a) The facet key "size" is not already in the top 8 slots, then the facet "size" will appear at a position close to 8. b) The facet key "size" in among the top 8 positions in the request, then it will stay at its current rank.
    GoogleCloudRetailV2alphaRuleIgnoreAction
    Prevents a term in the query from being used in search. Example: Don't search for "shoddy".
    GoogleCloudRetailV2alphaRuleIgnoreActionResponse
    Prevents a term in the query from being used in search. Example: Don't search for "shoddy".
    GoogleCloudRetailV2alphaRuleOnewaySynonymsAction
    Maps a set of terms to a set of synonyms. Set of synonyms will be treated as synonyms of each query term only. query_terms will not be treated as synonyms of each other. Example: "sneakers" will use a synonym of "shoes". "shoes" will not use a synonym of "sneakers".
    GoogleCloudRetailV2alphaRuleOnewaySynonymsActionResponse
    Maps a set of terms to a set of synonyms. Set of synonyms will be treated as synonyms of each query term only. query_terms will not be treated as synonyms of each other. Example: "sneakers" will use a synonym of "shoes". "shoes" will not use a synonym of "sneakers".
    GoogleCloudRetailV2alphaRuleRedirectAction
    Redirects a shopper to a specific page. * Rule Condition: Must specify Condition.query_terms. * Action Input: Request Query * Action Result: Redirects shopper to provided uri.
    GoogleCloudRetailV2alphaRuleRedirectActionResponse
    Redirects a shopper to a specific page. * Rule Condition: Must specify Condition.query_terms. * Action Input: Request Query * Action Result: Redirects shopper to provided uri.
    GoogleCloudRetailV2alphaRuleRemoveFacetAction
    Removes an attribute/facet in the request if is present. * Rule Condition: Must specify non-empty Condition.query_terms (for search only) or Condition.page_categories (for browse only), but can't specify both. * Action Input: attribute name * Action Result: Will remove the attribute (as a facet) from the request if it is present. Example: Suppose the query is "shoes", the Condition.query_terms is "shoes" and the attribute name "size", then facet key "size" will be removed from the request (if it is present).
    GoogleCloudRetailV2alphaRuleRemoveFacetActionResponse
    Removes an attribute/facet in the request if is present. * Rule Condition: Must specify non-empty Condition.query_terms (for search only) or Condition.page_categories (for browse only), but can't specify both. * Action Input: attribute name * Action Result: Will remove the attribute (as a facet) from the request if it is present. Example: Suppose the query is "shoes", the Condition.query_terms is "shoes" and the attribute name "size", then facet key "size" will be removed from the request (if it is present).
    GoogleCloudRetailV2alphaRuleReplacementAction
    Replaces a term in the query. Multiple replacement candidates can be specified. All query_terms will be replaced with the replacement term. Example: Replace "gShoe" with "google shoe".
    GoogleCloudRetailV2alphaRuleReplacementActionResponse
    Replaces a term in the query. Multiple replacement candidates can be specified. All query_terms will be replaced with the replacement term. Example: Replace "gShoe" with "google shoe".
    GoogleCloudRetailV2alphaRuleResponse
    A rule is a condition-action pair * A condition defines when a rule is to be triggered. * An action specifies what occurs on that trigger. Currently rules only work for controls with SOLUTION_TYPE_SEARCH.
    GoogleCloudRetailV2alphaRuleTwowaySynonymsAction
    Creates a set of terms that will be treated as synonyms of each other. Example: synonyms of "sneakers" and "shoes": * "sneakers" will use a synonym of "shoes". * "shoes" will use a synonym of "sneakers".
    GoogleCloudRetailV2alphaRuleTwowaySynonymsActionResponse
    Creates a set of terms that will be treated as synonyms of each other. Example: synonyms of "sneakers" and "shoes": * "sneakers" will use a synonym of "shoes". * "shoes" will use a synonym of "sneakers".
    GoogleCloudRetailV2alphaSearchRequestDynamicFacetSpec
    The specifications of dynamically generated facets.
    GoogleCloudRetailV2alphaSearchRequestDynamicFacetSpecResponse
    The specifications of dynamically generated facets.
    GoogleCloudRetailV2alphaSearchRequestFacetSpec
    A facet specification to perform faceted search.
    GoogleCloudRetailV2alphaSearchRequestFacetSpecFacetKey
    Specifies how a facet is computed.
    GoogleCloudRetailV2alphaSearchRequestFacetSpecFacetKeyResponse
    Specifies how a facet is computed.
    GoogleCloudRetailV2alphaSearchRequestFacetSpecResponse
    A facet specification to perform faceted search.
    GoogleCloudRetailV2alphaSearchRequestPersonalizationSpec
    The specification for personalization.
    GoogleCloudRetailV2alphaSearchRequestPersonalizationSpecResponse
    The specification for personalization.
    GoogleCloudRetailV2Audience
    An intended audience of the Product for whom it's sold.
    GoogleCloudRetailV2AudienceResponse
    An intended audience of the Product for whom it's sold.
    GoogleCloudRetailV2betaAudience
    An intended audience of the Product for whom it's sold.
    GoogleCloudRetailV2betaAudienceResponse
    An intended audience of the Product for whom it's sold.
    GoogleCloudRetailV2betaColorInfo
    The color information of a Product.
    GoogleCloudRetailV2betaColorInfoResponse
    The color information of a Product.
    GoogleCloudRetailV2betaCondition
    Metadata that is used to define a condition that triggers an action. A valid condition must specify at least one of 'query_terms' or 'products_filter'. If multiple fields are specified, the condition is met if all the fields are satisfied e.g. if a set of query terms and product_filter are set, then only items matching the product_filter for requests with a query matching the query terms wil get boosted.
    GoogleCloudRetailV2betaConditionQueryTerm
    Query terms that we want to match on.
    GoogleCloudRetailV2betaConditionQueryTermResponse
    Query terms that we want to match on.
    GoogleCloudRetailV2betaConditionResponse
    Metadata that is used to define a condition that triggers an action. A valid condition must specify at least one of 'query_terms' or 'products_filter'. If multiple fields are specified, the condition is met if all the fields are satisfied e.g. if a set of query terms and product_filter are set, then only items matching the product_filter for requests with a query matching the query terms wil get boosted.
    GoogleCloudRetailV2betaConditionTimeRange
    Used for time-dependent conditions. Example: Want to have rule applied for week long sale.
    GoogleCloudRetailV2betaConditionTimeRangeResponse
    Used for time-dependent conditions. Example: Want to have rule applied for week long sale.
    GoogleCloudRetailV2betaFulfillmentInfo
    Fulfillment information, such as the store IDs for in-store pickup or region IDs for different shipping methods.
    GoogleCloudRetailV2betaFulfillmentInfoResponse
    Fulfillment information, such as the store IDs for in-store pickup or region IDs for different shipping methods.
    GoogleCloudRetailV2betaImage
    Product image. Recommendations AI and Retail Search do not use product images to improve prediction and search results. However, product images can be returned in results, and are shown in prediction or search previews in the console.
    GoogleCloudRetailV2betaImageResponse
    Product image. Recommendations AI and Retail Search do not use product images to improve prediction and search results. However, product images can be returned in results, and are shown in prediction or search previews in the console.
    GoogleCloudRetailV2betaInterval
    A floating point interval.
    GoogleCloudRetailV2betaIntervalResponse
    A floating point interval.
    GoogleCloudRetailV2betaLocalInventoryResponse
    The inventory information at a place (e.g. a store) identified by a place ID.
    GoogleCloudRetailV2betaModelFrequentlyBoughtTogetherFeaturesConfig
    Additional configs for the frequently-bought-together model type.
    GoogleCloudRetailV2betaModelFrequentlyBoughtTogetherFeaturesConfigResponse
    Additional configs for the frequently-bought-together model type.
    GoogleCloudRetailV2betaModelModelFeaturesConfig
    Additional model features config.
    GoogleCloudRetailV2betaModelModelFeaturesConfigResponse
    Additional model features config.
    GoogleCloudRetailV2betaModelServingConfigListResponse
    Represents an ordered combination of valid serving configs, which can be used for PAGE_OPTIMIZATION recommendations.
    GoogleCloudRetailV2betaPriceInfo
    The price information of a Product.
    GoogleCloudRetailV2betaPriceInfoPriceRangeResponse
    The price range of all variant Product having the same Product.primary_product_id.
    GoogleCloudRetailV2betaPriceInfoResponse
    The price information of a Product.
    GoogleCloudRetailV2betaProductResponse
    Product captures all metadata information of items to be recommended or searched.
    GoogleCloudRetailV2betaPromotion
    Promotion specification.
    GoogleCloudRetailV2betaPromotionResponse
    Promotion specification.
    GoogleCloudRetailV2betaRating
    The rating of a Product.
    GoogleCloudRetailV2betaRatingResponse
    The rating of a Product.
    GoogleCloudRetailV2betaRule
    A rule is a condition-action pair * A condition defines when a rule is to be triggered. * An action specifies what occurs on that trigger. Currently rules only work for controls with SOLUTION_TYPE_SEARCH.
    GoogleCloudRetailV2betaRuleBoostAction
    A boost action to apply to results matching condition specified above.
    GoogleCloudRetailV2betaRuleBoostActionResponse
    A boost action to apply to results matching condition specified above.
    GoogleCloudRetailV2betaRuleDoNotAssociateAction
    Prevents query_term from being associated with specified terms during search. Example: Don't associate "gShoe" and "cheap".
    GoogleCloudRetailV2betaRuleDoNotAssociateActionResponse
    Prevents query_term from being associated with specified terms during search. Example: Don't associate "gShoe" and "cheap".
    GoogleCloudRetailV2betaRuleFilterAction
  • Rule Condition: - No Condition.query_terms provided is a global match. - 1 or more Condition.query_terms provided are combined with OR operator. * Action Input: The request query and filter that are applied to the retrieved products, in addition to any filters already provided with the SearchRequest. The AND operator is used to combine the query's existing filters with the filter rule(s). NOTE: May result in 0 results when filters conflict. * Action Result: Filters the returned objects to be ONLY those that passed the filter.
  • GoogleCloudRetailV2betaRuleFilterActionResponse
  • Rule Condition: - No Condition.query_terms provided is a global match. - 1 or more Condition.query_terms provided are combined with OR operator. * Action Input: The request query and filter that are applied to the retrieved products, in addition to any filters already provided with the SearchRequest. The AND operator is used to combine the query's existing filters with the filter rule(s). NOTE: May result in 0 results when filters conflict. * Action Result: Filters the returned objects to be ONLY those that passed the filter.
  • GoogleCloudRetailV2betaRuleForceReturnFacetAction
    Force returns an attribute/facet in the request around a certain position or above. * Rule Condition: Must specify non-empty Condition.query_terms (for search only) or Condition.page_categories (for browse only), but can't specify both. * Action Inputs: attribute name, position * Action Result: Will force return a facet key around a certain position or above if the condition is satisfied. Example: Suppose the query is "shoes", the Condition.query_terms is "shoes", the ForceReturnFacetAction.FacetPositionAdjustment.attribute_name is "size" and the ForceReturnFacetAction.FacetPositionAdjustment.position is 8. Two cases: a) The facet key "size" is not already in the top 8 slots, then the facet "size" will appear at a position close to 8. b) The facet key "size" in among the top 8 positions in the request, then it will stay at its current rank.
    GoogleCloudRetailV2betaRuleForceReturnFacetActionFacetPositionAdjustment
    Each facet position adjustment consists of a single attribute name (i.e. facet key) along with a specified position.
    GoogleCloudRetailV2betaRuleForceReturnFacetActionFacetPositionAdjustmentResponse
    Each facet position adjustment consists of a single attribute name (i.e. facet key) along with a specified position.
    GoogleCloudRetailV2betaRuleForceReturnFacetActionResponse
    Force returns an attribute/facet in the request around a certain position or above. * Rule Condition: Must specify non-empty Condition.query_terms (for search only) or Condition.page_categories (for browse only), but can't specify both. * Action Inputs: attribute name, position * Action Result: Will force return a facet key around a certain position or above if the condition is satisfied. Example: Suppose the query is "shoes", the Condition.query_terms is "shoes", the ForceReturnFacetAction.FacetPositionAdjustment.attribute_name is "size" and the ForceReturnFacetAction.FacetPositionAdjustment.position is 8. Two cases: a) The facet key "size" is not already in the top 8 slots, then the facet "size" will appear at a position close to 8. b) The facet key "size" in among the top 8 positions in the request, then it will stay at its current rank.
    GoogleCloudRetailV2betaRuleIgnoreAction
    Prevents a term in the query from being used in search. Example: Don't search for "shoddy".
    GoogleCloudRetailV2betaRuleIgnoreActionResponse
    Prevents a term in the query from being used in search. Example: Don't search for "shoddy".
    GoogleCloudRetailV2betaRuleOnewaySynonymsAction
    Maps a set of terms to a set of synonyms. Set of synonyms will be treated as synonyms of each query term only. query_terms will not be treated as synonyms of each other. Example: "sneakers" will use a synonym of "shoes". "shoes" will not use a synonym of "sneakers".
    GoogleCloudRetailV2betaRuleOnewaySynonymsActionResponse
    Maps a set of terms to a set of synonyms. Set of synonyms will be treated as synonyms of each query term only. query_terms will not be treated as synonyms of each other. Example: "sneakers" will use a synonym of "shoes". "shoes" will not use a synonym of "sneakers".
    GoogleCloudRetailV2betaRuleRedirectAction
    Redirects a shopper to a specific page. * Rule Condition: Must specify Condition.query_terms. * Action Input: Request Query * Action Result: Redirects shopper to provided uri.
    GoogleCloudRetailV2betaRuleRedirectActionResponse
    Redirects a shopper to a specific page. * Rule Condition: Must specify Condition.query_terms. * Action Input: Request Query * Action Result: Redirects shopper to provided uri.
    GoogleCloudRetailV2betaRuleRemoveFacetAction
    Removes an attribute/facet in the request if is present. * Rule Condition: Must specify non-empty Condition.query_terms (for search only) or Condition.page_categories (for browse only), but can't specify both. * Action Input: attribute name * Action Result: Will remove the attribute (as a facet) from the request if it is present. Example: Suppose the query is "shoes", the Condition.query_terms is "shoes" and the attribute name "size", then facet key "size" will be removed from the request (if it is present).
    GoogleCloudRetailV2betaRuleRemoveFacetActionResponse
    Removes an attribute/facet in the request if is present. * Rule Condition: Must specify non-empty Condition.query_terms (for search only) or Condition.page_categories (for browse only), but can't specify both. * Action Input: attribute name * Action Result: Will remove the attribute (as a facet) from the request if it is present. Example: Suppose the query is "shoes", the Condition.query_terms is "shoes" and the attribute name "size", then facet key "size" will be removed from the request (if it is present).
    GoogleCloudRetailV2betaRuleReplacementAction
    Replaces a term in the query. Multiple replacement candidates can be specified. All query_terms will be replaced with the replacement term. Example: Replace "gShoe" with "google shoe".
    GoogleCloudRetailV2betaRuleReplacementActionResponse
    Replaces a term in the query. Multiple replacement candidates can be specified. All query_terms will be replaced with the replacement term. Example: Replace "gShoe" with "google shoe".
    GoogleCloudRetailV2betaRuleResponse
    A rule is a condition-action pair * A condition defines when a rule is to be triggered. * An action specifies what occurs on that trigger. Currently rules only work for controls with SOLUTION_TYPE_SEARCH.
    GoogleCloudRetailV2betaRuleTwowaySynonymsAction
    Creates a set of terms that will be treated as synonyms of each other. Example: synonyms of "sneakers" and "shoes": * "sneakers" will use a synonym of "shoes". * "shoes" will use a synonym of "sneakers".
    GoogleCloudRetailV2betaRuleTwowaySynonymsActionResponse
    Creates a set of terms that will be treated as synonyms of each other. Example: synonyms of "sneakers" and "shoes": * "sneakers" will use a synonym of "shoes". * "shoes" will use a synonym of "sneakers".
    GoogleCloudRetailV2betaSearchRequestDynamicFacetSpec
    The specifications of dynamically generated facets.
    GoogleCloudRetailV2betaSearchRequestDynamicFacetSpecResponse
    The specifications of dynamically generated facets.
    GoogleCloudRetailV2betaSearchRequestFacetSpec
    A facet specification to perform faceted search.
    GoogleCloudRetailV2betaSearchRequestFacetSpecFacetKey
    Specifies how a facet is computed.
    GoogleCloudRetailV2betaSearchRequestFacetSpecFacetKeyResponse
    Specifies how a facet is computed.
    GoogleCloudRetailV2betaSearchRequestFacetSpecResponse
    A facet specification to perform faceted search.
    GoogleCloudRetailV2betaSearchRequestPersonalizationSpec
    The specification for personalization.
    GoogleCloudRetailV2betaSearchRequestPersonalizationSpecResponse
    The specification for personalization.
    GoogleCloudRetailV2ColorInfo
    The color information of a Product.
    GoogleCloudRetailV2ColorInfoResponse
    The color information of a Product.
    GoogleCloudRetailV2Condition
    Metadata that is used to define a condition that triggers an action. A valid condition must specify at least one of 'query_terms' or 'products_filter'. If multiple fields are specified, the condition is met if all the fields are satisfied e.g. if a set of query terms and product_filter are set, then only items matching the product_filter for requests with a query matching the query terms wil get boosted.
    GoogleCloudRetailV2ConditionQueryTerm
    Query terms that we want to match on.
    GoogleCloudRetailV2ConditionQueryTermResponse
    Query terms that we want to match on.
    GoogleCloudRetailV2ConditionResponse
    Metadata that is used to define a condition that triggers an action. A valid condition must specify at least one of 'query_terms' or 'products_filter'. If multiple fields are specified, the condition is met if all the fields are satisfied e.g. if a set of query terms and product_filter are set, then only items matching the product_filter for requests with a query matching the query terms wil get boosted.
    GoogleCloudRetailV2ConditionTimeRange
    Used for time-dependent conditions. Example: Want to have rule applied for week long sale.
    GoogleCloudRetailV2ConditionTimeRangeResponse
    Used for time-dependent conditions. Example: Want to have rule applied for week long sale.
    GoogleCloudRetailV2FulfillmentInfo
    Fulfillment information, such as the store IDs for in-store pickup or region IDs for different shipping methods.
    GoogleCloudRetailV2FulfillmentInfoResponse
    Fulfillment information, such as the store IDs for in-store pickup or region IDs for different shipping methods.
    GoogleCloudRetailV2Image
    Product image. Recommendations AI and Retail Search do not use product images to improve prediction and search results. However, product images can be returned in results, and are shown in prediction or search previews in the console.
    GoogleCloudRetailV2ImageResponse
    Product image. Recommendations AI and Retail Search do not use product images to improve prediction and search results. However, product images can be returned in results, and are shown in prediction or search previews in the console.
    GoogleCloudRetailV2IntervalResponse
    A floating point interval.
    GoogleCloudRetailV2LocalInventoryResponse
    The inventory information at a place (e.g. a store) identified by a place ID.
    GoogleCloudRetailV2ModelFrequentlyBoughtTogetherFeaturesConfig
    Additional configs for the frequently-bought-together model type.
    GoogleCloudRetailV2ModelFrequentlyBoughtTogetherFeaturesConfigResponse
    Additional configs for the frequently-bought-together model type.
    GoogleCloudRetailV2ModelModelFeaturesConfig
    Additional model features config.
    GoogleCloudRetailV2ModelModelFeaturesConfigResponse
    Additional model features config.
    GoogleCloudRetailV2ModelServingConfigListResponse
    Represents an ordered combination of valid serving configs, which can be used for PAGE_OPTIMIZATION recommendations.
    GoogleCloudRetailV2PriceInfo
    The price information of a Product.
    GoogleCloudRetailV2PriceInfoPriceRangeResponse
    The price range of all variant Product having the same Product.primary_product_id.
    GoogleCloudRetailV2PriceInfoResponse
    The price information of a Product.
    GoogleCloudRetailV2ProductResponse
    Product captures all metadata information of items to be recommended or searched.
    GoogleCloudRetailV2Promotion
    Promotion specification.
    GoogleCloudRetailV2PromotionResponse
    Promotion specification.
    GoogleCloudRetailV2Rating
    The rating of a Product.
    GoogleCloudRetailV2RatingResponse
    The rating of a Product.
    GoogleCloudRetailV2Rule
    A rule is a condition-action pair * A condition defines when a rule is to be triggered. * An action specifies what occurs on that trigger. Currently rules only work for controls with SOLUTION_TYPE_SEARCH.
    GoogleCloudRetailV2RuleBoostAction
    A boost action to apply to results matching condition specified above.
    GoogleCloudRetailV2RuleBoostActionResponse
    A boost action to apply to results matching condition specified above.
    GoogleCloudRetailV2RuleDoNotAssociateAction
    Prevents query_term from being associated with specified terms during search. Example: Don't associate "gShoe" and "cheap".
    GoogleCloudRetailV2RuleDoNotAssociateActionResponse
    Prevents query_term from being associated with specified terms during search. Example: Don't associate "gShoe" and "cheap".
    GoogleCloudRetailV2RuleFilterAction
  • Rule Condition: - No Condition.query_terms provided is a global match. - 1 or more Condition.query_terms provided are combined with OR operator. * Action Input: The request query and filter that are applied to the retrieved products, in addition to any filters already provided with the SearchRequest. The AND operator is used to combine the query's existing filters with the filter rule(s). NOTE: May result in 0 results when filters conflict. * Action Result: Filters the returned objects to be ONLY those that passed the filter.
  • GoogleCloudRetailV2RuleFilterActionResponse
  • Rule Condition: - No Condition.query_terms provided is a global match. - 1 or more Condition.query_terms provided are combined with OR operator. * Action Input: The request query and filter that are applied to the retrieved products, in addition to any filters already provided with the SearchRequest. The AND operator is used to combine the query's existing filters with the filter rule(s). NOTE: May result in 0 results when filters conflict. * Action Result: Filters the returned objects to be ONLY those that passed the filter.
  • GoogleCloudRetailV2RuleForceReturnFacetAction
    Force returns an attribute/facet in the request around a certain position or above. * Rule Condition: Must specify non-empty Condition.query_terms (for search only) or Condition.page_categories (for browse only), but can't specify both. * Action Inputs: attribute name, position * Action Result: Will force return a facet key around a certain position or above if the condition is satisfied. Example: Suppose the query is "shoes", the Condition.query_terms is "shoes", the ForceReturnFacetAction.FacetPositionAdjustment.attribute_name is "size" and the ForceReturnFacetAction.FacetPositionAdjustment.position is 8. Two cases: a) The facet key "size" is not already in the top 8 slots, then the facet "size" will appear at a position close to 8. b) The facet key "size" in among the top 8 positions in the request, then it will stay at its current rank.
    GoogleCloudRetailV2RuleForceReturnFacetActionFacetPositionAdjustment
    Each facet position adjustment consists of a single attribute name (i.e. facet key) along with a specified position.
    GoogleCloudRetailV2RuleForceReturnFacetActionFacetPositionAdjustmentResponse
    Each facet position adjustment consists of a single attribute name (i.e. facet key) along with a specified position.
    GoogleCloudRetailV2RuleForceReturnFacetActionResponse
    Force returns an attribute/facet in the request around a certain position or above. * Rule Condition: Must specify non-empty Condition.query_terms (for search only) or Condition.page_categories (for browse only), but can't specify both. * Action Inputs: attribute name, position * Action Result: Will force return a facet key around a certain position or above if the condition is satisfied. Example: Suppose the query is "shoes", the Condition.query_terms is "shoes", the ForceReturnFacetAction.FacetPositionAdjustment.attribute_name is "size" and the ForceReturnFacetAction.FacetPositionAdjustment.position is 8. Two cases: a) The facet key "size" is not already in the top 8 slots, then the facet "size" will appear at a position close to 8. b) The facet key "size" in among the top 8 positions in the request, then it will stay at its current rank.
    GoogleCloudRetailV2RuleIgnoreAction
    Prevents a term in the query from being used in search. Example: Don't search for "shoddy".
    GoogleCloudRetailV2RuleIgnoreActionResponse
    Prevents a term in the query from being used in search. Example: Don't search for "shoddy".
    GoogleCloudRetailV2RuleOnewaySynonymsAction
    Maps a set of terms to a set of synonyms. Set of synonyms will be treated as synonyms of each query term only. query_terms will not be treated as synonyms of each other. Example: "sneakers" will use a synonym of "shoes". "shoes" will not use a synonym of "sneakers".
    GoogleCloudRetailV2RuleOnewaySynonymsActionResponse
    Maps a set of terms to a set of synonyms. Set of synonyms will be treated as synonyms of each query term only. query_terms will not be treated as synonyms of each other. Example: "sneakers" will use a synonym of "shoes". "shoes" will not use a synonym of "sneakers".
    GoogleCloudRetailV2RuleRedirectAction
    Redirects a shopper to a specific page. * Rule Condition: Must specify Condition.query_terms. * Action Input: Request Query * Action Result: Redirects shopper to provided uri.
    GoogleCloudRetailV2RuleRedirectActionResponse
    Redirects a shopper to a specific page. * Rule Condition: Must specify Condition.query_terms. * Action Input: Request Query * Action Result: Redirects shopper to provided uri.
    GoogleCloudRetailV2RuleRemoveFacetAction
    Removes an attribute/facet in the request if is present. * Rule Condition: Must specify non-empty Condition.query_terms (for search only) or Condition.page_categories (for browse only), but can't specify both. * Action Input: attribute name * Action Result: Will remove the attribute (as a facet) from the request if it is present. Example: Suppose the query is "shoes", the Condition.query_terms is "shoes" and the attribute name "size", then facet key "size" will be removed from the request (if it is present).
    GoogleCloudRetailV2RuleRemoveFacetActionResponse
    Removes an attribute/facet in the request if is present. * Rule Condition: Must specify non-empty Condition.query_terms (for search only) or Condition.page_categories (for browse only), but can't specify both. * Action Input: attribute name * Action Result: Will remove the attribute (as a facet) from the request if it is present. Example: Suppose the query is "shoes", the Condition.query_terms is "shoes" and the attribute name "size", then facet key "size" will be removed from the request (if it is present).
    GoogleCloudRetailV2RuleReplacementAction
    Replaces a term in the query. Multiple replacement candidates can be specified. All query_terms will be replaced with the replacement term. Example: Replace "gShoe" with "google shoe".
    GoogleCloudRetailV2RuleReplacementActionResponse
    Replaces a term in the query. Multiple replacement candidates can be specified. All query_terms will be replaced with the replacement term. Example: Replace "gShoe" with "google shoe".
    GoogleCloudRetailV2RuleResponse
    A rule is a condition-action pair * A condition defines when a rule is to be triggered. * An action specifies what occurs on that trigger. Currently rules only work for controls with SOLUTION_TYPE_SEARCH.
    GoogleCloudRetailV2RuleTwowaySynonymsAction
    Creates a set of terms that will be treated as synonyms of each other. Example: synonyms of "sneakers" and "shoes": * "sneakers" will use a synonym of "shoes". * "shoes" will use a synonym of "sneakers".
    GoogleCloudRetailV2RuleTwowaySynonymsActionResponse
    Creates a set of terms that will be treated as synonyms of each other. Example: synonyms of "sneakers" and "shoes": * "sneakers" will use a synonym of "shoes". * "shoes" will use a synonym of "sneakers".
    GoogleCloudRetailV2SearchRequestDynamicFacetSpec
    The specifications of dynamically generated facets.
    GoogleCloudRetailV2SearchRequestDynamicFacetSpecResponse
    The specifications of dynamically generated facets.
    GoogleCloudRetailV2SearchRequestPersonalizationSpec
    The specification for personalization.
    GoogleCloudRetailV2SearchRequestPersonalizationSpecResponse
    The specification for personalization.
    Model
    Creates a new model.
    ModelArgs
    The set of arguments for Model. The set of arguments for Model.
    ModelRetailV2alpha
    Creates a new model.
    ModelRetailV2alphaArgs
    The set of arguments for Model. The set of arguments for Model.
    ModelRetailV2beta
    Creates a new model.
    ModelRetailV2betaArgs
    The set of arguments for Model. The set of arguments for Model.
    Product
    Creates a Product.
    ProductArgs
    The set of arguments for Product. The set of arguments for Product.
    ProductRetailV2alpha
    Creates a Product.
    ProductRetailV2alphaArgs
    The set of arguments for Product. The set of arguments for Product.
    ProductRetailV2beta
    Creates a Product.
    ProductRetailV2betaArgs
    The set of arguments for Product. The set of arguments for Product.
    ServingConfig
    Creates a ServingConfig. A maximum of 100 ServingConfigs are allowed in a Catalog, otherwise a FAILED_PRECONDITION error is returned. Auto-naming is currently not supported for this resource.
    ServingConfigArgs
    The set of arguments for ServingConfig. The set of arguments for ServingConfig.
    ServingConfigRetailV2alpha
    Creates a ServingConfig. A maximum of 100 ServingConfigs are allowed in a Catalog, otherwise a FAILED_PRECONDITION error is returned. Auto-naming is currently not supported for this resource.
    ServingConfigRetailV2alphaArgs
    The set of arguments for ServingConfig. The set of arguments for ServingConfig.
    ServingConfigRetailV2beta
    Creates a ServingConfig. A maximum of 100 ServingConfigs are allowed in a Catalog, otherwise a FAILED_PRECONDITION error is returned. Auto-naming is currently not supported for this resource.
    ServingConfigRetailV2betaArgs
    The set of arguments for ServingConfig. The set of arguments for ServingConfig.

    Enums

    ControlSearchSolutionUseCaseItem
    ControlSearchSolutionUseCaseItemRetailV2alpha
    ControlSearchSolutionUseCaseItemRetailV2beta
    ControlSolutionTypesItem
    ControlSolutionTypesItemRetailV2alpha
    ControlSolutionTypesItemRetailV2beta
    GoogleCloudRetailV2alphaModelFrequentlyBoughtTogetherFeaturesConfigContextProductsType
    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.
    GoogleCloudRetailV2alphaModelPageOptimizationConfigRestriction
    Optional. How to restrict results across panels e.g. can the same ServingConfig be shown on multiple panels at once. If unspecified, default to UNIQUE_MODEL_RESTRICTION.
    GoogleCloudRetailV2alphaSearchRequestDynamicFacetSpecMode
    Mode of the DynamicFacet feature. Defaults to Mode.DISABLED if it's unset.
    GoogleCloudRetailV2alphaSearchRequestPersonalizationSpecMode
    Defaults to Mode.AUTO.
    GoogleCloudRetailV2betaModelFrequentlyBoughtTogetherFeaturesConfigContextProductsType
    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.
    GoogleCloudRetailV2betaSearchRequestDynamicFacetSpecMode
    Mode of the DynamicFacet feature. Defaults to Mode.DISABLED if it's unset.
    GoogleCloudRetailV2betaSearchRequestPersonalizationSpecMode
    Defaults to Mode.AUTO.
    GoogleCloudRetailV2ModelFrequentlyBoughtTogetherFeaturesConfigContextProductsType
    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.
    GoogleCloudRetailV2SearchRequestDynamicFacetSpecMode
    Mode of the DynamicFacet feature. Defaults to Mode.DISABLED if it's unset.
    GoogleCloudRetailV2SearchRequestPersonalizationSpecMode
    Defaults to Mode.AUTO.
    ModelFilteringOption
    Optional. If RECOMMENDATIONS_FILTERING_ENABLED, recommendation filtering by attributes is enabled for the model.
    ModelFilteringOptionRetailV2alpha
    Optional. If RECOMMENDATIONS_FILTERING_ENABLED, recommendation filtering by attributes is enabled for the model.
    ModelFilteringOptionRetailV2beta
    Optional. If RECOMMENDATIONS_FILTERING_ENABLED, recommendation filtering by attributes is enabled for the model.
    ModelPeriodicTuningState
    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.
    ModelPeriodicTuningStateRetailV2alpha
    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.
    ModelPeriodicTuningStateRetailV2beta
    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.
    ModelTrainingState
    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.
    ModelTrainingStateRetailV2alpha
    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.
    ModelTrainingStateRetailV2beta
    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.
    ProductAvailability
    The online availability of the Product. Default to Availability.IN_STOCK. Corresponding properties: Google Merchant Center property availability. Schema.org property Offer.availability.
    ProductAvailabilityRetailV2alpha
    The online availability of the Product. Default to Availability.IN_STOCK. Corresponding properties: Google Merchant Center property availability. Schema.org property Offer.availability.
    ProductAvailabilityRetailV2beta
    The online availability of the Product. Default to Availability.IN_STOCK. Corresponding properties: Google Merchant Center property availability. Schema.org property Offer.availability.
    ProductType
    Immutable. The type of the product. Default to Catalog.product_level_config.ingestion_product_type if unset.
    ProductTypeRetailV2alpha
    Immutable. The type of the product. Default to Catalog.product_level_config.ingestion_product_type if unset.
    ProductTypeRetailV2beta
    Immutable. The type of the product. Default to Catalog.product_level_config.ingestion_product_type if unset.
    ServingConfigDiversityType
    What kind of diversity to use - data driven or rule based. If unset, the server behavior defaults to RULE_BASED_DIVERSITY.
    ServingConfigDiversityTypeRetailV2alpha
    What kind of diversity to use - data driven or rule based. If unset, the server behavior defaults to RULE_BASED_DIVERSITY.
    ServingConfigDiversityTypeRetailV2beta
    What kind of diversity to use - data driven or rule based. If unset, the server behavior defaults to RULE_BASED_DIVERSITY.
    ServingConfigSolutionTypesItem
    ServingConfigSolutionTypesItemRetailV2alpha
    ServingConfigSolutionTypesItemRetailV2beta

    Functions

    getControl(GetControlArgs args, {InvokeOptions? options}) → Future<GetControlResult>
    Gets a Control. args Arguments passed to this invoke. Arguments for getControl. options Invoke options controlling this call.
    getControlRetailV2alpha(GetControlRetailV2alphaArgs args, {InvokeOptions? options}) → Future<GetControlRetailV2alphaResult>
    Gets a Control. args Arguments passed to this invoke. Arguments for getControl. options Invoke options controlling this call.
    getControlRetailV2beta(GetControlRetailV2betaArgs args, {InvokeOptions? options}) → Future<GetControlRetailV2betaResult>
    Gets a Control. args Arguments passed to this invoke. Arguments for getControl. options Invoke options controlling this call.
    getModel(GetModelArgs args, {InvokeOptions? options}) → Future<GetModelResult>
    Gets a model. args Arguments passed to this invoke. Arguments for getModel. options Invoke options controlling this call.
    getModelRetailV2alpha(GetModelRetailV2alphaArgs args, {InvokeOptions? options}) → Future<GetModelRetailV2alphaResult>
    Gets a model. args Arguments passed to this invoke. Arguments for getModel. options Invoke options controlling this call.
    getModelRetailV2beta(GetModelRetailV2betaArgs args, {InvokeOptions? options}) → Future<GetModelRetailV2betaResult>
    Gets a model. args Arguments passed to this invoke. Arguments for getModel. options Invoke options controlling this call.
    getProduct(GetProductArgs args, {InvokeOptions? options}) → Future<GetProductResult>
    Gets a Product. args Arguments passed to this invoke. Arguments for getProduct. options Invoke options controlling this call.
    getProductRetailV2alpha(GetProductRetailV2alphaArgs args, {InvokeOptions? options}) → Future<GetProductRetailV2alphaResult>
    Gets a Product. args Arguments passed to this invoke. Arguments for getProduct. options Invoke options controlling this call.
    getProductRetailV2beta(GetProductRetailV2betaArgs args, {InvokeOptions? options}) → Future<GetProductRetailV2betaResult>
    Gets a Product. args Arguments passed to this invoke. Arguments for getProduct. options Invoke options controlling this call.
    getServingConfig(GetServingConfigArgs args, {InvokeOptions? options}) → Future<GetServingConfigResult>
    Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist. args Arguments passed to this invoke. Arguments for getServingConfig. options Invoke options controlling this call.
    getServingConfigRetailV2alpha(GetServingConfigRetailV2alphaArgs args, {InvokeOptions? options}) → Future<GetServingConfigRetailV2alphaResult>
    Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist. args Arguments passed to this invoke. Arguments for getServingConfig. options Invoke options controlling this call.
    getServingConfigRetailV2beta(GetServingConfigRetailV2betaArgs args, {InvokeOptions? options}) → Future<GetServingConfigRetailV2betaResult>
    Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist. args Arguments passed to this invoke. Arguments for getServingConfig. options Invoke options controlling this call.