google-apis-retail_v2 0.27.0 → 0.28.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: aabae2c3c0eeb2902db7cc0ae776090140f88f54b756fc48582afac856df59f6
4
- data.tar.gz: ac7abf0ce698c0d6dad2d95d368086a865d956e3a74d8b68173e5da72a54fda5
3
+ metadata.gz: 300ffa2560aad86e0f5783721309655a1afe52ec37d50f45698a3d9fcbb0d023
4
+ data.tar.gz: 5b77548ac25a18bcea4296878fbd720fb9a816c38f558f21448ccdbc0edda267
5
5
  SHA512:
6
- metadata.gz: 5e14fd09be344914f7c2c1b48d0949e2f3b1f97f2b16de37d05086c1881356c915e54736a6905004e97c96be036dea07556cdf220b44910d94d1796eb86fa4c6
7
- data.tar.gz: 992e443e049a016f75e9422319aa953eb045fe19e87bd6e3c0a2a60f28425be44d1cf4549699119d630c00f0ede33de8d61a15bb1c46b22aa1fef107fb7e672a
6
+ metadata.gz: 3ca5f224b3560132f6c139cd1393242eba1ea0fa6196d895dbd264652ac2ecba593cee943a44606e535bb01c1a6a507638992e475b83efcbb357b84160a036a9
7
+ data.tar.gz: 504198365b7dfdaeb4e31d104c75c0c04f2fbbe1374374c3c4af81a6c5fcce3049502028b375786f95eded5de0373b21f82d4285ded61fadd020fb88a190095a
data/CHANGELOG.md CHANGED
@@ -1,5 +1,9 @@
1
1
  # Release history for google-apis-retail_v2
2
2
 
3
+ ### v0.28.0 (2022-02-12)
4
+
5
+ * Regenerated from discovery document revision 20220210
6
+
3
7
  ### v0.27.0 (2022-02-03)
4
8
 
5
9
  * Regenerated from discovery document revision 20220127
@@ -412,7 +412,11 @@ module Google
412
412
  # Importing catalog data from Merchant Center](https://cloud.google.com/retail/
413
413
  # recommendations-ai/docs/upload-catalog#mc). Supported values for user events
414
414
  # imports: * `user_event` (default): One JSON UserEvent per line. * `
415
- # user_event_ga360`: Using https://support.google.com/analytics/answer/3437719.
415
+ # user_event_ga360`: The schema is available here: https://support.google.com/
416
+ # analytics/answer/3437719. * `user_event_ga4`: This feature is in private
417
+ # preview. Please contact the support team for importing Google Analytics 4
418
+ # events. The schema is available here: https://support.google.com/analytics/
419
+ # answer/7029846.
416
420
  # Corresponds to the JSON property `dataSchema`
417
421
  # @return [String]
418
422
  attr_accessor :data_schema
@@ -434,10 +438,10 @@ module Google
434
438
  # day and time zone are either specified elsewhere or are insignificant. The
435
439
  # date is relative to the Gregorian Calendar. This can represent one of the
436
440
  # following: * A full date, with non-zero year, month, and day values * A month
437
- # and day value, with a zero year, such as an anniversary * A year on its own,
438
- # with zero month and day values * A year and month value, with a zero day, such
439
- # as a credit card expiration date Related types are google.type.TimeOfDay and `
440
- # google.protobuf.Timestamp`.
441
+ # and day, with a zero year (e.g., an anniversary) * A year on its own, with a
442
+ # zero month and a zero day * A year and month, with a zero day (e.g., a credit
443
+ # card expiration date) Related types: * google.type.TimeOfDay * google.type.
444
+ # DateTime * google.protobuf.Timestamp
441
445
  # Corresponds to the JSON property `partitionDate`
442
446
  # @return [Google::Apis::RetailV2::GoogleTypeDate]
443
447
  attr_accessor :partition_date
@@ -686,10 +690,12 @@ module Google
686
690
  class GoogleCloudRetailV2CustomAttribute
687
691
  include Google::Apis::Core::Hashable
688
692
 
689
- # If true, custom attribute values are indexed, so that it can be filtered,
690
- # faceted or boosted in SearchService.Search. This field is ignored in a
691
- # UserEvent. See SearchRequest.filter, SearchRequest.facet_specs and
692
- # SearchRequest.boost_spec for more details.
693
+ # This field will only be used when AttributesConfig.attribute_config_level of
694
+ # the Catalog is 'PRODUCT_LEVEL_ATTRIBUTE_CONFIG', if true, custom attribute
695
+ # values are indexed, so that it can be filtered, faceted or boosted in
696
+ # SearchService.Search. This field is ignored in a UserEvent. See SearchRequest.
697
+ # filter, SearchRequest.facet_specs and SearchRequest.boost_spec for more
698
+ # details.
693
699
  # Corresponds to the JSON property `indexable`
694
700
  # @return [Boolean]
695
701
  attr_accessor :indexable
@@ -702,9 +708,11 @@ module Google
702
708
  # @return [Array<Float>]
703
709
  attr_accessor :numbers
704
710
 
705
- # If true, custom attribute values are searchable by text queries in
706
- # SearchService.Search. This field is ignored in a UserEvent. Only set if type
707
- # text is set. Otherwise, a INVALID_ARGUMENT error is returned.
711
+ # This field will only be used when AttributesConfig.attribute_config_level of
712
+ # the Catalog is 'PRODUCT_LEVEL_ATTRIBUTE_CONFIG', if true, custom attribute
713
+ # values are searchable by text queries in SearchService.Search. This field is
714
+ # ignored in a UserEvent. Only set if type text is set. Otherwise, a
715
+ # INVALID_ARGUMENT error is returned.
708
716
  # Corresponds to the JSON property `searchable`
709
717
  # @return [Boolean]
710
718
  attr_accessor :searchable
@@ -1680,7 +1688,7 @@ module Google
1680
1688
 
1681
1689
  # The material of the product. For example, "leather", "wooden". A maximum of 20
1682
1690
  # values are allowed. Each value must be a UTF-8 encoded string with a length
1683
- # limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.
1691
+ # limit of 200 characters. Otherwise, an INVALID_ARGUMENT error is returned.
1684
1692
  # Corresponding properties: Google Merchant Center property [material](https://
1685
1693
  # support.google.com/merchants/answer/6324410). Schema.org property [Product.
1686
1694
  # material](https://schema.org/material).
@@ -2512,6 +2520,14 @@ module Google
2512
2520
  # @return [Array<Google::Apis::RetailV2::GoogleCloudRetailV2SearchRequestBoostSpecConditionBoostSpec>]
2513
2521
  attr_accessor :condition_boost_specs
2514
2522
 
2523
+ # Whether to skip boostspec validation. If this field is set to true, invalid
2524
+ # BoostSpec.condition_boost_specs will be ignored and valid BoostSpec.
2525
+ # condition_boost_specs will still be applied.
2526
+ # Corresponds to the JSON property `skipBoostSpecValidation`
2527
+ # @return [Boolean]
2528
+ attr_accessor :skip_boost_spec_validation
2529
+ alias_method :skip_boost_spec_validation?, :skip_boost_spec_validation
2530
+
2515
2531
  def initialize(**args)
2516
2532
  update!(**args)
2517
2533
  end
@@ -2519,6 +2535,7 @@ module Google
2519
2535
  # Update properties of this object
2520
2536
  def update!(**args)
2521
2537
  @condition_boost_specs = args[:condition_boost_specs] if args.key?(:condition_boost_specs)
2538
+ @skip_boost_spec_validation = args[:skip_boost_spec_validation] if args.key?(:skip_boost_spec_validation)
2522
2539
  end
2523
2540
  end
2524
2541
 
@@ -2816,6 +2833,12 @@ module Google
2816
2833
  # @return [Array<Google::Apis::RetailV2::GoogleCloudRetailV2SearchResponseFacet>]
2817
2834
  attr_accessor :facets
2818
2835
 
2836
+ # The invalid SearchRequest.BoostSpec.condition_boost_specs that are not applied
2837
+ # during serving.
2838
+ # Corresponds to the JSON property `invalidConditionBoostSpecs`
2839
+ # @return [Array<Google::Apis::RetailV2::GoogleCloudRetailV2SearchRequestBoostSpecConditionBoostSpec>]
2840
+ attr_accessor :invalid_condition_boost_specs
2841
+
2819
2842
  # A token that can be sent as SearchRequest.page_token to retrieve the next page.
2820
2843
  # If this field is omitted, there are no subsequent pages.
2821
2844
  # Corresponds to the JSON property `nextPageToken`
@@ -2857,6 +2880,7 @@ module Google
2857
2880
  @attribution_token = args[:attribution_token] if args.key?(:attribution_token)
2858
2881
  @corrected_query = args[:corrected_query] if args.key?(:corrected_query)
2859
2882
  @facets = args[:facets] if args.key?(:facets)
2883
+ @invalid_condition_boost_specs = args[:invalid_condition_boost_specs] if args.key?(:invalid_condition_boost_specs)
2860
2884
  @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
2861
2885
  @query_expansion_info = args[:query_expansion_info] if args.key?(:query_expansion_info)
2862
2886
  @redirect_uri = args[:redirect_uri] if args.key?(:redirect_uri)
@@ -4559,10 +4583,10 @@ module Google
4559
4583
  # day and time zone are either specified elsewhere or are insignificant. The
4560
4584
  # date is relative to the Gregorian Calendar. This can represent one of the
4561
4585
  # following: * A full date, with non-zero year, month, and day values * A month
4562
- # and day value, with a zero year, such as an anniversary * A year on its own,
4563
- # with zero month and day values * A year and month value, with a zero day, such
4564
- # as a credit card expiration date Related types are google.type.TimeOfDay and `
4565
- # google.protobuf.Timestamp`.
4586
+ # and day, with a zero year (e.g., an anniversary) * A year on its own, with a
4587
+ # zero month and a zero day * A year and month, with a zero day (e.g., a credit
4588
+ # card expiration date) Related types: * google.type.TimeOfDay * google.type.
4589
+ # DateTime * google.protobuf.Timestamp
4566
4590
  class GoogleTypeDate
4567
4591
  include Google::Apis::Core::Hashable
4568
4592
 
@@ -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.27.0"
19
+ GEM_VERSION = "0.28.0"
20
20
 
21
21
  # Version of the code generator used to generate this client
22
22
  GENERATOR_VERSION = "0.4.1"
23
23
 
24
24
  # Revision of the discovery document this client was generated from
25
- REVISION = "20220127"
25
+ REVISION = "20220210"
26
26
  end
27
27
  end
28
28
  end
@@ -1385,6 +1385,7 @@ module Google
1385
1385
  class Representation < Google::Apis::Core::JsonRepresentation
1386
1386
  collection :condition_boost_specs, as: 'conditionBoostSpecs', class: Google::Apis::RetailV2::GoogleCloudRetailV2SearchRequestBoostSpecConditionBoostSpec, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2SearchRequestBoostSpecConditionBoostSpec::Representation
1387
1387
 
1388
+ property :skip_boost_spec_validation, as: 'skipBoostSpecValidation'
1388
1389
  end
1389
1390
  end
1390
1391
 
@@ -1451,6 +1452,8 @@ module Google
1451
1452
  property :corrected_query, as: 'correctedQuery'
1452
1453
  collection :facets, as: 'facets', class: Google::Apis::RetailV2::GoogleCloudRetailV2SearchResponseFacet, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2SearchResponseFacet::Representation
1453
1454
 
1455
+ collection :invalid_condition_boost_specs, as: 'invalidConditionBoostSpecs', class: Google::Apis::RetailV2::GoogleCloudRetailV2SearchRequestBoostSpecConditionBoostSpec, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2SearchRequestBoostSpecConditionBoostSpec::Representation
1456
+
1454
1457
  property :next_page_token, as: 'nextPageToken'
1455
1458
  property :query_expansion_info, as: 'queryExpansionInfo', class: Google::Apis::RetailV2::GoogleCloudRetailV2SearchResponseQueryExpansionInfo, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2SearchResponseQueryExpansionInfo::Representation
1456
1459
 
@@ -124,10 +124,7 @@ module Google
124
124
  end
125
125
 
126
126
  # Get which branch is currently default branch set by CatalogService.
127
- # SetDefaultBranch method under a specified parent catalog. This feature is only
128
- # available for users who have Retail Search enabled. Please submit a form [here]
129
- # (https://cloud.google.com/contact) to contact cloud sales if you are
130
- # interested in using Retail Search.
127
+ # SetDefaultBranch method under a specified parent catalog.
131
128
  # @param [String] catalog
132
129
  # The parent catalog resource name, such as `projects/*/locations/global/
133
130
  # catalogs/default_catalog`.
@@ -256,9 +253,7 @@ module Google
256
253
  # PredictionService will only return product IDs from branch `newBranch`. *
257
254
  # SearchService will only return product IDs from branch `newBranch` (if branch
258
255
  # is not explicitly set). * UserEventService will only join events with products
259
- # from branch `newBranch`. This feature is only available for users who have
260
- # Retail Search enabled. Please submit a form [here](https://cloud.google.com/
261
- # contact) to contact cloud sales if you are interested in using Retail Search.
256
+ # from branch `newBranch`.
262
257
  # @param [String] catalog
263
258
  # Full resource name of the catalog, such as `projects/*/locations/global/
264
259
  # catalogs/default_catalog`.
@@ -1190,6 +1185,83 @@ module Google
1190
1185
  command.query['quotaUser'] = quota_user unless quota_user.nil?
1191
1186
  execute_or_queue_command(command, &block)
1192
1187
  end
1188
+
1189
+ # Gets the latest state of a long-running operation. Clients can use this method
1190
+ # to poll the operation result at intervals as recommended by the API service.
1191
+ # @param [String] name
1192
+ # The name of the operation resource.
1193
+ # @param [String] fields
1194
+ # Selector specifying which fields to include in a partial response.
1195
+ # @param [String] quota_user
1196
+ # Available to use for quota purposes for server-side applications. Can be any
1197
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1198
+ # @param [Google::Apis::RequestOptions] options
1199
+ # Request-specific options
1200
+ #
1201
+ # @yield [result, err] Result & error if block supplied
1202
+ # @yieldparam result [Google::Apis::RetailV2::GoogleLongrunningOperation] parsed result object
1203
+ # @yieldparam err [StandardError] error object if request failed
1204
+ #
1205
+ # @return [Google::Apis::RetailV2::GoogleLongrunningOperation]
1206
+ #
1207
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1208
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1209
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1210
+ def get_project_operation(name, fields: nil, quota_user: nil, options: nil, &block)
1211
+ command = make_simple_command(:get, 'v2/{+name}', options)
1212
+ command.response_representation = Google::Apis::RetailV2::GoogleLongrunningOperation::Representation
1213
+ command.response_class = Google::Apis::RetailV2::GoogleLongrunningOperation
1214
+ command.params['name'] = name unless name.nil?
1215
+ command.query['fields'] = fields unless fields.nil?
1216
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1217
+ execute_or_queue_command(command, &block)
1218
+ end
1219
+
1220
+ # Lists operations that match the specified filter in the request. If the server
1221
+ # doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name`
1222
+ # binding allows API services to override the binding to use different resource
1223
+ # name schemes, such as `users/*/operations`. To override the binding, API
1224
+ # services can add a binding such as `"/v1/`name=users/*`/operations"` to their
1225
+ # service configuration. For backwards compatibility, the default name includes
1226
+ # the operations collection id, however overriding users must ensure the name
1227
+ # binding is the parent resource, without the operations collection id.
1228
+ # @param [String] name
1229
+ # The name of the operation's parent resource.
1230
+ # @param [String] filter
1231
+ # The standard list filter.
1232
+ # @param [Fixnum] page_size
1233
+ # The standard list page size.
1234
+ # @param [String] page_token
1235
+ # The standard list page token.
1236
+ # @param [String] fields
1237
+ # Selector specifying which fields to include in a partial response.
1238
+ # @param [String] quota_user
1239
+ # Available to use for quota purposes for server-side applications. Can be any
1240
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1241
+ # @param [Google::Apis::RequestOptions] options
1242
+ # Request-specific options
1243
+ #
1244
+ # @yield [result, err] Result & error if block supplied
1245
+ # @yieldparam result [Google::Apis::RetailV2::GoogleLongrunningListOperationsResponse] parsed result object
1246
+ # @yieldparam err [StandardError] error object if request failed
1247
+ #
1248
+ # @return [Google::Apis::RetailV2::GoogleLongrunningListOperationsResponse]
1249
+ #
1250
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1251
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1252
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1253
+ def list_project_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
1254
+ command = make_simple_command(:get, 'v2/{+name}/operations', options)
1255
+ command.response_representation = Google::Apis::RetailV2::GoogleLongrunningListOperationsResponse::Representation
1256
+ command.response_class = Google::Apis::RetailV2::GoogleLongrunningListOperationsResponse
1257
+ command.params['name'] = name unless name.nil?
1258
+ command.query['filter'] = filter unless filter.nil?
1259
+ command.query['pageSize'] = page_size unless page_size.nil?
1260
+ command.query['pageToken'] = page_token unless page_token.nil?
1261
+ command.query['fields'] = fields unless fields.nil?
1262
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1263
+ execute_or_queue_command(command, &block)
1264
+ end
1193
1265
 
1194
1266
  protected
1195
1267
 
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.27.0
4
+ version: 0.28.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: 2022-02-07 00:00:00.000000000 Z
11
+ date: 2022-02-14 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.27.0
61
+ documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2/v0.28.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: []