google-apis-retail_v2 0.35.0 → 0.38.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: 530f53f799eda6665eb83ac1b7e46cad9132092a5beaf31a8efd981ca78d55e0
4
- data.tar.gz: 0d5c6a488b5f2e3c9bafec0af8a1e72075aa0cb098b7597a40f5ab7000522891
3
+ metadata.gz: 21aa629c3a0c4c57e44fc1b3fe592bc1ecd92908121a31f16315238224603c1f
4
+ data.tar.gz: 126758f4b650cd5b3b7181128c8359976b0a5019c2871fa030916e486a20ad5f
5
5
  SHA512:
6
- metadata.gz: 1f3e416aaf3950c7426053919eb5c9bd38622a339992059bd058e897007d714e2ba8ec91b0acc64310ac3ec311e8944afa82852ae7d3e0557162dc31fc179c35
7
- data.tar.gz: 78d37620b41ee26b09aaf923fba197ebde44380e26853e939d9759009732d9cc2d17cda1b2150ac037b8f41e43b040a1379b46ea9101d8dd9bfd8d804e9d595b
6
+ metadata.gz: 5ebf22a1ca11048758bd1b953a965c01218175706147585de4e4b350a439b6a3f453834917130acec9a9b91884398028cb32c9e6f57b9b8ebec72450cea84903
7
+ data.tar.gz: b042af707818c22dc4fee730f5de1bef29bbc92a057441ec9882c096098144b5538798779be1f5ede6a79b578a83a3d3c16092090ca25a269d2cdf5462ebbeb1
data/CHANGELOG.md CHANGED
@@ -1,5 +1,17 @@
1
1
  # Release history for google-apis-retail_v2
2
2
 
3
+ ### v0.38.0 (2022-05-12)
4
+
5
+ * Regenerated from discovery document revision 20220505
6
+
7
+ ### v0.37.0 (2022-05-05)
8
+
9
+ * Regenerated from discovery document revision 20220430
10
+
11
+ ### v0.36.0 (2022-04-28)
12
+
13
+ * Regenerated from discovery document revision 20220421
14
+
3
15
  ### v0.35.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
 
@@ -294,7 +294,7 @@ module Google
294
294
  end
295
295
  end
296
296
 
297
- # Request message for AddFulfillmentPlaces method.
297
+ # Request message for ProductService.AddFulfillmentPlaces method.
298
298
  class GoogleCloudRetailV2AddFulfillmentPlacesRequest
299
299
  include Google::Apis::Core::Hashable
300
300
 
@@ -351,7 +351,8 @@ module Google
351
351
  end
352
352
 
353
353
  # Response of the AddFulfillmentPlacesRequest. Currently empty because there is
354
- # no meaningful response populated from the AddFulfillmentPlaces method.
354
+ # no meaningful response populated from the ProductService.AddFulfillmentPlaces
355
+ # method.
355
356
  class GoogleCloudRetailV2AddFulfillmentPlacesResponse
356
357
  include Google::Apis::Core::Hashable
357
358
 
@@ -366,7 +367,7 @@ module Google
366
367
 
367
368
  # Metadata related to the progress of the AddLocalInventories operation.
368
369
  # Currently empty because there is no meaningful metadata populated from the
369
- # AddLocalInventories method.
370
+ # ProductService.AddLocalInventories method.
370
371
  class GoogleCloudRetailV2AddLocalInventoriesMetadata
371
372
  include Google::Apis::Core::Hashable
372
373
 
@@ -379,7 +380,7 @@ module Google
379
380
  end
380
381
  end
381
382
 
382
- # Request message for AddLocalInventories method.
383
+ # Request message for ProductService.AddLocalInventories method.
383
384
  class GoogleCloudRetailV2AddLocalInventoriesRequest
384
385
  include Google::Apis::Core::Hashable
385
386
 
@@ -430,8 +431,9 @@ module Google
430
431
  end
431
432
  end
432
433
 
433
- # Response of the AddLocalInventories API. Currently empty because there is no
434
- # meaningful response populated from the AddLocalInventories method.
434
+ # Response of the ProductService.AddLocalInventories API. Currently empty
435
+ # because there is no meaningful response populated from the ProductService.
436
+ # AddLocalInventories method.
435
437
  class GoogleCloudRetailV2AddLocalInventoriesResponse
436
438
  include Google::Apis::Core::Hashable
437
439
 
@@ -774,12 +776,14 @@ module Google
774
776
  class GoogleCloudRetailV2CustomAttribute
775
777
  include Google::Apis::Core::Hashable
776
778
 
777
- # This field will only be used when AttributesConfig.attribute_config_level of
778
- # the Catalog is 'PRODUCT_LEVEL_ATTRIBUTE_CONFIG', if true, custom attribute
779
- # values are indexed, so that it can be filtered, faceted or boosted in
780
- # SearchService.Search. This field is ignored in a UserEvent. See SearchRequest.
781
- # filter, SearchRequest.facet_specs and SearchRequest.boost_spec for more
782
- # details.
779
+ # This field is normally ignored unless AttributesConfig.attribute_config_level
780
+ # of the Catalog is set to the deprecated 'PRODUCT_LEVEL_ATTRIBUTE_CONFIG' mode.
781
+ # For information about product-level attribute configuration, see [
782
+ # Configuration modes](https://cloud.google.com/retail/docs/attribute-config#
783
+ # config-modes). If true, custom attribute values are indexed, so that they can
784
+ # be filtered, faceted or boosted in SearchService.Search. This field is ignored
785
+ # in a UserEvent. See SearchRequest.filter, SearchRequest.facet_specs and
786
+ # SearchRequest.boost_spec for more details.
783
787
  # Corresponds to the JSON property `indexable`
784
788
  # @return [Boolean]
785
789
  attr_accessor :indexable
@@ -792,11 +796,13 @@ module Google
792
796
  # @return [Array<Float>]
793
797
  attr_accessor :numbers
794
798
 
795
- # This field will only be used when AttributesConfig.attribute_config_level of
796
- # the Catalog is 'PRODUCT_LEVEL_ATTRIBUTE_CONFIG', if true, custom attribute
797
- # values are searchable by text queries in SearchService.Search. This field is
798
- # ignored in a UserEvent. Only set if type text is set. Otherwise, a
799
- # INVALID_ARGUMENT error is returned.
799
+ # This field is normally ignored unless AttributesConfig.attribute_config_level
800
+ # of the Catalog is set to the deprecated 'PRODUCT_LEVEL_ATTRIBUTE_CONFIG' mode.
801
+ # For information about product-level attribute configuration, see [
802
+ # Configuration modes](https://cloud.google.com/retail/docs/attribute-config#
803
+ # config-modes). If true, custom attribute values are searchable by text queries
804
+ # in SearchService.Search. This field is ignored in a UserEvent. Only set if
805
+ # type text is set. Otherwise, a INVALID_ARGUMENT error is returned.
800
806
  # Corresponds to the JSON property `searchable`
801
807
  # @return [Boolean]
802
808
  attr_accessor :searchable
@@ -1410,7 +1416,7 @@ module Google
1410
1416
  # The labels applied to a resource must meet the following requirements: * Each
1411
1417
  # resource can have multiple labels, up to a maximum of 64. * Each label must be
1412
1418
  # a key-value pair. * Keys have a minimum length of 1 character and a maximum
1413
- # length of 63 characters, and cannot be empty. Values can be empty, and have a
1419
+ # length of 63 characters and cannot be empty. Values can be empty and have a
1414
1420
  # maximum length of 63 characters. * Keys and values can contain only lowercase
1415
1421
  # letters, numeric characters, underscores, and dashes. All characters must use
1416
1422
  # UTF-8 encoding, and international characters are allowed. * The key portion of
@@ -1538,9 +1544,9 @@ module Google
1538
1544
  attr_accessor :id
1539
1545
 
1540
1546
  # Additional product metadata / annotations. Possible values: * `product`: JSON
1541
- # representation of the product. Will be set if `returnProduct` is set to true
1542
- # in `PredictRequest.params`. * `score`: Prediction score in double value. Will
1543
- # be set if `returnScore` is set to true in `PredictRequest.params`.
1547
+ # representation of the product. Is set if `returnProduct` is set to true in `
1548
+ # PredictRequest.params`. * `score`: Prediction score in double value. Is set if
1549
+ # `returnScore` is set to true in `PredictRequest.params`.
1544
1550
  # Corresponds to the JSON property `metadata`
1545
1551
  # @return [Hash<String,Object>]
1546
1552
  attr_accessor :metadata
@@ -1903,9 +1909,9 @@ module Google
1903
1909
  # attribute, as specified in attributes. For Type.PRIMARY and Type.COLLECTION,
1904
1910
  # the following fields are always returned in SearchResponse by default: * name
1905
1911
  # For Type.VARIANT, the following fields are always returned in by default: *
1906
- # name * color_info Maximum number of paths is 30. Otherwise, an
1912
+ # name * color_info The maximum number of paths is 30. Otherwise, an
1907
1913
  # INVALID_ARGUMENT error is returned. Note: Returning more fields in
1908
- # SearchResponse may increase response payload size and serving latency.
1914
+ # SearchResponse can increase response payload size and serving latency.
1909
1915
  # Corresponds to the JSON property `retrievableFields`
1910
1916
  # @return [String]
1911
1917
  attr_accessor :retrievable_fields
@@ -2586,7 +2592,7 @@ module Google
2586
2592
  # The labels applied to a resource must meet the following requirements: * Each
2587
2593
  # resource can have multiple labels, up to a maximum of 64. * Each label must be
2588
2594
  # a key-value pair. * Keys have a minimum length of 1 character and a maximum
2589
- # length of 63 characters, and cannot be empty. Values can be empty, and have a
2595
+ # length of 63 characters and cannot be empty. Values can be empty and have a
2590
2596
  # maximum length of 63 characters. * Keys and values can contain only lowercase
2591
2597
  # letters, numeric characters, underscores, and dashes. All characters must use
2592
2598
  # UTF-8 encoding, and international characters are allowed. * The key portion of
@@ -2664,6 +2670,11 @@ module Google
2664
2670
  # @return [String]
2665
2671
  attr_accessor :search_mode
2666
2672
 
2673
+ # The specification for query spell correction.
2674
+ # Corresponds to the JSON property `spellCorrectionSpec`
2675
+ # @return [Google::Apis::RetailV2::GoogleCloudRetailV2SearchRequestSpellCorrectionSpec]
2676
+ attr_accessor :spell_correction_spec
2677
+
2667
2678
  # Information of an end user.
2668
2679
  # Corresponds to the JSON property `userInfo`
2669
2680
  # @return [Google::Apis::RetailV2::GoogleCloudRetailV2UserInfo]
@@ -2679,8 +2690,8 @@ module Google
2679
2690
  # the store ID. Supported keys are: * colorFamilies * price * originalPrice *
2680
2691
  # discount * variantId * inventory(place_id,price) * inventory(place_id,
2681
2692
  # original_price) * inventory(place_id,attributes.key), where key is any key in
2682
- # the Product.inventories.attributes map. * attributes.key, where key is any key
2683
- # in the Product.attributes map. * pickupInStore.id, where id is any
2693
+ # the Product.local_inventories.attributes map. * attributes.key, where key is
2694
+ # any key in the Product.attributes map. * pickupInStore.id, where id is any
2684
2695
  # FulfillmentInfo.place_ids for FulfillmentInfo.type "pickup-in-store". *
2685
2696
  # shipToStore.id, where id is any FulfillmentInfo.place_ids for FulfillmentInfo.
2686
2697
  # type "ship-to-store". * sameDayDelivery.id, where id is any FulfillmentInfo.
@@ -2731,6 +2742,7 @@ module Google
2731
2742
  @query = args[:query] if args.key?(:query)
2732
2743
  @query_expansion_spec = args[:query_expansion_spec] if args.key?(:query_expansion_spec)
2733
2744
  @search_mode = args[:search_mode] if args.key?(:search_mode)
2745
+ @spell_correction_spec = args[:spell_correction_spec] if args.key?(:spell_correction_spec)
2734
2746
  @user_info = args[:user_info] if args.key?(:user_info)
2735
2747
  @variant_rollup_keys = args[:variant_rollup_keys] if args.key?(:variant_rollup_keys)
2736
2748
  @visitor_id = args[:visitor_id] if args.key?(:visitor_id)
@@ -3034,6 +3046,26 @@ module Google
3034
3046
  end
3035
3047
  end
3036
3048
 
3049
+ # The specification for query spell correction.
3050
+ class GoogleCloudRetailV2SearchRequestSpellCorrectionSpec
3051
+ include Google::Apis::Core::Hashable
3052
+
3053
+ # The mode under which spell correction should take effect to replace the
3054
+ # original search query. Default to Mode.AUTO.
3055
+ # Corresponds to the JSON property `mode`
3056
+ # @return [String]
3057
+ attr_accessor :mode
3058
+
3059
+ def initialize(**args)
3060
+ update!(**args)
3061
+ end
3062
+
3063
+ # Update properties of this object
3064
+ def update!(**args)
3065
+ @mode = args[:mode] if args.key?(:mode)
3066
+ end
3067
+ end
3068
+
3037
3069
  # Response message for SearchService.Search method.
3038
3070
  class GoogleCloudRetailV2SearchResponse
3039
3071
  include Google::Apis::Core::Hashable
@@ -3051,7 +3083,9 @@ module Google
3051
3083
  # @return [String]
3052
3084
  attr_accessor :attribution_token
3053
3085
 
3054
- # If spell correction applies, the corrected query. Otherwise, empty.
3086
+ # Contains the spell corrected query, if found. If the spell correction type is
3087
+ # AUTOMATIC, then the search results are based on corrected_query. Otherwise the
3088
+ # original query will be used for search.
3055
3089
  # Corresponds to the JSON property `correctedQuery`
3056
3090
  # @return [String]
3057
3091
  attr_accessor :corrected_query
@@ -3080,8 +3114,8 @@ module Google
3080
3114
  attr_accessor :query_expansion_info
3081
3115
 
3082
3116
  # The URI of a customer-defined redirect page. If redirect action is triggered,
3083
- # no search will be performed, and only redirect_uri and attribution_token will
3084
- # be set in the response.
3117
+ # no search is performed, and only redirect_uri and attribution_token are set in
3118
+ # the response.
3085
3119
  # Corresponds to the JSON property `redirectUri`
3086
3120
  # @return [String]
3087
3121
  attr_accessor :redirect_uri
@@ -3512,9 +3546,9 @@ module Google
3512
3546
  # @return [String]
3513
3547
  attr_accessor :page_view_id
3514
3548
 
3515
- # The main product details related to the event. This field is required for the
3516
- # following event types: * `add-to-cart` * `detail-page-view` * `purchase-
3517
- # complete` * `search` In a `search` event, this field represents the products
3549
+ # The main product details related to the event. This field is optional except
3550
+ # for the following event types: * `add-to-cart` * `detail-page-view` * `
3551
+ # purchase-complete` In a `search` event, this field represents the products
3518
3552
  # returned to the end user on the current page (the end user may have not
3519
3553
  # finished browsing the whole page yet). When a new page is returned to the end
3520
3554
  # user, after pagination/filtering/ordering even for the same query, a new `
@@ -3746,7 +3780,7 @@ module Google
3746
3780
 
3747
3781
  # Metadata related to the progress of the AddFulfillmentPlaces operation.
3748
3782
  # Currently empty because there is no meaningful metadata populated from the
3749
- # AddFulfillmentPlaces method.
3783
+ # ProductService.AddFulfillmentPlaces method.
3750
3784
  class GoogleCloudRetailV2alphaAddFulfillmentPlacesMetadata
3751
3785
  include Google::Apis::Core::Hashable
3752
3786
 
@@ -3760,7 +3794,8 @@ module Google
3760
3794
  end
3761
3795
 
3762
3796
  # Response of the AddFulfillmentPlacesRequest. Currently empty because there is
3763
- # no meaningful response populated from the AddFulfillmentPlaces method.
3797
+ # no meaningful response populated from the ProductService.AddFulfillmentPlaces
3798
+ # method.
3764
3799
  class GoogleCloudRetailV2alphaAddFulfillmentPlacesResponse
3765
3800
  include Google::Apis::Core::Hashable
3766
3801
 
@@ -3775,7 +3810,7 @@ module Google
3775
3810
 
3776
3811
  # Metadata related to the progress of the AddLocalInventories operation.
3777
3812
  # Currently empty because there is no meaningful metadata populated from the
3778
- # AddLocalInventories method.
3813
+ # ProductService.AddLocalInventories method.
3779
3814
  class GoogleCloudRetailV2alphaAddLocalInventoriesMetadata
3780
3815
  include Google::Apis::Core::Hashable
3781
3816
 
@@ -3788,8 +3823,9 @@ module Google
3788
3823
  end
3789
3824
  end
3790
3825
 
3791
- # Response of the AddLocalInventories API. Currently empty because there is no
3792
- # meaningful response populated from the AddLocalInventories method.
3826
+ # Response of the ProductService.AddLocalInventories API. Currently empty
3827
+ # because there is no meaningful response populated from the ProductService.
3828
+ # AddLocalInventories method.
3793
3829
  class GoogleCloudRetailV2alphaAddLocalInventoriesResponse
3794
3830
  include Google::Apis::Core::Hashable
3795
3831
 
@@ -4312,7 +4348,7 @@ module Google
4312
4348
 
4313
4349
  # Metadata related to the progress of the AddFulfillmentPlaces operation.
4314
4350
  # Currently empty because there is no meaningful metadata populated from the
4315
- # AddFulfillmentPlaces method.
4351
+ # ProductService.AddFulfillmentPlaces method.
4316
4352
  class GoogleCloudRetailV2betaAddFulfillmentPlacesMetadata
4317
4353
  include Google::Apis::Core::Hashable
4318
4354
 
@@ -4326,7 +4362,8 @@ module Google
4326
4362
  end
4327
4363
 
4328
4364
  # Response of the AddFulfillmentPlacesRequest. Currently empty because there is
4329
- # no meaningful response populated from the AddFulfillmentPlaces method.
4365
+ # no meaningful response populated from the ProductService.AddFulfillmentPlaces
4366
+ # method.
4330
4367
  class GoogleCloudRetailV2betaAddFulfillmentPlacesResponse
4331
4368
  include Google::Apis::Core::Hashable
4332
4369
 
@@ -4341,7 +4378,7 @@ module Google
4341
4378
 
4342
4379
  # Metadata related to the progress of the AddLocalInventories operation.
4343
4380
  # Currently empty because there is no meaningful metadata populated from the
4344
- # AddLocalInventories method.
4381
+ # ProductService.AddLocalInventories method.
4345
4382
  class GoogleCloudRetailV2betaAddLocalInventoriesMetadata
4346
4383
  include Google::Apis::Core::Hashable
4347
4384
 
@@ -4354,8 +4391,9 @@ module Google
4354
4391
  end
4355
4392
  end
4356
4393
 
4357
- # Response of the AddLocalInventories API. Currently empty because there is no
4358
- # meaningful response populated from the AddLocalInventories method.
4394
+ # Response of the ProductService.AddLocalInventories API. Currently empty
4395
+ # because there is no meaningful response populated from the ProductService.
4396
+ # AddLocalInventories method.
4359
4397
  class GoogleCloudRetailV2betaAddLocalInventoriesResponse
4360
4398
  include Google::Apis::Core::Hashable
4361
4399
 
@@ -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.35.0"
19
+ GEM_VERSION = "0.38.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
@@ -454,6 +454,12 @@ module Google
454
454
  include Google::Apis::Core::JsonObjectSupport
455
455
  end
456
456
 
457
+ class GoogleCloudRetailV2SearchRequestSpellCorrectionSpec
458
+ class Representation < Google::Apis::Core::JsonRepresentation; end
459
+
460
+ include Google::Apis::Core::JsonObjectSupport
461
+ end
462
+
457
463
  class GoogleCloudRetailV2SearchResponse
458
464
  class Representation < Google::Apis::Core::JsonRepresentation; end
459
465
 
@@ -1508,6 +1514,8 @@ module Google
1508
1514
  property :query_expansion_spec, as: 'queryExpansionSpec', class: Google::Apis::RetailV2::GoogleCloudRetailV2SearchRequestQueryExpansionSpec, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2SearchRequestQueryExpansionSpec::Representation
1509
1515
 
1510
1516
  property :search_mode, as: 'searchMode'
1517
+ property :spell_correction_spec, as: 'spellCorrectionSpec', class: Google::Apis::RetailV2::GoogleCloudRetailV2SearchRequestSpellCorrectionSpec, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2SearchRequestSpellCorrectionSpec::Representation
1518
+
1511
1519
  property :user_info, as: 'userInfo', class: Google::Apis::RetailV2::GoogleCloudRetailV2UserInfo, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2UserInfo::Representation
1512
1520
 
1513
1521
  collection :variant_rollup_keys, as: 'variantRollupKeys'
@@ -1579,6 +1587,13 @@ module Google
1579
1587
  end
1580
1588
  end
1581
1589
 
1590
+ class GoogleCloudRetailV2SearchRequestSpellCorrectionSpec
1591
+ # @private
1592
+ class Representation < Google::Apis::Core::JsonRepresentation
1593
+ property :mode, as: 'mode'
1594
+ end
1595
+ end
1596
+
1582
1597
  class GoogleCloudRetailV2SearchResponse
1583
1598
  # @private
1584
1599
  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
@@ -774,9 +775,9 @@ module Google
774
775
  # this product will be used. If no inventory fields are set in
775
776
  # SetInventoryRequest.set_mask, then any existing inventory information will be
776
777
  # preserved. Pre-existing inventory information can only be updated with
777
- # SetInventory, AddFulfillmentPlaces, and RemoveFulfillmentPlaces. This feature
778
- # is only available for users who have Retail Search enabled. Please enable
779
- # Retail Search on Cloud Console before using this feature.
778
+ # SetInventory, ProductService.AddFulfillmentPlaces, and RemoveFulfillmentPlaces.
779
+ # This feature is only available for users who have Retail Search enabled.
780
+ # Please enable Retail Search on Cloud Console before using this feature.
780
781
  # @param [String] name
781
782
  # Immutable. Full resource name of the product, such as `projects/*/locations/
782
783
  # global/catalogs/default_catalog/branches/default_branch/products/product_id`.
@@ -929,15 +930,12 @@ module Google
929
930
  # Makes a recommendation prediction.
930
931
  # @param [String] placement
931
932
  # Required. Full resource name of the format: `name=projects/*/locations/global/
932
- # catalogs/default_catalog/servingConfigs/*` or `name=projects/*/locations/
933
- # global/catalogs/default_catalog/placements/*`. We recommend using the `
934
- # servingConfigs` resource. `placements` is a legacy resource. The ID of the
935
- # Recommendations AI serving config or placement. Before you can request
936
- # predictions from your model, you must create at least one serving config or
937
- # placement for it. For more information, see [Managing serving configurations] (
938
- # https://cloud.google.com/retail/docs/manage-configs). The full list of
939
- # available serving configs can be seen at https://console.cloud.google.com/ai/
940
- # retail/catalogs/default_catalog/configs
933
+ # catalogs/default_catalog/placements/*` The ID of the Recommendations AI
934
+ # placement. Before you can request predictions from your model, you must create
935
+ # at least one placement for it. For more information, see [Managing placements](
936
+ # https://cloud.google.com/retail/recommendations-ai/docs/manage-placements).
937
+ # The full list of available placements can be seen at https://console.cloud.
938
+ # google.com/recommendation/catalogs/default_catalog/placements
941
939
  # @param [Google::Apis::RetailV2::GoogleCloudRetailV2PredictRequest] google_cloud_retail_v2_predict_request_object
942
940
  # @param [String] fields
943
941
  # Selector specifying which fields to include in a partial response.
@@ -972,12 +970,10 @@ module Google
972
970
  # Search enabled. Please enable Retail Search on Cloud Console before using this
973
971
  # feature.
974
972
  # @param [String] placement
975
- # Required. The resource name of the Retail Search serving config, such as `
976
- # projects/*/locations/global/catalogs/default_catalog/servingConfigs/
977
- # default_serving_config` or the name of the legacy placement resource, such as `
978
- # projects/*/locations/global/catalogs/default_catalog/placements/default_search`
979
- # . This field is used to identify the serving configuration name and the set of
980
- # models that will be used to make the search.
973
+ # Required. The resource name of the search engine placement, such as `projects/*
974
+ # /locations/global/catalogs/default_catalog/placements/default_search`. This
975
+ # field is used to identify the serving configuration name and the set of models
976
+ # that will be used to make the search.
981
977
  # @param [Google::Apis::RetailV2::GoogleCloudRetailV2SearchRequest] google_cloud_retail_v2_search_request_object
982
978
  # @param [String] fields
983
979
  # Selector specifying which fields to include in a partial response.
@@ -1008,88 +1004,6 @@ module Google
1008
1004
  execute_or_queue_command(command, &block)
1009
1005
  end
1010
1006
 
1011
- # Makes a recommendation prediction.
1012
- # @param [String] placement
1013
- # Required. Full resource name of the format: `name=projects/*/locations/global/
1014
- # catalogs/default_catalog/servingConfigs/*` or `name=projects/*/locations/
1015
- # global/catalogs/default_catalog/placements/*`. We recommend using the `
1016
- # servingConfigs` resource. `placements` is a legacy resource. The ID of the
1017
- # Recommendations AI serving config or placement. Before you can request
1018
- # predictions from your model, you must create at least one serving config or
1019
- # placement for it. For more information, see [Managing serving configurations] (
1020
- # https://cloud.google.com/retail/docs/manage-configs). The full list of
1021
- # available serving configs can be seen at https://console.cloud.google.com/ai/
1022
- # retail/catalogs/default_catalog/configs
1023
- # @param [Google::Apis::RetailV2::GoogleCloudRetailV2PredictRequest] google_cloud_retail_v2_predict_request_object
1024
- # @param [String] fields
1025
- # Selector specifying which fields to include in a partial response.
1026
- # @param [String] quota_user
1027
- # Available to use for quota purposes for server-side applications. Can be any
1028
- # arbitrary string assigned to a user, but should not exceed 40 characters.
1029
- # @param [Google::Apis::RequestOptions] options
1030
- # Request-specific options
1031
- #
1032
- # @yield [result, err] Result & error if block supplied
1033
- # @yieldparam result [Google::Apis::RetailV2::GoogleCloudRetailV2PredictResponse] parsed result object
1034
- # @yieldparam err [StandardError] error object if request failed
1035
- #
1036
- # @return [Google::Apis::RetailV2::GoogleCloudRetailV2PredictResponse]
1037
- #
1038
- # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1039
- # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1040
- # @raise [Google::Apis::AuthorizationError] Authorization is required
1041
- def predict_project_location_catalog_serving_config(placement, google_cloud_retail_v2_predict_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1042
- command = make_simple_command(:post, 'v2/{+placement}:predict', options)
1043
- command.request_representation = Google::Apis::RetailV2::GoogleCloudRetailV2PredictRequest::Representation
1044
- command.request_object = google_cloud_retail_v2_predict_request_object
1045
- command.response_representation = Google::Apis::RetailV2::GoogleCloudRetailV2PredictResponse::Representation
1046
- command.response_class = Google::Apis::RetailV2::GoogleCloudRetailV2PredictResponse
1047
- command.params['placement'] = placement unless placement.nil?
1048
- command.query['fields'] = fields unless fields.nil?
1049
- command.query['quotaUser'] = quota_user unless quota_user.nil?
1050
- execute_or_queue_command(command, &block)
1051
- end
1052
-
1053
- # Performs a search. This feature is only available for users who have Retail
1054
- # Search enabled. Please enable Retail Search on Cloud Console before using this
1055
- # feature.
1056
- # @param [String] placement
1057
- # Required. The resource name of the Retail Search serving config, such as `
1058
- # projects/*/locations/global/catalogs/default_catalog/servingConfigs/
1059
- # default_serving_config` or the name of the legacy placement resource, such as `
1060
- # projects/*/locations/global/catalogs/default_catalog/placements/default_search`
1061
- # . This field is used to identify the serving configuration name and the set of
1062
- # models that will be used to make the search.
1063
- # @param [Google::Apis::RetailV2::GoogleCloudRetailV2SearchRequest] google_cloud_retail_v2_search_request_object
1064
- # @param [String] fields
1065
- # Selector specifying which fields to include in a partial response.
1066
- # @param [String] quota_user
1067
- # Available to use for quota purposes for server-side applications. Can be any
1068
- # arbitrary string assigned to a user, but should not exceed 40 characters.
1069
- # @param [Google::Apis::RequestOptions] options
1070
- # Request-specific options
1071
- #
1072
- # @yield [result, err] Result & error if block supplied
1073
- # @yieldparam result [Google::Apis::RetailV2::GoogleCloudRetailV2SearchResponse] parsed result object
1074
- # @yieldparam err [StandardError] error object if request failed
1075
- #
1076
- # @return [Google::Apis::RetailV2::GoogleCloudRetailV2SearchResponse]
1077
- #
1078
- # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1079
- # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1080
- # @raise [Google::Apis::AuthorizationError] Authorization is required
1081
- def search_project_location_catalog_serving_configs(placement, google_cloud_retail_v2_search_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1082
- command = make_simple_command(:post, 'v2/{+placement}:search', options)
1083
- command.request_representation = Google::Apis::RetailV2::GoogleCloudRetailV2SearchRequest::Representation
1084
- command.request_object = google_cloud_retail_v2_search_request_object
1085
- command.response_representation = Google::Apis::RetailV2::GoogleCloudRetailV2SearchResponse::Representation
1086
- command.response_class = Google::Apis::RetailV2::GoogleCloudRetailV2SearchResponse
1087
- command.params['placement'] = placement unless placement.nil?
1088
- command.query['fields'] = fields unless fields.nil?
1089
- command.query['quotaUser'] = quota_user unless quota_user.nil?
1090
- execute_or_queue_command(command, &block)
1091
- end
1092
-
1093
1007
  # Writes a single user event from the browser. This uses a GET request to due to
1094
1008
  # browser restriction of POST-ing to a 3rd party domain. This method is used
1095
1009
  # 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_v2
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.35.0
4
+ version: 0.38.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_v2/CHANGELOG.md
61
- documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2/v0.35.0
61
+ documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2/v0.38.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: []