google-apis-retail_v2alpha 0.46.0 → 0.49.0

data/lib/google/apis/retail_v2alpha/classes.rb

@@ -565,7 +565,7 @@ module Google
       
       # Metadata related to the progress of the RemoveFulfillmentPlaces operation.
       # Currently empty because there is no meaningful metadata populated from the
-      # RemoveFulfillmentPlaces method.
+      # ProductService.RemoveFulfillmentPlaces method.
       class GoogleCloudRetailV2RemoveFulfillmentPlacesMetadata
         include Google::Apis::Core::Hashable
       
@@ -579,7 +579,8 @@ module Google
       end
       
       # Response of the RemoveFulfillmentPlacesRequest. Currently empty because there
-      # is no meaningful response populated from the RemoveFulfillmentPlaces method.
+      # is no meaningful response populated from the ProductService.
+      # RemoveFulfillmentPlaces method.
       class GoogleCloudRetailV2RemoveFulfillmentPlacesResponse
         include Google::Apis::Core::Hashable
       
@@ -594,7 +595,7 @@ module Google
       
       # Metadata related to the progress of the RemoveLocalInventories operation.
       # Currently empty because there is no meaningful metadata populated from the
-      # RemoveLocalInventories method.
+      # ProductService.RemoveLocalInventories method.
       class GoogleCloudRetailV2RemoveLocalInventoriesMetadata
         include Google::Apis::Core::Hashable
       
@@ -607,8 +608,9 @@ module Google
         end
       end
       
-      # Response of the RemoveLocalInventories API. Currently empty because there is
-      # no meaningful response populated from the RemoveLocalInventories method.
+      # Response of the ProductService.RemoveLocalInventories API. Currently empty
+      # because there is no meaningful response populated from the ProductService.
+      # RemoveLocalInventories method.
       class GoogleCloudRetailV2RemoveLocalInventoriesResponse
         include Google::Apis::Core::Hashable
       
@@ -622,8 +624,8 @@ module Google
       end
       
       # Metadata related to the progress of the SetInventory operation. Currently
-      # empty because there is no meaningful metadata populated from the SetInventory
-      # method.
+      # empty because there is no meaningful metadata populated from the
+      # ProductService.SetInventory method.
       class GoogleCloudRetailV2SetInventoryMetadata
         include Google::Apis::Core::Hashable
       
@@ -637,7 +639,7 @@ module Google
       end
       
       # Response of the SetInventoryRequest. Currently empty because there is no
-      # meaningful response populated from the SetInventory method.
+      # meaningful response populated from the ProductService.SetInventory method.
       class GoogleCloudRetailV2SetInventoryResponse
         include Google::Apis::Core::Hashable
       
@@ -1090,11 +1092,11 @@ module Google
         # Otherwise, this field is `False`. CatalogAttribute can be pre-loaded by using
         # CatalogService.AddCatalogAttribute, CatalogService.ImportCatalogAttributes, or
         # CatalogService.UpdateAttributesConfig APIs. This field is `False` for pre-
-        # loaded CatalogAttributes. Only CatalogAttributes that are not in use by
-        # products can be deleted. CatalogAttributes that are in use by products cannot
-        # be deleted; however, their configuration properties will reset to default
-        # values upon removal request. After catalog changes, it takes about 10 minutes
-        # for this field to update.
+        # loaded CatalogAttributes. Only pre-loaded CatalogAttributes that are neither
+        # in use by products nor predefined can be deleted. CatalogAttributes that are
+        # either in use by products or are predefined cannot be deleted; however, their
+        # configuration properties will reset to default values upon removal request.
+        # After catalog changes, it takes about 10 minutes for this field to update.
         # Corresponds to the JSON property `inUse`
         # @return [Boolean]
         attr_accessor :in_use
@@ -1243,9 +1245,8 @@ module Google
       
         # Custom attributes for the suggestion term. * For "user-data", the attributes
         # are additional custom attributes ingested through BigQuery. * For "cloud-
-        # retail", the attributes are product attributes generated by Cloud Retail. This
-        # is an experimental feature. Contact Retail Search support team if you are
-        # interested in enabling it.
+        # retail", the attributes are product attributes generated by Cloud Retail. It
+        # requires UserEvent.product_details is imported properly.
         # Corresponds to the JSON property `attributes`
         # @return [Hash<String,Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCustomAttribute>]
         attr_accessor :attributes
@@ -1584,6 +1585,26 @@ module Google
         end
       end
       
+      # Metadata associated with a create operation.
+      class GoogleCloudRetailV2alphaCreateModelMetadata
+        include Google::Apis::Core::Hashable
+      
+        # The resource name of the model that this create applies to. Format: projects/`
+        # project_number`/locations/`location_id`/catalogs/`catalog_id`/models/`model_id`
+        # Corresponds to the JSON property `model`
+        # @return [String]
+        attr_accessor :model
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @model = args[:model] if args.key?(:model)
+        end
+      end
+      
       # A custom attribute that is not explicitly modeled in Product.
       class GoogleCloudRetailV2alphaCustomAttribute
         include Google::Apis::Core::Hashable
@@ -2258,6 +2279,31 @@ module Google
         end
       end
       
+      # Response to a ListModelRequest.
+      class GoogleCloudRetailV2alphaListModelsResponse
+        include Google::Apis::Core::Hashable
+      
+        # List of Models.
+        # Corresponds to the JSON property `models`
+        # @return [Array<Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaModel>]
+        attr_accessor :models
+      
+        # Pagination token, if not returned indicates the last page.
+        # Corresponds to the JSON property `nextPageToken`
+        # @return [String]
+        attr_accessor :next_page_token
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @models = args[:models] if args.key?(:models)
+          @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
+        end
+      end
+      
       # Response message for ProductService.ListProducts method.
       class GoogleCloudRetailV2alphaListProductsResponse
         include Google::Apis::Core::Hashable
@@ -2453,6 +2499,244 @@ module Google
         end
       end
       
+      # Metadata that describes the training and serving parameters of a Model. A
+      # Model can be associated with a ServingConfig and then queried through the
+      # Predict api.
+      class GoogleCloudRetailV2alphaModel
+        include Google::Apis::Core::Hashable
+      
+        # Output only. Timestamp the Recommendation Model was created at.
+        # Corresponds to the JSON property `createTime`
+        # @return [String]
+        attr_accessor :create_time
+      
+        # Output only. The state of data requirements for this model: DATA_OK and
+        # DATA_ERROR. Recommendation model cannot be trained if the data is in
+        # DATA_ERROR state. Recommendation model can have DATA_ERROR state even if
+        # serving state is ACTIVE: models were trained successfully before, but cannot
+        # be refreshed because model no longer has sufficient data for training.
+        # Corresponds to the JSON property `dataState`
+        # @return [String]
+        attr_accessor :data_state
+      
+        # Required. The display name of the model. Should be human readable, used to
+        # display Recommendation Models in the Retail Pantheon Dashboard. UTF-8 encoded
+        # string with limit of 1024 characters.
+        # Corresponds to the JSON property `displayName`
+        # @return [String]
+        attr_accessor :display_name
+      
+        # Optional. If RECOMMENDATIONS_FILTERING_ENABLED, recommendation filtering by
+        # attributes is enabled for the model.
+        # Corresponds to the JSON property `filteringOption`
+        # @return [String]
+        attr_accessor :filtering_option
+      
+        # Output only. The timestamp when the latest successful tune finished.
+        # Corresponds to the JSON property `lastTuneTime`
+        # @return [String]
+        attr_accessor :last_tune_time
+      
+        # 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.
+        # Corresponds to the JSON property `name`
+        # @return [String]
+        attr_accessor :name
+      
+        # 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`
+        # Corresponds to the JSON property `optimizationObjective`
+        # @return [String]
+        attr_accessor :optimization_objective
+      
+        # The PageOptimizationConfig for model training. This determines how many panels
+        # to optimize for, and which serving configurations 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.
+        # Corresponds to the JSON property `pageOptimizationConfig`
+        # @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaModelPageOptimizationConfig]
+        attr_accessor :page_optimization_config
+      
+        # 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.
+        # Corresponds to the JSON property `periodicTuningState`
+        # @return [String]
+        attr_accessor :periodic_tuning_state
+      
+        # Output only. The serving state of the model: ACTIVE, NOT_ACTIVE.
+        # Corresponds to the JSON property `servingState`
+        # @return [String]
+        attr_accessor :serving_state
+      
+        # 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.
+        # Corresponds to the JSON property `trainingState`
+        # @return [String]
+        attr_accessor :training_state
+      
+        # Output only. The tune operation associated with the model. Can be used to
+        # determine if there is an ongoing tune for this recommendation. Empty field
+        # implies no tune is goig on.
+        # Corresponds to the JSON property `tuningOperation`
+        # @return [String]
+        attr_accessor :tuning_operation
+      
+        # 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', `recently-viewed`(
+        # readonly value).
+        # Corresponds to the JSON property `type`
+        # @return [String]
+        attr_accessor :type
+      
+        # Output only. Timestamp the Recommendation Model was last updated. E.g. if a
+        # Recommendation Model was paused - this would be the time the pause was
+        # initiated.
+        # Corresponds to the JSON property `updateTime`
+        # @return [String]
+        attr_accessor :update_time
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @create_time = args[:create_time] if args.key?(:create_time)
+          @data_state = args[:data_state] if args.key?(:data_state)
+          @display_name = args[:display_name] if args.key?(:display_name)
+          @filtering_option = args[:filtering_option] if args.key?(:filtering_option)
+          @last_tune_time = args[:last_tune_time] if args.key?(:last_tune_time)
+          @name = args[:name] if args.key?(:name)
+          @optimization_objective = args[:optimization_objective] if args.key?(:optimization_objective)
+          @page_optimization_config = args[:page_optimization_config] if args.key?(:page_optimization_config)
+          @periodic_tuning_state = args[:periodic_tuning_state] if args.key?(:periodic_tuning_state)
+          @serving_state = args[:serving_state] if args.key?(:serving_state)
+          @training_state = args[:training_state] if args.key?(:training_state)
+          @tuning_operation = args[:tuning_operation] if args.key?(:tuning_operation)
+          @type = args[:type] if args.key?(:type)
+          @update_time = args[:update_time] if args.key?(:update_time)
+        end
+      end
+      
+      # The PageOptimizationConfig for model training. This determines how many panels
+      # to optimize for, and which serving configurations 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.
+      class GoogleCloudRetailV2alphaModelPageOptimizationConfig
+        include Google::Apis::Core::Hashable
+      
+        # Required. The type of UserEvent this page optimization is shown for. Each page
+        # has an associated event type - this will be the corresponding event type for
+        # the page that the page optimization model is used on. Supported types: * `add-
+        # to-cart`: Products being added to cart. * `detail-page-view`: Products detail
+        # page viewed. * `home-page-view`: Homepage viewed * `category-page-view`:
+        # Homepage viewed * `shopping-cart-page-view`: User viewing a shopping cart. `
+        # home-page-view` only allows models with type `recommended-for-you`. All other
+        # page_optimization_event_type allow all Model.types.
+        # Corresponds to the JSON property `pageOptimizationEventType`
+        # @return [String]
+        attr_accessor :page_optimization_event_type
+      
+        # Required. A list of panel configurations. Limit = 5.
+        # Corresponds to the JSON property `panels`
+        # @return [Array<Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaModelPageOptimizationConfigPanel>]
+        attr_accessor :panels
+      
+        # 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`.
+        # Corresponds to the JSON property `restriction`
+        # @return [String]
+        attr_accessor :restriction
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @page_optimization_event_type = args[:page_optimization_event_type] if args.key?(:page_optimization_event_type)
+          @panels = args[:panels] if args.key?(:panels)
+          @restriction = args[:restriction] if args.key?(:restriction)
+        end
+      end
+      
+      # A candidate to consider for a given panel. Currently only ServingConfig are
+      # valid candidates.
+      class GoogleCloudRetailV2alphaModelPageOptimizationConfigCandidate
+        include Google::Apis::Core::Hashable
+      
+        # This has to be a valid ServingConfig identifier. e.g. for a ServingConfig with
+        # full name: `projects/*/locations/global/catalogs/default_catalog/
+        # servingConfigs/my_candidate_config` this would be 'my_candidate_config'
+        # Corresponds to the JSON property `servingConfigId`
+        # @return [String]
+        attr_accessor :serving_config_id
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @serving_config_id = args[:serving_config_id] if args.key?(:serving_config_id)
+        end
+      end
+      
+      # An individual panel with a list of ServingConfigs to consider for it.
+      class GoogleCloudRetailV2alphaModelPageOptimizationConfigPanel
+        include Google::Apis::Core::Hashable
+      
+        # Required. The candidates to consider on the panel. Limit = 10.
+        # Corresponds to the JSON property `candidates`
+        # @return [Array<Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaModelPageOptimizationConfigCandidate>]
+        attr_accessor :candidates
+      
+        # A candidate to consider for a given panel. Currently only ServingConfig are
+        # valid candidates.
+        # Corresponds to the JSON property `defaultCandidate`
+        # @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaModelPageOptimizationConfigCandidate]
+        attr_accessor :default_candidate
+      
+        # Optional. The name to display for the panel.
+        # Corresponds to the JSON property `displayName`
+        # @return [String]
+        attr_accessor :display_name
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @candidates = args[:candidates] if args.key?(:candidates)
+          @default_candidate = args[:default_candidate] if args.key?(:default_candidate)
+          @display_name = args[:display_name] if args.key?(:display_name)
+        end
+      end
+      
+      # Request for pausing training of a model.
+      class GoogleCloudRetailV2alphaPauseModelRequest
+        include Google::Apis::Core::Hashable
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+        end
+      end
+      
       # Request message for Predict method.
       class GoogleCloudRetailV2alphaPredictRequest
         include Google::Apis::Core::Hashable
@@ -2474,7 +2758,7 @@ module Google
         # in `PredictRequest.params` to receive empty results instead. Note that the API
         # will never return items with storageStatus of "EXPIRED" or "DELETED"
         # regardless of filter choices. If `filterSyntaxV2` is set to true under the `
-        # params` field, then attribute based expressions are expected instead of the
+        # params` field, then attribute-based expressions are expected instead of the
         # above described tag-based syntax. Examples: * (colors: ANY("Red", "Blue")) AND
         # NOT (categories: ANY("Phones")) * (availability: ANY("IN_STOCK")) AND (colors:
         # ANY("Red") OR categories: ANY("Phones"))
@@ -2505,7 +2789,7 @@ module Google
         # @return [Fixnum]
         attr_accessor :page_size
       
-        # The previous PredictResponse.next_page_token.
+        # This field is not used for now, leave it unset.
         # Corresponds to the JSON property `pageToken`
         # @return [String]
         attr_accessor :page_token
@@ -2527,8 +2811,8 @@ module Google
         # it needs to be one of `'no-diversity', 'low-diversity', 'medium-diversity', '
         # high-diversity', 'auto-diversity'`. This gives request-level control and
         # adjusts prediction results based on product category. * `filterSyntaxV2`:
-        # Boolean. False by default. If set to true, the `filter` field will be
-        # interpreteted according to the new, attribute-based syntax.
+        # Boolean. False by default. If set to true, the `filter` field is interpreteted
+        # according to the new, attribute-based syntax.
         # Corresponds to the JSON property `params`
         # @return [Hash<String,Object>]
         attr_accessor :params
@@ -3614,7 +3898,7 @@ module Google
       
       # Metadata related to the progress of the RemoveFulfillmentPlaces operation.
       # Currently empty because there is no meaningful metadata populated from the
-      # RemoveFulfillmentPlaces method.
+      # ProductService.RemoveFulfillmentPlaces method.
       class GoogleCloudRetailV2alphaRemoveFulfillmentPlacesMetadata
         include Google::Apis::Core::Hashable
       
@@ -3627,7 +3911,7 @@ module Google
         end
       end
       
-      # Request message for RemoveFulfillmentPlaces method.
+      # Request message for ProductService.RemoveFulfillmentPlaces method.
       class GoogleCloudRetailV2alphaRemoveFulfillmentPlacesRequest
         include Google::Apis::Core::Hashable
       
@@ -3682,7 +3966,8 @@ module Google
       end
       
       # Response of the RemoveFulfillmentPlacesRequest. Currently empty because there
-      # is no meaningful response populated from the RemoveFulfillmentPlaces method.
+      # is no meaningful response populated from the ProductService.
+      # RemoveFulfillmentPlaces method.
       class GoogleCloudRetailV2alphaRemoveFulfillmentPlacesResponse
         include Google::Apis::Core::Hashable
       
@@ -3697,7 +3982,7 @@ module Google
       
       # Metadata related to the progress of the RemoveLocalInventories operation.
       # Currently empty because there is no meaningful metadata populated from the
-      # RemoveLocalInventories method.
+      # ProductService.RemoveLocalInventories method.
       class GoogleCloudRetailV2alphaRemoveLocalInventoriesMetadata
         include Google::Apis::Core::Hashable
       
@@ -3710,7 +3995,7 @@ module Google
         end
       end
       
-      # Request message for RemoveLocalInventories method.
+      # Request message for ProductService.RemoveLocalInventories method.
       class GoogleCloudRetailV2alphaRemoveLocalInventoriesRequest
         include Google::Apis::Core::Hashable
       
@@ -3748,8 +4033,9 @@ module Google
         end
       end
       
-      # Response of the RemoveLocalInventories API. Currently empty because there is
-      # no meaningful response populated from the RemoveLocalInventories method.
+      # Response of the ProductService.RemoveLocalInventories API. Currently empty
+      # because there is no meaningful response populated from the ProductService.
+      # RemoveLocalInventories method.
       class GoogleCloudRetailV2alphaRemoveLocalInventoriesResponse
         include Google::Apis::Core::Hashable
       
@@ -3790,6 +4076,19 @@ module Google
         end
       end
       
+      # Request for resuming training of a model.
+      class GoogleCloudRetailV2alphaResumeModelRequest
+        include Google::Apis::Core::Hashable
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+        end
+      end
+      
       # 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 only
       # boost rules are supported. Currently only supported by the search endpoint.
@@ -3817,13 +4116,13 @@ module Google
         # @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaRuleDoNotAssociateAction]
         attr_accessor :do_not_associate_action
       
-        # * Rule Condition: - No Condition provided is a global match. - 1 or more
-        # Condition provided is combined with OR operator. * Action Input: The request
-        # query and filter that will be 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.
+        # * Rule Condition: - No Condition.query_terms provided is a global match. - 1
+        # or more Condition.query_terms provided is 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.
         # Corresponds to the JSON property `filterAction`
         # @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaRuleFilterAction]
         attr_accessor :filter_action
@@ -3843,8 +4142,8 @@ module Google
         attr_accessor :oneway_synonyms_action
       
         # Redirects a shopper to a specific page. * Rule Condition: - Must specify
-        # Condition. * Action Input: Request Query * Action Result: Redirects shopper to
-        # provided uri.
+        # Condition.query_terms. * Action Input: Request Query * Action Result:
+        # Redirects shopper to provided uri.
         # Corresponds to the JSON property `redirectAction`
         # @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaRuleRedirectAction]
         attr_accessor :redirect_action
@@ -3954,13 +4253,13 @@ module Google
         end
       end
       
-      # * Rule Condition: - No Condition provided is a global match. - 1 or more
-      # Condition provided is combined with OR operator. * Action Input: The request
-      # query and filter that will be 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.
+      # * Rule Condition: - No Condition.query_terms provided is a global match. - 1
+      # or more Condition.query_terms provided is 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.
       class GoogleCloudRetailV2alphaRuleFilterAction
         include Google::Apis::Core::Hashable
       
@@ -4041,8 +4340,8 @@ module Google
       end
       
       # Redirects a shopper to a specific page. * Rule Condition: - Must specify
-      # Condition. * Action Input: Request Query * Action Result: Redirects shopper to
-      # provided uri.
+      # Condition.query_terms. * Action Input: Request Query * Action Result:
+      # Redirects shopper to provided uri.
       class GoogleCloudRetailV2alphaRuleRedirectAction
         include Google::Apis::Core::Hashable
       
@@ -4536,13 +4835,14 @@ module Google
         # @return [String]
         attr_accessor :key
       
-        # The order in which Facet.values are returned. Allowed values are: * "count
-        # desc", which means order by Facet.FacetValue.count descending. * "value desc",
-        # which means order by Facet.FacetValue.value descending. Only applies to
-        # textual facets. If not set, textual values are sorted in [natural order](https:
-        # //en.wikipedia.org/wiki/Natural_sort_order); numerical intervals are sorted in
-        # the order given by FacetSpec.FacetKey.intervals; FulfillmentInfo.place_ids are
-        # sorted in the order given by FacetSpec.FacetKey.restricted_values.
+        # The order in which SearchResponse.Facet.values are returned. Allowed values
+        # are: * "count desc", which means order by SearchResponse.Facet.values.count
+        # descending. * "value desc", which means order by SearchResponse.Facet.values.
+        # value descending. Only applies to textual facets. If not set, textual values
+        # are sorted in [natural order](https://en.wikipedia.org/wiki/Natural_sort_order)
+        # ; numerical intervals are sorted in the order given by FacetSpec.FacetKey.
+        # intervals; FulfillmentInfo.place_ids are sorted in the order given by
+        # FacetSpec.FacetKey.restricted_values.
         # Corresponds to the JSON property `orderBy`
         # @return [String]
         attr_accessor :order_by
@@ -4560,12 +4860,13 @@ module Google
         # it will override the default behavior of facet computation. The query syntax
         # is the same as a filter expression. See SearchRequest.filter for detail syntax
         # and limitations. Notice that there is no limitation on FacetKey.key when query
-        # is specified. In the response, FacetValue.value will be always "1" and
-        # FacetValue.count will be the number of results that matches the query. For
-        # example, you can set a customized facet for "shipToStore", where FacetKey.key
-        # is "customizedShipToStore", and FacetKey.query is "availability: ANY(\"
-        # IN_STOCK\") AND shipToStore: ANY(\"123\")". Then the facet will count the
-        # products that are both in stock and ship to store "123".
+        # is specified. In the response, SearchResponse.Facet.values.value will be
+        # always "1" and SearchResponse.Facet.values.count will be the number of results
+        # that match the query. For example, you can set a customized facet for "
+        # shipToStore", where FacetKey.key is "customizedShipToStore", and FacetKey.
+        # query is "availability: ANY(\"IN_STOCK\") AND shipToStore: ANY(\"123\")". Then
+        # the facet will count the products that are both in stock and ship to store "
+        # 123".
         # Corresponds to the JSON property `query`
         # @return [String]
         attr_accessor :query
@@ -4686,7 +4987,7 @@ module Google
       
         # Contains the spell corrected query, if found. If the spell correction type is
         # AUTOMATIC, then the search results are based on corrected_query. Otherwise the
-        # original query will be used for search.
+        # original query is used for search.
         # Corresponds to the JSON property `correctedQuery`
         # @return [String]
         attr_accessor :corrected_query
@@ -5120,8 +5421,8 @@ module Google
       end
       
       # Metadata related to the progress of the SetInventory operation. Currently
-      # empty because there is no meaningful metadata populated from the SetInventory
-      # method.
+      # empty because there is no meaningful metadata populated from the
+      # ProductService.SetInventory method.
       class GoogleCloudRetailV2alphaSetInventoryMetadata
         include Google::Apis::Core::Hashable
       
@@ -5134,7 +5435,7 @@ module Google
         end
       end
       
-      # Request message for SetInventory method.
+      # Request message for ProductService.SetInventory method.
       class GoogleCloudRetailV2alphaSetInventoryRequest
         include Google::Apis::Core::Hashable
       
@@ -5181,7 +5482,7 @@ module Google
       end
       
       # Response of the SetInventoryRequest. Currently empty because there is no
-      # meaningful response populated from the SetInventory method.
+      # meaningful response populated from the ProductService.SetInventory method.
       class GoogleCloudRetailV2alphaSetInventoryResponse
         include Google::Apis::Core::Hashable
       
@@ -5194,6 +5495,53 @@ module Google
         end
       end
       
+      # Metadata associated with a tune operation.
+      class GoogleCloudRetailV2alphaTuneModelMetadata
+        include Google::Apis::Core::Hashable
+      
+        # The resource name of the model that this tune applies to. Format: projects/`
+        # project_number`/locations/`location_id`/catalogs/`catalog_id`/models/`model_id`
+        # Corresponds to the JSON property `model`
+        # @return [String]
+        attr_accessor :model
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @model = args[:model] if args.key?(:model)
+        end
+      end
+      
+      # Request to manually start a tuning process now (instead of waiting for the
+      # periodically scheduled tuning to happen).
+      class GoogleCloudRetailV2alphaTuneModelRequest
+        include Google::Apis::Core::Hashable
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+        end
+      end
+      
+      # Response associated with a tune operation.
+      class GoogleCloudRetailV2alphaTuneModelResponse
+        include Google::Apis::Core::Hashable
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+        end
+      end
+      
       # UserEvent captures all metadata information Retail API needs to know about how
       # end users interact with customers' website.
       class GoogleCloudRetailV2alphaUserEvent
@@ -5944,7 +6292,7 @@ module Google
       
       # Metadata related to the progress of the RemoveFulfillmentPlaces operation.
       # Currently empty because there is no meaningful metadata populated from the
-      # RemoveFulfillmentPlaces method.
+      # ProductService.RemoveFulfillmentPlaces method.
       class GoogleCloudRetailV2betaRemoveFulfillmentPlacesMetadata
         include Google::Apis::Core::Hashable
       
@@ -5958,7 +6306,8 @@ module Google
       end
       
       # Response of the RemoveFulfillmentPlacesRequest. Currently empty because there
-      # is no meaningful response populated from the RemoveFulfillmentPlaces method.
+      # is no meaningful response populated from the ProductService.
+      # RemoveFulfillmentPlaces method.
       class GoogleCloudRetailV2betaRemoveFulfillmentPlacesResponse
         include Google::Apis::Core::Hashable
       
@@ -5973,7 +6322,7 @@ module Google
       
       # Metadata related to the progress of the RemoveLocalInventories operation.
       # Currently empty because there is no meaningful metadata populated from the
-      # RemoveLocalInventories method.
+      # ProductService.RemoveLocalInventories method.
       class GoogleCloudRetailV2betaRemoveLocalInventoriesMetadata
         include Google::Apis::Core::Hashable
       
@@ -5986,8 +6335,9 @@ module Google
         end
       end
       
-      # Response of the RemoveLocalInventories API. Currently empty because there is
-      # no meaningful response populated from the RemoveLocalInventories method.
+      # Response of the ProductService.RemoveLocalInventories API. Currently empty
+      # because there is no meaningful response populated from the ProductService.
+      # RemoveLocalInventories method.
       class GoogleCloudRetailV2betaRemoveLocalInventoriesResponse
         include Google::Apis::Core::Hashable
       
@@ -6001,8 +6351,8 @@ module Google
       end
       
       # Metadata related to the progress of the SetInventory operation. Currently
-      # empty because there is no meaningful metadata populated from the SetInventory
-      # method.
+      # empty because there is no meaningful metadata populated from the
+      # ProductService.SetInventory method.
       class GoogleCloudRetailV2betaSetInventoryMetadata
         include Google::Apis::Core::Hashable
       
@@ -6016,7 +6366,7 @@ module Google
       end
       
       # Response of the SetInventoryRequest. Currently empty because there is no
-      # meaningful response populated from the SetInventory method.
+      # meaningful response populated from the ProductService.SetInventory method.
       class GoogleCloudRetailV2betaSetInventoryResponse
         include Google::Apis::Core::Hashable