google-apis-retail_v2alpha 0.106.0 → 0.108.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 07f6db77df89b198242e29eb2c70ec65597e9088426e9ebd7e71df595c7f428d
-  data.tar.gz: 803e3ccbc116b91924cfafc68ca590cf081f6e8f8a778efdeefbdd03fe68d81f
+  metadata.gz: 6cd1a34e2d99550069ac0acdccff035eb50acc77910e60039a22ffe9364f5253
+  data.tar.gz: 05f1b5f1e765ee107985582dbae0250631ea195231f9796be8cfb5d6aaaa7507
 SHA512:
-  metadata.gz: 4233ccfdb2a1840200f1853dbd4a5f2fd7990ebe564f3e2a3c4fd8c02a3c739fc6504e6cf5fc473cb56a90481354b06fff570abdbade989e47f8d4bdec76a874
-  data.tar.gz: d2d3ae385b2060b54775c28f9b8ead341fa73d06b1eef8d8ff26c1efc15da8339286c3e1a7f9cd10ad503a8c31b88d64bb8581ba00604eca9d521613c2258cb2
+  metadata.gz: 27b0c2945c976bf7273edb4fd3c54964caa8e9e459e119049c9ba35ae86769663bb66b9ed5966fdfb76edbb776fa26f800f027184fd0e163eda6146cdef971c6
+  data.tar.gz: 0f2142c017142504646a5d027dbf30ee013caa70a088127a4766f4c4b34f553d46ba6c71913be2f072944dabf535f36a520c7c8f73522fbf88cb5ad3447cdb7d

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Release history for google-apis-retail_v2alpha
 
+### v0.108.0 (2025-01-12)
+
+* Regenerated from discovery document revision 20250107
+* Regenerated using generator version 0.16.0
+
+### v0.107.0 (2025-01-05)
+
+* Regenerated from discovery document revision 20241231
+
 ### v0.106.0 (2024-12-15)
 
 * Regenerated from discovery document revision 20241205

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

@@ -2232,6 +2232,58 @@ module Google
         end
       end
       
+      # Request message for CollectUserEvent method.
+      class GoogleCloudRetailV2alphaCollectUserEventRequest
+        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 GoogleCloudRetailV2alphaColorInfo
         include Google::Apis::Core::Hashable
@@ -2244,7 +2296,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
@@ -6406,6 +6461,21 @@ module Google
         # @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaRuleOnewaySynonymsAction]
         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::RetailV2alpha::GoogleCloudRetailV2alphaRulePinAction]
+        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.
@@ -6451,6 +6521,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)
@@ -6676,6 +6747,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 GoogleCloudRetailV2alphaRulePinAction
+        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_v2alpha/gem_version.rb

@@ -16,13 +16,13 @@ module Google
   module Apis
     module RetailV2alpha
       # Version of the google-apis-retail_v2alpha gem
-      GEM_VERSION = "0.106.0"
+      GEM_VERSION = "0.108.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_v2alpha/representations.rb

@@ -454,6 +454,12 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class GoogleCloudRetailV2alphaCollectUserEventRequest
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class GoogleCloudRetailV2alphaColorInfo
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -1168,6 +1174,12 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class GoogleCloudRetailV2alphaRulePinAction
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class GoogleCloudRetailV2alphaRuleRedirectAction
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -2292,6 +2304,17 @@ module Google
         end
       end
       
+      class GoogleCloudRetailV2alphaCollectUserEventRequest
+        # @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 GoogleCloudRetailV2alphaColorInfo
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -3374,6 +3397,8 @@ module Google
       
           property :oneway_synonyms_action, as: 'onewaySynonymsAction', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaRuleOnewaySynonymsAction, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaRuleOnewaySynonymsAction::Representation
       
+          property :pin_action, as: 'pinAction', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaRulePinAction, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaRulePinAction::Representation
+      
           property :redirect_action, as: 'redirectAction', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaRuleRedirectAction, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaRuleRedirectAction::Representation
       
           property :remove_facet_action, as: 'removeFacetAction', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaRuleRemoveFacetAction, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaRuleRemoveFacetAction::Representation
@@ -3441,6 +3466,13 @@ module Google
         end
       end
       
+      class GoogleCloudRetailV2alphaRulePinAction
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          hash :pin_map, as: 'pinMap'
+        end
+      end
+      
       class GoogleCloudRetailV2alphaRuleRedirectAction
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation

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

@@ -2887,32 +2887,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::RetailV2alpha::GoogleCloudRetailV2alphaCollectUserEventRequest] google_cloud_retail_v2alpha_collect_user_event_request_object
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
         # @param [String] quota_user
@@ -2930,16 +2913,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, 'v2alpha/{+parent}/userEvents:collect', options)
+        def collect_project_location_catalog_user_event(parent, google_cloud_retail_v2alpha_collect_user_event_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:post, 'v2alpha/{+parent}/userEvents:collect', options)
+          command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCollectUserEventRequest::Representation
+          command.request_object = google_cloud_retail_v2alpha_collect_user_event_request_object
           command.response_representation = Google::Apis::RetailV2alpha::GoogleApiHttpBody::Representation
           command.response_class = Google::Apis::RetailV2alpha::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_v2alpha
 version: !ruby/object:Gem::Version
-  version: 0.106.0
+  version: 0.108.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_v2alpha/CHANGELOG.md
-  documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2alpha/v0.106.0
+  documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2alpha/v0.108.0
   source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-retail_v2alpha
-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 V2alpha
 test_files: []