google-apis-retail_v2 0.85.0 → 0.87.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '083ac8a5ae6c70975c2e7f567130a7634d6879604908eb7b3aa9a364149e2fa2'
-  data.tar.gz: 43270701f88c2ee681de3180eac511ae238de28efc51d1a21195516899c1b125
+  metadata.gz: f955a2116199d0020d8d7fa1a31d9f3a9530a3345077b13a1a14512d564d8ef2
+  data.tar.gz: 0b47e9ce274392ad9339ef2ed95b69f1508bd756a1bdfae2f9f85ae821771f0d
 SHA512:
-  metadata.gz: 776ce228a4f7c9e8ae52c961729f89681164526c4d70c721d612a704665846856380ebf5c00ddc401be66d7d6e7736161168c4a3828087ef59323efe53afefce
-  data.tar.gz: 7dcfae679d606fa3bf6ade22a51989362ecd6f310aae07539b0ced1ef8eefe164277fc17ca51915364d43d33f2a519c2047d18a7b22dcddf55dc83506e5ce6a7
+  metadata.gz: 47cf0ae95d3738f20a7050d5bef1598aec06e598de1d30d03363bfb0077ba2dffb40a3086b8609accedb3fadecc9f5f147410e9da3751a1884ebf9bd6a506cb4
+  data.tar.gz: e61cee1be25b125ee7060b440555490bddf9cd03bbc22197c0bda4dfc74ec0cdb2dc34ecaded290d8fd5102477f3cc43dce1067b8b63b44dd6a4a98ae32c0fd1

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Release history for google-apis-retail_v2
 
+### v0.87.0 (2024-01-23)
+
+* Regenerated from discovery document revision 20240118
+* Regenerated using generator version 0.13.0
+
+### v0.86.0 (2023-12-10)
+
+* Regenerated from discovery document revision 20231130
+
 ### v0.85.0 (2023-11-19)
 
 * Regenerated from discovery document revision 20231109

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

@@ -806,6 +806,18 @@ module Google
         # @return [Array<Google::Apis::RetailV2::GoogleCloudRetailV2CatalogAttributeFacetConfigMergedFacetValue>]
         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::RetailV2::GoogleCloudRetailV2CatalogAttributeFacetConfigRerankConfig]
+        attr_accessor :rerank_config
+      
         def initialize(**args)
            update!(**args)
         end
@@ -815,6 +827,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
       
@@ -887,6 +900,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 GoogleCloudRetailV2CatalogAttributeFacetConfigRerankConfig
+        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 GoogleCloudRetailV2ColorInfo
         include Google::Apis::Core::Hashable
@@ -2662,13 +2710,13 @@ module Google
         # Fitness" -> "Athletic Clothing" -> "Shoes"], it could be represented as: "
         # categories": [ "Shoes & Accessories > Shoes", "Sports & Fitness > Athletic
         # Clothing > Shoes" ] Must be set for Type.PRIMARY Product otherwise an
-        # INVALID_ARGUMENT error is returned. At most 250 values are allowed per Product.
-        # Empty values are not allowed. Each value must be a UTF-8 encoded string with
-        # a length limit of 5,000 characters. Otherwise, an INVALID_ARGUMENT error is
-        # returned. Corresponding properties: Google Merchant Center property
-        # google_product_category. Schema.org property [Product.category] (https://
-        # schema.org/category). [mc_google_product_category]: https://support.google.com/
-        # merchants/answer/6324436
+        # INVALID_ARGUMENT error is returned. At most 250 values are allowed per Product
+        # unless overridden via pantheon UI. Empty values are not allowed. Each value
+        # must be a UTF-8 encoded string with a length limit of 5,000 characters.
+        # Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties:
+        # Google Merchant Center property google_product_category. Schema.org property [
+        # Product.category] (https://schema.org/category). [mc_google_product_category]:
+        # https://support.google.com/merchants/answer/6324436
         # Corresponds to the JSON property `categories`
         # @return [Array<String>]
         attr_accessor :categories
@@ -2707,16 +2755,16 @@ module Google
         # @return [String]
         attr_accessor :description
       
-        # The timestamp when this product becomes unavailable for SearchService.Search.
-        # 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.
-        # Corresponding properties: Google Merchant Center property [expiration_date](
-        # https://support.google.com/merchants/answer/6324499).
+        # Note that this field is applied in the following ways: * If the Product is
+        # already expired when it is uploaded, this product is not indexed for search. *
+        # If the Product is not expired when it is uploaded, only the Type.PRIMARY's and
+        # Type.COLLECTION's expireTime is respected, and Type.VARIANT's expireTime is
+        # not used. In general, we suggest the users to delete the stale products
+        # explicitly, instead of using this field to determine staleness. expire_time
+        # must be later than available_time and publish_time, otherwise an
+        # INVALID_ARGUMENT error is thrown. Corresponding properties: Google Merchant
+        # Center property [expiration_date](https://support.google.com/merchants/answer/
+        # 6324499).
         # Corresponds to the JSON property `expireTime`
         # @return [String]
         attr_accessor :expire_time
@@ -5845,6 +5893,40 @@ module Google
         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 GoogleCloudRetailV2alphaExportAnalyticsMetricsResponse
+        include Google::Apis::Core::Hashable
+      
+        # A sample of errors encountered while processing the request.
+        # Corresponds to the JSON property `errorSamples`
+        # @return [Array<Google::Apis::RetailV2::GoogleRpcStatus>]
+        attr_accessor :error_samples
+      
+        # Configuration of destination for Export related errors.
+        # Corresponds to the JSON property `errorsConfig`
+        # @return [Google::Apis::RetailV2::GoogleCloudRetailV2alphaExportErrorsConfig]
+        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::RetailV2::GoogleCloudRetailV2alphaOutputResult]
+        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 GoogleCloudRetailV2alphaExportErrorsConfig
         include Google::Apis::Core::Hashable
@@ -7046,6 +7128,40 @@ module Google
         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::RetailV2::GoogleRpcStatus>]
+        attr_accessor :error_samples
+      
+        # Configuration of destination for Export related errors.
+        # Corresponds to the JSON property `errorsConfig`
+        # @return [Google::Apis::RetailV2::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::RetailV2::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

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.85.0"
+      GEM_VERSION = "0.87.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 = "20231109"
+      REVISION = "20240118"
     end
   end
 end

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

@@ -160,6 +160,12 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class GoogleCloudRetailV2CatalogAttributeFacetConfigRerankConfig
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class GoogleCloudRetailV2ColorInfo
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -874,6 +880,12 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class GoogleCloudRetailV2alphaExportAnalyticsMetricsResponse
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class GoogleCloudRetailV2alphaExportErrorsConfig
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -1132,6 +1144,12 @@ module Google
         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
       
@@ -1549,6 +1567,8 @@ module Google
       
           collection :merged_facet_values, as: 'mergedFacetValues', class: Google::Apis::RetailV2::GoogleCloudRetailV2CatalogAttributeFacetConfigMergedFacetValue, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2CatalogAttributeFacetConfigMergedFacetValue::Representation
       
+          property :rerank_config, as: 'rerankConfig', class: Google::Apis::RetailV2::GoogleCloudRetailV2CatalogAttributeFacetConfigRerankConfig, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2CatalogAttributeFacetConfigRerankConfig::Representation
+      
         end
       end
       
@@ -1569,6 +1589,14 @@ module Google
         end
       end
       
+      class GoogleCloudRetailV2CatalogAttributeFacetConfigRerankConfig
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          collection :facet_values, as: 'facetValues'
+          property :rerank_facet, as: 'rerankFacet'
+        end
+      end
+      
       class GoogleCloudRetailV2ColorInfo
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -2753,6 +2781,18 @@ module Google
         end
       end
       
+      class GoogleCloudRetailV2alphaExportAnalyticsMetricsResponse
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          collection :error_samples, as: 'errorSamples', class: Google::Apis::RetailV2::GoogleRpcStatus, decorator: Google::Apis::RetailV2::GoogleRpcStatus::Representation
+      
+          property :errors_config, as: 'errorsConfig', class: Google::Apis::RetailV2::GoogleCloudRetailV2alphaExportErrorsConfig, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2alphaExportErrorsConfig::Representation
+      
+          property :output_result, as: 'outputResult', class: Google::Apis::RetailV2::GoogleCloudRetailV2alphaOutputResult, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2alphaOutputResult::Representation
+      
+        end
+      end
+      
       class GoogleCloudRetailV2alphaExportErrorsConfig
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -3116,6 +3156,18 @@ module Google
         end
       end
       
+      class GoogleCloudRetailV2betaExportAnalyticsMetricsResponse
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          collection :error_samples, as: 'errorSamples', class: Google::Apis::RetailV2::GoogleRpcStatus, decorator: Google::Apis::RetailV2::GoogleRpcStatus::Representation
+      
+          property :errors_config, as: 'errorsConfig', class: Google::Apis::RetailV2::GoogleCloudRetailV2betaExportErrorsConfig, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2betaExportErrorsConfig::Representation
+      
+          property :output_result, as: 'outputResult', class: Google::Apis::RetailV2::GoogleCloudRetailV2betaOutputResult, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2betaOutputResult::Representation
+      
+        end
+      end
+      
       class GoogleCloudRetailV2betaExportErrorsConfig
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation

data/lib/google/apis/retail_v2/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_v2',
                 client_version: Google::Apis::RetailV2::GEM_VERSION)
           @batch_path = 'batch'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-apis-retail_v2
 version: !ruby/object:Gem::Version
-  version: 0.85.0
+  version: 0.87.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-11-19 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_v2/CHANGELOG.md
-  documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2/v0.85.0
+  documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2/v0.87.0
   source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-retail_v2
 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 V2