google-apis-retail_v2 0.46.0 → 0.49.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +12 -0
- data/lib/google/apis/retail_v2/classes.rb +745 -20
- data/lib/google/apis/retail_v2/gem_version.rb +2 -2
- data/lib/google/apis/retail_v2/representations.rb +297 -0
- data/lib/google/apis/retail_v2/service.rb +223 -6
- metadata +3 -3
|
@@ -126,6 +126,68 @@ module Google
|
|
|
126
126
|
execute_or_queue_command(command, &block)
|
|
127
127
|
end
|
|
128
128
|
|
|
129
|
+
# Gets an AttributesConfig.
|
|
130
|
+
# @param [String] name
|
|
131
|
+
# Required. Full AttributesConfig resource name. Format: `projects/`
|
|
132
|
+
# project_number`/locations/`location_id`/catalogs/`catalog_id`/attributesConfig`
|
|
133
|
+
# @param [String] fields
|
|
134
|
+
# Selector specifying which fields to include in a partial response.
|
|
135
|
+
# @param [String] quota_user
|
|
136
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
137
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
138
|
+
# @param [Google::Apis::RequestOptions] options
|
|
139
|
+
# Request-specific options
|
|
140
|
+
#
|
|
141
|
+
# @yield [result, err] Result & error if block supplied
|
|
142
|
+
# @yieldparam result [Google::Apis::RetailV2::GoogleCloudRetailV2AttributesConfig] parsed result object
|
|
143
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
144
|
+
#
|
|
145
|
+
# @return [Google::Apis::RetailV2::GoogleCloudRetailV2AttributesConfig]
|
|
146
|
+
#
|
|
147
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
148
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
149
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
150
|
+
def get_project_location_catalog_attributes_config(name, fields: nil, quota_user: nil, options: nil, &block)
|
|
151
|
+
command = make_simple_command(:get, 'v2/{+name}', options)
|
|
152
|
+
command.response_representation = Google::Apis::RetailV2::GoogleCloudRetailV2AttributesConfig::Representation
|
|
153
|
+
command.response_class = Google::Apis::RetailV2::GoogleCloudRetailV2AttributesConfig
|
|
154
|
+
command.params['name'] = name unless name.nil?
|
|
155
|
+
command.query['fields'] = fields unless fields.nil?
|
|
156
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
157
|
+
execute_or_queue_command(command, &block)
|
|
158
|
+
end
|
|
159
|
+
|
|
160
|
+
# Gets a CompletionConfig.
|
|
161
|
+
# @param [String] name
|
|
162
|
+
# Required. Full CompletionConfig resource name. Format: projects/`
|
|
163
|
+
# project_number`/locations/`location_id`/catalogs/`catalog_id`/completionConfig
|
|
164
|
+
# @param [String] fields
|
|
165
|
+
# Selector specifying which fields to include in a partial response.
|
|
166
|
+
# @param [String] quota_user
|
|
167
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
168
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
169
|
+
# @param [Google::Apis::RequestOptions] options
|
|
170
|
+
# Request-specific options
|
|
171
|
+
#
|
|
172
|
+
# @yield [result, err] Result & error if block supplied
|
|
173
|
+
# @yieldparam result [Google::Apis::RetailV2::GoogleCloudRetailV2CompletionConfig] parsed result object
|
|
174
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
175
|
+
#
|
|
176
|
+
# @return [Google::Apis::RetailV2::GoogleCloudRetailV2CompletionConfig]
|
|
177
|
+
#
|
|
178
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
179
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
180
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
181
|
+
def get_project_location_catalog_completion_config(name, fields: nil, quota_user: nil, options: nil, &block)
|
|
182
|
+
command = make_simple_command(:get, 'v2/{+name}', options)
|
|
183
|
+
command.response_representation = Google::Apis::RetailV2::GoogleCloudRetailV2CompletionConfig::Representation
|
|
184
|
+
command.response_class = Google::Apis::RetailV2::GoogleCloudRetailV2CompletionConfig
|
|
185
|
+
command.params['name'] = name unless name.nil?
|
|
186
|
+
command.query['fields'] = fields unless fields.nil?
|
|
187
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
188
|
+
execute_or_queue_command(command, &block)
|
|
189
|
+
end
|
|
190
|
+
|
|
129
191
|
# Get which branch is currently default branch set by CatalogService.
|
|
130
192
|
# SetDefaultBranch method under a specified parent catalog.
|
|
131
193
|
# @param [String] catalog
|
|
@@ -290,6 +352,161 @@ module Google
|
|
|
290
352
|
execute_or_queue_command(command, &block)
|
|
291
353
|
end
|
|
292
354
|
|
|
355
|
+
# Updates the AttributesConfig. The catalog attributes in the request will be
|
|
356
|
+
# updated in the catalog, or inserted if they do not exist. Existing catalog
|
|
357
|
+
# attributes not included in the request will remain unchanged. Attributes that
|
|
358
|
+
# are assigned to products, but do not exist at the catalog level, are always
|
|
359
|
+
# included in the response. The product attribute is assigned default values for
|
|
360
|
+
# missing catalog attribute fields, e.g., searchable and dynamic facetable
|
|
361
|
+
# options.
|
|
362
|
+
# @param [String] name
|
|
363
|
+
# Required. Immutable. The fully qualified resource name of the attribute config.
|
|
364
|
+
# Format: `projects/*/locations/*/catalogs/*/attributesConfig`
|
|
365
|
+
# @param [Google::Apis::RetailV2::GoogleCloudRetailV2AttributesConfig] google_cloud_retail_v2_attributes_config_object
|
|
366
|
+
# @param [String] update_mask
|
|
367
|
+
# Indicates which fields in the provided AttributesConfig to update. The
|
|
368
|
+
# following is the only supported field: * AttributesConfig.catalog_attributes
|
|
369
|
+
# If not set, all supported fields are updated.
|
|
370
|
+
# @param [String] fields
|
|
371
|
+
# Selector specifying which fields to include in a partial response.
|
|
372
|
+
# @param [String] quota_user
|
|
373
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
374
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
375
|
+
# @param [Google::Apis::RequestOptions] options
|
|
376
|
+
# Request-specific options
|
|
377
|
+
#
|
|
378
|
+
# @yield [result, err] Result & error if block supplied
|
|
379
|
+
# @yieldparam result [Google::Apis::RetailV2::GoogleCloudRetailV2AttributesConfig] parsed result object
|
|
380
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
381
|
+
#
|
|
382
|
+
# @return [Google::Apis::RetailV2::GoogleCloudRetailV2AttributesConfig]
|
|
383
|
+
#
|
|
384
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
385
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
386
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
387
|
+
def update_project_location_catalog_attributes_config(name, google_cloud_retail_v2_attributes_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
388
|
+
command = make_simple_command(:patch, 'v2/{+name}', options)
|
|
389
|
+
command.request_representation = Google::Apis::RetailV2::GoogleCloudRetailV2AttributesConfig::Representation
|
|
390
|
+
command.request_object = google_cloud_retail_v2_attributes_config_object
|
|
391
|
+
command.response_representation = Google::Apis::RetailV2::GoogleCloudRetailV2AttributesConfig::Representation
|
|
392
|
+
command.response_class = Google::Apis::RetailV2::GoogleCloudRetailV2AttributesConfig
|
|
393
|
+
command.params['name'] = name unless name.nil?
|
|
394
|
+
command.query['updateMask'] = update_mask unless update_mask.nil?
|
|
395
|
+
command.query['fields'] = fields unless fields.nil?
|
|
396
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
397
|
+
execute_or_queue_command(command, &block)
|
|
398
|
+
end
|
|
399
|
+
|
|
400
|
+
# Updates the CompletionConfigs.
|
|
401
|
+
# @param [String] name
|
|
402
|
+
# Required. Immutable. Fully qualified name `projects/*/locations/*/catalogs/*/
|
|
403
|
+
# completionConfig`
|
|
404
|
+
# @param [Google::Apis::RetailV2::GoogleCloudRetailV2CompletionConfig] google_cloud_retail_v2_completion_config_object
|
|
405
|
+
# @param [String] update_mask
|
|
406
|
+
# Indicates which fields in the provided CompletionConfig to update. The
|
|
407
|
+
# following are the only supported fields: * CompletionConfig.matching_order *
|
|
408
|
+
# CompletionConfig.max_suggestions * CompletionConfig.min_prefix_length *
|
|
409
|
+
# CompletionConfig.auto_learning If not set, all supported fields are updated.
|
|
410
|
+
# @param [String] fields
|
|
411
|
+
# Selector specifying which fields to include in a partial response.
|
|
412
|
+
# @param [String] quota_user
|
|
413
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
414
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
415
|
+
# @param [Google::Apis::RequestOptions] options
|
|
416
|
+
# Request-specific options
|
|
417
|
+
#
|
|
418
|
+
# @yield [result, err] Result & error if block supplied
|
|
419
|
+
# @yieldparam result [Google::Apis::RetailV2::GoogleCloudRetailV2CompletionConfig] parsed result object
|
|
420
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
421
|
+
#
|
|
422
|
+
# @return [Google::Apis::RetailV2::GoogleCloudRetailV2CompletionConfig]
|
|
423
|
+
#
|
|
424
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
425
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
426
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
427
|
+
def update_project_location_catalog_completion_config(name, google_cloud_retail_v2_completion_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
428
|
+
command = make_simple_command(:patch, 'v2/{+name}', options)
|
|
429
|
+
command.request_representation = Google::Apis::RetailV2::GoogleCloudRetailV2CompletionConfig::Representation
|
|
430
|
+
command.request_object = google_cloud_retail_v2_completion_config_object
|
|
431
|
+
command.response_representation = Google::Apis::RetailV2::GoogleCloudRetailV2CompletionConfig::Representation
|
|
432
|
+
command.response_class = Google::Apis::RetailV2::GoogleCloudRetailV2CompletionConfig
|
|
433
|
+
command.params['name'] = name unless name.nil?
|
|
434
|
+
command.query['updateMask'] = update_mask unless update_mask.nil?
|
|
435
|
+
command.query['fields'] = fields unless fields.nil?
|
|
436
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
437
|
+
execute_or_queue_command(command, &block)
|
|
438
|
+
end
|
|
439
|
+
|
|
440
|
+
# Adds the specified CatalogAttribute to the AttributesConfig. If the
|
|
441
|
+
# CatalogAttribute to add already exists, an ALREADY_EXISTS error is returned.
|
|
442
|
+
# @param [String] attributes_config
|
|
443
|
+
# Required. Full AttributesConfig resource name. Format: `projects/`
|
|
444
|
+
# project_number`/locations/`location_id`/catalogs/`catalog_id`/attributesConfig`
|
|
445
|
+
# @param [Google::Apis::RetailV2::GoogleCloudRetailV2AddCatalogAttributeRequest] google_cloud_retail_v2_add_catalog_attribute_request_object
|
|
446
|
+
# @param [String] fields
|
|
447
|
+
# Selector specifying which fields to include in a partial response.
|
|
448
|
+
# @param [String] quota_user
|
|
449
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
450
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
451
|
+
# @param [Google::Apis::RequestOptions] options
|
|
452
|
+
# Request-specific options
|
|
453
|
+
#
|
|
454
|
+
# @yield [result, err] Result & error if block supplied
|
|
455
|
+
# @yieldparam result [Google::Apis::RetailV2::GoogleCloudRetailV2AttributesConfig] parsed result object
|
|
456
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
457
|
+
#
|
|
458
|
+
# @return [Google::Apis::RetailV2::GoogleCloudRetailV2AttributesConfig]
|
|
459
|
+
#
|
|
460
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
461
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
462
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
463
|
+
def add_project_location_catalog_attributes_config_catalog_attribute(attributes_config, google_cloud_retail_v2_add_catalog_attribute_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
464
|
+
command = make_simple_command(:post, 'v2/{+attributesConfig}:addCatalogAttribute', options)
|
|
465
|
+
command.request_representation = Google::Apis::RetailV2::GoogleCloudRetailV2AddCatalogAttributeRequest::Representation
|
|
466
|
+
command.request_object = google_cloud_retail_v2_add_catalog_attribute_request_object
|
|
467
|
+
command.response_representation = Google::Apis::RetailV2::GoogleCloudRetailV2AttributesConfig::Representation
|
|
468
|
+
command.response_class = Google::Apis::RetailV2::GoogleCloudRetailV2AttributesConfig
|
|
469
|
+
command.params['attributesConfig'] = attributes_config unless attributes_config.nil?
|
|
470
|
+
command.query['fields'] = fields unless fields.nil?
|
|
471
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
472
|
+
execute_or_queue_command(command, &block)
|
|
473
|
+
end
|
|
474
|
+
|
|
475
|
+
# Removes the specified CatalogAttribute from the AttributesConfig. If the
|
|
476
|
+
# CatalogAttribute to remove does not exist, a NOT_FOUND error is returned.
|
|
477
|
+
# @param [String] attributes_config
|
|
478
|
+
# Required. Full AttributesConfig resource name. Format: `projects/`
|
|
479
|
+
# project_number`/locations/`location_id`/catalogs/`catalog_id`/attributesConfig`
|
|
480
|
+
# @param [Google::Apis::RetailV2::GoogleCloudRetailV2RemoveCatalogAttributeRequest] google_cloud_retail_v2_remove_catalog_attribute_request_object
|
|
481
|
+
# @param [String] fields
|
|
482
|
+
# Selector specifying which fields to include in a partial response.
|
|
483
|
+
# @param [String] quota_user
|
|
484
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
485
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
486
|
+
# @param [Google::Apis::RequestOptions] options
|
|
487
|
+
# Request-specific options
|
|
488
|
+
#
|
|
489
|
+
# @yield [result, err] Result & error if block supplied
|
|
490
|
+
# @yieldparam result [Google::Apis::RetailV2::GoogleCloudRetailV2AttributesConfig] parsed result object
|
|
491
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
492
|
+
#
|
|
493
|
+
# @return [Google::Apis::RetailV2::GoogleCloudRetailV2AttributesConfig]
|
|
494
|
+
#
|
|
495
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
496
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
497
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
498
|
+
def remove_project_location_catalog_attributes_config_catalog_attribute(attributes_config, google_cloud_retail_v2_remove_catalog_attribute_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
499
|
+
command = make_simple_command(:post, 'v2/{+attributesConfig}:removeCatalogAttribute', options)
|
|
500
|
+
command.request_representation = Google::Apis::RetailV2::GoogleCloudRetailV2RemoveCatalogAttributeRequest::Representation
|
|
501
|
+
command.request_object = google_cloud_retail_v2_remove_catalog_attribute_request_object
|
|
502
|
+
command.response_representation = Google::Apis::RetailV2::GoogleCloudRetailV2AttributesConfig::Representation
|
|
503
|
+
command.response_class = Google::Apis::RetailV2::GoogleCloudRetailV2AttributesConfig
|
|
504
|
+
command.params['attributesConfig'] = attributes_config unless attributes_config.nil?
|
|
505
|
+
command.query['fields'] = fields unless fields.nil?
|
|
506
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
507
|
+
execute_or_queue_command(command, &block)
|
|
508
|
+
end
|
|
509
|
+
|
|
293
510
|
# Gets the latest state of a long-running operation. Clients can use this method
|
|
294
511
|
# to poll the operation result at intervals as recommended by the API service.
|
|
295
512
|
# @param [String] name
|
|
@@ -935,9 +1152,9 @@ module Google
|
|
|
935
1152
|
|
|
936
1153
|
# Makes a recommendation prediction.
|
|
937
1154
|
# @param [String] placement
|
|
938
|
-
# Required. Full resource name of the format:
|
|
939
|
-
# global/catalogs/default_catalog/servingConfigs
|
|
940
|
-
# locations/global/catalogs/default_catalog/placements
|
|
1155
|
+
# Required. Full resource name of the format: ``placement=projects/*/locations/
|
|
1156
|
+
# global/catalogs/default_catalog/servingConfigs/*`` or ``placement=projects/*/
|
|
1157
|
+
# locations/global/catalogs/default_catalog/placements/*``. We recommend using
|
|
941
1158
|
# the `servingConfigs` resource. `placements` is a legacy resource. The ID of
|
|
942
1159
|
# the Recommendations AI serving config or placement. Before you can request
|
|
943
1160
|
# predictions from your model, you must create at least one serving config or
|
|
@@ -1017,9 +1234,9 @@ module Google
|
|
|
1017
1234
|
|
|
1018
1235
|
# Makes a recommendation prediction.
|
|
1019
1236
|
# @param [String] placement
|
|
1020
|
-
# Required. Full resource name of the format:
|
|
1021
|
-
# global/catalogs/default_catalog/servingConfigs
|
|
1022
|
-
# locations/global/catalogs/default_catalog/placements
|
|
1237
|
+
# Required. Full resource name of the format: ``placement=projects/*/locations/
|
|
1238
|
+
# global/catalogs/default_catalog/servingConfigs/*`` or ``placement=projects/*/
|
|
1239
|
+
# locations/global/catalogs/default_catalog/placements/*``. We recommend using
|
|
1023
1240
|
# the `servingConfigs` resource. `placements` is a legacy resource. The ID of
|
|
1024
1241
|
# the Recommendations AI serving config or placement. Before you can request
|
|
1025
1242
|
# predictions from your model, you must create at least one serving config or
|
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.
|
|
4
|
+
version: 0.49.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-08-08 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.
|
|
61
|
+
documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2/v0.49.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: []
|