google-apis-retail_v2 0.107.0 → 0.108.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: abcd2c186e9dd9efa05359c9af301e1f81c73cfef8fb257a571d4c5326663e54
4
- data.tar.gz: 5aae938443e35f4dc6ddf40dca5b071f54e234e4e76c5987d57665dc4948c9c2
3
+ metadata.gz: e01471f2a93620d0e7e35ce73f3d5a2b82375cfcba9245db5c0a0116ca7891bb
4
+ data.tar.gz: a4bb5c1ad75969be2b6553e9e572e40dab251ded0156ec39aae44a266886c61b
5
5
  SHA512:
6
- metadata.gz: 9e1e27096534330d3caf00e316f9d39e67fac8a61ef9a122ecf844671dde626df6b762f775ca3f13693d46a9f785fbb07e371166e472b5fafc59dfd832ddc24d
7
- data.tar.gz: e6773b1a1f3d30bdcfbfa3b64bbb37eda36c285a0c9d844bd371dd81c60993d5c9fb564f3c6b65055682b452bbd5d05c673576b5220461d818d470c08af0a813
6
+ metadata.gz: 81f31b8f354cfbd780874e873b8b490d36082814bb6901feb2e352652de1259a80e8c42edbbd3387db71190fac91fa4dbf5d1e3651de6312e14943eb0e3d5406
7
+ data.tar.gz: 974fceb93953c7cf312aa9c1f84f092ec6b901b3f73bf28d34124f053a8ef1c4b40abf873641162ccae1eda1ab5228d11a4bc43501faeaa8cf4e7bb226719333
data/CHANGELOG.md CHANGED
@@ -1,5 +1,9 @@
1
1
  # Release history for google-apis-retail_v2
2
2
 
3
+ ### v0.108.0 (2025-01-05)
4
+
5
+ * Regenerated from discovery document revision 20241231
6
+
3
7
  ### v0.107.0 (2024-12-15)
4
8
 
5
9
  * Regenerated from discovery document revision 20241205
@@ -1033,6 +1033,58 @@ module Google
1033
1033
  end
1034
1034
  end
1035
1035
 
1036
+ # Request message for CollectUserEvent method.
1037
+ class GoogleCloudRetailV2CollectUserEventRequest
1038
+ include Google::Apis::Core::Hashable
1039
+
1040
+ # The event timestamp in milliseconds. This prevents browser caching of
1041
+ # otherwise identical get requests. The name is abbreviated to reduce the
1042
+ # payload bytes.
1043
+ # Corresponds to the JSON property `ets`
1044
+ # @return [Fixnum]
1045
+ attr_accessor :ets
1046
+
1047
+ # The prebuilt rule name that can convert a specific type of raw_json. For
1048
+ # example: "ga4_bq" rule for the GA4 user event schema.
1049
+ # Corresponds to the JSON property `prebuiltRule`
1050
+ # @return [String]
1051
+ attr_accessor :prebuilt_rule
1052
+
1053
+ # An arbitrary serialized JSON string that contains necessary information that
1054
+ # can comprise a user event. When this field is specified, the user_event field
1055
+ # will be ignored. Note: line-delimited JSON is not supported, a single JSON
1056
+ # only.
1057
+ # Corresponds to the JSON property `rawJson`
1058
+ # @return [String]
1059
+ attr_accessor :raw_json
1060
+
1061
+ # The URL including cgi-parameters but excluding the hash fragment with a length
1062
+ # limit of 5,000 characters. This is often more useful than the referer URL,
1063
+ # because many browsers only send the domain for 3rd party requests.
1064
+ # Corresponds to the JSON property `uri`
1065
+ # @return [String]
1066
+ attr_accessor :uri
1067
+
1068
+ # Required. URL encoded UserEvent proto with a length limit of 2,000,000
1069
+ # characters.
1070
+ # Corresponds to the JSON property `userEvent`
1071
+ # @return [String]
1072
+ attr_accessor :user_event
1073
+
1074
+ def initialize(**args)
1075
+ update!(**args)
1076
+ end
1077
+
1078
+ # Update properties of this object
1079
+ def update!(**args)
1080
+ @ets = args[:ets] if args.key?(:ets)
1081
+ @prebuilt_rule = args[:prebuilt_rule] if args.key?(:prebuilt_rule)
1082
+ @raw_json = args[:raw_json] if args.key?(:raw_json)
1083
+ @uri = args[:uri] if args.key?(:uri)
1084
+ @user_event = args[:user_event] if args.key?(:user_event)
1085
+ end
1086
+ end
1087
+
1036
1088
  # The color information of a Product.
1037
1089
  class GoogleCloudRetailV2ColorInfo
1038
1090
  include Google::Apis::Core::Hashable
@@ -1045,7 +1097,10 @@ module Google
1045
1097
  # be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an
1046
1098
  # INVALID_ARGUMENT error is returned. Google Merchant Center property [color](
1047
1099
  # https://support.google.com/merchants/answer/6324487). Schema.org property [
1048
- # Product.color](https://schema.org/color).
1100
+ # Product.color](https://schema.org/color). The colorFamilies field as a system
1101
+ # attribute is not a required field but strongly recommended to be specified.
1102
+ # Google Search models treat this field as more important than a custom product
1103
+ # attribute when specified.
1049
1104
  # Corresponds to the JSON property `colorFamilies`
1050
1105
  # @return [Array<String>]
1051
1106
  attr_accessor :color_families
@@ -16,13 +16,13 @@ module Google
16
16
  module Apis
17
17
  module RetailV2
18
18
  # Version of the google-apis-retail_v2 gem
19
- GEM_VERSION = "0.107.0"
19
+ GEM_VERSION = "0.108.0"
20
20
 
21
21
  # Version of the code generator used to generate this client
22
22
  GENERATOR_VERSION = "0.15.1"
23
23
 
24
24
  # Revision of the discovery document this client was generated from
25
- REVISION = "20241205"
25
+ REVISION = "20241231"
26
26
  end
27
27
  end
28
28
  end
@@ -190,6 +190,12 @@ module Google
190
190
  include Google::Apis::Core::JsonObjectSupport
191
191
  end
192
192
 
193
+ class GoogleCloudRetailV2CollectUserEventRequest
194
+ class Representation < Google::Apis::Core::JsonRepresentation; end
195
+
196
+ include Google::Apis::Core::JsonObjectSupport
197
+ end
198
+
193
199
  class GoogleCloudRetailV2ColorInfo
194
200
  class Representation < Google::Apis::Core::JsonRepresentation; end
195
201
 
@@ -1798,6 +1804,17 @@ module Google
1798
1804
  end
1799
1805
  end
1800
1806
 
1807
+ class GoogleCloudRetailV2CollectUserEventRequest
1808
+ # @private
1809
+ class Representation < Google::Apis::Core::JsonRepresentation
1810
+ property :ets, :numeric_string => true, as: 'ets'
1811
+ property :prebuilt_rule, as: 'prebuiltRule'
1812
+ property :raw_json, as: 'rawJson'
1813
+ property :uri, as: 'uri'
1814
+ property :user_event, as: 'userEvent'
1815
+ end
1816
+ end
1817
+
1801
1818
  class GoogleCloudRetailV2ColorInfo
1802
1819
  # @private
1803
1820
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -2362,32 +2362,15 @@ module Google
2362
2362
  execute_or_queue_command(command, &block)
2363
2363
  end
2364
2364
 
2365
- # Writes a single user event from the browser. This uses a GET request to due to
2366
- # browser restriction of POST-ing to a 3rd party domain. This method is used
2367
- # only by the Retail API JavaScript pixel and Google Tag Manager. Users should
2368
- # not call this method directly.
2365
+ # Writes a single user event from the browser. For larger user event payload
2366
+ # over 16 KB, the POST method should be used instead, otherwise a 400 Bad
2367
+ # Request error is returned. This method is used only by the Retail API
2368
+ # JavaScript pixel and Google Tag Manager. Users should not call this method
2369
+ # directly.
2369
2370
  # @param [String] parent
2370
2371
  # Required. The parent catalog name, such as `projects/1234/locations/global/
2371
2372
  # catalogs/default_catalog`.
2372
- # @param [Fixnum] ets
2373
- # The event timestamp in milliseconds. This prevents browser caching of
2374
- # otherwise identical get requests. The name is abbreviated to reduce the
2375
- # payload bytes.
2376
- # @param [String] prebuilt_rule
2377
- # The prebuilt rule name that can convert a specific type of raw_json. For
2378
- # example: "ga4_bq" rule for the GA4 user event schema.
2379
- # @param [String] raw_json
2380
- # An arbitrary serialized JSON string that contains necessary information that
2381
- # can comprise a user event. When this field is specified, the user_event field
2382
- # will be ignored. Note: line-delimited JSON is not supported, a single JSON
2383
- # only.
2384
- # @param [String] uri
2385
- # The URL including cgi-parameters but excluding the hash fragment with a length
2386
- # limit of 5,000 characters. This is often more useful than the referer URL,
2387
- # because many browsers only send the domain for 3rd party requests.
2388
- # @param [String] user_event
2389
- # Required. URL encoded UserEvent proto with a length limit of 2,000,000
2390
- # characters.
2373
+ # @param [Google::Apis::RetailV2::GoogleCloudRetailV2CollectUserEventRequest] google_cloud_retail_v2_collect_user_event_request_object
2391
2374
  # @param [String] fields
2392
2375
  # Selector specifying which fields to include in a partial response.
2393
2376
  # @param [String] quota_user
@@ -2405,16 +2388,13 @@ module Google
2405
2388
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2406
2389
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2407
2390
  # @raise [Google::Apis::AuthorizationError] Authorization is required
2408
- 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)
2409
- command = make_simple_command(:get, 'v2/{+parent}/userEvents:collect', options)
2391
+ 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)
2392
+ command = make_simple_command(:post, 'v2/{+parent}/userEvents:collect', options)
2393
+ command.request_representation = Google::Apis::RetailV2::GoogleCloudRetailV2CollectUserEventRequest::Representation
2394
+ command.request_object = google_cloud_retail_v2_collect_user_event_request_object
2410
2395
  command.response_representation = Google::Apis::RetailV2::GoogleApiHttpBody::Representation
2411
2396
  command.response_class = Google::Apis::RetailV2::GoogleApiHttpBody
2412
2397
  command.params['parent'] = parent unless parent.nil?
2413
- command.query['ets'] = ets unless ets.nil?
2414
- command.query['prebuiltRule'] = prebuilt_rule unless prebuilt_rule.nil?
2415
- command.query['rawJson'] = raw_json unless raw_json.nil?
2416
- command.query['uri'] = uri unless uri.nil?
2417
- command.query['userEvent'] = user_event unless user_event.nil?
2418
2398
  command.query['fields'] = fields unless fields.nil?
2419
2399
  command.query['quotaUser'] = quota_user unless quota_user.nil?
2420
2400
  execute_or_queue_command(command, &block)
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-apis-retail_v2
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.107.0
4
+ version: 0.108.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2024-12-15 00:00:00.000000000 Z
11
+ date: 2025-01-05 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: google-apis-core
@@ -58,7 +58,7 @@ licenses:
58
58
  metadata:
59
59
  bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
60
60
  changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-retail_v2/CHANGELOG.md
61
- documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2/v0.107.0
61
+ documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2/v0.108.0
62
62
  source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-retail_v2
63
63
  post_install_message:
64
64
  rdoc_options: []