google-apis-retail_v2 0.107.0 → 0.109.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: abcd2c186e9dd9efa05359c9af301e1f81c73cfef8fb257a571d4c5326663e54
-  data.tar.gz: 5aae938443e35f4dc6ddf40dca5b071f54e234e4e76c5987d57665dc4948c9c2
+  metadata.gz: 53a99bcd01f678ae1f49d39948927b996c557dd67f3bee6366d240d66875ddd5
+  data.tar.gz: d7a47a6cfae677c27d9f29fb2e5da5ebfe17b42fac9407562eea1a43894999fc
 SHA512:
-  metadata.gz: 9e1e27096534330d3caf00e316f9d39e67fac8a61ef9a122ecf844671dde626df6b762f775ca3f13693d46a9f785fbb07e371166e472b5fafc59dfd832ddc24d
-  data.tar.gz: e6773b1a1f3d30bdcfbfa3b64bbb37eda36c285a0c9d844bd371dd81c60993d5c9fb564f3c6b65055682b452bbd5d05c673576b5220461d818d470c08af0a813
+  metadata.gz: 3b66bf58cd1d27490496728182dbbe16bb5727cab791442de01df7f3179a9a28cd55632a11a08c1a2882e3321b05bf66e2de51181f1e4482d49ee1c8a94b2f49
+  data.tar.gz: a34e77109a19db75bf431c7b6224c50d9e3f437b151e2781f8e4a0ad590382655309cba5333ca6181f3965d375ef14c06f7b7c7435065a6d9b82c95772f614ff

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # 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
+
 ### v0.107.0 (2024-12-15)
 
 * Regenerated from discovery document revision 20241205

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

@@ -1033,6 +1033,58 @@ module Google
         end
       end
       
+      # Request message for CollectUserEvent method.
+      class GoogleCloudRetailV2CollectUserEventRequest
+        include Google::Apis::Core::Hashable
+      
+        # The event timestamp in milliseconds. This prevents browser caching of
+        # otherwise identical get requests. The name is abbreviated to reduce the
+        # payload bytes.
+        # Corresponds to the JSON property `ets`
+        # @return [Fixnum]
+        attr_accessor :ets
+      
+        # The prebuilt rule name that can convert a specific type of raw_json. For
+        # example: "ga4_bq" rule for the GA4 user event schema.
+        # Corresponds to the JSON property `prebuiltRule`
+        # @return [String]
+        attr_accessor :prebuilt_rule
+      
+        # An arbitrary serialized JSON string that contains necessary information that
+        # can comprise a user event. When this field is specified, the user_event field
+        # will be ignored. Note: line-delimited JSON is not supported, a single JSON
+        # only.
+        # Corresponds to the JSON property `rawJson`
+        # @return [String]
+        attr_accessor :raw_json
+      
+        # The URL including cgi-parameters but excluding the hash fragment with a length
+        # limit of 5,000 characters. This is often more useful than the referer URL,
+        # because many browsers only send the domain for 3rd party requests.
+        # Corresponds to the JSON property `uri`
+        # @return [String]
+        attr_accessor :uri
+      
+        # Required. URL encoded UserEvent proto with a length limit of 2,000,000
+        # characters.
+        # Corresponds to the JSON property `userEvent`
+        # @return [String]
+        attr_accessor :user_event
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @ets = args[:ets] if args.key?(:ets)
+          @prebuilt_rule = args[:prebuilt_rule] if args.key?(:prebuilt_rule)
+          @raw_json = args[:raw_json] if args.key?(:raw_json)
+          @uri = args[:uri] if args.key?(:uri)
+          @user_event = args[:user_event] if args.key?(:user_event)
+        end
+      end
+      
       # The color information of a Product.
       class GoogleCloudRetailV2ColorInfo
         include Google::Apis::Core::Hashable
@@ -1045,7 +1097,10 @@ module Google
         # be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an
         # INVALID_ARGUMENT error is returned. Google Merchant Center property [color](
         # https://support.google.com/merchants/answer/6324487). Schema.org property [
-        # Product.color](https://schema.org/color).
+        # Product.color](https://schema.org/color). The colorFamilies field as a system
+        # attribute is not a required field but strongly recommended to be specified.
+        # Google Search models treat this field as more important than a custom product
+        # attribute when specified.
         # Corresponds to the JSON property `colorFamilies`
         # @return [Array<String>]
         attr_accessor :color_families
@@ -4396,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.
@@ -4441,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)
@@ -4666,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.107.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 = "20241205"
+      REVISION = "20250107"
     end
   end
 end

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

@@ -190,6 +190,12 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class GoogleCloudRetailV2CollectUserEventRequest
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class GoogleCloudRetailV2ColorInfo
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -766,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
       
@@ -1798,6 +1810,17 @@ module Google
         end
       end
       
+      class GoogleCloudRetailV2CollectUserEventRequest
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :ets, :numeric_string => true, as: 'ets'
+          property :prebuilt_rule, as: 'prebuiltRule'
+          property :raw_json, as: 'rawJson'
+          property :uri, as: 'uri'
+          property :user_event, as: 'userEvent'
+        end
+      end
+      
       class GoogleCloudRetailV2ColorInfo
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -2658,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
@@ -2725,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

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

@@ -2362,32 +2362,15 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
-        # Writes a single user event from the browser. This uses a GET request to due to
-        # browser restriction of POST-ing to a 3rd party domain. This method is used
-        # only by the Retail API JavaScript pixel and Google Tag Manager. Users should
-        # not call this method directly.
+        # Writes a single user event from the browser. For larger user event payload
+        # over 16 KB, the POST method should be used instead, otherwise a 400 Bad
+        # Request error is returned. This method is used only by the Retail API
+        # JavaScript pixel and Google Tag Manager. Users should not call this method
+        # directly.
         # @param [String] parent
         #   Required. The parent catalog name, such as `projects/1234/locations/global/
         #   catalogs/default_catalog`.
-        # @param [Fixnum] ets
-        #   The event timestamp in milliseconds. This prevents browser caching of
-        #   otherwise identical get requests. The name is abbreviated to reduce the
-        #   payload bytes.
-        # @param [String] prebuilt_rule
-        #   The prebuilt rule name that can convert a specific type of raw_json. For
-        #   example: "ga4_bq" rule for the GA4 user event schema.
-        # @param [String] raw_json
-        #   An arbitrary serialized JSON string that contains necessary information that
-        #   can comprise a user event. When this field is specified, the user_event field
-        #   will be ignored. Note: line-delimited JSON is not supported, a single JSON
-        #   only.
-        # @param [String] uri
-        #   The URL including cgi-parameters but excluding the hash fragment with a length
-        #   limit of 5,000 characters. This is often more useful than the referer URL,
-        #   because many browsers only send the domain for 3rd party requests.
-        # @param [String] user_event
-        #   Required. URL encoded UserEvent proto with a length limit of 2,000,000
-        #   characters.
+        # @param [Google::Apis::RetailV2::GoogleCloudRetailV2CollectUserEventRequest] google_cloud_retail_v2_collect_user_event_request_object
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
         # @param [String] quota_user
@@ -2405,16 +2388,13 @@ module Google
         # @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 collect_project_location_catalog_user_event(parent, ets: nil, prebuilt_rule: nil, raw_json: nil, uri: nil, user_event: nil, fields: nil, quota_user: nil, options: nil, &block)
-          command = make_simple_command(:get, 'v2/{+parent}/userEvents:collect', options)
+        def collect_project_location_catalog_user_event(parent, google_cloud_retail_v2_collect_user_event_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:post, 'v2/{+parent}/userEvents:collect', options)
+          command.request_representation = Google::Apis::RetailV2::GoogleCloudRetailV2CollectUserEventRequest::Representation
+          command.request_object = google_cloud_retail_v2_collect_user_event_request_object
           command.response_representation = Google::Apis::RetailV2::GoogleApiHttpBody::Representation
           command.response_class = Google::Apis::RetailV2::GoogleApiHttpBody
           command.params['parent'] = parent unless parent.nil?
-          command.query['ets'] = ets unless ets.nil?
-          command.query['prebuiltRule'] = prebuilt_rule unless prebuilt_rule.nil?
-          command.query['rawJson'] = raw_json unless raw_json.nil?
-          command.query['uri'] = uri unless uri.nil?
-          command.query['userEvent'] = user_event unless user_event.nil?
           command.query['fields'] = fields unless fields.nil?
           command.query['quotaUser'] = quota_user unless quota_user.nil?
           execute_or_queue_command(command, &block)

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: google-apis-retail_v2
 version: !ruby/object:Gem::Version
-  version: 0.107.0
+  version: 0.109.0
 platform: ruby
 authors:
 - Google LLC
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-12-15 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.107.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: []