google-apis-retail_v2beta 0.36.0 → 0.39.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: 44cf423c7ab4fde9b6f15c075befe8dc7fa579383879e5143d796c1fdfcd6125
4
- data.tar.gz: 1f4e0fe60920a8d21aef45e1e3d7357cfd214c98ac8d8e8122d093bfec6a9358
3
+ metadata.gz: ed2bfb428f1ecdf36eca5e60746d6eae9318255c4ec56a90ebed2c58d115d7e5
4
+ data.tar.gz: a855226a31061a5418a63c300aa55687f6de453da9923c881bbdf7c6d7c4351a
5
5
  SHA512:
6
- metadata.gz: 410497307d187e4d7eb7d2efa3a0ec793f700cbba51726b51fc592306e5cec7cd76bc57c9db3c12523c9f2cde5186464f8c79d5beb68292c748741add9bd5ec7
7
- data.tar.gz: eecbab370046cdec13c99420007858c108bd6fb36bba852b6795404f25114dedff8bf74ae11bfde5d0fce3aaa1dbd0611d0d646f00ec3d9809a89fe892f49ca8
6
+ metadata.gz: 8cff4071beb59d7bf86947be814d07cc574f24a14c77ffebf5a6d65b3699ef779f4a50dcf19bf85fe95fe2ad0ddc618d4fb361818c231fc0d6aa292e23897c46
7
+ data.tar.gz: 2251edbd097eab37b7183f1ff3ef6a99aca1c83266bf18da49960cb53749d204ac7a9eff4512551efd202b149c774e855375d6bd095d7c0e79db3bb7b2c1b3c2
data/CHANGELOG.md CHANGED
@@ -1,5 +1,17 @@
1
1
  # Release history for google-apis-retail_v2beta
2
2
 
3
+ ### v0.39.0 (2022-05-12)
4
+
5
+ * Regenerated from discovery document revision 20220505
6
+
7
+ ### v0.38.0 (2022-05-05)
8
+
9
+ * Regenerated from discovery document revision 20220430
10
+
11
+ ### v0.37.0 (2022-04-28)
12
+
13
+ * Regenerated from discovery document revision 20220421
14
+
3
15
  ### v0.36.0 (2022-04-22)
4
16
 
5
17
  * Regenerated from discovery document revision 20220414
@@ -281,7 +281,7 @@ module Google
281
281
 
282
282
  # Metadata related to the progress of the AddFulfillmentPlaces operation.
283
283
  # Currently empty because there is no meaningful metadata populated from the
284
- # AddFulfillmentPlaces method.
284
+ # ProductService.AddFulfillmentPlaces method.
285
285
  class GoogleCloudRetailV2AddFulfillmentPlacesMetadata
286
286
  include Google::Apis::Core::Hashable
287
287
 
@@ -295,7 +295,8 @@ module Google
295
295
  end
296
296
 
297
297
  # Response of the AddFulfillmentPlacesRequest. Currently empty because there is
298
- # no meaningful response populated from the AddFulfillmentPlaces method.
298
+ # no meaningful response populated from the ProductService.AddFulfillmentPlaces
299
+ # method.
299
300
  class GoogleCloudRetailV2AddFulfillmentPlacesResponse
300
301
  include Google::Apis::Core::Hashable
301
302
 
@@ -310,7 +311,7 @@ module Google
310
311
 
311
312
  # Metadata related to the progress of the AddLocalInventories operation.
312
313
  # Currently empty because there is no meaningful metadata populated from the
313
- # AddLocalInventories method.
314
+ # ProductService.AddLocalInventories method.
314
315
  class GoogleCloudRetailV2AddLocalInventoriesMetadata
315
316
  include Google::Apis::Core::Hashable
316
317
 
@@ -323,8 +324,9 @@ module Google
323
324
  end
324
325
  end
325
326
 
326
- # Response of the AddLocalInventories API. Currently empty because there is no
327
- # meaningful response populated from the AddLocalInventories method.
327
+ # Response of the ProductService.AddLocalInventories API. Currently empty
328
+ # because there is no meaningful response populated from the ProductService.
329
+ # AddLocalInventories method.
328
330
  class GoogleCloudRetailV2AddLocalInventoriesResponse
329
331
  include Google::Apis::Core::Hashable
330
332
 
@@ -677,7 +679,7 @@ module Google
677
679
 
678
680
  # Metadata related to the progress of the AddFulfillmentPlaces operation.
679
681
  # Currently empty because there is no meaningful metadata populated from the
680
- # AddFulfillmentPlaces method.
682
+ # ProductService.AddFulfillmentPlaces method.
681
683
  class GoogleCloudRetailV2alphaAddFulfillmentPlacesMetadata
682
684
  include Google::Apis::Core::Hashable
683
685
 
@@ -691,7 +693,8 @@ module Google
691
693
  end
692
694
 
693
695
  # Response of the AddFulfillmentPlacesRequest. Currently empty because there is
694
- # no meaningful response populated from the AddFulfillmentPlaces method.
696
+ # no meaningful response populated from the ProductService.AddFulfillmentPlaces
697
+ # method.
695
698
  class GoogleCloudRetailV2alphaAddFulfillmentPlacesResponse
696
699
  include Google::Apis::Core::Hashable
697
700
 
@@ -706,7 +709,7 @@ module Google
706
709
 
707
710
  # Metadata related to the progress of the AddLocalInventories operation.
708
711
  # Currently empty because there is no meaningful metadata populated from the
709
- # AddLocalInventories method.
712
+ # ProductService.AddLocalInventories method.
710
713
  class GoogleCloudRetailV2alphaAddLocalInventoriesMetadata
711
714
  include Google::Apis::Core::Hashable
712
715
 
@@ -719,8 +722,9 @@ module Google
719
722
  end
720
723
  end
721
724
 
722
- # Response of the AddLocalInventories API. Currently empty because there is no
723
- # meaningful response populated from the AddLocalInventories method.
725
+ # Response of the ProductService.AddLocalInventories API. Currently empty
726
+ # because there is no meaningful response populated from the ProductService.
727
+ # AddLocalInventories method.
724
728
  class GoogleCloudRetailV2alphaAddLocalInventoriesResponse
725
729
  include Google::Apis::Core::Hashable
726
730
 
@@ -1283,7 +1287,7 @@ module Google
1283
1287
 
1284
1288
  # Metadata related to the progress of the AddFulfillmentPlaces operation.
1285
1289
  # Currently empty because there is no meaningful metadata populated from the
1286
- # AddFulfillmentPlaces method.
1290
+ # ProductService.AddFulfillmentPlaces method.
1287
1291
  class GoogleCloudRetailV2betaAddFulfillmentPlacesMetadata
1288
1292
  include Google::Apis::Core::Hashable
1289
1293
 
@@ -1296,7 +1300,7 @@ module Google
1296
1300
  end
1297
1301
  end
1298
1302
 
1299
- # Request message for AddFulfillmentPlaces method.
1303
+ # Request message for ProductService.AddFulfillmentPlaces method.
1300
1304
  class GoogleCloudRetailV2betaAddFulfillmentPlacesRequest
1301
1305
  include Google::Apis::Core::Hashable
1302
1306
 
@@ -1353,7 +1357,8 @@ module Google
1353
1357
  end
1354
1358
 
1355
1359
  # Response of the AddFulfillmentPlacesRequest. Currently empty because there is
1356
- # no meaningful response populated from the AddFulfillmentPlaces method.
1360
+ # no meaningful response populated from the ProductService.AddFulfillmentPlaces
1361
+ # method.
1357
1362
  class GoogleCloudRetailV2betaAddFulfillmentPlacesResponse
1358
1363
  include Google::Apis::Core::Hashable
1359
1364
 
@@ -1368,7 +1373,7 @@ module Google
1368
1373
 
1369
1374
  # Metadata related to the progress of the AddLocalInventories operation.
1370
1375
  # Currently empty because there is no meaningful metadata populated from the
1371
- # AddLocalInventories method.
1376
+ # ProductService.AddLocalInventories method.
1372
1377
  class GoogleCloudRetailV2betaAddLocalInventoriesMetadata
1373
1378
  include Google::Apis::Core::Hashable
1374
1379
 
@@ -1381,7 +1386,7 @@ module Google
1381
1386
  end
1382
1387
  end
1383
1388
 
1384
- # Request message for AddLocalInventories method.
1389
+ # Request message for ProductService.AddLocalInventories method.
1385
1390
  class GoogleCloudRetailV2betaAddLocalInventoriesRequest
1386
1391
  include Google::Apis::Core::Hashable
1387
1392
 
@@ -1432,8 +1437,9 @@ module Google
1432
1437
  end
1433
1438
  end
1434
1439
 
1435
- # Response of the AddLocalInventories API. Currently empty because there is no
1436
- # meaningful response populated from the AddLocalInventories method.
1440
+ # Response of the ProductService.AddLocalInventories API. Currently empty
1441
+ # because there is no meaningful response populated from the ProductService.
1442
+ # AddLocalInventories method.
1437
1443
  class GoogleCloudRetailV2betaAddLocalInventoriesResponse
1438
1444
  include Google::Apis::Core::Hashable
1439
1445
 
@@ -1650,12 +1656,13 @@ module Google
1650
1656
  # Output only. Indicates whether this attribute has been used by any products. `
1651
1657
  # True` if at least one Product is using this attribute in Product.attributes.
1652
1658
  # Otherwise, this field is `False`. CatalogAttribute can be pre-loaded by using
1653
- # AddCatalogAttribute, ImportCatalogAttributes, or UpdateAttributesConfig APIs.
1654
- # This field is `False` for pre-loaded CatalogAttributes. Only CatalogAttributes
1655
- # that are not in use by products can be deleted. CatalogAttributes that are in
1656
- # use by products cannot be deleted; however, their configuration properties
1657
- # will reset to default values upon removal request. After catalog changes, it
1658
- # takes about 10 minutes for this field to update.
1659
+ # CatalogService.AddCatalogAttribute, CatalogService.ImportCatalogAttributes, or
1660
+ # CatalogService.UpdateAttributesConfig APIs. This field is `False` for pre-
1661
+ # loaded CatalogAttributes. Only CatalogAttributes that are not in use by
1662
+ # products can be deleted. CatalogAttributes that are in use by products cannot
1663
+ # be deleted; however, their configuration properties will reset to default
1664
+ # values upon removal request. After catalog changes, it takes about 10 minutes
1665
+ # for this field to update.
1659
1666
  # Corresponds to the JSON property `inUse`
1660
1667
  # @return [Boolean]
1661
1668
  attr_accessor :in_use
@@ -2133,12 +2140,14 @@ module Google
2133
2140
  class GoogleCloudRetailV2betaCustomAttribute
2134
2141
  include Google::Apis::Core::Hashable
2135
2142
 
2136
- # This field will only be used when AttributesConfig.attribute_config_level of
2137
- # the Catalog is 'PRODUCT_LEVEL_ATTRIBUTE_CONFIG', if true, custom attribute
2138
- # values are indexed, so that it can be filtered, faceted or boosted in
2139
- # SearchService.Search. This field is ignored in a UserEvent. See SearchRequest.
2140
- # filter, SearchRequest.facet_specs and SearchRequest.boost_spec for more
2141
- # details.
2143
+ # This field is normally ignored unless AttributesConfig.attribute_config_level
2144
+ # of the Catalog is set to the deprecated 'PRODUCT_LEVEL_ATTRIBUTE_CONFIG' mode.
2145
+ # For information about product-level attribute configuration, see [
2146
+ # Configuration modes](https://cloud.google.com/retail/docs/attribute-config#
2147
+ # config-modes). If true, custom attribute values are indexed, so that they can
2148
+ # be filtered, faceted or boosted in SearchService.Search. This field is ignored
2149
+ # in a UserEvent. See SearchRequest.filter, SearchRequest.facet_specs and
2150
+ # SearchRequest.boost_spec for more details.
2142
2151
  # Corresponds to the JSON property `indexable`
2143
2152
  # @return [Boolean]
2144
2153
  attr_accessor :indexable
@@ -2151,11 +2160,13 @@ module Google
2151
2160
  # @return [Array<Float>]
2152
2161
  attr_accessor :numbers
2153
2162
 
2154
- # This field will only be used when AttributesConfig.attribute_config_level of
2155
- # the Catalog is 'PRODUCT_LEVEL_ATTRIBUTE_CONFIG', if true, custom attribute
2156
- # values are searchable by text queries in SearchService.Search. This field is
2157
- # ignored in a UserEvent. Only set if type text is set. Otherwise, a
2158
- # INVALID_ARGUMENT error is returned.
2163
+ # This field is normally ignored unless AttributesConfig.attribute_config_level
2164
+ # of the Catalog is set to the deprecated 'PRODUCT_LEVEL_ATTRIBUTE_CONFIG' mode.
2165
+ # For information about product-level attribute configuration, see [
2166
+ # Configuration modes](https://cloud.google.com/retail/docs/attribute-config#
2167
+ # config-modes). If true, custom attribute values are searchable by text queries
2168
+ # in SearchService.Search. This field is ignored in a UserEvent. Only set if
2169
+ # type text is set. Otherwise, a INVALID_ARGUMENT error is returned.
2159
2170
  # Corresponds to the JSON property `searchable`
2160
2171
  # @return [Boolean]
2161
2172
  attr_accessor :searchable
@@ -3003,7 +3014,7 @@ module Google
3003
3014
  # The labels applied to a resource must meet the following requirements: * Each
3004
3015
  # resource can have multiple labels, up to a maximum of 64. * Each label must be
3005
3016
  # a key-value pair. * Keys have a minimum length of 1 character and a maximum
3006
- # length of 63 characters, and cannot be empty. Values can be empty, and have a
3017
+ # length of 63 characters and cannot be empty. Values can be empty and have a
3007
3018
  # maximum length of 63 characters. * Keys and values can contain only lowercase
3008
3019
  # letters, numeric characters, underscores, and dashes. All characters must use
3009
3020
  # UTF-8 encoding, and international characters are allowed. * The key portion of
@@ -3131,9 +3142,9 @@ module Google
3131
3142
  attr_accessor :id
3132
3143
 
3133
3144
  # Additional product metadata / annotations. Possible values: * `product`: JSON
3134
- # representation of the product. Will be set if `returnProduct` is set to true
3135
- # in `PredictRequest.params`. * `score`: Prediction score in double value. Will
3136
- # be set if `returnScore` is set to true in `PredictRequest.params`.
3145
+ # representation of the product. Is set if `returnProduct` is set to true in `
3146
+ # PredictRequest.params`. * `score`: Prediction score in double value. Is set if
3147
+ # `returnScore` is set to true in `PredictRequest.params`.
3137
3148
  # Corresponds to the JSON property `metadata`
3138
3149
  # @return [Hash<String,Object>]
3139
3150
  attr_accessor :metadata
@@ -3496,9 +3507,9 @@ module Google
3496
3507
  # attribute, as specified in attributes. For Type.PRIMARY and Type.COLLECTION,
3497
3508
  # the following fields are always returned in SearchResponse by default: * name
3498
3509
  # For Type.VARIANT, the following fields are always returned in by default: *
3499
- # name * color_info Maximum number of paths is 30. Otherwise, an
3510
+ # name * color_info The maximum number of paths is 30. Otherwise, an
3500
3511
  # INVALID_ARGUMENT error is returned. Note: Returning more fields in
3501
- # SearchResponse may increase response payload size and serving latency.
3512
+ # SearchResponse can increase response payload size and serving latency.
3502
3513
  # Corresponds to the JSON property `retrievableFields`
3503
3514
  # @return [String]
3504
3515
  attr_accessor :retrievable_fields
@@ -4573,7 +4584,7 @@ module Google
4573
4584
  # The labels applied to a resource must meet the following requirements: * Each
4574
4585
  # resource can have multiple labels, up to a maximum of 64. * Each label must be
4575
4586
  # a key-value pair. * Keys have a minimum length of 1 character and a maximum
4576
- # length of 63 characters, and cannot be empty. Values can be empty, and have a
4587
+ # length of 63 characters and cannot be empty. Values can be empty and have a
4577
4588
  # maximum length of 63 characters. * Keys and values can contain only lowercase
4578
4589
  # letters, numeric characters, underscores, and dashes. All characters must use
4579
4590
  # UTF-8 encoding, and international characters are allowed. * The key portion of
@@ -4651,6 +4662,11 @@ module Google
4651
4662
  # @return [String]
4652
4663
  attr_accessor :search_mode
4653
4664
 
4665
+ # The specification for query spell correction.
4666
+ # Corresponds to the JSON property `spellCorrectionSpec`
4667
+ # @return [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaSearchRequestSpellCorrectionSpec]
4668
+ attr_accessor :spell_correction_spec
4669
+
4654
4670
  # Information of an end user.
4655
4671
  # Corresponds to the JSON property `userInfo`
4656
4672
  # @return [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaUserInfo]
@@ -4666,8 +4682,8 @@ module Google
4666
4682
  # the store ID. Supported keys are: * colorFamilies * price * originalPrice *
4667
4683
  # discount * variantId * inventory(place_id,price) * inventory(place_id,
4668
4684
  # original_price) * inventory(place_id,attributes.key), where key is any key in
4669
- # the Product.inventories.attributes map. * attributes.key, where key is any key
4670
- # in the Product.attributes map. * pickupInStore.id, where id is any
4685
+ # the Product.local_inventories.attributes map. * attributes.key, where key is
4686
+ # any key in the Product.attributes map. * pickupInStore.id, where id is any
4671
4687
  # FulfillmentInfo.place_ids for FulfillmentInfo.type "pickup-in-store". *
4672
4688
  # shipToStore.id, where id is any FulfillmentInfo.place_ids for FulfillmentInfo.
4673
4689
  # type "ship-to-store". * sameDayDelivery.id, where id is any FulfillmentInfo.
@@ -4718,6 +4734,7 @@ module Google
4718
4734
  @query = args[:query] if args.key?(:query)
4719
4735
  @query_expansion_spec = args[:query_expansion_spec] if args.key?(:query_expansion_spec)
4720
4736
  @search_mode = args[:search_mode] if args.key?(:search_mode)
4737
+ @spell_correction_spec = args[:spell_correction_spec] if args.key?(:spell_correction_spec)
4721
4738
  @user_info = args[:user_info] if args.key?(:user_info)
4722
4739
  @variant_rollup_keys = args[:variant_rollup_keys] if args.key?(:variant_rollup_keys)
4723
4740
  @visitor_id = args[:visitor_id] if args.key?(:visitor_id)
@@ -5021,6 +5038,26 @@ module Google
5021
5038
  end
5022
5039
  end
5023
5040
 
5041
+ # The specification for query spell correction.
5042
+ class GoogleCloudRetailV2betaSearchRequestSpellCorrectionSpec
5043
+ include Google::Apis::Core::Hashable
5044
+
5045
+ # The mode under which spell correction should take effect to replace the
5046
+ # original search query. Default to Mode.AUTO.
5047
+ # Corresponds to the JSON property `mode`
5048
+ # @return [String]
5049
+ attr_accessor :mode
5050
+
5051
+ def initialize(**args)
5052
+ update!(**args)
5053
+ end
5054
+
5055
+ # Update properties of this object
5056
+ def update!(**args)
5057
+ @mode = args[:mode] if args.key?(:mode)
5058
+ end
5059
+ end
5060
+
5024
5061
  # Response message for SearchService.Search method.
5025
5062
  class GoogleCloudRetailV2betaSearchResponse
5026
5063
  include Google::Apis::Core::Hashable
@@ -5038,7 +5075,9 @@ module Google
5038
5075
  # @return [String]
5039
5076
  attr_accessor :attribution_token
5040
5077
 
5041
- # If spell correction applies, the corrected query. Otherwise, empty.
5078
+ # Contains the spell corrected query, if found. If the spell correction type is
5079
+ # AUTOMATIC, then the search results are based on corrected_query. Otherwise the
5080
+ # original query will be used for search.
5042
5081
  # Corresponds to the JSON property `correctedQuery`
5043
5082
  # @return [String]
5044
5083
  attr_accessor :corrected_query
@@ -5067,8 +5106,8 @@ module Google
5067
5106
  attr_accessor :query_expansion_info
5068
5107
 
5069
5108
  # The URI of a customer-defined redirect page. If redirect action is triggered,
5070
- # no search will be performed, and only redirect_uri and attribution_token will
5071
- # be set in the response.
5109
+ # no search is performed, and only redirect_uri and attribution_token are set in
5110
+ # the response.
5072
5111
  # Corresponds to the JSON property `redirectUri`
5073
5112
  # @return [String]
5074
5113
  attr_accessor :redirect_uri
@@ -5265,11 +5304,11 @@ module Google
5265
5304
  # Condition boost specifications. If a product matches multiple conditions in
5266
5305
  # the specifications, boost scores from these specifications are all applied and
5267
5306
  # combined in a non-linear way. Maximum number of specifications is 100. Notice
5268
- # that if both ServingConfig.boost_control_ids and [SearchRequest.boost_spec]
5269
- # are set, the boost conditions from both places are evaluated. If a search
5270
- # request matches multiple boost conditions, the final boost score is equal to
5271
- # the sum of the boost scores from all matched boost conditions. Can only be set
5272
- # if solution_types is SOLUTION_TYPE_SEARCH.
5307
+ # that if both ServingConfig.boost_control_ids and SearchRequest.boost_spec are
5308
+ # set, the boost conditions from both places are evaluated. If a search request
5309
+ # matches multiple boost conditions, the final boost score is equal to the sum
5310
+ # of the boost scores from all matched boost conditions. Can only be set if
5311
+ # solution_types is SOLUTION_TYPE_SEARCH.
5273
5312
  # Corresponds to the JSON property `boostControlIds`
5274
5313
  # @return [Array<String>]
5275
5314
  attr_accessor :boost_control_ids
@@ -5676,9 +5715,9 @@ module Google
5676
5715
  # @return [String]
5677
5716
  attr_accessor :page_view_id
5678
5717
 
5679
- # The main product details related to the event. This field is required for the
5680
- # following event types: * `add-to-cart` * `detail-page-view` * `purchase-
5681
- # complete` * `search` In a `search` event, this field represents the products
5718
+ # The main product details related to the event. This field is optional except
5719
+ # for the following event types: * `add-to-cart` * `detail-page-view` * `
5720
+ # purchase-complete` In a `search` event, this field represents the products
5682
5721
  # returned to the end user on the current page (the end user may have not
5683
5722
  # finished browsing the whole page yet). When a new page is returned to the end
5684
5723
  # user, after pagination/filtering/ordering even for the same query, a new `
@@ -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.36.0"
19
+ GEM_VERSION = "0.39.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 = "20220414"
25
+ REVISION = "20220505"
26
26
  end
27
27
  end
28
28
  end
@@ -904,6 +904,12 @@ module Google
904
904
  include Google::Apis::Core::JsonObjectSupport
905
905
  end
906
906
 
907
+ class GoogleCloudRetailV2betaSearchRequestSpellCorrectionSpec
908
+ class Representation < Google::Apis::Core::JsonRepresentation; end
909
+
910
+ include Google::Apis::Core::JsonObjectSupport
911
+ end
912
+
907
913
  class GoogleCloudRetailV2betaSearchResponse
908
914
  class Representation < Google::Apis::Core::JsonRepresentation; end
909
915
 
@@ -2284,6 +2290,8 @@ module Google
2284
2290
  property :query_expansion_spec, as: 'queryExpansionSpec', class: Google::Apis::RetailV2beta::GoogleCloudRetailV2betaSearchRequestQueryExpansionSpec, decorator: Google::Apis::RetailV2beta::GoogleCloudRetailV2betaSearchRequestQueryExpansionSpec::Representation
2285
2291
 
2286
2292
  property :search_mode, as: 'searchMode'
2293
+ property :spell_correction_spec, as: 'spellCorrectionSpec', class: Google::Apis::RetailV2beta::GoogleCloudRetailV2betaSearchRequestSpellCorrectionSpec, decorator: Google::Apis::RetailV2beta::GoogleCloudRetailV2betaSearchRequestSpellCorrectionSpec::Representation
2294
+
2287
2295
  property :user_info, as: 'userInfo', class: Google::Apis::RetailV2beta::GoogleCloudRetailV2betaUserInfo, decorator: Google::Apis::RetailV2beta::GoogleCloudRetailV2betaUserInfo::Representation
2288
2296
 
2289
2297
  collection :variant_rollup_keys, as: 'variantRollupKeys'
@@ -2355,6 +2363,13 @@ module Google
2355
2363
  end
2356
2364
  end
2357
2365
 
2366
+ class GoogleCloudRetailV2betaSearchRequestSpellCorrectionSpec
2367
+ # @private
2368
+ class Representation < Google::Apis::Core::JsonRepresentation
2369
+ property :mode, as: 'mode'
2370
+ end
2371
+ end
2372
+
2358
2373
  class GoogleCloudRetailV2betaSearchResponse
2359
2374
  # @private
2360
2375
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -62,8 +62,9 @@ module Google
62
62
  # the imported dataset through CompletionService.ImportCompletionData. "cloud-
63
63
  # retail" will use the dataset generated by cloud retail based on user events.
64
64
  # If leave empty, it will use the "user-data". Current supported values: * user-
65
- # data * cloud-retail This option requires additional allowlisting. Before using
66
- # cloud-retail, contact Cloud Retail support team first.
65
+ # data * cloud-retail: This option requires enabling auto-learning function
66
+ # first. See [guidelines](https://cloud.google.com/retail/docs/completion-
67
+ # overview#generated-completion-dataset).
67
68
  # @param [String] device_type
68
69
  # The device type context for completion suggestions. It is useful to apply
69
70
  # different suggestions on different device types, e.g. `DESKTOP`, `MOBILE`. If
@@ -1027,9 +1028,9 @@ module Google
1027
1028
  # this product will be used. If no inventory fields are set in
1028
1029
  # SetInventoryRequest.set_mask, then any existing inventory information will be
1029
1030
  # preserved. Pre-existing inventory information can only be updated with
1030
- # SetInventory, AddFulfillmentPlaces, and RemoveFulfillmentPlaces. This feature
1031
- # is only available for users who have Retail Search enabled. Please enable
1032
- # Retail Search on Cloud Console before using this feature.
1031
+ # SetInventory, ProductService.AddFulfillmentPlaces, and RemoveFulfillmentPlaces.
1032
+ # This feature is only available for users who have Retail Search enabled.
1033
+ # Please enable Retail Search on Cloud Console before using this feature.
1033
1034
  # @param [String] name
1034
1035
  # Immutable. Full resource name of the product, such as `projects/*/locations/
1035
1036
  # global/catalogs/default_catalog/branches/default_branch/products/product_id`.
@@ -1373,15 +1374,12 @@ module Google
1373
1374
  # Makes a recommendation prediction.
1374
1375
  # @param [String] placement
1375
1376
  # Required. Full resource name of the format: `name=projects/*/locations/global/
1376
- # catalogs/default_catalog/servingConfigs/*` or `name=projects/*/locations/
1377
- # global/catalogs/default_catalog/placements/*`. We recommend using the `
1378
- # servingConfigs` resource. `placements` is a legacy resource. The ID of the
1379
- # Recommendations AI serving config or placement. Before you can request
1380
- # predictions from your model, you must create at least one serving config or
1381
- # placement for it. For more information, see [Managing serving configurations] (
1382
- # https://cloud.google.com/retail/docs/manage-configs). The full list of
1383
- # available serving configs can be seen at https://console.cloud.google.com/ai/
1384
- # retail/catalogs/default_catalog/configs
1377
+ # catalogs/default_catalog/placements/*` The ID of the Recommendations AI
1378
+ # placement. Before you can request predictions from your model, you must create
1379
+ # at least one placement for it. For more information, see [Managing placements](
1380
+ # https://cloud.google.com/retail/recommendations-ai/docs/manage-placements).
1381
+ # The full list of available placements can be seen at https://console.cloud.
1382
+ # google.com/recommendation/catalogs/default_catalog/placements
1385
1383
  # @param [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaPredictRequest] google_cloud_retail_v2beta_predict_request_object
1386
1384
  # @param [String] fields
1387
1385
  # Selector specifying which fields to include in a partial response.
@@ -1416,12 +1414,10 @@ module Google
1416
1414
  # Search enabled. Please enable Retail Search on Cloud Console before using this
1417
1415
  # feature.
1418
1416
  # @param [String] placement
1419
- # Required. The resource name of the Retail Search serving config, such as `
1420
- # projects/*/locations/global/catalogs/default_catalog/servingConfigs/
1421
- # default_serving_config` or the name of the legacy placement resource, such as `
1422
- # projects/*/locations/global/catalogs/default_catalog/placements/default_search`
1423
- # . This field is used to identify the serving configuration name and the set of
1424
- # models that will be used to make the search.
1417
+ # Required. The resource name of the search engine placement, such as `projects/*
1418
+ # /locations/global/catalogs/default_catalog/placements/default_search`. This
1419
+ # field is used to identify the serving configuration name and the set of models
1420
+ # that will be used to make the search.
1425
1421
  # @param [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaSearchRequest] google_cloud_retail_v2beta_search_request_object
1426
1422
  # @param [String] fields
1427
1423
  # Selector specifying which fields to include in a partial response.
@@ -1676,48 +1672,6 @@ module Google
1676
1672
  execute_or_queue_command(command, &block)
1677
1673
  end
1678
1674
 
1679
- # Makes a recommendation prediction.
1680
- # @param [String] placement
1681
- # Required. Full resource name of the format: `name=projects/*/locations/global/
1682
- # catalogs/default_catalog/servingConfigs/*` or `name=projects/*/locations/
1683
- # global/catalogs/default_catalog/placements/*`. We recommend using the `
1684
- # servingConfigs` resource. `placements` is a legacy resource. The ID of the
1685
- # Recommendations AI serving config or placement. Before you can request
1686
- # predictions from your model, you must create at least one serving config or
1687
- # placement for it. For more information, see [Managing serving configurations] (
1688
- # https://cloud.google.com/retail/docs/manage-configs). The full list of
1689
- # available serving configs can be seen at https://console.cloud.google.com/ai/
1690
- # retail/catalogs/default_catalog/configs
1691
- # @param [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaPredictRequest] google_cloud_retail_v2beta_predict_request_object
1692
- # @param [String] fields
1693
- # Selector specifying which fields to include in a partial response.
1694
- # @param [String] quota_user
1695
- # Available to use for quota purposes for server-side applications. Can be any
1696
- # arbitrary string assigned to a user, but should not exceed 40 characters.
1697
- # @param [Google::Apis::RequestOptions] options
1698
- # Request-specific options
1699
- #
1700
- # @yield [result, err] Result & error if block supplied
1701
- # @yieldparam result [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaPredictResponse] parsed result object
1702
- # @yieldparam err [StandardError] error object if request failed
1703
- #
1704
- # @return [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaPredictResponse]
1705
- #
1706
- # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1707
- # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1708
- # @raise [Google::Apis::AuthorizationError] Authorization is required
1709
- def predict_project_location_catalog_serving_config(placement, google_cloud_retail_v2beta_predict_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1710
- command = make_simple_command(:post, 'v2beta/{+placement}:predict', options)
1711
- command.request_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaPredictRequest::Representation
1712
- command.request_object = google_cloud_retail_v2beta_predict_request_object
1713
- command.response_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaPredictResponse::Representation
1714
- command.response_class = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaPredictResponse
1715
- command.params['placement'] = placement unless placement.nil?
1716
- command.query['fields'] = fields unless fields.nil?
1717
- command.query['quotaUser'] = quota_user unless quota_user.nil?
1718
- execute_or_queue_command(command, &block)
1719
- end
1720
-
1721
1675
  # Disables a Control on the specified ServingConfig. The control is removed from
1722
1676
  # the ServingConfig. Returns a NOT_FOUND error if the Control is not enabled for
1723
1677
  # the ServingConfig.
@@ -1755,46 +1709,6 @@ module Google
1755
1709
  execute_or_queue_command(command, &block)
1756
1710
  end
1757
1711
 
1758
- # Performs a search. This feature is only available for users who have Retail
1759
- # Search enabled. Please enable Retail Search on Cloud Console before using this
1760
- # feature.
1761
- # @param [String] placement
1762
- # Required. The resource name of the Retail Search serving config, such as `
1763
- # projects/*/locations/global/catalogs/default_catalog/servingConfigs/
1764
- # default_serving_config` or the name of the legacy placement resource, such as `
1765
- # projects/*/locations/global/catalogs/default_catalog/placements/default_search`
1766
- # . This field is used to identify the serving configuration name and the set of
1767
- # models that will be used to make the search.
1768
- # @param [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaSearchRequest] google_cloud_retail_v2beta_search_request_object
1769
- # @param [String] fields
1770
- # Selector specifying which fields to include in a partial response.
1771
- # @param [String] quota_user
1772
- # Available to use for quota purposes for server-side applications. Can be any
1773
- # arbitrary string assigned to a user, but should not exceed 40 characters.
1774
- # @param [Google::Apis::RequestOptions] options
1775
- # Request-specific options
1776
- #
1777
- # @yield [result, err] Result & error if block supplied
1778
- # @yieldparam result [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaSearchResponse] parsed result object
1779
- # @yieldparam err [StandardError] error object if request failed
1780
- #
1781
- # @return [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaSearchResponse]
1782
- #
1783
- # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1784
- # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1785
- # @raise [Google::Apis::AuthorizationError] Authorization is required
1786
- def search_project_location_catalog_serving_configs(placement, google_cloud_retail_v2beta_search_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1787
- command = make_simple_command(:post, 'v2beta/{+placement}:search', options)
1788
- command.request_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaSearchRequest::Representation
1789
- command.request_object = google_cloud_retail_v2beta_search_request_object
1790
- command.response_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaSearchResponse::Representation
1791
- command.response_class = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaSearchResponse
1792
- command.params['placement'] = placement unless placement.nil?
1793
- command.query['fields'] = fields unless fields.nil?
1794
- command.query['quotaUser'] = quota_user unless quota_user.nil?
1795
- execute_or_queue_command(command, &block)
1796
- end
1797
-
1798
1712
  # Writes a single user event from the browser. This uses a GET request to due to
1799
1713
  # browser restriction of POST-ing to a 3rd party domain. This method is used
1800
1714
  # only by the Retail API JavaScript pixel and Google Tag Manager. Users should
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.36.0
4
+ version: 0.39.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-04-25 00:00:00.000000000 Z
11
+ date: 2022-05-16 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.36.0
61
+ documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2beta/v0.39.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: []