google-apis-retail_v2beta 0.88.0 → 0.89.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e374b89042fce1fbccde2391a4863872c8cecebd45f58f550bc11e4ea1e964b0
-  data.tar.gz: 14ddbd48e98aeae1f5d89a89da5b6127e7640f8ac667346f8666901848fafd54
+  metadata.gz: 42180bdb12b8db55ddd6a7b1448d9f9e85262bf60efea9db77fb7bfc116453f1
+  data.tar.gz: 1c6ed7f9a3ad401dea2beca1e389e828bb7b2b24722cc2e192516e985e59b37d
 SHA512:
-  metadata.gz: 19088697531d1ef966139b251bc261891129e131da89354242404010435d39787ccab095cfc68c1c681731373660fcfeead1bbc4ac96a5af678a98a1cb777071
-  data.tar.gz: 9d3c20288cdd815bdbf6c6734f81add847984214e3c8f1e9f9f33e54b4372b77ea46d82c199e611e17039f64bb3f635bb35bec699ba33323d370060d297dd8fb
+  metadata.gz: ea9722b184c76ec2ce747acad0249a7ec9681f90716e7c3e0635b7ada9eda8646186e0bf2a404266dbeecce18ff1cabc65b7602aa83beddfb04bd4f4611445f2
+  data.tar.gz: bf81c2f5c6083069c34413297befb0fd97c57e0a4184cc142855b03154462fcefdb99d01f22eed2be6e9223a96604db886d45c5ed8560eb765f8c1d5958fef69

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Release history for google-apis-retail_v2beta
 
+### v0.89.0 (2024-01-23)
+
+* Regenerated from discovery document revision 20240118
+* Regenerated using generator version 0.13.0
+
 ### v0.88.0 (2023-12-10)
 
 * Regenerated from discovery document revision 20231130

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

@@ -2892,6 +2892,18 @@ module Google
         # @return [Array<Google::Apis::RetailV2beta::GoogleCloudRetailV2betaCatalogAttributeFacetConfigMergedFacetValue>]
         attr_accessor :merged_facet_values
       
+        # Options to rerank based on facet values engaged by the user for the current
+        # key. That key needs to be a custom textual key and facetable. To use this
+        # control, you also need to pass all the facet keys engaged by the user in the
+        # request using the field [SearchRequest.FacetSpec]. In particular, if you don't
+        # pass the facet keys engaged that you want to rerank on, this control won't be
+        # effective. Moreover, to obtain better results, the facet values that you want
+        # to rerank on should be close to English (ideally made of words, underscores,
+        # and spaces).
+        # Corresponds to the JSON property `rerankConfig`
+        # @return [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaCatalogAttributeFacetConfigRerankConfig]
+        attr_accessor :rerank_config
+      
         def initialize(**args)
            update!(**args)
         end
@@ -2901,6 +2913,7 @@ module Google
           @facet_intervals = args[:facet_intervals] if args.key?(:facet_intervals)
           @ignored_facet_values = args[:ignored_facet_values] if args.key?(:ignored_facet_values)
           @merged_facet_values = args[:merged_facet_values] if args.key?(:merged_facet_values)
+          @rerank_config = args[:rerank_config] if args.key?(:rerank_config)
         end
       end
       
@@ -2973,6 +2986,41 @@ module Google
         end
       end
       
+      # Options to rerank based on facet values engaged by the user for the current
+      # key. That key needs to be a custom textual key and facetable. To use this
+      # control, you also need to pass all the facet keys engaged by the user in the
+      # request using the field [SearchRequest.FacetSpec]. In particular, if you don't
+      # pass the facet keys engaged that you want to rerank on, this control won't be
+      # effective. Moreover, to obtain better results, the facet values that you want
+      # to rerank on should be close to English (ideally made of words, underscores,
+      # and spaces).
+      class GoogleCloudRetailV2betaCatalogAttributeFacetConfigRerankConfig
+        include Google::Apis::Core::Hashable
+      
+        # If empty, rerank on all facet values for the current key. Otherwise, will
+        # rerank on the facet values from this list only.
+        # Corresponds to the JSON property `facetValues`
+        # @return [Array<String>]
+        attr_accessor :facet_values
+      
+        # If set to true, then we also rerank the dynamic facets based on the facet
+        # values engaged by the user for the current attribute key during serving.
+        # Corresponds to the JSON property `rerankFacet`
+        # @return [Boolean]
+        attr_accessor :rerank_facet
+        alias_method :rerank_facet?, :rerank_facet
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @facet_values = args[:facet_values] if args.key?(:facet_values)
+          @rerank_facet = args[:rerank_facet] if args.key?(:rerank_facet)
+        end
+      end
+      
       # The color information of a Product.
       class GoogleCloudRetailV2betaColorInfo
         include Google::Apis::Core::Hashable
@@ -3577,6 +3625,73 @@ module Google
         end
       end
       
+      # Request message for the `ExportAnalyticsMetrics` method.
+      class GoogleCloudRetailV2betaExportAnalyticsMetricsRequest
+        include Google::Apis::Core::Hashable
+      
+        # A filtering expression to specify restrictions on returned metrics. The
+        # expression is a sequence of terms. Each term applies a restriction to the
+        # returned metrics. Use this expression to restrict results to a specific time
+        # range. Currently we expect only one types of fields: * `timestamp`: This can
+        # be specified twice, once with a less than operator and once with a greater
+        # than operator. The `timestamp` restriction should result in one, contiguous,
+        # valid, `timestamp` range. Some examples of valid filters expressions: *
+        # Example 1: `timestamp > "2012-04-23T18:25:43.511Z" timestamp < "2012-04-23T18:
+        # 30:43.511Z"` * Example 2: `timestamp > "2012-04-23T18:25:43.511Z"`
+        # Corresponds to the JSON property `filter`
+        # @return [String]
+        attr_accessor :filter
+      
+        # The output configuration setting.
+        # Corresponds to the JSON property `outputConfig`
+        # @return [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaOutputConfig]
+        attr_accessor :output_config
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @filter = args[:filter] if args.key?(:filter)
+          @output_config = args[:output_config] if args.key?(:output_config)
+        end
+      end
+      
+      # Response of the ExportAnalyticsMetricsRequest. If the long running operation
+      # was successful, then this message is returned by the google.longrunning.
+      # Operations.response field if the operation was successful.
+      class GoogleCloudRetailV2betaExportAnalyticsMetricsResponse
+        include Google::Apis::Core::Hashable
+      
+        # A sample of errors encountered while processing the request.
+        # Corresponds to the JSON property `errorSamples`
+        # @return [Array<Google::Apis::RetailV2beta::GoogleRpcStatus>]
+        attr_accessor :error_samples
+      
+        # Configuration of destination for Export related errors.
+        # Corresponds to the JSON property `errorsConfig`
+        # @return [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaExportErrorsConfig]
+        attr_accessor :errors_config
+      
+        # Output result that stores the information about where the exported data is
+        # stored.
+        # Corresponds to the JSON property `outputResult`
+        # @return [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaOutputResult]
+        attr_accessor :output_result
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @error_samples = args[:error_samples] if args.key?(:error_samples)
+          @errors_config = args[:errors_config] if args.key?(:errors_config)
+          @output_result = args[:output_result] if args.key?(:output_result)
+        end
+      end
+      
       # Configuration of destination for Export related errors.
       class GoogleCloudRetailV2betaExportErrorsConfig
         include Google::Apis::Core::Hashable
@@ -4789,6 +4904,87 @@ module Google
         end
       end
       
+      # The output configuration setting.
+      class GoogleCloudRetailV2betaOutputConfig
+        include Google::Apis::Core::Hashable
+      
+        # The BigQuery output destination configuration.
+        # Corresponds to the JSON property `bigqueryDestination`
+        # @return [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaOutputConfigBigQueryDestination]
+        attr_accessor :bigquery_destination
+      
+        # The Google Cloud Storage output destination configuration.
+        # Corresponds to the JSON property `gcsDestination`
+        # @return [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaOutputConfigGcsDestination]
+        attr_accessor :gcs_destination
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @bigquery_destination = args[:bigquery_destination] if args.key?(:bigquery_destination)
+          @gcs_destination = args[:gcs_destination] if args.key?(:gcs_destination)
+        end
+      end
+      
+      # The BigQuery output destination configuration.
+      class GoogleCloudRetailV2betaOutputConfigBigQueryDestination
+        include Google::Apis::Core::Hashable
+      
+        # Required. The ID of a BigQuery Dataset.
+        # Corresponds to the JSON property `datasetId`
+        # @return [String]
+        attr_accessor :dataset_id
+      
+        # Required. The prefix of exported BigQuery tables.
+        # Corresponds to the JSON property `tableIdPrefix`
+        # @return [String]
+        attr_accessor :table_id_prefix
+      
+        # Required. Describes the table type. The following values are supported: * `
+        # table`: A BigQuery native table. * `view`: A virtual table defined by a SQL
+        # query.
+        # Corresponds to the JSON property `tableType`
+        # @return [String]
+        attr_accessor :table_type
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @dataset_id = args[:dataset_id] if args.key?(:dataset_id)
+          @table_id_prefix = args[:table_id_prefix] if args.key?(:table_id_prefix)
+          @table_type = args[:table_type] if args.key?(:table_type)
+        end
+      end
+      
+      # The Google Cloud Storage output destination configuration.
+      class GoogleCloudRetailV2betaOutputConfigGcsDestination
+        include Google::Apis::Core::Hashable
+      
+        # Required. The output uri prefix for saving output data to json files. Some
+        # mapping examples are as follows: output_uri_prefix sample output(assuming the
+        # object is foo.json) ======================== ==================================
+        # =========== gs://bucket/ gs://bucket/foo.json gs://bucket/folder/ gs://bucket/
+        # folder/foo.json gs://bucket/folder/item_ gs://bucket/folder/item_foo.json
+        # Corresponds to the JSON property `outputUriPrefix`
+        # @return [String]
+        attr_accessor :output_uri_prefix
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @output_uri_prefix = args[:output_uri_prefix] if args.key?(:output_uri_prefix)
+        end
+      end
+      
       # Output result that stores the information about where the exported data is
       # stored.
       class GoogleCloudRetailV2betaOutputResult

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.88.0"
+      GEM_VERSION = "0.89.0"
 
       # Version of the code generator used to generate this client
-      GENERATOR_VERSION = "0.12.0"
+      GENERATOR_VERSION = "0.13.0"
 
       # Revision of the discovery document this client was generated from
-      REVISION = "20231130"
+      REVISION = "20240118"
     end
   end
 end

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

@@ -628,6 +628,12 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class GoogleCloudRetailV2betaCatalogAttributeFacetConfigRerankConfig
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class GoogleCloudRetailV2betaColorInfo
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -724,6 +730,18 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class GoogleCloudRetailV2betaExportAnalyticsMetricsRequest
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleCloudRetailV2betaExportAnalyticsMetricsResponse
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class GoogleCloudRetailV2betaExportErrorsConfig
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -922,6 +940,24 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class GoogleCloudRetailV2betaOutputConfig
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleCloudRetailV2betaOutputConfigBigQueryDestination
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleCloudRetailV2betaOutputConfigGcsDestination
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class GoogleCloudRetailV2betaOutputResult
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -2225,6 +2261,8 @@ module Google
       
           collection :merged_facet_values, as: 'mergedFacetValues', class: Google::Apis::RetailV2beta::GoogleCloudRetailV2betaCatalogAttributeFacetConfigMergedFacetValue, decorator: Google::Apis::RetailV2beta::GoogleCloudRetailV2betaCatalogAttributeFacetConfigMergedFacetValue::Representation
       
+          property :rerank_config, as: 'rerankConfig', class: Google::Apis::RetailV2beta::GoogleCloudRetailV2betaCatalogAttributeFacetConfigRerankConfig, decorator: Google::Apis::RetailV2beta::GoogleCloudRetailV2betaCatalogAttributeFacetConfigRerankConfig::Representation
+      
         end
       end
       
@@ -2245,6 +2283,14 @@ module Google
         end
       end
       
+      class GoogleCloudRetailV2betaCatalogAttributeFacetConfigRerankConfig
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          collection :facet_values, as: 'facetValues'
+          property :rerank_facet, as: 'rerankFacet'
+        end
+      end
+      
       class GoogleCloudRetailV2betaColorInfo
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -2401,6 +2447,27 @@ module Google
         end
       end
       
+      class GoogleCloudRetailV2betaExportAnalyticsMetricsRequest
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :filter, as: 'filter'
+          property :output_config, as: 'outputConfig', class: Google::Apis::RetailV2beta::GoogleCloudRetailV2betaOutputConfig, decorator: Google::Apis::RetailV2beta::GoogleCloudRetailV2betaOutputConfig::Representation
+      
+        end
+      end
+      
+      class GoogleCloudRetailV2betaExportAnalyticsMetricsResponse
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          collection :error_samples, as: 'errorSamples', class: Google::Apis::RetailV2beta::GoogleRpcStatus, decorator: Google::Apis::RetailV2beta::GoogleRpcStatus::Representation
+      
+          property :errors_config, as: 'errorsConfig', class: Google::Apis::RetailV2beta::GoogleCloudRetailV2betaExportErrorsConfig, decorator: Google::Apis::RetailV2beta::GoogleCloudRetailV2betaExportErrorsConfig::Representation
+      
+          property :output_result, as: 'outputResult', class: Google::Apis::RetailV2beta::GoogleCloudRetailV2betaOutputResult, decorator: Google::Apis::RetailV2beta::GoogleCloudRetailV2betaOutputResult::Representation
+      
+        end
+      end
+      
       class GoogleCloudRetailV2betaExportErrorsConfig
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -2729,6 +2796,32 @@ module Google
         end
       end
       
+      class GoogleCloudRetailV2betaOutputConfig
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :bigquery_destination, as: 'bigqueryDestination', class: Google::Apis::RetailV2beta::GoogleCloudRetailV2betaOutputConfigBigQueryDestination, decorator: Google::Apis::RetailV2beta::GoogleCloudRetailV2betaOutputConfigBigQueryDestination::Representation
+      
+          property :gcs_destination, as: 'gcsDestination', class: Google::Apis::RetailV2beta::GoogleCloudRetailV2betaOutputConfigGcsDestination, decorator: Google::Apis::RetailV2beta::GoogleCloudRetailV2betaOutputConfigGcsDestination::Representation
+      
+        end
+      end
+      
+      class GoogleCloudRetailV2betaOutputConfigBigQueryDestination
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :dataset_id, as: 'datasetId'
+          property :table_id_prefix, as: 'tableIdPrefix'
+          property :table_type, as: 'tableType'
+        end
+      end
+      
+      class GoogleCloudRetailV2betaOutputConfigGcsDestination
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :output_uri_prefix, as: 'outputUriPrefix'
+        end
+      end
+      
       class GoogleCloudRetailV2betaOutputResult
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation

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

@@ -34,6 +34,8 @@ module Google
       #
       # @see https://cloud.google.com/recommendations
       class CloudRetailService < Google::Apis::Core::BaseService
+        DEFAULT_ENDPOINT_TEMPLATE = "https://retail.$UNIVERSE_DOMAIN$/"
+
         # @return [String]
         #  API key. Your API key identifies your project and provides you with API access,
         #  quota, and reports. Required unless you provide an OAuth 2.0 token.
@@ -45,7 +47,7 @@ module Google
         attr_accessor :quota_user
 
         def initialize
-          super('https://retail.googleapis.com/', '',
+          super(DEFAULT_ENDPOINT_TEMPLATE, '',
                 client_name: 'google-apis-retail_v2beta',
                 client_version: Google::Apis::RetailV2beta::GEM_VERSION)
           @batch_path = 'batch'
@@ -132,6 +134,42 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
+        # Exports analytics metrics. `Operation.response` is of type `
+        # ExportAnalyticsMetricsResponse`. `Operation.metadata` is of type `
+        # ExportMetadata`.
+        # @param [String] catalog
+        #   Required. Full resource name of the parent catalog. Expected format: `projects/
+        #   */locations/*/catalogs/*`
+        # @param [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaExportAnalyticsMetricsRequest] google_cloud_retail_v2beta_export_analytics_metrics_request_object
+        # @param [String] fields
+        #   Selector specifying which fields to include in a partial response.
+        # @param [String] quota_user
+        #   Available to use for quota purposes for server-side applications. Can be any
+        #   arbitrary string assigned to a user, but should not exceed 40 characters.
+        # @param [Google::Apis::RequestOptions] options
+        #   Request-specific options
+        #
+        # @yield [result, err] Result & error if block supplied
+        # @yieldparam result [Google::Apis::RetailV2beta::GoogleLongrunningOperation] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::RetailV2beta::GoogleLongrunningOperation]
+        #
+        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
+        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
+        # @raise [Google::Apis::AuthorizationError] Authorization is required
+        def export_project_location_catalog_analytics_metrics(catalog, google_cloud_retail_v2beta_export_analytics_metrics_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:post, 'v2beta/{+catalog}:exportAnalyticsMetrics', options)
+          command.request_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaExportAnalyticsMetricsRequest::Representation
+          command.request_object = google_cloud_retail_v2beta_export_analytics_metrics_request_object
+          command.response_representation = Google::Apis::RetailV2beta::GoogleLongrunningOperation::Representation
+          command.response_class = Google::Apis::RetailV2beta::GoogleLongrunningOperation
+          command.params['catalog'] = catalog unless catalog.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
         # Gets an AttributesConfig.
         # @param [String] name
         #   Required. Full AttributesConfig resource name. Format: `projects/`

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-apis-retail_v2beta
 version: !ruby/object:Gem::Version
-  version: 0.88.0
+  version: 0.89.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-12-10 00:00:00.000000000 Z
+date: 2024-01-23 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.11.0
+        version: 0.12.0
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.11.0
+        version: 0.12.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_v2beta/CHANGELOG.md
-  documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2beta/v0.88.0
+  documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2beta/v0.89.0
   source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-retail_v2beta
 post_install_message: 
 rdoc_options: []
@@ -75,7 +75,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.19
+rubygems_version: 3.5.3
 signing_key: 
 specification_version: 4
 summary: Simple REST client for Retail API V2beta