google-apis-retail_v2beta 0.31.0 → 0.34.0
Sign up to get free protection for your applications and to get access to all the features.
@@ -52,9 +52,8 @@ module Google
|
|
52
52
|
end
|
53
53
|
|
54
54
|
# Completes the specified prefix with keyword suggestions. This feature is only
|
55
|
-
# available for users who have Retail Search enabled. Please
|
56
|
-
#
|
57
|
-
# interested in using Retail Search.
|
55
|
+
# available for users who have Retail Search enabled. Please enable Retail
|
56
|
+
# Search on Cloud Console before using this feature.
|
58
57
|
# @param [String] catalog
|
59
58
|
# Required. Catalog for which the completion is performed. Full resource name of
|
60
59
|
# catalog, such as `projects/*/locations/global/catalogs/default_catalog`.
|
@@ -86,12 +85,12 @@ module Google
|
|
86
85
|
# Required. The query used to generate suggestions. The maximum number of
|
87
86
|
# allowed characters is 255.
|
88
87
|
# @param [String] visitor_id
|
89
|
-
# A unique identifier for tracking visitors. For example, this
|
90
|
-
# implemented with an HTTP cookie, which should be able to uniquely
|
91
|
-
# visitor on a single device. This unique identifier should not
|
92
|
-
# visitor logs in or out of the website. The field must be a UTF-8
|
93
|
-
# string with a length limit of 128 characters. Otherwise, an
|
94
|
-
# error is returned.
|
88
|
+
# Required field. A unique identifier for tracking visitors. For example, this
|
89
|
+
# could be implemented with an HTTP cookie, which should be able to uniquely
|
90
|
+
# identify a visitor on a single device. This unique identifier should not
|
91
|
+
# change if the visitor logs in or out of the website. The field must be a UTF-8
|
92
|
+
# encoded string with a length limit of 128 characters. Otherwise, an
|
93
|
+
# INVALID_ARGUMENT error is returned.
|
95
94
|
# @param [String] fields
|
96
95
|
# Selector specifying which fields to include in a partial response.
|
97
96
|
# @param [String] quota_user
|
@@ -156,6 +155,37 @@ module Google
|
|
156
155
|
execute_or_queue_command(command, &block)
|
157
156
|
end
|
158
157
|
|
158
|
+
# Gets a CompletionConfig.
|
159
|
+
# @param [String] name
|
160
|
+
# Required. Full CompletionConfig resource name. Format: projects/`
|
161
|
+
# project_number`/locations/`location_id`/catalogs/`catalog_id`/completionConfig
|
162
|
+
# @param [String] fields
|
163
|
+
# Selector specifying which fields to include in a partial response.
|
164
|
+
# @param [String] quota_user
|
165
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
166
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
167
|
+
# @param [Google::Apis::RequestOptions] options
|
168
|
+
# Request-specific options
|
169
|
+
#
|
170
|
+
# @yield [result, err] Result & error if block supplied
|
171
|
+
# @yieldparam result [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaCompletionConfig] parsed result object
|
172
|
+
# @yieldparam err [StandardError] error object if request failed
|
173
|
+
#
|
174
|
+
# @return [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaCompletionConfig]
|
175
|
+
#
|
176
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
177
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
178
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
179
|
+
def get_project_location_catalog_completion_config(name, fields: nil, quota_user: nil, options: nil, &block)
|
180
|
+
command = make_simple_command(:get, 'v2beta/{+name}', options)
|
181
|
+
command.response_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaCompletionConfig::Representation
|
182
|
+
command.response_class = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaCompletionConfig
|
183
|
+
command.params['name'] = name unless name.nil?
|
184
|
+
command.query['fields'] = fields unless fields.nil?
|
185
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
186
|
+
execute_or_queue_command(command, &block)
|
187
|
+
end
|
188
|
+
|
159
189
|
# Get which branch is currently default branch set by CatalogService.
|
160
190
|
# SetDefaultBranch method under a specified parent catalog.
|
161
191
|
# @param [String] catalog
|
@@ -365,6 +395,46 @@ module Google
|
|
365
395
|
execute_or_queue_command(command, &block)
|
366
396
|
end
|
367
397
|
|
398
|
+
# Updates the CompletionConfigs.
|
399
|
+
# @param [String] name
|
400
|
+
# Required. Immutable. Fully qualified name projects/*/locations/*/catalogs/*/
|
401
|
+
# completionConfig
|
402
|
+
# @param [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaCompletionConfig] google_cloud_retail_v2beta_completion_config_object
|
403
|
+
# @param [String] update_mask
|
404
|
+
# Indicates which fields in the provided CompletionConfig to update. The
|
405
|
+
# following are the only supported fields: * CompletionConfig.matching_order *
|
406
|
+
# CompletionConfig.max_suggestions * CompletionConfig.min_prefix_length *
|
407
|
+
# CompletionConfig.auto_learning If not set, all supported fields are updated.
|
408
|
+
# @param [String] fields
|
409
|
+
# Selector specifying which fields to include in a partial response.
|
410
|
+
# @param [String] quota_user
|
411
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
412
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
413
|
+
# @param [Google::Apis::RequestOptions] options
|
414
|
+
# Request-specific options
|
415
|
+
#
|
416
|
+
# @yield [result, err] Result & error if block supplied
|
417
|
+
# @yieldparam result [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaCompletionConfig] parsed result object
|
418
|
+
# @yieldparam err [StandardError] error object if request failed
|
419
|
+
#
|
420
|
+
# @return [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaCompletionConfig]
|
421
|
+
#
|
422
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
423
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
424
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
425
|
+
def update_project_location_catalog_completion_config(name, google_cloud_retail_v2beta_completion_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
426
|
+
command = make_simple_command(:patch, 'v2beta/{+name}', options)
|
427
|
+
command.request_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaCompletionConfig::Representation
|
428
|
+
command.request_object = google_cloud_retail_v2beta_completion_config_object
|
429
|
+
command.response_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaCompletionConfig::Representation
|
430
|
+
command.response_class = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaCompletionConfig
|
431
|
+
command.params['name'] = name unless name.nil?
|
432
|
+
command.query['updateMask'] = update_mask unless update_mask.nil?
|
433
|
+
command.query['fields'] = fields unless fields.nil?
|
434
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
435
|
+
execute_or_queue_command(command, &block)
|
436
|
+
end
|
437
|
+
|
368
438
|
# Adds the specified CatalogAttribute to the AttributesConfig. If the
|
369
439
|
# CatalogAttribute to add already exists, an ALREADY_EXISTS error is returned.
|
370
440
|
# @param [String] attributes_config
|
@@ -508,9 +578,8 @@ module Google
|
|
508
578
|
# enqueued and processed downstream. As a consequence, when a response is
|
509
579
|
# returned, the added place IDs are not immediately manifested in the Product
|
510
580
|
# queried by GetProduct or ListProducts. This feature is only available for
|
511
|
-
# users who have Retail Search enabled. Please
|
512
|
-
#
|
513
|
-
# using Retail Search.
|
581
|
+
# users who have Retail Search enabled. Please enable Retail Search on Cloud
|
582
|
+
# Console before using this feature.
|
514
583
|
# @param [String] product
|
515
584
|
# Required. Full resource name of Product, such as `projects/*/locations/global/
|
516
585
|
# catalogs/default_catalog/branches/default_branch/products/some_product_id`. If
|
@@ -546,6 +615,51 @@ module Google
|
|
546
615
|
execute_or_queue_command(command, &block)
|
547
616
|
end
|
548
617
|
|
618
|
+
# Updates local inventory information for a Product at a list of places, while
|
619
|
+
# respecting the last update timestamps of each inventory field. This process is
|
620
|
+
# asynchronous and does not require the Product to exist before updating
|
621
|
+
# inventory information. If the request is valid, the update will be enqueued
|
622
|
+
# and processed downstream. As a consequence, when a response is returned,
|
623
|
+
# updates are not immediately manifested in the Product queried by GetProduct or
|
624
|
+
# ListProducts. Local inventory information can only be modified using this
|
625
|
+
# method. CreateProduct and UpdateProduct has no effect on local inventories.
|
626
|
+
# This feature is only available for users who have Retail Search enabled.
|
627
|
+
# Please enable Retail Search on Cloud Console before using this feature.
|
628
|
+
# @param [String] product
|
629
|
+
# Required. Full resource name of Product, such as `projects/*/locations/global/
|
630
|
+
# catalogs/default_catalog/branches/default_branch/products/some_product_id`. If
|
631
|
+
# the caller does not have permission to access the Product, regardless of
|
632
|
+
# whether or not it exists, a PERMISSION_DENIED error is returned.
|
633
|
+
# @param [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaAddLocalInventoriesRequest] google_cloud_retail_v2beta_add_local_inventories_request_object
|
634
|
+
# @param [String] fields
|
635
|
+
# Selector specifying which fields to include in a partial response.
|
636
|
+
# @param [String] quota_user
|
637
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
638
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
639
|
+
# @param [Google::Apis::RequestOptions] options
|
640
|
+
# Request-specific options
|
641
|
+
#
|
642
|
+
# @yield [result, err] Result & error if block supplied
|
643
|
+
# @yieldparam result [Google::Apis::RetailV2beta::GoogleLongrunningOperation] parsed result object
|
644
|
+
# @yieldparam err [StandardError] error object if request failed
|
645
|
+
#
|
646
|
+
# @return [Google::Apis::RetailV2beta::GoogleLongrunningOperation]
|
647
|
+
#
|
648
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
649
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
650
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
651
|
+
def add_project_location_catalog_branch_product_local_inventories(product, google_cloud_retail_v2beta_add_local_inventories_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
652
|
+
command = make_simple_command(:post, 'v2beta/{+product}:addLocalInventories', options)
|
653
|
+
command.request_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaAddLocalInventoriesRequest::Representation
|
654
|
+
command.request_object = google_cloud_retail_v2beta_add_local_inventories_request_object
|
655
|
+
command.response_representation = Google::Apis::RetailV2beta::GoogleLongrunningOperation::Representation
|
656
|
+
command.response_class = Google::Apis::RetailV2beta::GoogleLongrunningOperation
|
657
|
+
command.params['product'] = product unless product.nil?
|
658
|
+
command.query['fields'] = fields unless fields.nil?
|
659
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
660
|
+
execute_or_queue_command(command, &block)
|
661
|
+
end
|
662
|
+
|
549
663
|
# Creates a Product.
|
550
664
|
# @param [String] parent
|
551
665
|
# Required. The parent catalog resource name, such as `projects/*/locations/
|
@@ -815,9 +929,8 @@ module Google
|
|
815
929
|
# enqueued and processed downstream. As a consequence, when a response is
|
816
930
|
# returned, the removed place IDs are not immediately manifested in the Product
|
817
931
|
# queried by GetProduct or ListProducts. This feature is only available for
|
818
|
-
# users who have Retail Search enabled. Please
|
819
|
-
#
|
820
|
-
# using Retail Search.
|
932
|
+
# users who have Retail Search enabled. Please enable Retail Search on Cloud
|
933
|
+
# Console before using this feature.
|
821
934
|
# @param [String] product
|
822
935
|
# Required. Full resource name of Product, such as `projects/*/locations/global/
|
823
936
|
# catalogs/default_catalog/branches/default_branch/products/some_product_id`. If
|
@@ -853,6 +966,50 @@ module Google
|
|
853
966
|
execute_or_queue_command(command, &block)
|
854
967
|
end
|
855
968
|
|
969
|
+
# Remove local inventory information for a Product at a list of places at a
|
970
|
+
# removal timestamp. This process is asynchronous. If the request is valid, the
|
971
|
+
# removal will be enqueued and processed downstream. As a consequence, when a
|
972
|
+
# response is returned, removals are not immediately manifested in the Product
|
973
|
+
# queried by GetProduct or ListProducts. Local inventory information can only be
|
974
|
+
# removed using this method. CreateProduct and UpdateProduct has no effect on
|
975
|
+
# local inventories. This feature is only available for users who have Retail
|
976
|
+
# Search enabled. Please enable Retail Search on Cloud Console before using this
|
977
|
+
# feature.
|
978
|
+
# @param [String] product
|
979
|
+
# Required. Full resource name of Product, such as `projects/*/locations/global/
|
980
|
+
# catalogs/default_catalog/branches/default_branch/products/some_product_id`. If
|
981
|
+
# the caller does not have permission to access the Product, regardless of
|
982
|
+
# whether or not it exists, a PERMISSION_DENIED error is returned.
|
983
|
+
# @param [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaRemoveLocalInventoriesRequest] google_cloud_retail_v2beta_remove_local_inventories_request_object
|
984
|
+
# @param [String] fields
|
985
|
+
# Selector specifying which fields to include in a partial response.
|
986
|
+
# @param [String] quota_user
|
987
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
988
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
989
|
+
# @param [Google::Apis::RequestOptions] options
|
990
|
+
# Request-specific options
|
991
|
+
#
|
992
|
+
# @yield [result, err] Result & error if block supplied
|
993
|
+
# @yieldparam result [Google::Apis::RetailV2beta::GoogleLongrunningOperation] parsed result object
|
994
|
+
# @yieldparam err [StandardError] error object if request failed
|
995
|
+
#
|
996
|
+
# @return [Google::Apis::RetailV2beta::GoogleLongrunningOperation]
|
997
|
+
#
|
998
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
999
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1000
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1001
|
+
def remove_project_location_catalog_branch_product_local_inventories(product, google_cloud_retail_v2beta_remove_local_inventories_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
1002
|
+
command = make_simple_command(:post, 'v2beta/{+product}:removeLocalInventories', options)
|
1003
|
+
command.request_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaRemoveLocalInventoriesRequest::Representation
|
1004
|
+
command.request_object = google_cloud_retail_v2beta_remove_local_inventories_request_object
|
1005
|
+
command.response_representation = Google::Apis::RetailV2beta::GoogleLongrunningOperation::Representation
|
1006
|
+
command.response_class = Google::Apis::RetailV2beta::GoogleLongrunningOperation
|
1007
|
+
command.params['product'] = product unless product.nil?
|
1008
|
+
command.query['fields'] = fields unless fields.nil?
|
1009
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1010
|
+
execute_or_queue_command(command, &block)
|
1011
|
+
end
|
1012
|
+
|
856
1013
|
# Updates inventory information for a Product while respecting the last update
|
857
1014
|
# timestamps of each inventory field. This process is asynchronous and does not
|
858
1015
|
# require the Product to exist before updating fulfillment information. If the
|
@@ -869,9 +1026,8 @@ module Google
|
|
869
1026
|
# SetInventoryRequest.set_mask, then any existing inventory information will be
|
870
1027
|
# preserved. Pre-existing inventory information can only be updated with
|
871
1028
|
# SetInventory, AddFulfillmentPlaces, and RemoveFulfillmentPlaces. This feature
|
872
|
-
# is only available for users who have Retail Search enabled. Please
|
873
|
-
#
|
874
|
-
# are interested in using Retail Search.
|
1029
|
+
# is only available for users who have Retail Search enabled. Please enable
|
1030
|
+
# Retail Search on Cloud Console before using this feature.
|
875
1031
|
# @param [String] name
|
876
1032
|
# Immutable. Full resource name of the product, such as `projects/*/locations/
|
877
1033
|
# global/catalogs/default_catalog/branches/default_branch/products/product_id`.
|
@@ -905,11 +1061,12 @@ module Google
|
|
905
1061
|
execute_or_queue_command(command, &block)
|
906
1062
|
end
|
907
1063
|
|
908
|
-
# Bulk import of processed completion dataset. Request processing
|
909
|
-
#
|
910
|
-
#
|
911
|
-
#
|
912
|
-
#
|
1064
|
+
# Bulk import of processed completion dataset. Request processing is
|
1065
|
+
# asynchronous. Partial updating is not supported. The operation is successfully
|
1066
|
+
# finished only after the imported suggestions are indexed successfully and
|
1067
|
+
# ready for serving. The process takes hours. This feature is only available for
|
1068
|
+
# users who have Retail Search enabled. Please enable Retail Search on Cloud
|
1069
|
+
# Console before using this feature.
|
913
1070
|
# @param [String] parent
|
914
1071
|
# Required. The catalog which the suggestions dataset belongs to. Format: `
|
915
1072
|
# projects/1234/locations/global/catalogs/default_catalog`.
|
@@ -1214,7 +1371,8 @@ module Google
|
|
1214
1371
|
# Makes a recommendation prediction.
|
1215
1372
|
# @param [String] placement
|
1216
1373
|
# Required. Full resource name of the format: `name=projects/*/locations/global/
|
1217
|
-
# catalogs/default_catalog/placements/*`
|
1374
|
+
# catalogs/default_catalog/placements/*` or `name=projects/*/locations/global/
|
1375
|
+
# catalogs/default_catalog/servingConfigs/*` The ID of the Recommendations AI
|
1218
1376
|
# placement. Before you can request predictions from your model, you must create
|
1219
1377
|
# at least one placement for it. For more information, see [Managing placements](
|
1220
1378
|
# https://cloud.google.com/retail/recommendations-ai/docs/manage-placements).
|
@@ -1251,13 +1409,14 @@ module Google
|
|
1251
1409
|
end
|
1252
1410
|
|
1253
1411
|
# Performs a search. This feature is only available for users who have Retail
|
1254
|
-
# Search enabled. Please
|
1255
|
-
#
|
1412
|
+
# Search enabled. Please enable Retail Search on Cloud Console before using this
|
1413
|
+
# feature.
|
1256
1414
|
# @param [String] placement
|
1257
1415
|
# Required. The resource name of the search engine placement, such as `projects/*
|
1258
|
-
# /locations/global/catalogs/default_catalog/placements/default_search
|
1259
|
-
#
|
1260
|
-
#
|
1416
|
+
# /locations/global/catalogs/default_catalog/placements/default_search` or `
|
1417
|
+
# projects/*/locations/global/catalogs/default_catalog/servingConfigs/
|
1418
|
+
# default_serving_config` This field is used to identify the serving
|
1419
|
+
# configuration name and the set of models that will be used to make the search.
|
1261
1420
|
# @param [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaSearchRequest] google_cloud_retail_v2beta_search_request_object
|
1262
1421
|
# @param [String] fields
|
1263
1422
|
# Selector specifying which fields to include in a partial response.
|
@@ -1512,6 +1671,46 @@ module Google
|
|
1512
1671
|
execute_or_queue_command(command, &block)
|
1513
1672
|
end
|
1514
1673
|
|
1674
|
+
# Makes a recommendation prediction.
|
1675
|
+
# @param [String] placement
|
1676
|
+
# Required. Full resource name of the format: `name=projects/*/locations/global/
|
1677
|
+
# catalogs/default_catalog/placements/*` or `name=projects/*/locations/global/
|
1678
|
+
# catalogs/default_catalog/servingConfigs/*` The ID of the Recommendations AI
|
1679
|
+
# placement. Before you can request predictions from your model, you must create
|
1680
|
+
# at least one placement for it. For more information, see [Managing placements](
|
1681
|
+
# https://cloud.google.com/retail/recommendations-ai/docs/manage-placements).
|
1682
|
+
# The full list of available placements can be seen at https://console.cloud.
|
1683
|
+
# google.com/recommendation/catalogs/default_catalog/placements
|
1684
|
+
# @param [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaPredictRequest] google_cloud_retail_v2beta_predict_request_object
|
1685
|
+
# @param [String] fields
|
1686
|
+
# Selector specifying which fields to include in a partial response.
|
1687
|
+
# @param [String] quota_user
|
1688
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1689
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1690
|
+
# @param [Google::Apis::RequestOptions] options
|
1691
|
+
# Request-specific options
|
1692
|
+
#
|
1693
|
+
# @yield [result, err] Result & error if block supplied
|
1694
|
+
# @yieldparam result [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaPredictResponse] parsed result object
|
1695
|
+
# @yieldparam err [StandardError] error object if request failed
|
1696
|
+
#
|
1697
|
+
# @return [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaPredictResponse]
|
1698
|
+
#
|
1699
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1700
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1701
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1702
|
+
def predict_project_location_catalog_serving_config(placement, google_cloud_retail_v2beta_predict_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
1703
|
+
command = make_simple_command(:post, 'v2beta/{+placement}:predict', options)
|
1704
|
+
command.request_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaPredictRequest::Representation
|
1705
|
+
command.request_object = google_cloud_retail_v2beta_predict_request_object
|
1706
|
+
command.response_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaPredictResponse::Representation
|
1707
|
+
command.response_class = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaPredictResponse
|
1708
|
+
command.params['placement'] = placement unless placement.nil?
|
1709
|
+
command.query['fields'] = fields unless fields.nil?
|
1710
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1711
|
+
execute_or_queue_command(command, &block)
|
1712
|
+
end
|
1713
|
+
|
1515
1714
|
# Disables a Control on the specified ServingConfig. The control is removed from
|
1516
1715
|
# the ServingConfig. Returns a NOT_FOUND error if the Control is not enabled for
|
1517
1716
|
# the ServingConfig.
|
@@ -1549,6 +1748,45 @@ module Google
|
|
1549
1748
|
execute_or_queue_command(command, &block)
|
1550
1749
|
end
|
1551
1750
|
|
1751
|
+
# Performs a search. This feature is only available for users who have Retail
|
1752
|
+
# Search enabled. Please enable Retail Search on Cloud Console before using this
|
1753
|
+
# feature.
|
1754
|
+
# @param [String] placement
|
1755
|
+
# Required. The resource name of the search engine placement, such as `projects/*
|
1756
|
+
# /locations/global/catalogs/default_catalog/placements/default_search` or `
|
1757
|
+
# projects/*/locations/global/catalogs/default_catalog/servingConfigs/
|
1758
|
+
# default_serving_config` This field is used to identify the serving
|
1759
|
+
# configuration name and the set of models that will be used to make the search.
|
1760
|
+
# @param [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaSearchRequest] google_cloud_retail_v2beta_search_request_object
|
1761
|
+
# @param [String] fields
|
1762
|
+
# Selector specifying which fields to include in a partial response.
|
1763
|
+
# @param [String] quota_user
|
1764
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1765
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1766
|
+
# @param [Google::Apis::RequestOptions] options
|
1767
|
+
# Request-specific options
|
1768
|
+
#
|
1769
|
+
# @yield [result, err] Result & error if block supplied
|
1770
|
+
# @yieldparam result [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaSearchResponse] parsed result object
|
1771
|
+
# @yieldparam err [StandardError] error object if request failed
|
1772
|
+
#
|
1773
|
+
# @return [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaSearchResponse]
|
1774
|
+
#
|
1775
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1776
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1777
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1778
|
+
def search_project_location_catalog_serving_configs(placement, google_cloud_retail_v2beta_search_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
1779
|
+
command = make_simple_command(:post, 'v2beta/{+placement}:search', options)
|
1780
|
+
command.request_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaSearchRequest::Representation
|
1781
|
+
command.request_object = google_cloud_retail_v2beta_search_request_object
|
1782
|
+
command.response_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaSearchResponse::Representation
|
1783
|
+
command.response_class = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaSearchResponse
|
1784
|
+
command.params['placement'] = placement unless placement.nil?
|
1785
|
+
command.query['fields'] = fields unless fields.nil?
|
1786
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1787
|
+
execute_or_queue_command(command, &block)
|
1788
|
+
end
|
1789
|
+
|
1552
1790
|
# Writes a single user event from the browser. This uses a GET request to due to
|
1553
1791
|
# browser restriction of POST-ing to a 3rd party domain. This method is used
|
1554
1792
|
# only by the Retail API JavaScript pixel and Google Tag Manager. Users should
|
@@ -1671,13 +1909,14 @@ module Google
|
|
1671
1909
|
execute_or_queue_command(command, &block)
|
1672
1910
|
end
|
1673
1911
|
|
1674
|
-
#
|
1675
|
-
#
|
1676
|
-
#
|
1912
|
+
# Starts a user event rejoin operation with latest product catalog. Events will
|
1913
|
+
# not be annotated with detailed product information if product is missing from
|
1914
|
+
# the catalog at the time the user event is ingested, and these events are
|
1677
1915
|
# stored as unjoined events with a limited usage on training and serving. This
|
1678
|
-
#
|
1916
|
+
# method can be used to start a join operation on specified events with latest
|
1679
1917
|
# version of product catalog. It can also be used to correct events joined with
|
1680
|
-
# wrong product catalog.
|
1918
|
+
# the wrong product catalog. A rejoin operation can take hours or days to
|
1919
|
+
# complete.
|
1681
1920
|
# @param [String] parent
|
1682
1921
|
# Required. The parent catalog resource name, such as `projects/1234/locations/
|
1683
1922
|
# global/catalogs/default_catalog`.
|
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.
|
4
|
+
version: 0.34.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-
|
11
|
+
date: 2022-04-04 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.
|
61
|
+
documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2beta/v0.34.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: []
|