google-apis-retail_v2 0.108.0 → 0.110.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e01471f2a93620d0e7e35ce73f3d5a2b82375cfcba9245db5c0a0116ca7891bb
-  data.tar.gz: a4bb5c1ad75969be2b6553e9e572e40dab251ded0156ec39aae44a266886c61b
+  metadata.gz: f4181ef79f3d14f5a56d305f91b0a76e7467d7e9a3eeba8c4796f732c4f25f7c
+  data.tar.gz: 712e6cd366520b80d48298437fb6dff185f0cf4aa1ed7f3951cdc2222e339092
 SHA512:
-  metadata.gz: 81f31b8f354cfbd780874e873b8b490d36082814bb6901feb2e352652de1259a80e8c42edbbd3387db71190fac91fa4dbf5d1e3651de6312e14943eb0e3d5406
-  data.tar.gz: 974fceb93953c7cf312aa9c1f84f092ec6b901b3f73bf28d34124f053a8ef1c4b40abf873641162ccae1eda1ab5228d11a4bc43501faeaa8cf4e7bb226719333
+  metadata.gz: 6b25dd876aeebbfb04a535d756cffbf874c7aa9054eb4bf6cc6b039bbc0820afbc37af818a331bb6ed0fb3744d12cb05e6ffc4b0ad9e4f5fa1c00190e406bb19
+  data.tar.gz: 7b02c4bb639a0f900abeea760e2d62ad825817835122144d997fc698cc884e3c9c3048448590c89d55c34afaa7d2e4ff32004257e22974f0601bbda939c0d7d5

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Release history for google-apis-retail_v2
 
+### v0.110.0 (2025-02-26)
+
+* Regenerated from discovery document revision 20250221
+
+### v0.109.0 (2025-01-12)
+
+* Regenerated from discovery document revision 20250107
+* Regenerated using generator version 0.16.0
+
 ### v0.108.0 (2025-01-05)
 
 * Regenerated from discovery document revision 20241231

data/OVERVIEW.md

@@ -1,6 +1,6 @@
-# Simple REST client for version V2 of the Vertex AI Search for Retail API
+# Simple REST client for version V2 of the Vertex AI Search for commerce API
 
-This is a simple client library for version V2 of the Vertex AI Search for Retail API. It provides:
+This is a simple client library for version V2 of the Vertex AI Search for commerce API. It provides:
 
 * A client object that connects to the HTTP/JSON REST endpoint for the service.
 * Ruby objects for data structures related to the service.
@@ -65,7 +65,7 @@ More detailed descriptions of the Google simple REST clients are available in tw
 
 (Note: the above documents are written for the simple REST clients in general, and their examples may not reflect the Retail service in particular.)
 
-For reference information on specific calls in the Vertex AI Search for Retail API, see the {Google::Apis::RetailV2::CloudRetailService class reference docs}.
+For reference information on specific calls in the Vertex AI Search for commerce API, see the {Google::Apis::RetailV2::CloudRetailService class reference docs}.
 
 ## Which client should I use?
 

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

@@ -1177,12 +1177,11 @@ module Google
         end
       end
       
-      # Resource that represents attribute results. The list of suggestions for the
-      # attribute.
+      # Resource that represents attribute results.
       class GoogleCloudRetailV2CompleteQueryResponseAttributeResult
         include Google::Apis::Core::Hashable
       
-        # 
+        # The list of suggestions for the attribute.
         # Corresponds to the JSON property `suggestions`
         # @return [Array<String>]
         attr_accessor :suggestions
@@ -4451,6 +4450,21 @@ module Google
         # @return [Google::Apis::RetailV2::GoogleCloudRetailV2RuleOnewaySynonymsAction]
         attr_accessor :oneway_synonyms_action
       
+        # Pins one or more specified products to a specific position in the results. *
+        # Rule Condition: Must specify non-empty Condition.query_terms (for search only)
+        # or Condition.page_categories (for browse only), but can't specify both. *
+        # Action Input: mapping of `[pin_position, product_id]` pairs (pin position uses
+        # 1-based indexing). * Action Result: Will pin products with matching ids to the
+        # position specified in the final result order. Example: Suppose the query is `
+        # shoes`, the Condition.query_terms is `shoes` and the pin_map has ``1, "pid1"``,
+        # then product with `pid1` will be pinned to the top position in the final
+        # results. If multiple PinActions are matched to a single request the actions
+        # will be processed from most to least recently updated. Pins to positions
+        # larger than the max allowed page size of 120 are not allowed.
+        # Corresponds to the JSON property `pinAction`
+        # @return [Google::Apis::RetailV2::GoogleCloudRetailV2RulePinAction]
+        attr_accessor :pin_action
+      
         # Redirects a shopper to a specific page. * Rule Condition: Must specify
         # Condition.query_terms. * Action Input: Request Query * Action Result:
         # Redirects shopper to provided uri.
@@ -4496,6 +4510,7 @@ module Google
           @force_return_facet_action = args[:force_return_facet_action] if args.key?(:force_return_facet_action)
           @ignore_action = args[:ignore_action] if args.key?(:ignore_action)
           @oneway_synonyms_action = args[:oneway_synonyms_action] if args.key?(:oneway_synonyms_action)
+          @pin_action = args[:pin_action] if args.key?(:pin_action)
           @redirect_action = args[:redirect_action] if args.key?(:redirect_action)
           @remove_facet_action = args[:remove_facet_action] if args.key?(:remove_facet_action)
           @replacement_action = args[:replacement_action] if args.key?(:replacement_action)
@@ -4721,6 +4736,43 @@ module Google
         end
       end
       
+      # Pins one or more specified products to a specific position in the results. *
+      # Rule Condition: Must specify non-empty Condition.query_terms (for search only)
+      # or Condition.page_categories (for browse only), but can't specify both. *
+      # Action Input: mapping of `[pin_position, product_id]` pairs (pin position uses
+      # 1-based indexing). * Action Result: Will pin products with matching ids to the
+      # position specified in the final result order. Example: Suppose the query is `
+      # shoes`, the Condition.query_terms is `shoes` and the pin_map has ``1, "pid1"``,
+      # then product with `pid1` will be pinned to the top position in the final
+      # results. If multiple PinActions are matched to a single request the actions
+      # will be processed from most to least recently updated. Pins to positions
+      # larger than the max allowed page size of 120 are not allowed.
+      class GoogleCloudRetailV2RulePinAction
+        include Google::Apis::Core::Hashable
+      
+        # Required. A map of positions to product_ids. Partial matches per action are
+        # allowed, if a certain position in the map is already filled that `[position,
+        # product_id]` pair will be ignored but the rest may still be applied. This case
+        # will only occur if multiple pin actions are matched to a single request, as
+        # the map guarantees that pin positions are unique within the same action.
+        # Duplicate product_ids are not permitted within a single pin map. The max size
+        # of this map is 120, equivalent to the max [request page size](https://cloud.
+        # google.com/retail/docs/reference/rest/v2/projects.locations.catalogs.
+        # placements/search#request-body).
+        # Corresponds to the JSON property `pinMap`
+        # @return [Hash<String,String>]
+        attr_accessor :pin_map
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @pin_map = args[:pin_map] if args.key?(:pin_map)
+        end
+      end
+      
       # Redirects a shopper to a specific page. * Rule Condition: Must specify
       # Condition.query_terms. * Action Input: Request Query * Action Result:
       # Redirects shopper to provided uri.
@@ -4905,6 +4957,15 @@ module Google
         # @return [Hash<String,String>]
         attr_accessor :labels
       
+        # Optional. The BCP-47 language code, such as "en-US" or "sr-Latn" [list](https:/
+        # /www.unicode.org/cldr/charts/46/summary/root.html). For more information, see [
+        # Standardized codes](https://google.aip.dev/143). This field helps to better
+        # interpret the query. If a value isn't specified, the query language code is
+        # automatically detected, which may not be accurate.
+        # Corresponds to the JSON property `languageCode`
+        # @return [String]
+        attr_accessor :language_code
+      
         # A 0-indexed integer that specifies the current offset (that is, starting
         # result location, amongst the Products deemed by the API as relevant) in search
         # results. This field is only considered if page_token is unset. If this field
@@ -4965,6 +5026,15 @@ module Google
         # @return [Google::Apis::RetailV2::GoogleCloudRetailV2SearchRequestQueryExpansionSpec]
         attr_accessor :query_expansion_spec
       
+        # Optional. The Unicode country/region code (CLDR) of a location, such as "US"
+        # and "419" [list](https://www.unicode.org/cldr/charts/46/supplemental/
+        # territory_information.html). For more information, see [Standardized codes](
+        # https://google.aip.dev/143). If set, then results will be boosted based on the
+        # region_code provided.
+        # Corresponds to the JSON property `regionCode`
+        # @return [String]
+        attr_accessor :region_code
+      
         # The search mode of the search request. If not specified, a single search
         # request triggers both product search and faceted search.
         # Corresponds to the JSON property `searchMode`
@@ -5041,6 +5111,7 @@ module Google
           @facet_specs = args[:facet_specs] if args.key?(:facet_specs)
           @filter = args[:filter] if args.key?(:filter)
           @labels = args[:labels] if args.key?(:labels)
+          @language_code = args[:language_code] if args.key?(:language_code)
           @offset = args[:offset] if args.key?(:offset)
           @order_by = args[:order_by] if args.key?(:order_by)
           @page_categories = args[:page_categories] if args.key?(:page_categories)
@@ -5049,6 +5120,7 @@ module Google
           @personalization_spec = args[:personalization_spec] if args.key?(:personalization_spec)
           @query = args[:query] if args.key?(:query)
           @query_expansion_spec = args[:query_expansion_spec] if args.key?(:query_expansion_spec)
+          @region_code = args[:region_code] if args.key?(:region_code)
           @search_mode = args[:search_mode] if args.key?(:search_mode)
           @spell_correction_spec = args[:spell_correction_spec] if args.key?(:spell_correction_spec)
           @tile_navigation_spec = args[:tile_navigation_spec] if args.key?(:tile_navigation_spec)
@@ -5505,9 +5577,12 @@ module Google
       class GoogleCloudRetailV2SearchRequestTileNavigationSpec
         include Google::Apis::Core::Hashable
       
-        # This field specifies the tiles which are already clicked in client side. NOTE:
-        # This field is not being used for filtering search products. Client side should
-        # also put all the applied tiles in SearchRequest.filter.
+        # This optional field specifies the tiles which are already clicked in client
+        # side. While the feature works without this field set, particularly for an
+        # initial query, it is highly recommended to set this field because it can
+        # improve the quality of the search response and removes possible duplicate
+        # tiles. NOTE: This field is not being used for filtering search products.
+        # Client side should also put all the applied tiles in SearchRequest.filter.
         # Corresponds to the JSON property `appliedTiles`
         # @return [Array<Google::Apis::RetailV2::GoogleCloudRetailV2Tile>]
         attr_accessor :applied_tiles
@@ -6431,10 +6506,8 @@ module Google
         # added to cart. * `remove-from-cart`: Products being removed from cart. * `
         # category-page-view`: Special pages such as sale or promotion pages viewed. * `
         # detail-page-view`: Products detail page viewed. * `home-page-view`: Homepage
-        # viewed. * `promotion-offered`: Promotion is offered to a user. * `promotion-
-        # not-offered`: Promotion is not offered to a user. * `purchase-complete`: User
-        # finishing a purchase. * `search`: Product search. * `shopping-cart-page-view`:
-        # User viewing a shopping cart.
+        # viewed. * `purchase-complete`: User finishing a purchase. * `search`: Product
+        # search. * `shopping-cart-page-view`: User viewing a shopping cart.
         # Corresponds to the JSON property `eventType`
         # @return [String]
         attr_accessor :event_type

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.108.0"
+      GEM_VERSION = "0.110.0"
 
       # Version of the code generator used to generate this client
-      GENERATOR_VERSION = "0.15.1"
+      GENERATOR_VERSION = "0.16.0"
 
       # Revision of the discovery document this client was generated from
-      REVISION = "20241231"
+      REVISION = "20250221"
     end
   end
 end

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

@@ -772,6 +772,12 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class GoogleCloudRetailV2RulePinAction
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class GoogleCloudRetailV2RuleRedirectAction
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -2675,6 +2681,8 @@ module Google
       
           property :oneway_synonyms_action, as: 'onewaySynonymsAction', class: Google::Apis::RetailV2::GoogleCloudRetailV2RuleOnewaySynonymsAction, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2RuleOnewaySynonymsAction::Representation
       
+          property :pin_action, as: 'pinAction', class: Google::Apis::RetailV2::GoogleCloudRetailV2RulePinAction, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2RulePinAction::Representation
+      
           property :redirect_action, as: 'redirectAction', class: Google::Apis::RetailV2::GoogleCloudRetailV2RuleRedirectAction, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2RuleRedirectAction::Representation
       
           property :remove_facet_action, as: 'removeFacetAction', class: Google::Apis::RetailV2::GoogleCloudRetailV2RuleRemoveFacetAction, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2RuleRemoveFacetAction::Representation
@@ -2742,6 +2750,13 @@ module Google
         end
       end
       
+      class GoogleCloudRetailV2RulePinAction
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          hash :pin_map, as: 'pinMap'
+        end
+      end
+      
       class GoogleCloudRetailV2RuleRedirectAction
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -2788,6 +2803,7 @@ module Google
       
           property :filter, as: 'filter'
           hash :labels, as: 'labels'
+          property :language_code, as: 'languageCode'
           property :offset, as: 'offset'
           property :order_by, as: 'orderBy'
           collection :page_categories, as: 'pageCategories'
@@ -2798,6 +2814,7 @@ module Google
           property :query, as: 'query'
           property :query_expansion_spec, as: 'queryExpansionSpec', class: Google::Apis::RetailV2::GoogleCloudRetailV2SearchRequestQueryExpansionSpec, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2SearchRequestQueryExpansionSpec::Representation
       
+          property :region_code, as: 'regionCode'
           property :search_mode, as: 'searchMode'
           property :spell_correction_spec, as: 'spellCorrectionSpec', class: Google::Apis::RetailV2::GoogleCloudRetailV2SearchRequestSpellCorrectionSpec, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2SearchRequestSpellCorrectionSpec::Representation
       

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

@@ -20,9 +20,9 @@ require 'google/apis/errors'
 module Google
   module Apis
     module RetailV2
-      # Vertex AI Search for Retail API
+      # Vertex AI Search for commerce API
       #
-      # Vertex AI Search for Retail API is made up of Retail Search, Browse and
+      # Vertex AI Search for commerce API is made up of Retail Search, Browse and
       #  Recommendations. These discovery AI solutions help you implement personalized
       #  search, browse and recommendations, based on machine learning models, across
       #  your websites and mobile applications.

data/lib/google/apis/retail_v2.rb

@@ -19,16 +19,16 @@ require 'google/apis/retail_v2/gem_version.rb'
 
 module Google
   module Apis
-    # Vertex AI Search for Retail API
+    # Vertex AI Search for commerce API
     #
-    # Vertex AI Search for Retail API is made up of Retail Search, Browse and
+    # Vertex AI Search for commerce API is made up of Retail Search, Browse and
     # Recommendations. These discovery AI solutions help you implement personalized
     # search, browse and recommendations, based on machine learning models, across
     # your websites and mobile applications.
     #
     # @see https://cloud.google.com/recommendations
     module RetailV2
-      # Version of the Vertex AI Search for Retail API this client connects to.
+      # Version of the Vertex AI Search for commerce API this client connects to.
       # This is NOT the gem version.
       VERSION = 'V2'
 

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: google-apis-retail_v2
 version: !ruby/object:Gem::Version
-  version: 0.108.0
+  version: 0.110.0
 platform: ruby
 authors:
 - Google LLC
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2025-01-05 00:00:00.000000000 Z
+date: 2025-03-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-apis-core
@@ -30,13 +29,13 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
-description: This is the simple REST client for Vertex AI Search for Retail API V2.
-  Simple REST clients are Ruby client libraries that provide access to Google services
-  via their HTTP REST API endpoints. These libraries are generated and updated automatically
-  based on the discovery documents published by the service, and they handle most
-  concerns such as authentication, pagination, retry, timeouts, and logging. You can
-  use this client to access the Vertex AI Search for Retail API, but note that some
-  services may provide a separate modern client that is easier to use.
+description: This is the simple REST client for Vertex AI Search for commerce API
+  V2. Simple REST clients are Ruby client libraries that provide access to Google
+  services via their HTTP REST API endpoints. These libraries are generated and updated
+  automatically based on the discovery documents published by the service, and they
+  handle most concerns such as authentication, pagination, retry, timeouts, and logging.
+  You can use this client to access the Vertex AI Search for commerce API, but note
+  that some services may provide a separate modern client that is easier to use.
 email: googleapis-packages@google.com
 executables: []
 extensions: []
@@ -58,9 +57,8 @@ 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.108.0
+  documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2/v0.110.0
   source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-retail_v2
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -75,8 +73,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.23
-signing_key: 
+rubygems_version: 3.6.5
 specification_version: 4
-summary: Simple REST client for Vertex AI Search for Retail API V2
+summary: Simple REST client for Vertex AI Search for commerce API V2
 test_files: []