google-apis-retail_v2alpha 0.56.0 → 0.58.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2b33836f3cf94e3635a5712ad26790d064c21e3665984409172e76ae3bb1c8c5
-  data.tar.gz: 745fc296d29777018c245ab31f2fec87f4e14e8dfeb56b419de6a033083f642a
+  metadata.gz: 33d839e5bf0b4020e6914b9314bc240c52994835661db4790a9d0f7f4f8a8e1f
+  data.tar.gz: 1506e9ca23e249d347c47955b8c3756e21d7fc3b9140bb7352b3fabf6c6c3148
 SHA512:
-  metadata.gz: 1b778bc5f4d8bcf0046ff0cec27a9a5afe4f6fc7fb133299ebf2cc3a1a79c544a9a59cc363da0c40d2e813c7d8bbffc50279740f284dc4ca1c3a40037912205f
-  data.tar.gz: 869373e3bc1901c8ab126b15f82b63d471072021e5e3d0f525a95115471b8710186f62e67a7ed1d2495b5e506c09459b0317638782199a5ef70c426fea362d96
+  metadata.gz: dfa7b58da40c0a35df8ebbb2cc90d4f44189e78ce1682595aebc6d26b1809565995e541693a4a3befcac75d1d854a6a74cea1a3ae7771fd3da2ee1d9a4169452
+  data.tar.gz: c5f0982716b217f68240ddd2d56b2ceff9b446c7e2edd8e203585827d3b619ce6f270c4f9ba6d823c9674ccad7777ff11fa970a774affc1a3979d638af2dfd19

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Release history for google-apis-retail_v2alpha
 
+### v0.58.0 (2022-09-23)
+
+* Regenerated from discovery document revision 20220917
+* Regenerated using generator version 0.10.0
+
+### v0.57.0 (2022-09-17)
+
+* Regenerated from discovery document revision 20220909
+
 ### v0.56.0 (2022-09-10)
 
 * Regenerated from discovery document revision 20220901

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

@@ -2524,6 +2524,32 @@ module Google
         end
       end
       
+      # Merchant Center Feed filter criterrion.
+      class GoogleCloudRetailV2alphaMerchantCenterFeedFilter
+        include Google::Apis::Core::Hashable
+      
+        # Merchant Center primary feed id.
+        # Corresponds to the JSON property `primaryFeedId`
+        # @return [Fixnum]
+        attr_accessor :primary_feed_id
+      
+        # Merchant Center primary feed name. The name is used for the display purposes
+        # only.
+        # Corresponds to the JSON property `primaryFeedName`
+        # @return [String]
+        attr_accessor :primary_feed_name
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @primary_feed_id = args[:primary_feed_id] if args.key?(:primary_feed_id)
+          @primary_feed_name = args[:primary_feed_name] if args.key?(:primary_feed_name)
+        end
+      end
+      
       # Represents a link between a Merchant Center account and a branch. Once a link
       # is established, products from the linked merchant center account will be
       # streamed to the linked branch.
@@ -2548,6 +2574,13 @@ module Google
         # @return [Array<String>]
         attr_accessor :destinations
       
+        # Criteria for the Merchant Center feeds to be ingested via the link. All offers
+        # will be ingested if the list is empty. Otherwise the offers will be ingested
+        # from selected feeds.
+        # Corresponds to the JSON property `feeds`
+        # @return [Array<Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaMerchantCenterFeedFilter>]
+        attr_accessor :feeds
+      
         # Language of the title/description and other string attributes. Use language
         # tags defined by [BCP 47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). ISO
         # 639-1. This specifies the language of offers in Merchant Center that will be
@@ -2580,6 +2613,7 @@ module Google
         def update!(**args)
           @branch_id = args[:branch_id] if args.key?(:branch_id)
           @destinations = args[:destinations] if args.key?(:destinations)
+          @feeds = args[:feeds] if args.key?(:feeds)
           @language_code = args[:language_code] if args.key?(:language_code)
           @merchant_center_account_id = args[:merchant_center_account_id] if args.key?(:merchant_center_account_id)
           @region_code = args[:region_code] if args.key?(:region_code)
@@ -2824,7 +2858,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::RetailV2alpha::GoogleCloudRetailV2alphaModelPageOptimizationConfigCandidate>]
         attr_accessor :candidates
@@ -2921,15 +2955,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
@@ -6243,6 +6277,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
@@ -6514,6 +6569,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::RetailV2alpha::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
@@ -6689,6 +6904,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_v2alpha/gem_version.rb

@@ -16,13 +16,13 @@ module Google
   module Apis
     module RetailV2alpha
       # Version of the google-apis-retail_v2alpha gem
-      GEM_VERSION = "0.56.0"
+      GEM_VERSION = "0.58.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 = "20220901"
+      REVISION = "20220917"
     end
   end
 end

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

@@ -496,6 +496,12 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class GoogleCloudRetailV2alphaMerchantCenterFeedFilter
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class GoogleCloudRetailV2alphaMerchantCenterLink
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -994,6 +1000,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
       
@@ -1048,6 +1060,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
       
@@ -1114,6 +1138,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
       
@@ -1858,11 +1894,21 @@ module Google
         end
       end
       
+      class GoogleCloudRetailV2alphaMerchantCenterFeedFilter
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :primary_feed_id, :numeric_string => true, as: 'primaryFeedId'
+          property :primary_feed_name, as: 'primaryFeedName'
+        end
+      end
+      
       class GoogleCloudRetailV2alphaMerchantCenterLink
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
           property :branch_id, as: 'branchId'
           collection :destinations, as: 'destinations'
+          collection :feeds, as: 'feeds', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaMerchantCenterFeedFilter, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaMerchantCenterFeedFilter::Representation
+      
           property :language_code, as: 'languageCode'
           property :merchant_center_account_id, :numeric_string => true, as: 'merchantCenterAccountId'
           property :region_code, as: 'regionCode'
@@ -2703,6 +2749,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
@@ -2791,6 +2844,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::RetailV2alpha::GoogleCloudRetailV2betaModelServingConfigList, decorator: Google::Apis::RetailV2alpha::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
@@ -2861,6 +2942,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_v2alpha
 version: !ruby/object:Gem::Version
-  version: 0.56.0
+  version: 0.58.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-09-12 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_v2alpha/CHANGELOG.md
-  documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2alpha/v0.56.0
+  documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2alpha/v0.58.0
   source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-retail_v2alpha
 post_install_message: 
 rdoc_options: []