google-apis-retail_v2beta 0.45.0 → 0.48.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f05a11bd21474caa0b330347bbf902a828e44fd6baa1178894a4725add222bbf
-  data.tar.gz: 75d0bb9f99b205498f908d76afb91feedfc6f5fbc9f3410e96400c9cadfba175
+  metadata.gz: db793e92a01d652adbcc15c48098a430659fc3b12e192b93d2469410f6950c46
+  data.tar.gz: 5e2ec82bdff8cee71cc4e7d04f797be372d66127d71cce2876fe0daa96c46980
 SHA512:
-  metadata.gz: 224f9910897cb1ff2ba3100dd2970691240338280df5474c19d45288c692328b395b8d3ea11bbf8651bd54bfcf1fd880e280cdf2d8a9222bd0f8194ed3d3bcc0
-  data.tar.gz: e0ade45afb115fd2e1d2794a547f116a59a02c91aedaeb23739fca29dfe6ee21089479a3a1031b4046d3647d8ff0fd5ed8f401dc33ba81d9d996b087f5eed261
+  metadata.gz: 57c3e8c7c580660a79bf8bbcf6ac487273c0a4ffbf209ced0f6b34022cee4fefc04fa8bbe6a8f9c07adefc7c302f50ada420f07ab7cff67217084dcdc2fa23fd
+  data.tar.gz: e46335c5a6eafd152f006ee6804ecc040541eb0c36711d19f196d9f9fb1570e484d237a6141fd3b8af753db0a990b56ae1e5d8bbf8a028bd95b52a1a3f87a06e

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 # Release history for google-apis-retail_v2beta
 
+### v0.48.0 (2022-07-19)
+
+* Regenerated from discovery document revision 20220716
+
+### v0.47.0 (2022-07-12)
+
+* Regenerated from discovery document revision 20220707
+
+### v0.46.0 (2022-07-08)
+
+* Regenerated from discovery document revision 20220630
+* Regenerated using generator version 0.9.0
+
 ### v0.45.0 (2022-06-30)
 
 * Regenerated from discovery document revision 20220623

data/lib/google/apis/retail_v2beta/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
       
@@ -737,6 +739,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
+      
       # Configuration of destination for Export related errors.
       class GoogleCloudRetailV2alphaExportErrorsConfig
         include Google::Apis::Core::Hashable
@@ -996,6 +1018,231 @@ 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::RetailV2beta::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::RetailV2beta::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::RetailV2beta::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::RetailV2beta::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
+      
       # Metadata related to the progress of the Purge operation. This will be returned
       # by the google.longrunning.Operation.metadata field.
       class GoogleCloudRetailV2alphaPurgeMetadata
@@ -1133,7 +1380,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
       
@@ -1147,7 +1394,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
       
@@ -1162,7 +1410,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
       
@@ -1175,8 +1423,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
       
@@ -1190,8 +1439,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
       
@@ -1205,7 +1454,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
       
@@ -1218,6 +1467,39 @@ 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
+      
+      # 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
+      
       # A summary of import result. The UserEventImportSummary summarizes the import
       # status for user events.
       class GoogleCloudRetailV2alphaUserEventImportSummary
@@ -1658,11 +1940,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
@@ -1811,9 +2093,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::RetailV2beta::GoogleCloudRetailV2betaCustomAttribute>]
         attr_accessor :attributes
@@ -3023,7 +3304,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"))
@@ -3054,7 +3335,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
@@ -3076,8 +3357,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
@@ -4054,7 +4335,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
       
@@ -4067,7 +4348,7 @@ module Google
         end
       end
       
-      # Request message for RemoveFulfillmentPlaces method.
+      # Request message for ProductService.RemoveFulfillmentPlaces method.
       class GoogleCloudRetailV2betaRemoveFulfillmentPlacesRequest
         include Google::Apis::Core::Hashable
       
@@ -4122,7 +4403,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
       
@@ -4137,7 +4419,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
       
@@ -4150,7 +4432,7 @@ module Google
         end
       end
       
-      # Request message for RemoveLocalInventories method.
+      # Request message for ProductService.RemoveLocalInventories method.
       class GoogleCloudRetailV2betaRemoveLocalInventoriesRequest
         include Google::Apis::Core::Hashable
       
@@ -4188,8 +4470,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
       
@@ -4257,13 +4540,13 @@ module Google
         # @return [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaRuleDoNotAssociateAction]
         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::RetailV2beta::GoogleCloudRetailV2betaRuleFilterAction]
         attr_accessor :filter_action
@@ -4283,8 +4566,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::RetailV2beta::GoogleCloudRetailV2betaRuleRedirectAction]
         attr_accessor :redirect_action
@@ -4394,13 +4677,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 GoogleCloudRetailV2betaRuleFilterAction
         include Google::Apis::Core::Hashable
       
@@ -4481,8 +4764,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 GoogleCloudRetailV2betaRuleRedirectAction
         include Google::Apis::Core::Hashable
       
@@ -4967,13 +5250,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
@@ -4991,12 +5275,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
@@ -5117,7 +5402,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
@@ -5551,8 +5836,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
       
@@ -5565,7 +5850,7 @@ module Google
         end
       end
       
-      # Request message for SetInventory method.
+      # Request message for ProductService.SetInventory method.
       class GoogleCloudRetailV2betaSetInventoryRequest
         include Google::Apis::Core::Hashable
       
@@ -5612,7 +5897,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
       

data/lib/google/apis/retail_v2beta/gem_version.rb

@@ -16,13 +16,13 @@ module Google
   module Apis
     module RetailV2beta
       # Version of the google-apis-retail_v2beta gem
-      GEM_VERSION = "0.45.0"
+      GEM_VERSION = "0.48.0"
 
       # Version of the code generator used to generate this client
-      GENERATOR_VERSION = "0.8.0"
+      GENERATOR_VERSION = "0.9.0"
 
       # Revision of the discovery document this client was generated from
-      REVISION = "20220623"
+      REVISION = "20220716"
     end
   end
 end

data/lib/google/apis/retail_v2beta/representations.rb

@@ -208,6 +208,12 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class GoogleCloudRetailV2alphaCreateModelMetadata
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class GoogleCloudRetailV2alphaExportErrorsConfig
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -262,6 +268,30 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class GoogleCloudRetailV2alphaModel
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleCloudRetailV2alphaModelPageOptimizationConfig
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleCloudRetailV2alphaModelPageOptimizationConfigCandidate
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleCloudRetailV2alphaModelPageOptimizationConfigPanel
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class GoogleCloudRetailV2alphaPurgeMetadata
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -334,6 +364,18 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class GoogleCloudRetailV2alphaTuneModelMetadata
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleCloudRetailV2alphaTuneModelResponse
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class GoogleCloudRetailV2alphaUserEventImportSummary
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -1266,6 +1308,13 @@ module Google
         end
       end
       
+      class GoogleCloudRetailV2alphaCreateModelMetadata
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :model, as: 'model'
+        end
+      end
+      
       class GoogleCloudRetailV2alphaExportErrorsConfig
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -1350,6 +1399,55 @@ module Google
         end
       end
       
+      class GoogleCloudRetailV2alphaModel
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :create_time, as: 'createTime'
+          property :data_state, as: 'dataState'
+          property :display_name, as: 'displayName'
+          property :filtering_option, as: 'filteringOption'
+          property :last_tune_time, as: 'lastTuneTime'
+          property :name, as: 'name'
+          property :optimization_objective, as: 'optimizationObjective'
+          property :page_optimization_config, as: 'pageOptimizationConfig', class: Google::Apis::RetailV2beta::GoogleCloudRetailV2alphaModelPageOptimizationConfig, decorator: Google::Apis::RetailV2beta::GoogleCloudRetailV2alphaModelPageOptimizationConfig::Representation
+      
+          property :periodic_tuning_state, as: 'periodicTuningState'
+          property :serving_state, as: 'servingState'
+          property :training_state, as: 'trainingState'
+          property :tuning_operation, as: 'tuningOperation'
+          property :type, as: 'type'
+          property :update_time, as: 'updateTime'
+        end
+      end
+      
+      class GoogleCloudRetailV2alphaModelPageOptimizationConfig
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :page_optimization_event_type, as: 'pageOptimizationEventType'
+          collection :panels, as: 'panels', class: Google::Apis::RetailV2beta::GoogleCloudRetailV2alphaModelPageOptimizationConfigPanel, decorator: Google::Apis::RetailV2beta::GoogleCloudRetailV2alphaModelPageOptimizationConfigPanel::Representation
+      
+          property :restriction, as: 'restriction'
+        end
+      end
+      
+      class GoogleCloudRetailV2alphaModelPageOptimizationConfigCandidate
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :serving_config_id, as: 'servingConfigId'
+        end
+      end
+      
+      class GoogleCloudRetailV2alphaModelPageOptimizationConfigPanel
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          collection :candidates, as: 'candidates', class: Google::Apis::RetailV2beta::GoogleCloudRetailV2alphaModelPageOptimizationConfigCandidate, decorator: Google::Apis::RetailV2beta::GoogleCloudRetailV2alphaModelPageOptimizationConfigCandidate::Representation
+      
+          property :default_candidate, as: 'defaultCandidate', class: Google::Apis::RetailV2beta::GoogleCloudRetailV2alphaModelPageOptimizationConfigCandidate, decorator: Google::Apis::RetailV2beta::GoogleCloudRetailV2alphaModelPageOptimizationConfigCandidate::Representation
+      
+          property :display_name, as: 'displayName'
+        end
+      end
+      
       class GoogleCloudRetailV2alphaPurgeMetadata
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -1430,6 +1528,19 @@ module Google
         end
       end
       
+      class GoogleCloudRetailV2alphaTuneModelMetadata
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :model, as: 'model'
+        end
+      end
+      
+      class GoogleCloudRetailV2alphaTuneModelResponse
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+        end
+      end
+      
       class GoogleCloudRetailV2alphaUserEventImportSummary
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation

data/lib/google/apis/retail_v2beta/service.rb

@@ -72,12 +72,13 @@ module Google
         #   `UNKNOWN_DEVICE_TYPE` * `DESKTOP` * `MOBILE` * A customized string starts with
         #   `OTHER_`, e.g. `OTHER_IPHONE`.
         # @param [Array<String>, String] language_codes
-        #   The language filters applied to the output suggestions. If set, it should
-        #   contain the language of the query. If not set, suggestions are returned
-        #   without considering language restrictions. This is the BCP-47 language code,
-        #   such as "en-US" or "sr-Latn". For more information, see [Tags for Identifying
-        #   Languages](https://tools.ietf.org/html/bcp47). The maximum number of language
-        #   codes is 3.
+        #   Note that this field applies for `user-data` dataset only. For requests with `
+        #   cloud-retail` dataset, setting this field has no effect. The language filters
+        #   applied to the output suggestions. If set, it should contain the language of
+        #   the query. If not set, suggestions are returned without considering language
+        #   restrictions. This is the BCP-47 language code, such as "en-US" or "sr-Latn".
+        #   For more information, see [Tags for Identifying Languages](https://tools.ietf.
+        #   org/html/bcp47). The maximum number of language codes is 3.
         # @param [Fixnum] max_suggestions
         #   Completion max suggestions. If left unset or set to 0, then will fallback to
         #   the configured value CompletionConfig.max_suggestions. The maximum allowed max
@@ -578,9 +579,9 @@ module Google
         # updating fulfillment information. If the request is valid, the update will be
         # enqueued and processed downstream. As a consequence, when a response is
         # returned, the added place IDs are not immediately manifested in the Product
-        # queried by GetProduct or ListProducts. This feature is only available for
-        # users who have Retail Search enabled. Please enable Retail Search on Cloud
-        # Console before using this feature.
+        # queried by ProductService.GetProduct or ProductService.ListProducts. This
+        # feature is only available for users who have Retail Search enabled. Please
+        # enable Retail Search on Cloud Console before using this feature.
         # @param [String] product
         #   Required. Full resource name of Product, such as `projects/*/locations/global/
         #   catalogs/default_catalog/branches/default_branch/products/some_product_id`. If
@@ -621,11 +622,13 @@ module Google
         # asynchronous and does not require the Product to exist before updating
         # inventory information. If the request is valid, the update will be enqueued
         # and processed downstream. As a consequence, when a response is returned,
-        # updates are not immediately manifested in the Product queried by GetProduct or
-        # ListProducts. Local inventory information can only be modified using this
-        # method. CreateProduct and UpdateProduct has no effect on local inventories.
-        # This feature is only available for users who have Retail Search enabled.
-        # Please enable Retail Search on Cloud Console before using this feature.
+        # updates are not immediately manifested in the Product queried by
+        # ProductService.GetProduct or ProductService.ListProducts. Local inventory
+        # information can only be modified using this method. ProductService.
+        # CreateProduct and ProductService.UpdateProduct has no effect on local
+        # inventories. This feature is only available for users who have Retail Search
+        # enabled. Please enable Retail Search on Cloud Console before using this
+        # feature.
         # @param [String] product
         #   Required. Full resource name of Product, such as `projects/*/locations/global/
         #   catalogs/default_catalog/branches/default_branch/products/some_product_id`. If
@@ -931,9 +934,9 @@ module Google
         # updating fulfillment information. If the request is valid, the update will be
         # enqueued and processed downstream. As a consequence, when a response is
         # returned, the removed place IDs are not immediately manifested in the Product
-        # queried by GetProduct or ListProducts. This feature is only available for
-        # users who have Retail Search enabled. Please enable Retail Search on Cloud
-        # Console before using this feature.
+        # queried by ProductService.GetProduct or ProductService.ListProducts. This
+        # feature is only available for users who have Retail Search enabled. Please
+        # enable Retail Search on Cloud Console before using this feature.
         # @param [String] product
         #   Required. Full resource name of Product, such as `projects/*/locations/global/
         #   catalogs/default_catalog/branches/default_branch/products/some_product_id`. If
@@ -973,10 +976,11 @@ module Google
         # removal timestamp. This process is asynchronous. If the request is valid, the
         # removal will be enqueued and processed downstream. As a consequence, when a
         # response is returned, removals are not immediately manifested in the Product
-        # queried by GetProduct or ListProducts. Local inventory information can only be
-        # removed using this method. CreateProduct and UpdateProduct has no effect on
-        # local inventories. This feature is only available for users who have Retail
-        # Search enabled. Please enable Retail Search on Cloud Console before using this
+        # queried by ProductService.GetProduct or ProductService.ListProducts. Local
+        # inventory information can only be removed using this method. ProductService.
+        # CreateProduct and ProductService.UpdateProduct has no effect on local
+        # inventories. This feature is only available for users who have Retail Search
+        # enabled. Please enable Retail Search on Cloud Console before using this
         # feature.
         # @param [String] product
         #   Required. Full resource name of Product, such as `projects/*/locations/global/
@@ -1018,19 +1022,21 @@ module Google
         # require the Product to exist before updating fulfillment information. If the
         # request is valid, the update will be enqueued and processed downstream. As a
         # consequence, when a response is returned, updates are not immediately
-        # manifested in the Product queried by GetProduct or ListProducts. When
-        # inventory is updated with CreateProduct and UpdateProduct, the specified
-        # inventory field value(s) will overwrite any existing value(s) while ignoring
-        # the last update time for this field. Furthermore, the last update time for the
-        # specified inventory fields will be overwritten to the time of the
-        # CreateProduct or UpdateProduct request. If no inventory fields are set in
-        # CreateProductRequest.product, then any pre-existing inventory information for
-        # this product will be used. If no inventory fields are set in
+        # manifested in the Product queried by ProductService.GetProduct or
+        # ProductService.ListProducts. When inventory is updated with ProductService.
+        # CreateProduct and ProductService.UpdateProduct, the specified inventory field
+        # value(s) will overwrite any existing value(s) while ignoring the last update
+        # time for this field. Furthermore, the last update time for the specified
+        # inventory fields will be overwritten to the time of the ProductService.
+        # CreateProduct or ProductService.UpdateProduct request. If no inventory fields
+        # are set in CreateProductRequest.product, then any pre-existing inventory
+        # information for this product will be used. If no inventory fields are set in
         # SetInventoryRequest.set_mask, then any existing inventory information will be
         # preserved. Pre-existing inventory information can only be updated with
-        # SetInventory, ProductService.AddFulfillmentPlaces, and RemoveFulfillmentPlaces.
-        # This feature is only available for users who have Retail Search enabled.
-        # Please enable Retail Search on Cloud Console before using this feature.
+        # ProductService.SetInventory, ProductService.AddFulfillmentPlaces, and
+        # ProductService.RemoveFulfillmentPlaces. This feature is only available for
+        # users who have Retail Search enabled. Please enable Retail Search on Cloud
+        # Console before using this feature.
         # @param [String] name
         #   Immutable. Full resource name of the product, such as `projects/*/locations/
         #   global/catalogs/default_catalog/branches/default_branch/products/product_id`.
@@ -1373,9 +1379,9 @@ module Google
         
         # Makes a recommendation prediction.
         # @param [String] placement
-        #   Required. Full resource name of the format: `placement=projects/*/locations/
-        #   global/catalogs/default_catalog/servingConfigs/*` or `placement=projects/*/
-        #   locations/global/catalogs/default_catalog/placements/*`. We recommend using
+        #   Required. Full resource name of the format: ``placement=projects/*/locations/
+        #   global/catalogs/default_catalog/servingConfigs/*`` or ``placement=projects/*/
+        #   locations/global/catalogs/default_catalog/placements/*``. We recommend using
         #   the `servingConfigs` resource. `placements` is a legacy resource. The ID of
         #   the Recommendations AI serving config or placement. Before you can request
         #   predictions from your model, you must create at least one serving config or
@@ -1679,9 +1685,9 @@ module Google
         
         # Makes a recommendation prediction.
         # @param [String] placement
-        #   Required. Full resource name of the format: `placement=projects/*/locations/
-        #   global/catalogs/default_catalog/servingConfigs/*` or `placement=projects/*/
-        #   locations/global/catalogs/default_catalog/placements/*`. We recommend using
+        #   Required. Full resource name of the format: ``placement=projects/*/locations/
+        #   global/catalogs/default_catalog/servingConfigs/*`` or ``placement=projects/*/
+        #   locations/global/catalogs/default_catalog/placements/*``. We recommend using
         #   the `servingConfigs` resource. `placements` is a legacy resource. The ID of
         #   the Recommendations AI serving config or placement. Before you can request
         #   predictions from your model, you must create at least one serving config or

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-apis-retail_v2beta
 version: !ruby/object:Gem::Version
-  version: 0.45.0
+  version: 0.48.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-07-04 00:00:00.000000000 Z
+date: 2022-07-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-apis-core
@@ -58,7 +58,7 @@ licenses:
 metadata:
   bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
   changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-retail_v2beta/CHANGELOG.md
-  documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2beta/v0.45.0
+  documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2beta/v0.48.0
   source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-retail_v2beta
 post_install_message: 
 rdoc_options: []