google-apis-retail_v2alpha 0.32.0 → 0.35.0
Sign up to get free protection for your applications and to get access to all the features.
@@ -16,13 +16,13 @@ module Google
|
|
16
16
|
module Apis
|
17
17
|
module RetailV2alpha
|
18
18
|
# Version of the google-apis-retail_v2alpha gem
|
19
|
-
GEM_VERSION = "0.
|
19
|
+
GEM_VERSION = "0.35.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 = "
|
25
|
+
REVISION = "20220324"
|
26
26
|
end
|
27
27
|
end
|
28
28
|
end
|
@@ -76,6 +76,18 @@ module Google
|
|
76
76
|
include Google::Apis::Core::JsonObjectSupport
|
77
77
|
end
|
78
78
|
|
79
|
+
class GoogleCloudRetailV2AddLocalInventoriesMetadata
|
80
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
81
|
+
|
82
|
+
include Google::Apis::Core::JsonObjectSupport
|
83
|
+
end
|
84
|
+
|
85
|
+
class GoogleCloudRetailV2AddLocalInventoriesResponse
|
86
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
87
|
+
|
88
|
+
include Google::Apis::Core::JsonObjectSupport
|
89
|
+
end
|
90
|
+
|
79
91
|
class GoogleCloudRetailV2ImportCompletionDataResponse
|
80
92
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
81
93
|
|
@@ -142,6 +154,18 @@ module Google
|
|
142
154
|
include Google::Apis::Core::JsonObjectSupport
|
143
155
|
end
|
144
156
|
|
157
|
+
class GoogleCloudRetailV2RemoveLocalInventoriesMetadata
|
158
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
159
|
+
|
160
|
+
include Google::Apis::Core::JsonObjectSupport
|
161
|
+
end
|
162
|
+
|
163
|
+
class GoogleCloudRetailV2RemoveLocalInventoriesResponse
|
164
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
165
|
+
|
166
|
+
include Google::Apis::Core::JsonObjectSupport
|
167
|
+
end
|
168
|
+
|
145
169
|
class GoogleCloudRetailV2SetInventoryMetadata
|
146
170
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
147
171
|
|
@@ -262,6 +286,12 @@ module Google
|
|
262
286
|
include Google::Apis::Core::JsonObjectSupport
|
263
287
|
end
|
264
288
|
|
289
|
+
class GoogleCloudRetailV2alphaCompletionConfig
|
290
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
291
|
+
|
292
|
+
include Google::Apis::Core::JsonObjectSupport
|
293
|
+
end
|
294
|
+
|
265
295
|
class GoogleCloudRetailV2alphaCompletionDataInputConfig
|
266
296
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
267
297
|
|
@@ -526,6 +556,24 @@ module Google
|
|
526
556
|
include Google::Apis::Core::JsonObjectSupport
|
527
557
|
end
|
528
558
|
|
559
|
+
class GoogleCloudRetailV2alphaPurgeProductsMetadata
|
560
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
561
|
+
|
562
|
+
include Google::Apis::Core::JsonObjectSupport
|
563
|
+
end
|
564
|
+
|
565
|
+
class GoogleCloudRetailV2alphaPurgeProductsRequest
|
566
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
567
|
+
|
568
|
+
include Google::Apis::Core::JsonObjectSupport
|
569
|
+
end
|
570
|
+
|
571
|
+
class GoogleCloudRetailV2alphaPurgeProductsResponse
|
572
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
573
|
+
|
574
|
+
include Google::Apis::Core::JsonObjectSupport
|
575
|
+
end
|
576
|
+
|
529
577
|
class GoogleCloudRetailV2alphaPurgeUserEventsRequest
|
530
578
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
531
579
|
|
@@ -820,6 +868,18 @@ module Google
|
|
820
868
|
include Google::Apis::Core::JsonObjectSupport
|
821
869
|
end
|
822
870
|
|
871
|
+
class GoogleCloudRetailV2betaAddLocalInventoriesMetadata
|
872
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
873
|
+
|
874
|
+
include Google::Apis::Core::JsonObjectSupport
|
875
|
+
end
|
876
|
+
|
877
|
+
class GoogleCloudRetailV2betaAddLocalInventoriesResponse
|
878
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
879
|
+
|
880
|
+
include Google::Apis::Core::JsonObjectSupport
|
881
|
+
end
|
882
|
+
|
823
883
|
class GoogleCloudRetailV2betaExportErrorsConfig
|
824
884
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
825
885
|
|
@@ -910,6 +970,18 @@ module Google
|
|
910
970
|
include Google::Apis::Core::JsonObjectSupport
|
911
971
|
end
|
912
972
|
|
973
|
+
class GoogleCloudRetailV2betaRemoveLocalInventoriesMetadata
|
974
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
975
|
+
|
976
|
+
include Google::Apis::Core::JsonObjectSupport
|
977
|
+
end
|
978
|
+
|
979
|
+
class GoogleCloudRetailV2betaRemoveLocalInventoriesResponse
|
980
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
981
|
+
|
982
|
+
include Google::Apis::Core::JsonObjectSupport
|
983
|
+
end
|
984
|
+
|
913
985
|
class GoogleCloudRetailV2betaSetInventoryMetadata
|
914
986
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
915
987
|
|
@@ -1039,6 +1111,18 @@ module Google
|
|
1039
1111
|
end
|
1040
1112
|
end
|
1041
1113
|
|
1114
|
+
class GoogleCloudRetailV2AddLocalInventoriesMetadata
|
1115
|
+
# @private
|
1116
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
1117
|
+
end
|
1118
|
+
end
|
1119
|
+
|
1120
|
+
class GoogleCloudRetailV2AddLocalInventoriesResponse
|
1121
|
+
# @private
|
1122
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
1123
|
+
end
|
1124
|
+
end
|
1125
|
+
|
1042
1126
|
class GoogleCloudRetailV2ImportCompletionDataResponse
|
1043
1127
|
# @private
|
1044
1128
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -1126,6 +1210,18 @@ module Google
|
|
1126
1210
|
end
|
1127
1211
|
end
|
1128
1212
|
|
1213
|
+
class GoogleCloudRetailV2RemoveLocalInventoriesMetadata
|
1214
|
+
# @private
|
1215
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
1216
|
+
end
|
1217
|
+
end
|
1218
|
+
|
1219
|
+
class GoogleCloudRetailV2RemoveLocalInventoriesResponse
|
1220
|
+
# @private
|
1221
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
1222
|
+
end
|
1223
|
+
end
|
1224
|
+
|
1129
1225
|
class GoogleCloudRetailV2SetInventoryMetadata
|
1130
1226
|
# @private
|
1131
1227
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -1296,6 +1392,26 @@ module Google
|
|
1296
1392
|
end
|
1297
1393
|
end
|
1298
1394
|
|
1395
|
+
class GoogleCloudRetailV2alphaCompletionConfig
|
1396
|
+
# @private
|
1397
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
1398
|
+
property :allowlist_input_config, as: 'allowlistInputConfig', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCompletionDataInputConfig, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCompletionDataInputConfig::Representation
|
1399
|
+
|
1400
|
+
property :auto_learning, as: 'autoLearning'
|
1401
|
+
property :denylist_input_config, as: 'denylistInputConfig', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCompletionDataInputConfig, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCompletionDataInputConfig::Representation
|
1402
|
+
|
1403
|
+
property :last_allowlist_import_operation, as: 'lastAllowlistImportOperation'
|
1404
|
+
property :last_denylist_import_operation, as: 'lastDenylistImportOperation'
|
1405
|
+
property :last_suggestions_import_operation, as: 'lastSuggestionsImportOperation'
|
1406
|
+
property :matching_order, as: 'matchingOrder'
|
1407
|
+
property :max_suggestions, as: 'maxSuggestions'
|
1408
|
+
property :min_prefix_length, as: 'minPrefixLength'
|
1409
|
+
property :name, as: 'name'
|
1410
|
+
property :suggestions_input_config, as: 'suggestionsInputConfig', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCompletionDataInputConfig, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCompletionDataInputConfig::Representation
|
1411
|
+
|
1412
|
+
end
|
1413
|
+
end
|
1414
|
+
|
1299
1415
|
class GoogleCloudRetailV2alphaCompletionDataInputConfig
|
1300
1416
|
# @private
|
1301
1417
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -1349,6 +1465,7 @@ module Google
|
|
1349
1465
|
property :name, as: 'name'
|
1350
1466
|
property :rule, as: 'rule', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaRule, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaRule::Representation
|
1351
1467
|
|
1468
|
+
collection :search_solution_use_case, as: 'searchSolutionUseCase'
|
1352
1469
|
collection :solution_types, as: 'solutionTypes'
|
1353
1470
|
end
|
1354
1471
|
end
|
@@ -1566,6 +1683,7 @@ module Google
|
|
1566
1683
|
class Representation < Google::Apis::Core::JsonRepresentation
|
1567
1684
|
hash :attributes, as: 'attributes', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCustomAttribute, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCustomAttribute::Representation
|
1568
1685
|
|
1686
|
+
collection :fulfillment_types, as: 'fulfillmentTypes'
|
1569
1687
|
property :place_id, as: 'placeId'
|
1570
1688
|
property :price_info, as: 'priceInfo', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaPriceInfo, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaPriceInfo::Representation
|
1571
1689
|
|
@@ -1757,6 +1875,32 @@ module Google
|
|
1757
1875
|
end
|
1758
1876
|
end
|
1759
1877
|
|
1878
|
+
class GoogleCloudRetailV2alphaPurgeProductsMetadata
|
1879
|
+
# @private
|
1880
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
1881
|
+
property :create_time, as: 'createTime'
|
1882
|
+
property :failure_count, :numeric_string => true, as: 'failureCount'
|
1883
|
+
property :success_count, :numeric_string => true, as: 'successCount'
|
1884
|
+
property :update_time, as: 'updateTime'
|
1885
|
+
end
|
1886
|
+
end
|
1887
|
+
|
1888
|
+
class GoogleCloudRetailV2alphaPurgeProductsRequest
|
1889
|
+
# @private
|
1890
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
1891
|
+
property :filter, as: 'filter'
|
1892
|
+
property :force, as: 'force'
|
1893
|
+
end
|
1894
|
+
end
|
1895
|
+
|
1896
|
+
class GoogleCloudRetailV2alphaPurgeProductsResponse
|
1897
|
+
# @private
|
1898
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
1899
|
+
property :purge_count, :numeric_string => true, as: 'purgeCount'
|
1900
|
+
collection :purge_sample, as: 'purgeSample'
|
1901
|
+
end
|
1902
|
+
end
|
1903
|
+
|
1760
1904
|
class GoogleCloudRetailV2alphaPurgeUserEventsRequest
|
1761
1905
|
# @private
|
1762
1906
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -2246,6 +2390,18 @@ module Google
|
|
2246
2390
|
end
|
2247
2391
|
end
|
2248
2392
|
|
2393
|
+
class GoogleCloudRetailV2betaAddLocalInventoriesMetadata
|
2394
|
+
# @private
|
2395
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
2396
|
+
end
|
2397
|
+
end
|
2398
|
+
|
2399
|
+
class GoogleCloudRetailV2betaAddLocalInventoriesResponse
|
2400
|
+
# @private
|
2401
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
2402
|
+
end
|
2403
|
+
end
|
2404
|
+
|
2249
2405
|
class GoogleCloudRetailV2betaExportErrorsConfig
|
2250
2406
|
# @private
|
2251
2407
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -2368,6 +2524,18 @@ module Google
|
|
2368
2524
|
end
|
2369
2525
|
end
|
2370
2526
|
|
2527
|
+
class GoogleCloudRetailV2betaRemoveLocalInventoriesMetadata
|
2528
|
+
# @private
|
2529
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
2530
|
+
end
|
2531
|
+
end
|
2532
|
+
|
2533
|
+
class GoogleCloudRetailV2betaRemoveLocalInventoriesResponse
|
2534
|
+
# @private
|
2535
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
2536
|
+
end
|
2537
|
+
end
|
2538
|
+
|
2371
2539
|
class GoogleCloudRetailV2betaSetInventoryMetadata
|
2372
2540
|
# @private
|
2373
2541
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -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::RetailV2alpha::GoogleCloudRetailV2alphaCompletionConfig] parsed result object
|
172
|
+
# @yieldparam err [StandardError] error object if request failed
|
173
|
+
#
|
174
|
+
# @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCompletionConfig]
|
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, 'v2alpha/{+name}', options)
|
181
|
+
command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCompletionConfig::Representation
|
182
|
+
command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCompletionConfig
|
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::RetailV2alpha::GoogleCloudRetailV2alphaCompletionConfig] google_cloud_retail_v2alpha_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::RetailV2alpha::GoogleCloudRetailV2alphaCompletionConfig] parsed result object
|
418
|
+
# @yieldparam err [StandardError] error object if request failed
|
419
|
+
#
|
420
|
+
# @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCompletionConfig]
|
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_v2alpha_completion_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
426
|
+
command = make_simple_command(:patch, 'v2alpha/{+name}', options)
|
427
|
+
command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCompletionConfig::Representation
|
428
|
+
command.request_object = google_cloud_retail_v2alpha_completion_config_object
|
429
|
+
command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCompletionConfig::Representation
|
430
|
+
command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCompletionConfig
|
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
|
@@ -555,8 +624,7 @@ module Google
|
|
555
624
|
# ListProducts. Local inventory information can only be modified using this
|
556
625
|
# method. CreateProduct and UpdateProduct has no effect on local inventories.
|
557
626
|
# This feature is only available for users who have Retail Search enabled.
|
558
|
-
# Please
|
559
|
-
# sales if you are interested in using Retail Search.
|
627
|
+
# Please enable Retail Search on Cloud Console before using this feature.
|
560
628
|
# @param [String] product
|
561
629
|
# Required. Full resource name of Product, such as `projects/*/locations/global/
|
562
630
|
# catalogs/default_catalog/branches/default_branch/products/some_product_id`. If
|
@@ -860,15 +928,55 @@ module Google
|
|
860
928
|
execute_or_queue_command(command, &block)
|
861
929
|
end
|
862
930
|
|
931
|
+
# Permanently deletes all selected Products under a branch. This process is
|
932
|
+
# asynchronous. If the request is valid, the removal will be enqueued and
|
933
|
+
# processed offline. Depending on the number of Products, this operation could
|
934
|
+
# take hours to complete. Before the operation completes, some Products may
|
935
|
+
# still be returned by GetProduct or ListProducts. Depending on the number of
|
936
|
+
# Products, this operation could take hours to complete. To get a sample of
|
937
|
+
# Products that would be deleted, set PurgeProductsRequest.force to false.
|
938
|
+
# @param [String] parent
|
939
|
+
# Required. The resource name of the branch under which the products are created.
|
940
|
+
# The format is `projects/$`projectId`/locations/global/catalogs/$`catalogId`/
|
941
|
+
# branches/$`branchId``
|
942
|
+
# @param [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaPurgeProductsRequest] google_cloud_retail_v2alpha_purge_products_request_object
|
943
|
+
# @param [String] fields
|
944
|
+
# Selector specifying which fields to include in a partial response.
|
945
|
+
# @param [String] quota_user
|
946
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
947
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
948
|
+
# @param [Google::Apis::RequestOptions] options
|
949
|
+
# Request-specific options
|
950
|
+
#
|
951
|
+
# @yield [result, err] Result & error if block supplied
|
952
|
+
# @yieldparam result [Google::Apis::RetailV2alpha::GoogleLongrunningOperation] parsed result object
|
953
|
+
# @yieldparam err [StandardError] error object if request failed
|
954
|
+
#
|
955
|
+
# @return [Google::Apis::RetailV2alpha::GoogleLongrunningOperation]
|
956
|
+
#
|
957
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
958
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
959
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
960
|
+
def purge_project_location_catalog_branch_product(parent, google_cloud_retail_v2alpha_purge_products_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
961
|
+
command = make_simple_command(:post, 'v2alpha/{+parent}/products:purge', options)
|
962
|
+
command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaPurgeProductsRequest::Representation
|
963
|
+
command.request_object = google_cloud_retail_v2alpha_purge_products_request_object
|
964
|
+
command.response_representation = Google::Apis::RetailV2alpha::GoogleLongrunningOperation::Representation
|
965
|
+
command.response_class = Google::Apis::RetailV2alpha::GoogleLongrunningOperation
|
966
|
+
command.params['parent'] = parent unless parent.nil?
|
967
|
+
command.query['fields'] = fields unless fields.nil?
|
968
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
969
|
+
execute_or_queue_command(command, &block)
|
970
|
+
end
|
971
|
+
|
863
972
|
# Incrementally removes place IDs from a Product.fulfillment_info.place_ids.
|
864
973
|
# This process is asynchronous and does not require the Product to exist before
|
865
974
|
# updating fulfillment information. If the request is valid, the update will be
|
866
975
|
# enqueued and processed downstream. As a consequence, when a response is
|
867
976
|
# returned, the removed place IDs are not immediately manifested in the Product
|
868
977
|
# queried by GetProduct or ListProducts. This feature is only available for
|
869
|
-
# users who have Retail Search enabled. Please
|
870
|
-
#
|
871
|
-
# using Retail Search.
|
978
|
+
# users who have Retail Search enabled. Please enable Retail Search on Cloud
|
979
|
+
# Console before using this feature.
|
872
980
|
# @param [String] product
|
873
981
|
# Required. Full resource name of Product, such as `projects/*/locations/global/
|
874
982
|
# catalogs/default_catalog/branches/default_branch/products/some_product_id`. If
|
@@ -911,8 +1019,8 @@ module Google
|
|
911
1019
|
# queried by GetProduct or ListProducts. Local inventory information can only be
|
912
1020
|
# removed using this method. CreateProduct and UpdateProduct has no effect on
|
913
1021
|
# local inventories. This feature is only available for users who have Retail
|
914
|
-
# Search enabled. Please
|
915
|
-
#
|
1022
|
+
# Search enabled. Please enable Retail Search on Cloud Console before using this
|
1023
|
+
# feature.
|
916
1024
|
# @param [String] product
|
917
1025
|
# Required. Full resource name of Product, such as `projects/*/locations/global/
|
918
1026
|
# catalogs/default_catalog/branches/default_branch/products/some_product_id`. If
|
@@ -964,9 +1072,8 @@ module Google
|
|
964
1072
|
# SetInventoryRequest.set_mask, then any existing inventory information will be
|
965
1073
|
# preserved. Pre-existing inventory information can only be updated with
|
966
1074
|
# SetInventory, AddFulfillmentPlaces, and RemoveFulfillmentPlaces. This feature
|
967
|
-
# is only available for users who have Retail Search enabled. Please
|
968
|
-
#
|
969
|
-
# are interested in using Retail Search.
|
1075
|
+
# is only available for users who have Retail Search enabled. Please enable
|
1076
|
+
# Retail Search on Cloud Console before using this feature.
|
970
1077
|
# @param [String] name
|
971
1078
|
# Immutable. Full resource name of the product, such as `projects/*/locations/
|
972
1079
|
# global/catalogs/default_catalog/branches/default_branch/products/product_id`.
|
@@ -1000,11 +1107,12 @@ module Google
|
|
1000
1107
|
execute_or_queue_command(command, &block)
|
1001
1108
|
end
|
1002
1109
|
|
1003
|
-
# Bulk import of processed completion dataset. Request processing
|
1004
|
-
#
|
1005
|
-
#
|
1006
|
-
#
|
1007
|
-
#
|
1110
|
+
# Bulk import of processed completion dataset. Request processing is
|
1111
|
+
# asynchronous. Partial updating is not supported. The operation is successfully
|
1112
|
+
# finished only after the imported suggestions are indexed successfully and
|
1113
|
+
# ready for serving. The process takes hours. This feature is only available for
|
1114
|
+
# users who have Retail Search enabled. Please enable Retail Search on Cloud
|
1115
|
+
# Console before using this feature.
|
1008
1116
|
# @param [String] parent
|
1009
1117
|
# Required. The catalog which the suggestions dataset belongs to. Format: `
|
1010
1118
|
# projects/1234/locations/global/catalogs/default_catalog`.
|
@@ -1309,7 +1417,8 @@ module Google
|
|
1309
1417
|
# Makes a recommendation prediction.
|
1310
1418
|
# @param [String] placement
|
1311
1419
|
# Required. Full resource name of the format: `name=projects/*/locations/global/
|
1312
|
-
# catalogs/default_catalog/placements/*`
|
1420
|
+
# catalogs/default_catalog/placements/*` or `name=projects/*/locations/global/
|
1421
|
+
# catalogs/default_catalog/servingConfigs/*` The ID of the Recommendations AI
|
1313
1422
|
# placement. Before you can request predictions from your model, you must create
|
1314
1423
|
# at least one placement for it. For more information, see [Managing placements](
|
1315
1424
|
# https://cloud.google.com/retail/recommendations-ai/docs/manage-placements).
|
@@ -1346,13 +1455,14 @@ module Google
|
|
1346
1455
|
end
|
1347
1456
|
|
1348
1457
|
# Performs a search. This feature is only available for users who have Retail
|
1349
|
-
# Search enabled. Please
|
1350
|
-
#
|
1458
|
+
# Search enabled. Please enable Retail Search on Cloud Console before using this
|
1459
|
+
# feature.
|
1351
1460
|
# @param [String] placement
|
1352
1461
|
# Required. The resource name of the search engine placement, such as `projects/*
|
1353
|
-
# /locations/global/catalogs/default_catalog/placements/default_search
|
1354
|
-
#
|
1355
|
-
#
|
1462
|
+
# /locations/global/catalogs/default_catalog/placements/default_search` or `
|
1463
|
+
# projects/*/locations/global/catalogs/default_catalog/servingConfigs/
|
1464
|
+
# default_serving_config` This field is used to identify the serving
|
1465
|
+
# configuration name and the set of models that will be used to make the search.
|
1356
1466
|
# @param [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchRequest] google_cloud_retail_v2alpha_search_request_object
|
1357
1467
|
# @param [String] fields
|
1358
1468
|
# Selector specifying which fields to include in a partial response.
|
@@ -1607,6 +1717,46 @@ module Google
|
|
1607
1717
|
execute_or_queue_command(command, &block)
|
1608
1718
|
end
|
1609
1719
|
|
1720
|
+
# Makes a recommendation prediction.
|
1721
|
+
# @param [String] placement
|
1722
|
+
# Required. Full resource name of the format: `name=projects/*/locations/global/
|
1723
|
+
# catalogs/default_catalog/placements/*` or `name=projects/*/locations/global/
|
1724
|
+
# catalogs/default_catalog/servingConfigs/*` The ID of the Recommendations AI
|
1725
|
+
# placement. Before you can request predictions from your model, you must create
|
1726
|
+
# at least one placement for it. For more information, see [Managing placements](
|
1727
|
+
# https://cloud.google.com/retail/recommendations-ai/docs/manage-placements).
|
1728
|
+
# The full list of available placements can be seen at https://console.cloud.
|
1729
|
+
# google.com/recommendation/catalogs/default_catalog/placements
|
1730
|
+
# @param [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaPredictRequest] google_cloud_retail_v2alpha_predict_request_object
|
1731
|
+
# @param [String] fields
|
1732
|
+
# Selector specifying which fields to include in a partial response.
|
1733
|
+
# @param [String] quota_user
|
1734
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1735
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1736
|
+
# @param [Google::Apis::RequestOptions] options
|
1737
|
+
# Request-specific options
|
1738
|
+
#
|
1739
|
+
# @yield [result, err] Result & error if block supplied
|
1740
|
+
# @yieldparam result [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaPredictResponse] parsed result object
|
1741
|
+
# @yieldparam err [StandardError] error object if request failed
|
1742
|
+
#
|
1743
|
+
# @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaPredictResponse]
|
1744
|
+
#
|
1745
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1746
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1747
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1748
|
+
def predict_project_location_catalog_serving_config(placement, google_cloud_retail_v2alpha_predict_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
1749
|
+
command = make_simple_command(:post, 'v2alpha/{+placement}:predict', options)
|
1750
|
+
command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaPredictRequest::Representation
|
1751
|
+
command.request_object = google_cloud_retail_v2alpha_predict_request_object
|
1752
|
+
command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaPredictResponse::Representation
|
1753
|
+
command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaPredictResponse
|
1754
|
+
command.params['placement'] = placement unless placement.nil?
|
1755
|
+
command.query['fields'] = fields unless fields.nil?
|
1756
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1757
|
+
execute_or_queue_command(command, &block)
|
1758
|
+
end
|
1759
|
+
|
1610
1760
|
# Disables a Control on the specified ServingConfig. The control is removed from
|
1611
1761
|
# the ServingConfig. Returns a NOT_FOUND error if the Control is not enabled for
|
1612
1762
|
# the ServingConfig.
|
@@ -1644,6 +1794,45 @@ module Google
|
|
1644
1794
|
execute_or_queue_command(command, &block)
|
1645
1795
|
end
|
1646
1796
|
|
1797
|
+
# Performs a search. This feature is only available for users who have Retail
|
1798
|
+
# Search enabled. Please enable Retail Search on Cloud Console before using this
|
1799
|
+
# feature.
|
1800
|
+
# @param [String] placement
|
1801
|
+
# Required. The resource name of the search engine placement, such as `projects/*
|
1802
|
+
# /locations/global/catalogs/default_catalog/placements/default_search` or `
|
1803
|
+
# projects/*/locations/global/catalogs/default_catalog/servingConfigs/
|
1804
|
+
# default_serving_config` This field is used to identify the serving
|
1805
|
+
# configuration name and the set of models that will be used to make the search.
|
1806
|
+
# @param [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchRequest] google_cloud_retail_v2alpha_search_request_object
|
1807
|
+
# @param [String] fields
|
1808
|
+
# Selector specifying which fields to include in a partial response.
|
1809
|
+
# @param [String] quota_user
|
1810
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1811
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1812
|
+
# @param [Google::Apis::RequestOptions] options
|
1813
|
+
# Request-specific options
|
1814
|
+
#
|
1815
|
+
# @yield [result, err] Result & error if block supplied
|
1816
|
+
# @yieldparam result [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchResponse] parsed result object
|
1817
|
+
# @yieldparam err [StandardError] error object if request failed
|
1818
|
+
#
|
1819
|
+
# @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchResponse]
|
1820
|
+
#
|
1821
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1822
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1823
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1824
|
+
def search_project_location_catalog_serving_configs(placement, google_cloud_retail_v2alpha_search_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
1825
|
+
command = make_simple_command(:post, 'v2alpha/{+placement}:search', options)
|
1826
|
+
command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchRequest::Representation
|
1827
|
+
command.request_object = google_cloud_retail_v2alpha_search_request_object
|
1828
|
+
command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchResponse::Representation
|
1829
|
+
command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchResponse
|
1830
|
+
command.params['placement'] = placement unless placement.nil?
|
1831
|
+
command.query['fields'] = fields unless fields.nil?
|
1832
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1833
|
+
execute_or_queue_command(command, &block)
|
1834
|
+
end
|
1835
|
+
|
1647
1836
|
# Writes a single user event from the browser. This uses a GET request to due to
|
1648
1837
|
# browser restriction of POST-ing to a 3rd party domain. This method is used
|
1649
1838
|
# only by the Retail API JavaScript pixel and Google Tag Manager. Users should
|
@@ -1766,13 +1955,14 @@ module Google
|
|
1766
1955
|
execute_or_queue_command(command, &block)
|
1767
1956
|
end
|
1768
1957
|
|
1769
|
-
#
|
1770
|
-
#
|
1771
|
-
#
|
1958
|
+
# Starts a user event rejoin operation with latest product catalog. Events will
|
1959
|
+
# not be annotated with detailed product information if product is missing from
|
1960
|
+
# the catalog at the time the user event is ingested, and these events are
|
1772
1961
|
# stored as unjoined events with a limited usage on training and serving. This
|
1773
|
-
#
|
1962
|
+
# method can be used to start a join operation on specified events with latest
|
1774
1963
|
# version of product catalog. It can also be used to correct events joined with
|
1775
|
-
# wrong product catalog.
|
1964
|
+
# the wrong product catalog. A rejoin operation can take hours or days to
|
1965
|
+
# complete.
|
1776
1966
|
# @param [String] parent
|
1777
1967
|
# Required. The parent catalog resource name, such as `projects/1234/locations/
|
1778
1968
|
# global/catalogs/default_catalog`.
|