google-apis-retail_v2 0.53.0 → 0.55.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 88883aaddf00d370e470ac65555dbaf9686cb92a960c3bed5a2419a15e7c6130
-  data.tar.gz: 9741c840d5716bf6ae937e297555555a26aa254ae3fc1fa398a20c0f288be0c8
+  metadata.gz: 2a9144b4dd277bbaf647869590b84eb34afe68a2d267b76feda0bb4373881be0
+  data.tar.gz: 4480c685ef15ec3e9472c438d5235566ae60741777bb394f4435905be7131f87
 SHA512:
-  metadata.gz: 8a9fab1f788472c15083d36645d24ab37e6c99d76191e5b39c7479bbdada0e6076a1d937c52760408cf242e6bf1047ddc012505932dfcdf6302fe45314946e62
-  data.tar.gz: 00d921a904369f26b49218011aa79db7cf5b046db98fe87a03a0afd13e34acc7764bba08714445ca56d33b34c7293f97dc74e7db0c5ad2eb684e16e6f21dd806
+  metadata.gz: 72fdc4d1474f30803b20b2fa3d7b72614ab1f6502ef4959b5770d8ee9233454473e08fee82a9b68077b4febc8a1705200094f290362b5af3f2b950186498fca2
+  data.tar.gz: ef09624a88f184ec348707fb222dd34de91e0bd1e1b768878ba4ca266665fdcc237147cca762617b99f9399a383838a4433d6988a80f3873e162b7de2b344516

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Release history for google-apis-retail_v2
 
+### v0.55.0 (2022-09-23)
+
+* Regenerated from discovery document revision 20220917
+* Regenerated using generator version 0.10.0
+
+### v0.54.0 (2022-09-10)
+
+* Regenerated from discovery document revision 20220901
+
 ### v0.53.0 (2022-08-31)
 
 * Regenerated from discovery document revision 20220825

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

@@ -684,11 +684,12 @@ 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 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.
+        # loaded CatalogAttributes. Only pre-loaded catalog attributes that are neither
+        # in use by products nor predefined can be deleted. Catalog attributes that are
+        # either in use by products or are predefined attributes 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
@@ -1851,15 +1852,15 @@ module Google
         # do not have a stockState value of OUT_OF_STOCK. Examples: * tag=("Red" OR "
         # Blue") tag="New-Arrival" tag=(NOT "promotional") * filterOutOfStockItems tag=(-
         # "promotional") * filterOutOfStockItems If your filter blocks all prediction
-        # results, the API will return generic (unfiltered) popular products. If you
-        # only want results strictly matching the filters, set `strictFiltering` to True
-        # 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
-        # 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"))
+        # results, the API will return *no* results. If instead you want empty result
+        # sets to return generic (unfiltered) popular products, set `strictFiltering` to
+        # False in `PredictRequest.params`. 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 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"))
         # Corresponds to the JSON property `filter`
         # @return [String]
         attr_accessor :filter
@@ -2159,6 +2160,8 @@ module Google
         attr_accessor :available_quantity
       
         # The timestamp when this Product becomes available for SearchService.Search.
+        # Note that this is only applicable to Type.PRIMARY and Type.COLLECTION, and
+        # ignored for Type.VARIANT.
         # Corresponds to the JSON property `availableTime`
         # @return [String]
         attr_accessor :available_time
@@ -2227,7 +2230,10 @@ module Google
         attr_accessor :description
       
         # The timestamp when this product becomes unavailable for SearchService.Search.
-        # If it is set, the Product is not available for SearchService.Search after
+        # Note that this is only applicable to Type.PRIMARY and Type.COLLECTION, and
+        # ignored for Type.VARIANT. In general, we suggest the users to delete the stale
+        # products explicitly, instead of using this field to determine staleness. If it
+        # is set, the Product is not available for SearchService.Search after
         # expire_time. However, the product can still be retrieved by ProductService.
         # GetProduct and ProductService.ListProducts. expire_time must be later than
         # available_time and publish_time, otherwise an INVALID_ARGUMENT error is thrown.
@@ -2290,7 +2296,8 @@ module Google
       
         # Output only. A list of local inventories specific to different places. This is
         # only available for users who have Retail Search enabled, and it can be managed
-        # by AddLocalInventories and RemoveLocalInventories APIs.
+        # by ProductService.AddLocalInventories and ProductService.
+        # RemoveLocalInventories APIs.
         # Corresponds to the JSON property `localInventories`
         # @return [Array<Google::Apis::RetailV2::GoogleCloudRetailV2LocalInventory>]
         attr_accessor :local_inventories
@@ -2413,7 +2420,10 @@ module Google
         # @return [String]
         attr_accessor :title
       
-        # Input only. The TTL (time to live) of the product. If it is set, it must be a
+        # Input only. The TTL (time to live) of the product. Note that this is only
+        # applicable to Type.PRIMARY and Type.COLLECTION, and ignored for Type.VARIANT.
+        # In general, we suggest the users to delete the stale products explicitly,
+        # instead of using this field to determine staleness. If it is set, it must be a
         # non-negative value, and expire_time is set as current timestamp plus ttl. The
         # derived expire_time is returned in the output and ttl is left blank when
         # retrieving the Product. If it is set, the product is not available for
@@ -5475,7 +5485,7 @@ module Google
       class GoogleCloudRetailV2alphaModelPageOptimizationConfigPanel
         include Google::Apis::Core::Hashable
       
-        # Required. The candidates to consider on the panel. Limit = 10.
+        # Required. The candidates to consider on the panel.
         # Corresponds to the JSON property `candidates`
         # @return [Array<Google::Apis::RetailV2::GoogleCloudRetailV2alphaModelPageOptimizationConfigCandidate>]
         attr_accessor :candidates
@@ -5939,6 +5949,27 @@ module Google
         end
       end
       
+      # Metadata associated with a create operation.
+      class GoogleCloudRetailV2betaCreateModelMetadata
+        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 GoogleCloudRetailV2betaExportErrorsConfig
         include Google::Apis::Core::Hashable
@@ -6210,6 +6241,166 @@ 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 GoogleCloudRetailV2betaModel
+        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 Cloud Console 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` This field together with optimization_objective describe
+        # model metadata to use to control model training and serving. See https://cloud.
+        # google.com/retail/docs/models for more details on what the model metadata
+        # control and which combination of parameters are valid. For invalid
+        # combinations of parameters (e.g. type = `frequently-bought-together` and
+        # optimization_objective = `ctr`), you receive an error 400 if you try to create/
+        # update a recommendation with this set of knobs.
+        # Corresponds to the JSON property `optimizationObjective`
+        # @return [String]
+        attr_accessor :optimization_objective
+      
+        # 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 list of valid serving configs associated with the
+        # PageOptimizationConfig.
+        # Corresponds to the JSON property `servingConfigLists`
+        # @return [Array<Google::Apis::RetailV2::GoogleCloudRetailV2betaModelServingConfigList>]
+        attr_accessor :serving_config_lists
+      
+        # 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`, and `recently-viewed`(
+        # readonly value). This field together with optimization_objective describe
+        # model metadata to use to control model training and serving. See https://cloud.
+        # google.com/retail/docs/models for more details on what the model metadata
+        # control and which combination of parameters are valid. For invalid
+        # combinations of parameters (e.g. type = `frequently-bought-together` and
+        # optimization_objective = `ctr`), you receive an error 400 if you try to create/
+        # update a recommendation with this set of knobs.
+        # 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)
+          @periodic_tuning_state = args[:periodic_tuning_state] if args.key?(:periodic_tuning_state)
+          @serving_config_lists = args[:serving_config_lists] if args.key?(:serving_config_lists)
+          @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
+      
+      # Represents an ordered combination of valid serving configs, which can be used
+      # for `PAGE_OPTIMIZATION` recommendations.
+      class GoogleCloudRetailV2betaModelServingConfigList
+        include Google::Apis::Core::Hashable
+      
+        # Optional. A set of valid serving configs that may be used for `
+        # PAGE_OPTIMIZATION`.
+        # Corresponds to the JSON property `servingConfigIds`
+        # @return [Array<String>]
+        attr_accessor :serving_config_ids
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @serving_config_ids = args[:serving_config_ids] if args.key?(:serving_config_ids)
+        end
+      end
+      
       # Output result.
       class GoogleCloudRetailV2betaOutputResult
         include Google::Apis::Core::Hashable
@@ -6385,6 +6576,40 @@ module Google
         end
       end
       
+      # Metadata associated with a tune operation.
+      class GoogleCloudRetailV2betaTuneModelMetadata
+        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 GoogleCloudRetailV2betaTuneModelResponse
+        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 GoogleCloudRetailV2betaUserEventImportSummary

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

@@ -16,13 +16,13 @@ module Google
   module Apis
     module RetailV2
       # Version of the google-apis-retail_v2 gem
-      GEM_VERSION = "0.53.0"
+      GEM_VERSION = "0.55.0"
 
       # Version of the code generator used to generate this client
-      GENERATOR_VERSION = "0.9.0"
+      GENERATOR_VERSION = "0.10.0"
 
       # Revision of the discovery document this client was generated from
-      REVISION = "20220825"
+      REVISION = "20220917"
     end
   end
 end

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

@@ -940,6 +940,12 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class GoogleCloudRetailV2betaCreateModelMetadata
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class GoogleCloudRetailV2betaExportErrorsConfig
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -994,6 +1000,18 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class GoogleCloudRetailV2betaModel
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleCloudRetailV2betaModelServingConfigList
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class GoogleCloudRetailV2betaOutputResult
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -1060,6 +1078,18 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class GoogleCloudRetailV2betaTuneModelMetadata
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleCloudRetailV2betaTuneModelResponse
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class GoogleCloudRetailV2betaUserEventImportSummary
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -2571,6 +2601,13 @@ module Google
         end
       end
       
+      class GoogleCloudRetailV2betaCreateModelMetadata
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :model, as: 'model'
+        end
+      end
+      
       class GoogleCloudRetailV2betaExportErrorsConfig
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -2659,6 +2696,34 @@ module Google
         end
       end
       
+      class GoogleCloudRetailV2betaModel
+        # @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 :periodic_tuning_state, as: 'periodicTuningState'
+          collection :serving_config_lists, as: 'servingConfigLists', class: Google::Apis::RetailV2::GoogleCloudRetailV2betaModelServingConfigList, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2betaModelServingConfigList::Representation
+      
+          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 GoogleCloudRetailV2betaModelServingConfigList
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          collection :serving_config_ids, as: 'servingConfigIds'
+        end
+      end
+      
       class GoogleCloudRetailV2betaOutputResult
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -2729,6 +2794,19 @@ module Google
         end
       end
       
+      class GoogleCloudRetailV2betaTuneModelMetadata
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :model, as: 'model'
+        end
+      end
+      
+      class GoogleCloudRetailV2betaTuneModelResponse
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+        end
+      end
+      
       class GoogleCloudRetailV2betaUserEventImportSummary
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-apis-retail_v2
 version: !ruby/object:Gem::Version
-  version: 0.53.0
+  version: 0.55.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-09-05 00:00:00.000000000 Z
+date: 2022-09-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-apis-core
@@ -16,7 +16,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: 0.9.0
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: 0.9.0
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
@@ -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_v2/CHANGELOG.md
-  documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2/v0.53.0
+  documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2/v0.55.0
   source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-retail_v2
 post_install_message: 
 rdoc_options: []