google-apis-retail_v2 0.108.0 → 0.109.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e01471f2a93620d0e7e35ce73f3d5a2b82375cfcba9245db5c0a0116ca7891bb
-  data.tar.gz: a4bb5c1ad75969be2b6553e9e572e40dab251ded0156ec39aae44a266886c61b
+  metadata.gz: 53a99bcd01f678ae1f49d39948927b996c557dd67f3bee6366d240d66875ddd5
+  data.tar.gz: d7a47a6cfae677c27d9f29fb2e5da5ebfe17b42fac9407562eea1a43894999fc
 SHA512:
-  metadata.gz: 81f31b8f354cfbd780874e873b8b490d36082814bb6901feb2e352652de1259a80e8c42edbbd3387db71190fac91fa4dbf5d1e3651de6312e14943eb0e3d5406
-  data.tar.gz: 974fceb93953c7cf312aa9c1f84f092ec6b901b3f73bf28d34124f053a8ef1c4b40abf873641162ccae1eda1ab5228d11a4bc43501faeaa8cf4e7bb226719333
+  metadata.gz: 3b66bf58cd1d27490496728182dbbe16bb5727cab791442de01df7f3179a9a28cd55632a11a08c1a2882e3321b05bf66e2de51181f1e4482d49ee1c8a94b2f49
+  data.tar.gz: a34e77109a19db75bf431c7b6224c50d9e3f437b151e2781f8e4a0ad590382655309cba5333ca6181f3965d375ef14c06f7b7c7435065a6d9b82c95772f614ff

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Release history for google-apis-retail_v2
 
+### 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/lib/google/apis/retail_v2/classes.rb

@@ -4451,6 +4451,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 +4511,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 +4737,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.

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.109.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 = "20250107"
     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

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.109.0
 platform: ruby
 authors:
 - Google LLC
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2025-01-05 00:00:00.000000000 Z
+date: 2025-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-apis-core
@@ -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.109.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.2
 specification_version: 4
 summary: Simple REST client for Vertex AI Search for Retail API V2
 test_files: []