google-apis-retail_v2beta 0.100.0 → 0.102.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 6c717022c76eb6a595cad75233c8b63aa64ea117fa0b9c41bca482f9a4cc8705
4
- data.tar.gz: 3ee09de8bc188efc260cacbd3049683105305c762569b30ea32324b0b3486cbe
3
+ metadata.gz: f9a93314ac1819322ba4e424d74aa7bc13a377ece1abc9439fa10cd1a997973d
4
+ data.tar.gz: 64102c49e10e9b4c0b5801b4e0d33522bb992bfedda9e790525bf3bba2a591c5
5
5
  SHA512:
6
- metadata.gz: 608941e1a08e7d6dd5a692c840e40151c663293c1b231ffa9284c23ed13d15256474fab50850f67de66ad23819c70542b81e5aa247cc1614e0240cf5657c9183
7
- data.tar.gz: 6a033f835184941a44df3bf52f18ff3439fe2d64bbce265a5f4755a655c7dda630469f6778fa9f1459900c8cb58e351eada63b8f44b30b516d36f7b1b0692d63
6
+ metadata.gz: abd16936a73a7f471f5fad5ce92a3c9a248114f797ac9e1b5bb2729db2289154a33ab3728d3c65212c410b40ba3fec15ca488da9d37c6f3eb52ece176a66f95a
7
+ data.tar.gz: ecb8a251ce6464e61ba5992fe898f9056ee6be8d0c34328ff0037f2d1a3b070fac3dd7682910da646ffaf8637f76472349368f718567761af06de275ee2240ef
data/CHANGELOG.md CHANGED
@@ -1,5 +1,13 @@
1
1
  # Release history for google-apis-retail_v2beta
2
2
 
3
+ ### v0.102.0 (2025-01-05)
4
+
5
+ * Regenerated from discovery document revision 20241231
6
+
7
+ ### v0.101.0 (2024-12-15)
8
+
9
+ * Regenerated from discovery document revision 20241205
10
+
3
11
  ### v0.100.0 (2024-12-02)
4
12
 
5
13
  * Regenerated from discovery document revision 20241114
@@ -3325,6 +3325,58 @@ module Google
3325
3325
  end
3326
3326
  end
3327
3327
 
3328
+ # Request message for CollectUserEvent method.
3329
+ class GoogleCloudRetailV2betaCollectUserEventRequest
3330
+ include Google::Apis::Core::Hashable
3331
+
3332
+ # The event timestamp in milliseconds. This prevents browser caching of
3333
+ # otherwise identical get requests. The name is abbreviated to reduce the
3334
+ # payload bytes.
3335
+ # Corresponds to the JSON property `ets`
3336
+ # @return [Fixnum]
3337
+ attr_accessor :ets
3338
+
3339
+ # The prebuilt rule name that can convert a specific type of raw_json. For
3340
+ # example: "ga4_bq" rule for the GA4 user event schema.
3341
+ # Corresponds to the JSON property `prebuiltRule`
3342
+ # @return [String]
3343
+ attr_accessor :prebuilt_rule
3344
+
3345
+ # An arbitrary serialized JSON string that contains necessary information that
3346
+ # can comprise a user event. When this field is specified, the user_event field
3347
+ # will be ignored. Note: line-delimited JSON is not supported, a single JSON
3348
+ # only.
3349
+ # Corresponds to the JSON property `rawJson`
3350
+ # @return [String]
3351
+ attr_accessor :raw_json
3352
+
3353
+ # The URL including cgi-parameters but excluding the hash fragment with a length
3354
+ # limit of 5,000 characters. This is often more useful than the referer URL,
3355
+ # because many browsers only send the domain for 3rd party requests.
3356
+ # Corresponds to the JSON property `uri`
3357
+ # @return [String]
3358
+ attr_accessor :uri
3359
+
3360
+ # Required. URL encoded UserEvent proto with a length limit of 2,000,000
3361
+ # characters.
3362
+ # Corresponds to the JSON property `userEvent`
3363
+ # @return [String]
3364
+ attr_accessor :user_event
3365
+
3366
+ def initialize(**args)
3367
+ update!(**args)
3368
+ end
3369
+
3370
+ # Update properties of this object
3371
+ def update!(**args)
3372
+ @ets = args[:ets] if args.key?(:ets)
3373
+ @prebuilt_rule = args[:prebuilt_rule] if args.key?(:prebuilt_rule)
3374
+ @raw_json = args[:raw_json] if args.key?(:raw_json)
3375
+ @uri = args[:uri] if args.key?(:uri)
3376
+ @user_event = args[:user_event] if args.key?(:user_event)
3377
+ end
3378
+ end
3379
+
3328
3380
  # The color information of a Product.
3329
3381
  class GoogleCloudRetailV2betaColorInfo
3330
3382
  include Google::Apis::Core::Hashable
@@ -3337,7 +3389,10 @@ module Google
3337
3389
  # be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an
3338
3390
  # INVALID_ARGUMENT error is returned. Google Merchant Center property [color](
3339
3391
  # https://support.google.com/merchants/answer/6324487). Schema.org property [
3340
- # Product.color](https://schema.org/color).
3392
+ # Product.color](https://schema.org/color). The colorFamilies field as a system
3393
+ # attribute is not a required field but strongly recommended to be specified.
3394
+ # Google Search models treat this field as more important than a custom product
3395
+ # attribute when specified.
3341
3396
  # Corresponds to the JSON property `colorFamilies`
3342
3397
  # @return [Array<String>]
3343
3398
  attr_accessor :color_families
@@ -4430,10 +4485,11 @@ module Google
4430
4485
  end
4431
4486
  end
4432
4487
 
4433
- # Product image. Recommendations AI and Retail Search do not use product images
4434
- # to improve prediction and search results. However, product images can be
4435
- # returned in results, and are shown in prediction or search previews in the
4436
- # console.
4488
+ # Product image. Recommendations AI and Retail Search use product images to
4489
+ # improve prediction and search results. Product images can be returned in
4490
+ # results, and are shown in prediction or search previews in the console. Please
4491
+ # try to provide correct product images and avoid using images with size too
4492
+ # small.
4437
4493
  class GoogleCloudRetailV2betaImage
4438
4494
  include Google::Apis::Core::Hashable
4439
4495
 
@@ -16,13 +16,13 @@ module Google
16
16
  module Apis
17
17
  module RetailV2beta
18
18
  # Version of the google-apis-retail_v2beta gem
19
- GEM_VERSION = "0.100.0"
19
+ GEM_VERSION = "0.102.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 = "20241114"
25
+ REVISION = "20241231"
26
26
  end
27
27
  end
28
28
  end
@@ -706,6 +706,12 @@ module Google
706
706
  include Google::Apis::Core::JsonObjectSupport
707
707
  end
708
708
 
709
+ class GoogleCloudRetailV2betaCollectUserEventRequest
710
+ class Representation < Google::Apis::Core::JsonRepresentation; end
711
+
712
+ include Google::Apis::Core::JsonObjectSupport
713
+ end
714
+
709
715
  class GoogleCloudRetailV2betaColorInfo
710
716
  class Representation < Google::Apis::Core::JsonRepresentation; end
711
717
 
@@ -2568,6 +2574,17 @@ module Google
2568
2574
  end
2569
2575
  end
2570
2576
 
2577
+ class GoogleCloudRetailV2betaCollectUserEventRequest
2578
+ # @private
2579
+ class Representation < Google::Apis::Core::JsonRepresentation
2580
+ property :ets, :numeric_string => true, as: 'ets'
2581
+ property :prebuilt_rule, as: 'prebuiltRule'
2582
+ property :raw_json, as: 'rawJson'
2583
+ property :uri, as: 'uri'
2584
+ property :user_event, as: 'userEvent'
2585
+ end
2586
+ end
2587
+
2571
2588
  class GoogleCloudRetailV2betaColorInfo
2572
2589
  # @private
2573
2590
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -2501,32 +2501,15 @@ module Google
2501
2501
  execute_or_queue_command(command, &block)
2502
2502
  end
2503
2503
 
2504
- # Writes a single user event from the browser. This uses a GET request to due to
2505
- # browser restriction of POST-ing to a 3rd party domain. This method is used
2506
- # only by the Retail API JavaScript pixel and Google Tag Manager. Users should
2507
- # not call this method directly.
2504
+ # Writes a single user event from the browser. For larger user event payload
2505
+ # over 16 KB, the POST method should be used instead, otherwise a 400 Bad
2506
+ # Request error is returned. This method is used only by the Retail API
2507
+ # JavaScript pixel and Google Tag Manager. Users should not call this method
2508
+ # directly.
2508
2509
  # @param [String] parent
2509
2510
  # Required. The parent catalog name, such as `projects/1234/locations/global/
2510
2511
  # catalogs/default_catalog`.
2511
- # @param [Fixnum] ets
2512
- # The event timestamp in milliseconds. This prevents browser caching of
2513
- # otherwise identical get requests. The name is abbreviated to reduce the
2514
- # payload bytes.
2515
- # @param [String] prebuilt_rule
2516
- # The prebuilt rule name that can convert a specific type of raw_json. For
2517
- # example: "ga4_bq" rule for the GA4 user event schema.
2518
- # @param [String] raw_json
2519
- # An arbitrary serialized JSON string that contains necessary information that
2520
- # can comprise a user event. When this field is specified, the user_event field
2521
- # will be ignored. Note: line-delimited JSON is not supported, a single JSON
2522
- # only.
2523
- # @param [String] uri
2524
- # The URL including cgi-parameters but excluding the hash fragment with a length
2525
- # limit of 5,000 characters. This is often more useful than the referer URL,
2526
- # because many browsers only send the domain for 3rd party requests.
2527
- # @param [String] user_event
2528
- # Required. URL encoded UserEvent proto with a length limit of 2,000,000
2529
- # characters.
2512
+ # @param [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaCollectUserEventRequest] google_cloud_retail_v2beta_collect_user_event_request_object
2530
2513
  # @param [String] fields
2531
2514
  # Selector specifying which fields to include in a partial response.
2532
2515
  # @param [String] quota_user
@@ -2544,16 +2527,13 @@ module Google
2544
2527
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2545
2528
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2546
2529
  # @raise [Google::Apis::AuthorizationError] Authorization is required
2547
- 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)
2548
- command = make_simple_command(:get, 'v2beta/{+parent}/userEvents:collect', options)
2530
+ def collect_project_location_catalog_user_event(parent, google_cloud_retail_v2beta_collect_user_event_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
2531
+ command = make_simple_command(:post, 'v2beta/{+parent}/userEvents:collect', options)
2532
+ command.request_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaCollectUserEventRequest::Representation
2533
+ command.request_object = google_cloud_retail_v2beta_collect_user_event_request_object
2549
2534
  command.response_representation = Google::Apis::RetailV2beta::GoogleApiHttpBody::Representation
2550
2535
  command.response_class = Google::Apis::RetailV2beta::GoogleApiHttpBody
2551
2536
  command.params['parent'] = parent unless parent.nil?
2552
- command.query['ets'] = ets unless ets.nil?
2553
- command.query['prebuiltRule'] = prebuilt_rule unless prebuilt_rule.nil?
2554
- command.query['rawJson'] = raw_json unless raw_json.nil?
2555
- command.query['uri'] = uri unless uri.nil?
2556
- command.query['userEvent'] = user_event unless user_event.nil?
2557
2537
  command.query['fields'] = fields unless fields.nil?
2558
2538
  command.query['quotaUser'] = quota_user unless quota_user.nil?
2559
2539
  execute_or_queue_command(command, &block)
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-apis-retail_v2beta
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.100.0
4
+ version: 0.102.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-04 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_v2beta/CHANGELOG.md
61
- documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2beta/v0.100.0
61
+ documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2beta/v0.102.0
62
62
  source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-retail_v2beta
63
63
  post_install_message:
64
64
  rdoc_options: []
@@ -75,7 +75,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
75
75
  - !ruby/object:Gem::Version
76
76
  version: '0'
77
77
  requirements: []
78
- rubygems_version: 3.5.22
78
+ rubygems_version: 3.5.23
79
79
  signing_key:
80
80
  specification_version: 4
81
81
  summary: Simple REST client for Vertex AI Search for Retail API V2beta