google-apis-retail_v2 0.30.0 → 0.33.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +12 -0
- data/lib/google/apis/retail_v2/classes.rb +381 -47
- data/lib/google/apis/retail_v2/gem_version.rb +2 -2
- data/lib/google/apis/retail_v2/representations.rb +176 -0
- data/lib/google/apis/retail_v2/service.rb +202 -34
- metadata +3 -3
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 18e916d64c386f6c9b65fcf3e6d27b2460371aa7dc0a23749c10f5c59b27db0f
|
4
|
+
data.tar.gz: f439bdacce1ca3cefdcde5cfdeb3ad8a026141758711ef1a7cc223c6261021ed
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: d7d59732abbc3a970e1a29a1eaef0d359ae436415e4166a69a09962fdfc67d766a9071c79050f11f4a77d14dcc30284626a63d24caf5346d3dd05b3929f5bafb
|
7
|
+
data.tar.gz: f1fb7248f0492d2ef6e237b224a75cb1ffb7b9d338e38aa33416eac49b4f5f20e94bdb7b646b14be02c499c0cc3b748a54d9d81bd113414441604114a0defb23
|
data/CHANGELOG.md
CHANGED
@@ -1,5 +1,17 @@
|
|
1
1
|
# Release history for google-apis-retail_v2
|
2
2
|
|
3
|
+
### v0.33.0 (2022-03-31)
|
4
|
+
|
5
|
+
* Regenerated from discovery document revision 20220324
|
6
|
+
|
7
|
+
### v0.32.0 (2022-03-24)
|
8
|
+
|
9
|
+
* Regenerated from discovery document revision 20220319
|
10
|
+
|
11
|
+
### v0.31.0 (2022-03-16)
|
12
|
+
|
13
|
+
* Regenerated from discovery document revision 20220310
|
14
|
+
|
3
15
|
### v0.30.0 (2022-03-09)
|
4
16
|
|
5
17
|
* Regenerated from discovery document revision 20220303
|
@@ -364,6 +364,86 @@ module Google
|
|
364
364
|
end
|
365
365
|
end
|
366
366
|
|
367
|
+
# Metadata related to the progress of the AddLocalInventories operation.
|
368
|
+
# Currently empty because there is no meaningful metadata populated from the
|
369
|
+
# AddLocalInventories method.
|
370
|
+
class GoogleCloudRetailV2AddLocalInventoriesMetadata
|
371
|
+
include Google::Apis::Core::Hashable
|
372
|
+
|
373
|
+
def initialize(**args)
|
374
|
+
update!(**args)
|
375
|
+
end
|
376
|
+
|
377
|
+
# Update properties of this object
|
378
|
+
def update!(**args)
|
379
|
+
end
|
380
|
+
end
|
381
|
+
|
382
|
+
# Request message for AddLocalInventories method.
|
383
|
+
class GoogleCloudRetailV2AddLocalInventoriesRequest
|
384
|
+
include Google::Apis::Core::Hashable
|
385
|
+
|
386
|
+
# Indicates which inventory fields in the provided list of LocalInventory to
|
387
|
+
# update. The field is updated to the provided value. If a field is set while
|
388
|
+
# the place does not have a previous local inventory, the local inventory at
|
389
|
+
# that store is created. If a field is set while the value of that field is not
|
390
|
+
# provided, the original field value, if it exists, is deleted. If the mask is
|
391
|
+
# not set or set with empty paths, all inventory fields will be updated. If an
|
392
|
+
# unsupported or unknown field is provided, an INVALID_ARGUMENT error is
|
393
|
+
# returned and the entire update will be ignored.
|
394
|
+
# Corresponds to the JSON property `addMask`
|
395
|
+
# @return [String]
|
396
|
+
attr_accessor :add_mask
|
397
|
+
|
398
|
+
# The time when the inventory updates are issued. Used to prevent out-of-order
|
399
|
+
# updates on local inventory fields. If not provided, the internal system time
|
400
|
+
# will be used.
|
401
|
+
# Corresponds to the JSON property `addTime`
|
402
|
+
# @return [String]
|
403
|
+
attr_accessor :add_time
|
404
|
+
|
405
|
+
# If set to true, and the Product is not found, the local inventory will still
|
406
|
+
# be processed and retained for at most 1 day and processed once the Product is
|
407
|
+
# created. If set to false, a NOT_FOUND error is returned if the Product is not
|
408
|
+
# found.
|
409
|
+
# Corresponds to the JSON property `allowMissing`
|
410
|
+
# @return [Boolean]
|
411
|
+
attr_accessor :allow_missing
|
412
|
+
alias_method :allow_missing?, :allow_missing
|
413
|
+
|
414
|
+
# Required. A list of inventory information at difference places. Each place is
|
415
|
+
# identified by its place ID. At most 3000 inventories are allowed per request.
|
416
|
+
# Corresponds to the JSON property `localInventories`
|
417
|
+
# @return [Array<Google::Apis::RetailV2::GoogleCloudRetailV2LocalInventory>]
|
418
|
+
attr_accessor :local_inventories
|
419
|
+
|
420
|
+
def initialize(**args)
|
421
|
+
update!(**args)
|
422
|
+
end
|
423
|
+
|
424
|
+
# Update properties of this object
|
425
|
+
def update!(**args)
|
426
|
+
@add_mask = args[:add_mask] if args.key?(:add_mask)
|
427
|
+
@add_time = args[:add_time] if args.key?(:add_time)
|
428
|
+
@allow_missing = args[:allow_missing] if args.key?(:allow_missing)
|
429
|
+
@local_inventories = args[:local_inventories] if args.key?(:local_inventories)
|
430
|
+
end
|
431
|
+
end
|
432
|
+
|
433
|
+
# Response of the AddLocalInventories API. Currently empty because there is no
|
434
|
+
# meaningful response populated from the AddLocalInventories method.
|
435
|
+
class GoogleCloudRetailV2AddLocalInventoriesResponse
|
436
|
+
include Google::Apis::Core::Hashable
|
437
|
+
|
438
|
+
def initialize(**args)
|
439
|
+
update!(**args)
|
440
|
+
end
|
441
|
+
|
442
|
+
# Update properties of this object
|
443
|
+
def update!(**args)
|
444
|
+
end
|
445
|
+
end
|
446
|
+
|
367
447
|
# An intended audience of the Product for whom it's sold.
|
368
448
|
class GoogleCloudRetailV2Audience
|
369
449
|
include Google::Apis::Core::Hashable
|
@@ -416,7 +496,9 @@ module Google
|
|
416
496
|
# analytics/answer/3437719. * `user_event_ga4`: This feature is in private
|
417
497
|
# preview. Please contact the support team for importing Google Analytics 4
|
418
498
|
# events. The schema is available here: https://support.google.com/analytics/
|
419
|
-
# answer/7029846.
|
499
|
+
# answer/7029846. Supported values for auto-completion imports: * `suggestions` (
|
500
|
+
# default): One JSON completion suggestion per line. * `denylist`: One JSON deny
|
501
|
+
# suggestion per line. * `allowlist`: One JSON allow suggestion per line.
|
420
502
|
# Corresponds to the JSON property `dataSchema`
|
421
503
|
# @return [String]
|
422
504
|
attr_accessor :data_schema
|
@@ -552,9 +634,9 @@ module Google
|
|
552
634
|
class GoogleCloudRetailV2CompleteQueryResponse
|
553
635
|
include Google::Apis::Core::Hashable
|
554
636
|
|
555
|
-
# A unique complete token. This should be included in the
|
556
|
-
# resulting from this completion, which
|
557
|
-
# model performance.
|
637
|
+
# A unique complete token. This should be included in the UserEvent.
|
638
|
+
# completion_detail for search events resulting from this completion, which
|
639
|
+
# enables accurate attribution of complete model performance.
|
558
640
|
# Corresponds to the JSON property `attributionToken`
|
559
641
|
# @return [String]
|
560
642
|
attr_accessor :attribution_token
|
@@ -594,7 +676,9 @@ module Google
|
|
594
676
|
class GoogleCloudRetailV2CompleteQueryResponseCompletionResult
|
595
677
|
include Google::Apis::Core::Hashable
|
596
678
|
|
597
|
-
#
|
679
|
+
# Custom attributes for the suggestion term. * For "user-data", the attributes
|
680
|
+
# are additional custom attributes ingested through BigQuery. * For "cloud-
|
681
|
+
# retail", the attributes are product attributes generated by Cloud Retail.
|
598
682
|
# Corresponds to the JSON property `attributes`
|
599
683
|
# @return [Hash<String,Google::Apis::RetailV2::GoogleCloudRetailV2CustomAttribute>]
|
600
684
|
attr_accessor :attributes
|
@@ -847,7 +931,10 @@ module Google
|
|
847
931
|
end
|
848
932
|
end
|
849
933
|
|
850
|
-
# Product
|
934
|
+
# Product image. Recommendations AI and Retail Search do not use product images
|
935
|
+
# to improve prediction and search results. However, product images can be
|
936
|
+
# returned in results, and are shown in prediction or search previews in the
|
937
|
+
# console.
|
851
938
|
class GoogleCloudRetailV2Image
|
852
939
|
include Google::Apis::Core::Hashable
|
853
940
|
|
@@ -977,8 +1064,7 @@ module Google
|
|
977
1064
|
# @return [String]
|
978
1065
|
attr_accessor :notification_pubsub_topic
|
979
1066
|
|
980
|
-
#
|
981
|
-
# passed in the request.
|
1067
|
+
# Deprecated. This field is never set.
|
982
1068
|
# Corresponds to the JSON property `requestId`
|
983
1069
|
# @return [String]
|
984
1070
|
attr_accessor :request_id
|
@@ -1038,11 +1124,7 @@ module Google
|
|
1038
1124
|
# @return [String]
|
1039
1125
|
attr_accessor :reconciliation_mode
|
1040
1126
|
|
1041
|
-
#
|
1042
|
-
# Ensures idempotency and used for request deduplication. Server-generated if
|
1043
|
-
# unspecified. Up to 128 characters long and must match the pattern: `[a-zA-Z0-
|
1044
|
-
# 9_]+`. This is returned as Operation.name in ImportMetadata. Only supported
|
1045
|
-
# when ImportProductsRequest.reconciliation_mode is set to `FULL`.
|
1127
|
+
# Deprecated. This field has no effect.
|
1046
1128
|
# Corresponds to the JSON property `requestId`
|
1047
1129
|
# @return [String]
|
1048
1130
|
attr_accessor :request_id
|
@@ -1243,6 +1325,59 @@ module Google
|
|
1243
1325
|
end
|
1244
1326
|
end
|
1245
1327
|
|
1328
|
+
# The inventory information at a place (e.g. a store) identified by a place ID.
|
1329
|
+
class GoogleCloudRetailV2LocalInventory
|
1330
|
+
include Google::Apis::Core::Hashable
|
1331
|
+
|
1332
|
+
# Additional local inventory attributes, for example, store name, promotion tags,
|
1333
|
+
# etc. This field needs to pass all below criteria, otherwise an
|
1334
|
+
# INVALID_ARGUMENT error is returned: * At most 30 attributes are allowed. * The
|
1335
|
+
# key must be a UTF-8 encoded string with a length limit of 32 characters. * The
|
1336
|
+
# key must match the pattern: `a-zA-Z0-9*`. For example, key0LikeThis or
|
1337
|
+
# KEY_1_LIKE_THIS. * The attribute values must be of the same type (text or
|
1338
|
+
# number). * Only 1 value is allowed for each attribute. * For text values, the
|
1339
|
+
# length limit is 256 UTF-8 characters. * The attribute does not support search.
|
1340
|
+
# The `searchable` field should be unset or set to false. * The max summed total
|
1341
|
+
# bytes of custom attribute keys and values per product is 5MiB.
|
1342
|
+
# Corresponds to the JSON property `attributes`
|
1343
|
+
# @return [Hash<String,Google::Apis::RetailV2::GoogleCloudRetailV2CustomAttribute>]
|
1344
|
+
attr_accessor :attributes
|
1345
|
+
|
1346
|
+
# Input only. Supported fulfillment types. Valid fulfillment type values include
|
1347
|
+
# commonly used types (such as pickup in store and same day delivery), and
|
1348
|
+
# custom types. Customers have to map custom types to their display names before
|
1349
|
+
# rendering UI. Supported values: * "pickup-in-store" * "ship-to-store" * "same-
|
1350
|
+
# day-delivery" * "next-day-delivery" * "custom-type-1" * "custom-type-2" * "
|
1351
|
+
# custom-type-3" * "custom-type-4" * "custom-type-5" If this field is set to an
|
1352
|
+
# invalid value other than these, an INVALID_ARGUMENT error is returned. All the
|
1353
|
+
# elements must be distinct. Otherwise, an INVALID_ARGUMENT error is returned.
|
1354
|
+
# Corresponds to the JSON property `fulfillmentTypes`
|
1355
|
+
# @return [Array<String>]
|
1356
|
+
attr_accessor :fulfillment_types
|
1357
|
+
|
1358
|
+
# The place ID for the current set of inventory information.
|
1359
|
+
# Corresponds to the JSON property `placeId`
|
1360
|
+
# @return [String]
|
1361
|
+
attr_accessor :place_id
|
1362
|
+
|
1363
|
+
# The price information of a Product.
|
1364
|
+
# Corresponds to the JSON property `priceInfo`
|
1365
|
+
# @return [Google::Apis::RetailV2::GoogleCloudRetailV2PriceInfo]
|
1366
|
+
attr_accessor :price_info
|
1367
|
+
|
1368
|
+
def initialize(**args)
|
1369
|
+
update!(**args)
|
1370
|
+
end
|
1371
|
+
|
1372
|
+
# Update properties of this object
|
1373
|
+
def update!(**args)
|
1374
|
+
@attributes = args[:attributes] if args.key?(:attributes)
|
1375
|
+
@fulfillment_types = args[:fulfillment_types] if args.key?(:fulfillment_types)
|
1376
|
+
@place_id = args[:place_id] if args.key?(:place_id)
|
1377
|
+
@price_info = args[:price_info] if args.key?(:price_info)
|
1378
|
+
end
|
1379
|
+
end
|
1380
|
+
|
1246
1381
|
# Request message for Predict method.
|
1247
1382
|
class GoogleCloudRetailV2PredictRequest
|
1248
1383
|
include Google::Apis::Core::Hashable
|
@@ -1259,9 +1394,11 @@ module Google
|
|
1259
1394
|
# do not have a stockState value of OUT_OF_STOCK. Examples: * tag=("Red" OR "
|
1260
1395
|
# Blue") tag="New-Arrival" tag=(NOT "promotional") * filterOutOfStockItems tag=(-
|
1261
1396
|
# "promotional") * filterOutOfStockItems If your filter blocks all prediction
|
1262
|
-
# results,
|
1263
|
-
#
|
1264
|
-
# PredictRequest.params
|
1397
|
+
# results, the API will return generic (unfiltered) popular products. If you
|
1398
|
+
# only want results strictly matching the filters, set `strictFiltering` to True
|
1399
|
+
# in `PredictRequest.params` to receive empty results instead. Note that the API
|
1400
|
+
# will never return items with storageStatus of "EXPIRED" or "DELETED"
|
1401
|
+
# regardless of filter choices.
|
1265
1402
|
# Corresponds to the JSON property `filter`
|
1266
1403
|
# @return [String]
|
1267
1404
|
attr_accessor :filter
|
@@ -1668,7 +1805,7 @@ module Google
|
|
1668
1805
|
# @return [String]
|
1669
1806
|
attr_accessor :id
|
1670
1807
|
|
1671
|
-
# Product images for the product.
|
1808
|
+
# Product images for the product. We highly recommend putting the main image
|
1672
1809
|
# first. A maximum of 300 images are allowed. Corresponding properties: Google
|
1673
1810
|
# Merchant Center property [image_link](https://support.google.com/merchants/
|
1674
1811
|
# answer/6324350). Schema.org property [Product.image](https://schema.org/image).
|
@@ -2326,6 +2463,73 @@ module Google
|
|
2326
2463
|
end
|
2327
2464
|
end
|
2328
2465
|
|
2466
|
+
# Metadata related to the progress of the RemoveLocalInventories operation.
|
2467
|
+
# Currently empty because there is no meaningful metadata populated from the
|
2468
|
+
# RemoveLocalInventories method.
|
2469
|
+
class GoogleCloudRetailV2RemoveLocalInventoriesMetadata
|
2470
|
+
include Google::Apis::Core::Hashable
|
2471
|
+
|
2472
|
+
def initialize(**args)
|
2473
|
+
update!(**args)
|
2474
|
+
end
|
2475
|
+
|
2476
|
+
# Update properties of this object
|
2477
|
+
def update!(**args)
|
2478
|
+
end
|
2479
|
+
end
|
2480
|
+
|
2481
|
+
# Request message for RemoveLocalInventories method.
|
2482
|
+
class GoogleCloudRetailV2RemoveLocalInventoriesRequest
|
2483
|
+
include Google::Apis::Core::Hashable
|
2484
|
+
|
2485
|
+
# If set to true, and the Product is not found, the local inventory removal
|
2486
|
+
# request will still be processed and retained for at most 1 day and processed
|
2487
|
+
# once the Product is created. If set to false, a NOT_FOUND error is returned if
|
2488
|
+
# the Product is not found.
|
2489
|
+
# Corresponds to the JSON property `allowMissing`
|
2490
|
+
# @return [Boolean]
|
2491
|
+
attr_accessor :allow_missing
|
2492
|
+
alias_method :allow_missing?, :allow_missing
|
2493
|
+
|
2494
|
+
# Required. A list of place IDs to have their inventory deleted. At most 3000
|
2495
|
+
# place IDs are allowed per request.
|
2496
|
+
# Corresponds to the JSON property `placeIds`
|
2497
|
+
# @return [Array<String>]
|
2498
|
+
attr_accessor :place_ids
|
2499
|
+
|
2500
|
+
# The time when the inventory deletions are issued. Used to prevent out-of-order
|
2501
|
+
# updates and deletions on local inventory fields. If not provided, the internal
|
2502
|
+
# system time will be used.
|
2503
|
+
# Corresponds to the JSON property `removeTime`
|
2504
|
+
# @return [String]
|
2505
|
+
attr_accessor :remove_time
|
2506
|
+
|
2507
|
+
def initialize(**args)
|
2508
|
+
update!(**args)
|
2509
|
+
end
|
2510
|
+
|
2511
|
+
# Update properties of this object
|
2512
|
+
def update!(**args)
|
2513
|
+
@allow_missing = args[:allow_missing] if args.key?(:allow_missing)
|
2514
|
+
@place_ids = args[:place_ids] if args.key?(:place_ids)
|
2515
|
+
@remove_time = args[:remove_time] if args.key?(:remove_time)
|
2516
|
+
end
|
2517
|
+
end
|
2518
|
+
|
2519
|
+
# Response of the RemoveLocalInventories API. Currently empty because there is
|
2520
|
+
# no meaningful response populated from the RemoveLocalInventories method.
|
2521
|
+
class GoogleCloudRetailV2RemoveLocalInventoriesResponse
|
2522
|
+
include Google::Apis::Core::Hashable
|
2523
|
+
|
2524
|
+
def initialize(**args)
|
2525
|
+
update!(**args)
|
2526
|
+
end
|
2527
|
+
|
2528
|
+
# Update properties of this object
|
2529
|
+
def update!(**args)
|
2530
|
+
end
|
2531
|
+
end
|
2532
|
+
|
2329
2533
|
# Request message for SearchService.Search method.
|
2330
2534
|
class GoogleCloudRetailV2SearchRequest
|
2331
2535
|
include Google::Apis::Core::Hashable
|
@@ -2342,12 +2546,13 @@ module Google
|
|
2342
2546
|
# @return [String]
|
2343
2547
|
attr_accessor :branch
|
2344
2548
|
|
2345
|
-
# The filter
|
2346
|
-
#
|
2347
|
-
#
|
2348
|
-
#
|
2349
|
-
#
|
2350
|
-
#
|
2549
|
+
# The default filter that is applied when a user performs a search without
|
2550
|
+
# checking any filters on the search page. The filter applied to every search
|
2551
|
+
# request when quality improvement such as query expansion is needed. For
|
2552
|
+
# example, if a query does not have enough results, an expanded query with
|
2553
|
+
# SearchRequest.canonical_filter will be returned as a supplement of the
|
2554
|
+
# original query. This field is strongly recommended to achieve high search
|
2555
|
+
# quality. See SearchRequest.filter for more details about filter syntax.
|
2351
2556
|
# Corresponds to the JSON property `canonicalFilter`
|
2352
2557
|
# @return [String]
|
2353
2558
|
attr_accessor :canonical_filter
|
@@ -3160,15 +3365,21 @@ module Google
|
|
3160
3365
|
class GoogleCloudRetailV2UserEvent
|
3161
3366
|
include Google::Apis::Core::Hashable
|
3162
3367
|
|
3163
|
-
# Extra user event features to include in the recommendation model.
|
3164
|
-
#
|
3165
|
-
#
|
3166
|
-
#
|
3167
|
-
#
|
3168
|
-
#
|
3169
|
-
#
|
3170
|
-
#
|
3171
|
-
#
|
3368
|
+
# Extra user event features to include in the recommendation model. If you
|
3369
|
+
# provide custom attributes for ingested user events, also include them in the
|
3370
|
+
# user events that you associate with prediction requests. Custom attribute
|
3371
|
+
# formatting must be consistent between imported events and events provided with
|
3372
|
+
# prediction requests. This lets the Retail API use those custom attributes when
|
3373
|
+
# training models and serving predictions, which helps improve recommendation
|
3374
|
+
# quality. This field needs to pass all below criteria, otherwise an
|
3375
|
+
# INVALID_ARGUMENT error is returned: * The key must be a UTF-8 encoded string
|
3376
|
+
# with a length limit of 5,000 characters. * For text attributes, at most 400
|
3377
|
+
# values are allowed. Empty values are not allowed. Each value must be a UTF-8
|
3378
|
+
# encoded string with a length limit of 256 characters. * For number attributes,
|
3379
|
+
# at most 400 values are allowed. For product recommendations, an example of
|
3380
|
+
# extra user information is traffic_channel, which is how a user arrives at the
|
3381
|
+
# site. Users can arrive at the site by coming to the site directly, coming
|
3382
|
+
# through Google search, or in other ways.
|
3172
3383
|
# Corresponds to the JSON property `attributes`
|
3173
3384
|
# @return [Hash<String,Google::Apis::RetailV2::GoogleCloudRetailV2CustomAttribute>]
|
3174
3385
|
attr_accessor :attributes
|
@@ -3466,13 +3677,12 @@ module Google
|
|
3466
3677
|
attr_accessor :direct_user_request
|
3467
3678
|
alias_method :direct_user_request?, :direct_user_request
|
3468
3679
|
|
3469
|
-
# The end user's IP address.
|
3470
|
-
#
|
3471
|
-
#
|
3472
|
-
#
|
3473
|
-
#
|
3474
|
-
#
|
3475
|
-
# direct_user_request is set.
|
3680
|
+
# The end user's IP address. This field is used to extract location information
|
3681
|
+
# for personalization. This field must be either an IPv4 address (e.g. "104.133.
|
3682
|
+
# 9.80") or an IPv6 address (e.g. "2001:0db8:85a3:0000:0000:8a2e:0370:7334").
|
3683
|
+
# Otherwise, an INVALID_ARGUMENT error is returned. This should not be set when:
|
3684
|
+
# * setting SearchRequest.user_info. * using the JavaScript tag in
|
3685
|
+
# UserEventService.CollectUserEvent or if direct_user_request is set.
|
3476
3686
|
# Corresponds to the JSON property `ipAddress`
|
3477
3687
|
# @return [String]
|
3478
3688
|
attr_accessor :ip_address
|
@@ -3488,8 +3698,9 @@ module Google
|
|
3488
3698
|
attr_accessor :user_agent
|
3489
3699
|
|
3490
3700
|
# Highly recommended for logged-in users. Unique identifier for logged-in user,
|
3491
|
-
# such as a user name.
|
3492
|
-
# limit of 128 characters. Otherwise, an
|
3701
|
+
# such as a user name. Always use a hashed value for this ID. The field must be
|
3702
|
+
# a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an
|
3703
|
+
# INVALID_ARGUMENT error is returned.
|
3493
3704
|
# Corresponds to the JSON property `userId`
|
3494
3705
|
# @return [String]
|
3495
3706
|
attr_accessor :user_id
|
@@ -3732,8 +3943,7 @@ module Google
|
|
3732
3943
|
# @return [String]
|
3733
3944
|
attr_accessor :notification_pubsub_topic
|
3734
3945
|
|
3735
|
-
#
|
3736
|
-
# passed in the request.
|
3946
|
+
# Deprecated. This field is never set.
|
3737
3947
|
# Corresponds to the JSON property `requestId`
|
3738
3948
|
# @return [String]
|
3739
3949
|
attr_accessor :request_id
|
@@ -3839,6 +4049,74 @@ module Google
|
|
3839
4049
|
end
|
3840
4050
|
end
|
3841
4051
|
|
4052
|
+
# Metadata related to the progress of the PurgeProducts operation. This will be
|
4053
|
+
# returned by the google.longrunning.Operation.metadata field.
|
4054
|
+
class GoogleCloudRetailV2alphaPurgeProductsMetadata
|
4055
|
+
include Google::Apis::Core::Hashable
|
4056
|
+
|
4057
|
+
# Operation create time.
|
4058
|
+
# Corresponds to the JSON property `createTime`
|
4059
|
+
# @return [String]
|
4060
|
+
attr_accessor :create_time
|
4061
|
+
|
4062
|
+
# Count of entries that encountered errors while processing.
|
4063
|
+
# Corresponds to the JSON property `failureCount`
|
4064
|
+
# @return [Fixnum]
|
4065
|
+
attr_accessor :failure_count
|
4066
|
+
|
4067
|
+
# Count of entries that were deleted successfully.
|
4068
|
+
# Corresponds to the JSON property `successCount`
|
4069
|
+
# @return [Fixnum]
|
4070
|
+
attr_accessor :success_count
|
4071
|
+
|
4072
|
+
# Operation last update time. If the operation is done, this is also the finish
|
4073
|
+
# time.
|
4074
|
+
# Corresponds to the JSON property `updateTime`
|
4075
|
+
# @return [String]
|
4076
|
+
attr_accessor :update_time
|
4077
|
+
|
4078
|
+
def initialize(**args)
|
4079
|
+
update!(**args)
|
4080
|
+
end
|
4081
|
+
|
4082
|
+
# Update properties of this object
|
4083
|
+
def update!(**args)
|
4084
|
+
@create_time = args[:create_time] if args.key?(:create_time)
|
4085
|
+
@failure_count = args[:failure_count] if args.key?(:failure_count)
|
4086
|
+
@success_count = args[:success_count] if args.key?(:success_count)
|
4087
|
+
@update_time = args[:update_time] if args.key?(:update_time)
|
4088
|
+
end
|
4089
|
+
end
|
4090
|
+
|
4091
|
+
# Response of the PurgeProductsRequest. If the long running operation is
|
4092
|
+
# successfully done, then this message is returned by the google.longrunning.
|
4093
|
+
# Operations.response field.
|
4094
|
+
class GoogleCloudRetailV2alphaPurgeProductsResponse
|
4095
|
+
include Google::Apis::Core::Hashable
|
4096
|
+
|
4097
|
+
# The total count of products purged as a result of the operation.
|
4098
|
+
# Corresponds to the JSON property `purgeCount`
|
4099
|
+
# @return [Fixnum]
|
4100
|
+
attr_accessor :purge_count
|
4101
|
+
|
4102
|
+
# A sample of the product names that will be deleted. Only populated if `force`
|
4103
|
+
# is set to false. A max of 100 names will be returned and the names are chosen
|
4104
|
+
# at random.
|
4105
|
+
# Corresponds to the JSON property `purgeSample`
|
4106
|
+
# @return [Array<String>]
|
4107
|
+
attr_accessor :purge_sample
|
4108
|
+
|
4109
|
+
def initialize(**args)
|
4110
|
+
update!(**args)
|
4111
|
+
end
|
4112
|
+
|
4113
|
+
# Update properties of this object
|
4114
|
+
def update!(**args)
|
4115
|
+
@purge_count = args[:purge_count] if args.key?(:purge_count)
|
4116
|
+
@purge_sample = args[:purge_sample] if args.key?(:purge_sample)
|
4117
|
+
end
|
4118
|
+
end
|
4119
|
+
|
3842
4120
|
# Response of the PurgeUserEventsRequest. If the long running operation is
|
3843
4121
|
# successfully done, then this message is returned by the google.longrunning.
|
3844
4122
|
# Operations.response field.
|
@@ -4035,6 +4313,35 @@ module Google
|
|
4035
4313
|
end
|
4036
4314
|
end
|
4037
4315
|
|
4316
|
+
# Metadata related to the progress of the AddLocalInventories operation.
|
4317
|
+
# Currently empty because there is no meaningful metadata populated from the
|
4318
|
+
# AddLocalInventories method.
|
4319
|
+
class GoogleCloudRetailV2betaAddLocalInventoriesMetadata
|
4320
|
+
include Google::Apis::Core::Hashable
|
4321
|
+
|
4322
|
+
def initialize(**args)
|
4323
|
+
update!(**args)
|
4324
|
+
end
|
4325
|
+
|
4326
|
+
# Update properties of this object
|
4327
|
+
def update!(**args)
|
4328
|
+
end
|
4329
|
+
end
|
4330
|
+
|
4331
|
+
# Response of the AddLocalInventories API. Currently empty because there is no
|
4332
|
+
# meaningful response populated from the AddLocalInventories method.
|
4333
|
+
class GoogleCloudRetailV2betaAddLocalInventoriesResponse
|
4334
|
+
include Google::Apis::Core::Hashable
|
4335
|
+
|
4336
|
+
def initialize(**args)
|
4337
|
+
update!(**args)
|
4338
|
+
end
|
4339
|
+
|
4340
|
+
# Update properties of this object
|
4341
|
+
def update!(**args)
|
4342
|
+
end
|
4343
|
+
end
|
4344
|
+
|
4038
4345
|
# Configuration of destination for Export related errors.
|
4039
4346
|
class GoogleCloudRetailV2betaExportErrorsConfig
|
4040
4347
|
include Google::Apis::Core::Hashable
|
@@ -4202,8 +4509,7 @@ module Google
|
|
4202
4509
|
# @return [String]
|
4203
4510
|
attr_accessor :notification_pubsub_topic
|
4204
4511
|
|
4205
|
-
#
|
4206
|
-
# passed in the request.
|
4512
|
+
# Deprecated. This field is never set.
|
4207
4513
|
# Corresponds to the JSON property `requestId`
|
4208
4514
|
# @return [String]
|
4209
4515
|
attr_accessor :request_id
|
@@ -4391,6 +4697,35 @@ module Google
|
|
4391
4697
|
end
|
4392
4698
|
end
|
4393
4699
|
|
4700
|
+
# Metadata related to the progress of the RemoveLocalInventories operation.
|
4701
|
+
# Currently empty because there is no meaningful metadata populated from the
|
4702
|
+
# RemoveLocalInventories method.
|
4703
|
+
class GoogleCloudRetailV2betaRemoveLocalInventoriesMetadata
|
4704
|
+
include Google::Apis::Core::Hashable
|
4705
|
+
|
4706
|
+
def initialize(**args)
|
4707
|
+
update!(**args)
|
4708
|
+
end
|
4709
|
+
|
4710
|
+
# Update properties of this object
|
4711
|
+
def update!(**args)
|
4712
|
+
end
|
4713
|
+
end
|
4714
|
+
|
4715
|
+
# Response of the RemoveLocalInventories API. Currently empty because there is
|
4716
|
+
# no meaningful response populated from the RemoveLocalInventories method.
|
4717
|
+
class GoogleCloudRetailV2betaRemoveLocalInventoriesResponse
|
4718
|
+
include Google::Apis::Core::Hashable
|
4719
|
+
|
4720
|
+
def initialize(**args)
|
4721
|
+
update!(**args)
|
4722
|
+
end
|
4723
|
+
|
4724
|
+
# Update properties of this object
|
4725
|
+
def update!(**args)
|
4726
|
+
end
|
4727
|
+
end
|
4728
|
+
|
4394
4729
|
# Metadata related to the progress of the SetInventory operation. Currently
|
4395
4730
|
# empty because there is no meaningful metadata populated from the SetInventory
|
4396
4731
|
# method.
|
@@ -4537,8 +4872,7 @@ module Google
|
|
4537
4872
|
# A generic empty message that you can re-use to avoid defining duplicated empty
|
4538
4873
|
# messages in your APIs. A typical example is to use it as the request or the
|
4539
4874
|
# response type of an API method. For instance: service Foo ` rpc Bar(google.
|
4540
|
-
# protobuf.Empty) returns (google.protobuf.Empty); `
|
4541
|
-
# `Empty` is empty JSON object ````.
|
4875
|
+
# protobuf.Empty) returns (google.protobuf.Empty); `
|
4542
4876
|
class GoogleProtobufEmpty
|
4543
4877
|
include Google::Apis::Core::Hashable
|
4544
4878
|
|
@@ -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.
|
19
|
+
GEM_VERSION = "0.33.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
|
@@ -82,6 +82,24 @@ module Google
|
|
82
82
|
include Google::Apis::Core::JsonObjectSupport
|
83
83
|
end
|
84
84
|
|
85
|
+
class GoogleCloudRetailV2AddLocalInventoriesMetadata
|
86
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
87
|
+
|
88
|
+
include Google::Apis::Core::JsonObjectSupport
|
89
|
+
end
|
90
|
+
|
91
|
+
class GoogleCloudRetailV2AddLocalInventoriesRequest
|
92
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
93
|
+
|
94
|
+
include Google::Apis::Core::JsonObjectSupport
|
95
|
+
end
|
96
|
+
|
97
|
+
class GoogleCloudRetailV2AddLocalInventoriesResponse
|
98
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
99
|
+
|
100
|
+
include Google::Apis::Core::JsonObjectSupport
|
101
|
+
end
|
102
|
+
|
85
103
|
class GoogleCloudRetailV2Audience
|
86
104
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
87
105
|
|
@@ -232,6 +250,12 @@ module Google
|
|
232
250
|
include Google::Apis::Core::JsonObjectSupport
|
233
251
|
end
|
234
252
|
|
253
|
+
class GoogleCloudRetailV2LocalInventory
|
254
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
255
|
+
|
256
|
+
include Google::Apis::Core::JsonObjectSupport
|
257
|
+
end
|
258
|
+
|
235
259
|
class GoogleCloudRetailV2PredictRequest
|
236
260
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
237
261
|
|
@@ -364,6 +388,24 @@ module Google
|
|
364
388
|
include Google::Apis::Core::JsonObjectSupport
|
365
389
|
end
|
366
390
|
|
391
|
+
class GoogleCloudRetailV2RemoveLocalInventoriesMetadata
|
392
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
393
|
+
|
394
|
+
include Google::Apis::Core::JsonObjectSupport
|
395
|
+
end
|
396
|
+
|
397
|
+
class GoogleCloudRetailV2RemoveLocalInventoriesRequest
|
398
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
399
|
+
|
400
|
+
include Google::Apis::Core::JsonObjectSupport
|
401
|
+
end
|
402
|
+
|
403
|
+
class GoogleCloudRetailV2RemoveLocalInventoriesResponse
|
404
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
405
|
+
|
406
|
+
include Google::Apis::Core::JsonObjectSupport
|
407
|
+
end
|
408
|
+
|
367
409
|
class GoogleCloudRetailV2SearchRequest
|
368
410
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
369
411
|
|
@@ -580,6 +622,18 @@ module Google
|
|
580
622
|
include Google::Apis::Core::JsonObjectSupport
|
581
623
|
end
|
582
624
|
|
625
|
+
class GoogleCloudRetailV2alphaPurgeProductsMetadata
|
626
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
627
|
+
|
628
|
+
include Google::Apis::Core::JsonObjectSupport
|
629
|
+
end
|
630
|
+
|
631
|
+
class GoogleCloudRetailV2alphaPurgeProductsResponse
|
632
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
633
|
+
|
634
|
+
include Google::Apis::Core::JsonObjectSupport
|
635
|
+
end
|
636
|
+
|
583
637
|
class GoogleCloudRetailV2alphaPurgeUserEventsResponse
|
584
638
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
585
639
|
|
@@ -652,6 +706,18 @@ module Google
|
|
652
706
|
include Google::Apis::Core::JsonObjectSupport
|
653
707
|
end
|
654
708
|
|
709
|
+
class GoogleCloudRetailV2betaAddLocalInventoriesMetadata
|
710
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
711
|
+
|
712
|
+
include Google::Apis::Core::JsonObjectSupport
|
713
|
+
end
|
714
|
+
|
715
|
+
class GoogleCloudRetailV2betaAddLocalInventoriesResponse
|
716
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
717
|
+
|
718
|
+
include Google::Apis::Core::JsonObjectSupport
|
719
|
+
end
|
720
|
+
|
655
721
|
class GoogleCloudRetailV2betaExportErrorsConfig
|
656
722
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
657
723
|
|
@@ -742,6 +808,18 @@ module Google
|
|
742
808
|
include Google::Apis::Core::JsonObjectSupport
|
743
809
|
end
|
744
810
|
|
811
|
+
class GoogleCloudRetailV2betaRemoveLocalInventoriesMetadata
|
812
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
813
|
+
|
814
|
+
include Google::Apis::Core::JsonObjectSupport
|
815
|
+
end
|
816
|
+
|
817
|
+
class GoogleCloudRetailV2betaRemoveLocalInventoriesResponse
|
818
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
819
|
+
|
820
|
+
include Google::Apis::Core::JsonObjectSupport
|
821
|
+
end
|
822
|
+
|
745
823
|
class GoogleCloudRetailV2betaSetInventoryMetadata
|
746
824
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
747
825
|
|
@@ -881,6 +959,29 @@ module Google
|
|
881
959
|
end
|
882
960
|
end
|
883
961
|
|
962
|
+
class GoogleCloudRetailV2AddLocalInventoriesMetadata
|
963
|
+
# @private
|
964
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
965
|
+
end
|
966
|
+
end
|
967
|
+
|
968
|
+
class GoogleCloudRetailV2AddLocalInventoriesRequest
|
969
|
+
# @private
|
970
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
971
|
+
property :add_mask, as: 'addMask'
|
972
|
+
property :add_time, as: 'addTime'
|
973
|
+
property :allow_missing, as: 'allowMissing'
|
974
|
+
collection :local_inventories, as: 'localInventories', class: Google::Apis::RetailV2::GoogleCloudRetailV2LocalInventory, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2LocalInventory::Representation
|
975
|
+
|
976
|
+
end
|
977
|
+
end
|
978
|
+
|
979
|
+
class GoogleCloudRetailV2AddLocalInventoriesResponse
|
980
|
+
# @private
|
981
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
982
|
+
end
|
983
|
+
end
|
984
|
+
|
884
985
|
class GoogleCloudRetailV2Audience
|
885
986
|
# @private
|
886
987
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -1118,6 +1219,18 @@ module Google
|
|
1118
1219
|
end
|
1119
1220
|
end
|
1120
1221
|
|
1222
|
+
class GoogleCloudRetailV2LocalInventory
|
1223
|
+
# @private
|
1224
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
1225
|
+
hash :attributes, as: 'attributes', class: Google::Apis::RetailV2::GoogleCloudRetailV2CustomAttribute, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2CustomAttribute::Representation
|
1226
|
+
|
1227
|
+
collection :fulfillment_types, as: 'fulfillmentTypes'
|
1228
|
+
property :place_id, as: 'placeId'
|
1229
|
+
property :price_info, as: 'priceInfo', class: Google::Apis::RetailV2::GoogleCloudRetailV2PriceInfo, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2PriceInfo::Representation
|
1230
|
+
|
1231
|
+
end
|
1232
|
+
end
|
1233
|
+
|
1121
1234
|
class GoogleCloudRetailV2PredictRequest
|
1122
1235
|
# @private
|
1123
1236
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -1350,6 +1463,27 @@ module Google
|
|
1350
1463
|
end
|
1351
1464
|
end
|
1352
1465
|
|
1466
|
+
class GoogleCloudRetailV2RemoveLocalInventoriesMetadata
|
1467
|
+
# @private
|
1468
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
1469
|
+
end
|
1470
|
+
end
|
1471
|
+
|
1472
|
+
class GoogleCloudRetailV2RemoveLocalInventoriesRequest
|
1473
|
+
# @private
|
1474
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
1475
|
+
property :allow_missing, as: 'allowMissing'
|
1476
|
+
collection :place_ids, as: 'placeIds'
|
1477
|
+
property :remove_time, as: 'removeTime'
|
1478
|
+
end
|
1479
|
+
end
|
1480
|
+
|
1481
|
+
class GoogleCloudRetailV2RemoveLocalInventoriesResponse
|
1482
|
+
# @private
|
1483
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
1484
|
+
end
|
1485
|
+
end
|
1486
|
+
|
1353
1487
|
class GoogleCloudRetailV2SearchRequest
|
1354
1488
|
# @private
|
1355
1489
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -1719,6 +1853,24 @@ module Google
|
|
1719
1853
|
end
|
1720
1854
|
end
|
1721
1855
|
|
1856
|
+
class GoogleCloudRetailV2alphaPurgeProductsMetadata
|
1857
|
+
# @private
|
1858
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
1859
|
+
property :create_time, as: 'createTime'
|
1860
|
+
property :failure_count, :numeric_string => true, as: 'failureCount'
|
1861
|
+
property :success_count, :numeric_string => true, as: 'successCount'
|
1862
|
+
property :update_time, as: 'updateTime'
|
1863
|
+
end
|
1864
|
+
end
|
1865
|
+
|
1866
|
+
class GoogleCloudRetailV2alphaPurgeProductsResponse
|
1867
|
+
# @private
|
1868
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
1869
|
+
property :purge_count, :numeric_string => true, as: 'purgeCount'
|
1870
|
+
collection :purge_sample, as: 'purgeSample'
|
1871
|
+
end
|
1872
|
+
end
|
1873
|
+
|
1722
1874
|
class GoogleCloudRetailV2alphaPurgeUserEventsResponse
|
1723
1875
|
# @private
|
1724
1876
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -1795,6 +1947,18 @@ module Google
|
|
1795
1947
|
end
|
1796
1948
|
end
|
1797
1949
|
|
1950
|
+
class GoogleCloudRetailV2betaAddLocalInventoriesMetadata
|
1951
|
+
# @private
|
1952
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
1953
|
+
end
|
1954
|
+
end
|
1955
|
+
|
1956
|
+
class GoogleCloudRetailV2betaAddLocalInventoriesResponse
|
1957
|
+
# @private
|
1958
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
1959
|
+
end
|
1960
|
+
end
|
1961
|
+
|
1798
1962
|
class GoogleCloudRetailV2betaExportErrorsConfig
|
1799
1963
|
# @private
|
1800
1964
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -1917,6 +2081,18 @@ module Google
|
|
1917
2081
|
end
|
1918
2082
|
end
|
1919
2083
|
|
2084
|
+
class GoogleCloudRetailV2betaRemoveLocalInventoriesMetadata
|
2085
|
+
# @private
|
2086
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
2087
|
+
end
|
2088
|
+
end
|
2089
|
+
|
2090
|
+
class GoogleCloudRetailV2betaRemoveLocalInventoriesResponse
|
2091
|
+
# @private
|
2092
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
2093
|
+
end
|
2094
|
+
end
|
2095
|
+
|
1920
2096
|
class GoogleCloudRetailV2betaSetInventoryMetadata
|
1921
2097
|
# @private
|
1922
2098
|
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
|
@@ -326,9 +325,8 @@ module Google
|
|
326
325
|
# enqueued and processed downstream. As a consequence, when a response is
|
327
326
|
# returned, the added place IDs are not immediately manifested in the Product
|
328
327
|
# queried by GetProduct or ListProducts. This feature is only available for
|
329
|
-
# users who have Retail Search enabled. Please
|
330
|
-
#
|
331
|
-
# using Retail Search.
|
328
|
+
# users who have Retail Search enabled. Please enable Retail Search on Cloud
|
329
|
+
# Console before using this feature.
|
332
330
|
# @param [String] product
|
333
331
|
# Required. Full resource name of Product, such as `projects/*/locations/global/
|
334
332
|
# catalogs/default_catalog/branches/default_branch/products/some_product_id`. If
|
@@ -364,6 +362,51 @@ module Google
|
|
364
362
|
execute_or_queue_command(command, &block)
|
365
363
|
end
|
366
364
|
|
365
|
+
# Updates local inventory information for a Product at a list of places, while
|
366
|
+
# respecting the last update timestamps of each inventory field. This process is
|
367
|
+
# asynchronous and does not require the Product to exist before updating
|
368
|
+
# inventory information. If the request is valid, the update will be enqueued
|
369
|
+
# and processed downstream. As a consequence, when a response is returned,
|
370
|
+
# updates are not immediately manifested in the Product queried by GetProduct or
|
371
|
+
# ListProducts. Local inventory information can only be modified using this
|
372
|
+
# method. CreateProduct and UpdateProduct has no effect on local inventories.
|
373
|
+
# This feature is only available for users who have Retail Search enabled.
|
374
|
+
# Please enable Retail Search on Cloud Console before using this feature.
|
375
|
+
# @param [String] product
|
376
|
+
# Required. Full resource name of Product, such as `projects/*/locations/global/
|
377
|
+
# catalogs/default_catalog/branches/default_branch/products/some_product_id`. If
|
378
|
+
# the caller does not have permission to access the Product, regardless of
|
379
|
+
# whether or not it exists, a PERMISSION_DENIED error is returned.
|
380
|
+
# @param [Google::Apis::RetailV2::GoogleCloudRetailV2AddLocalInventoriesRequest] google_cloud_retail_v2_add_local_inventories_request_object
|
381
|
+
# @param [String] fields
|
382
|
+
# Selector specifying which fields to include in a partial response.
|
383
|
+
# @param [String] quota_user
|
384
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
385
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
386
|
+
# @param [Google::Apis::RequestOptions] options
|
387
|
+
# Request-specific options
|
388
|
+
#
|
389
|
+
# @yield [result, err] Result & error if block supplied
|
390
|
+
# @yieldparam result [Google::Apis::RetailV2::GoogleLongrunningOperation] parsed result object
|
391
|
+
# @yieldparam err [StandardError] error object if request failed
|
392
|
+
#
|
393
|
+
# @return [Google::Apis::RetailV2::GoogleLongrunningOperation]
|
394
|
+
#
|
395
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
396
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
397
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
398
|
+
def add_project_location_catalog_branch_product_local_inventories(product, google_cloud_retail_v2_add_local_inventories_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
399
|
+
command = make_simple_command(:post, 'v2/{+product}:addLocalInventories', options)
|
400
|
+
command.request_representation = Google::Apis::RetailV2::GoogleCloudRetailV2AddLocalInventoriesRequest::Representation
|
401
|
+
command.request_object = google_cloud_retail_v2_add_local_inventories_request_object
|
402
|
+
command.response_representation = Google::Apis::RetailV2::GoogleLongrunningOperation::Representation
|
403
|
+
command.response_class = Google::Apis::RetailV2::GoogleLongrunningOperation
|
404
|
+
command.params['product'] = product unless product.nil?
|
405
|
+
command.query['fields'] = fields unless fields.nil?
|
406
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
407
|
+
execute_or_queue_command(command, &block)
|
408
|
+
end
|
409
|
+
|
367
410
|
# Creates a Product.
|
368
411
|
# @param [String] parent
|
369
412
|
# Required. The parent catalog resource name, such as `projects/*/locations/
|
@@ -633,9 +676,8 @@ module Google
|
|
633
676
|
# enqueued and processed downstream. As a consequence, when a response is
|
634
677
|
# returned, the removed place IDs are not immediately manifested in the Product
|
635
678
|
# queried by GetProduct or ListProducts. This feature is only available for
|
636
|
-
# users who have Retail Search enabled. Please
|
637
|
-
#
|
638
|
-
# using Retail Search.
|
679
|
+
# users who have Retail Search enabled. Please enable Retail Search on Cloud
|
680
|
+
# Console before using this feature.
|
639
681
|
# @param [String] product
|
640
682
|
# Required. Full resource name of Product, such as `projects/*/locations/global/
|
641
683
|
# catalogs/default_catalog/branches/default_branch/products/some_product_id`. If
|
@@ -671,6 +713,50 @@ module Google
|
|
671
713
|
execute_or_queue_command(command, &block)
|
672
714
|
end
|
673
715
|
|
716
|
+
# Remove local inventory information for a Product at a list of places at a
|
717
|
+
# removal timestamp. This process is asynchronous. If the request is valid, the
|
718
|
+
# removal will be enqueued and processed downstream. As a consequence, when a
|
719
|
+
# response is returned, removals are not immediately manifested in the Product
|
720
|
+
# queried by GetProduct or ListProducts. Local inventory information can only be
|
721
|
+
# removed using this method. CreateProduct and UpdateProduct has no effect on
|
722
|
+
# local inventories. This feature is only available for users who have Retail
|
723
|
+
# Search enabled. Please enable Retail Search on Cloud Console before using this
|
724
|
+
# feature.
|
725
|
+
# @param [String] product
|
726
|
+
# Required. Full resource name of Product, such as `projects/*/locations/global/
|
727
|
+
# catalogs/default_catalog/branches/default_branch/products/some_product_id`. If
|
728
|
+
# the caller does not have permission to access the Product, regardless of
|
729
|
+
# whether or not it exists, a PERMISSION_DENIED error is returned.
|
730
|
+
# @param [Google::Apis::RetailV2::GoogleCloudRetailV2RemoveLocalInventoriesRequest] google_cloud_retail_v2_remove_local_inventories_request_object
|
731
|
+
# @param [String] fields
|
732
|
+
# Selector specifying which fields to include in a partial response.
|
733
|
+
# @param [String] quota_user
|
734
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
735
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
736
|
+
# @param [Google::Apis::RequestOptions] options
|
737
|
+
# Request-specific options
|
738
|
+
#
|
739
|
+
# @yield [result, err] Result & error if block supplied
|
740
|
+
# @yieldparam result [Google::Apis::RetailV2::GoogleLongrunningOperation] parsed result object
|
741
|
+
# @yieldparam err [StandardError] error object if request failed
|
742
|
+
#
|
743
|
+
# @return [Google::Apis::RetailV2::GoogleLongrunningOperation]
|
744
|
+
#
|
745
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
746
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
747
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
748
|
+
def remove_project_location_catalog_branch_product_local_inventories(product, google_cloud_retail_v2_remove_local_inventories_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
749
|
+
command = make_simple_command(:post, 'v2/{+product}:removeLocalInventories', options)
|
750
|
+
command.request_representation = Google::Apis::RetailV2::GoogleCloudRetailV2RemoveLocalInventoriesRequest::Representation
|
751
|
+
command.request_object = google_cloud_retail_v2_remove_local_inventories_request_object
|
752
|
+
command.response_representation = Google::Apis::RetailV2::GoogleLongrunningOperation::Representation
|
753
|
+
command.response_class = Google::Apis::RetailV2::GoogleLongrunningOperation
|
754
|
+
command.params['product'] = product unless product.nil?
|
755
|
+
command.query['fields'] = fields unless fields.nil?
|
756
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
757
|
+
execute_or_queue_command(command, &block)
|
758
|
+
end
|
759
|
+
|
674
760
|
# Updates inventory information for a Product while respecting the last update
|
675
761
|
# timestamps of each inventory field. This process is asynchronous and does not
|
676
762
|
# require the Product to exist before updating fulfillment information. If the
|
@@ -687,9 +773,8 @@ module Google
|
|
687
773
|
# SetInventoryRequest.set_mask, then any existing inventory information will be
|
688
774
|
# preserved. Pre-existing inventory information can only be updated with
|
689
775
|
# SetInventory, AddFulfillmentPlaces, and RemoveFulfillmentPlaces. This feature
|
690
|
-
# is only available for users who have Retail Search enabled. Please
|
691
|
-
#
|
692
|
-
# are interested in using Retail Search.
|
776
|
+
# is only available for users who have Retail Search enabled. Please enable
|
777
|
+
# Retail Search on Cloud Console before using this feature.
|
693
778
|
# @param [String] name
|
694
779
|
# Immutable. Full resource name of the product, such as `projects/*/locations/
|
695
780
|
# global/catalogs/default_catalog/branches/default_branch/products/product_id`.
|
@@ -723,11 +808,12 @@ module Google
|
|
723
808
|
execute_or_queue_command(command, &block)
|
724
809
|
end
|
725
810
|
|
726
|
-
# Bulk import of processed completion dataset. Request processing
|
727
|
-
#
|
728
|
-
#
|
729
|
-
#
|
730
|
-
#
|
811
|
+
# Bulk import of processed completion dataset. Request processing is
|
812
|
+
# asynchronous. Partial updating is not supported. The operation is successfully
|
813
|
+
# finished only after the imported suggestions are indexed successfully and
|
814
|
+
# ready for serving. The process takes hours. This feature is only available for
|
815
|
+
# users who have Retail Search enabled. Please enable Retail Search on Cloud
|
816
|
+
# Console before using this feature.
|
731
817
|
# @param [String] parent
|
732
818
|
# Required. The catalog which the suggestions dataset belongs to. Format: `
|
733
819
|
# projects/1234/locations/global/catalogs/default_catalog`.
|
@@ -841,7 +927,8 @@ module Google
|
|
841
927
|
# Makes a recommendation prediction.
|
842
928
|
# @param [String] placement
|
843
929
|
# Required. Full resource name of the format: `name=projects/*/locations/global/
|
844
|
-
# catalogs/default_catalog/placements/*`
|
930
|
+
# catalogs/default_catalog/placements/*` or `name=projects/*/locations/global/
|
931
|
+
# catalogs/default_catalog/servingConfigs/*` The ID of the Recommendations AI
|
845
932
|
# placement. Before you can request predictions from your model, you must create
|
846
933
|
# at least one placement for it. For more information, see [Managing placements](
|
847
934
|
# https://cloud.google.com/retail/recommendations-ai/docs/manage-placements).
|
@@ -878,13 +965,14 @@ module Google
|
|
878
965
|
end
|
879
966
|
|
880
967
|
# Performs a search. This feature is only available for users who have Retail
|
881
|
-
# Search enabled. Please
|
882
|
-
#
|
968
|
+
# Search enabled. Please enable Retail Search on Cloud Console before using this
|
969
|
+
# feature.
|
883
970
|
# @param [String] placement
|
884
971
|
# Required. The resource name of the search engine placement, such as `projects/*
|
885
|
-
# /locations/global/catalogs/default_catalog/placements/default_search
|
886
|
-
#
|
887
|
-
#
|
972
|
+
# /locations/global/catalogs/default_catalog/placements/default_search` or `
|
973
|
+
# projects/*/locations/global/catalogs/default_catalog/servingConfigs/
|
974
|
+
# default_serving_config` This field is used to identify the serving
|
975
|
+
# configuration name and the set of models that will be used to make the search.
|
888
976
|
# @param [Google::Apis::RetailV2::GoogleCloudRetailV2SearchRequest] google_cloud_retail_v2_search_request_object
|
889
977
|
# @param [String] fields
|
890
978
|
# Selector specifying which fields to include in a partial response.
|
@@ -915,6 +1003,85 @@ module Google
|
|
915
1003
|
execute_or_queue_command(command, &block)
|
916
1004
|
end
|
917
1005
|
|
1006
|
+
# Makes a recommendation prediction.
|
1007
|
+
# @param [String] placement
|
1008
|
+
# Required. Full resource name of the format: `name=projects/*/locations/global/
|
1009
|
+
# catalogs/default_catalog/placements/*` or `name=projects/*/locations/global/
|
1010
|
+
# catalogs/default_catalog/servingConfigs/*` The ID of the Recommendations AI
|
1011
|
+
# placement. Before you can request predictions from your model, you must create
|
1012
|
+
# at least one placement for it. For more information, see [Managing placements](
|
1013
|
+
# https://cloud.google.com/retail/recommendations-ai/docs/manage-placements).
|
1014
|
+
# The full list of available placements can be seen at https://console.cloud.
|
1015
|
+
# google.com/recommendation/catalogs/default_catalog/placements
|
1016
|
+
# @param [Google::Apis::RetailV2::GoogleCloudRetailV2PredictRequest] google_cloud_retail_v2_predict_request_object
|
1017
|
+
# @param [String] fields
|
1018
|
+
# Selector specifying which fields to include in a partial response.
|
1019
|
+
# @param [String] quota_user
|
1020
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1021
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1022
|
+
# @param [Google::Apis::RequestOptions] options
|
1023
|
+
# Request-specific options
|
1024
|
+
#
|
1025
|
+
# @yield [result, err] Result & error if block supplied
|
1026
|
+
# @yieldparam result [Google::Apis::RetailV2::GoogleCloudRetailV2PredictResponse] parsed result object
|
1027
|
+
# @yieldparam err [StandardError] error object if request failed
|
1028
|
+
#
|
1029
|
+
# @return [Google::Apis::RetailV2::GoogleCloudRetailV2PredictResponse]
|
1030
|
+
#
|
1031
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1032
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1033
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1034
|
+
def predict_project_location_catalog_serving_config(placement, google_cloud_retail_v2_predict_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
1035
|
+
command = make_simple_command(:post, 'v2/{+placement}:predict', options)
|
1036
|
+
command.request_representation = Google::Apis::RetailV2::GoogleCloudRetailV2PredictRequest::Representation
|
1037
|
+
command.request_object = google_cloud_retail_v2_predict_request_object
|
1038
|
+
command.response_representation = Google::Apis::RetailV2::GoogleCloudRetailV2PredictResponse::Representation
|
1039
|
+
command.response_class = Google::Apis::RetailV2::GoogleCloudRetailV2PredictResponse
|
1040
|
+
command.params['placement'] = placement unless placement.nil?
|
1041
|
+
command.query['fields'] = fields unless fields.nil?
|
1042
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1043
|
+
execute_or_queue_command(command, &block)
|
1044
|
+
end
|
1045
|
+
|
1046
|
+
# Performs a search. This feature is only available for users who have Retail
|
1047
|
+
# Search enabled. Please enable Retail Search on Cloud Console before using this
|
1048
|
+
# feature.
|
1049
|
+
# @param [String] placement
|
1050
|
+
# Required. The resource name of the search engine placement, such as `projects/*
|
1051
|
+
# /locations/global/catalogs/default_catalog/placements/default_search` or `
|
1052
|
+
# projects/*/locations/global/catalogs/default_catalog/servingConfigs/
|
1053
|
+
# default_serving_config` This field is used to identify the serving
|
1054
|
+
# configuration name and the set of models that will be used to make the search.
|
1055
|
+
# @param [Google::Apis::RetailV2::GoogleCloudRetailV2SearchRequest] google_cloud_retail_v2_search_request_object
|
1056
|
+
# @param [String] fields
|
1057
|
+
# Selector specifying which fields to include in a partial response.
|
1058
|
+
# @param [String] quota_user
|
1059
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1060
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1061
|
+
# @param [Google::Apis::RequestOptions] options
|
1062
|
+
# Request-specific options
|
1063
|
+
#
|
1064
|
+
# @yield [result, err] Result & error if block supplied
|
1065
|
+
# @yieldparam result [Google::Apis::RetailV2::GoogleCloudRetailV2SearchResponse] parsed result object
|
1066
|
+
# @yieldparam err [StandardError] error object if request failed
|
1067
|
+
#
|
1068
|
+
# @return [Google::Apis::RetailV2::GoogleCloudRetailV2SearchResponse]
|
1069
|
+
#
|
1070
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1071
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1072
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1073
|
+
def search_project_location_catalog_serving_configs(placement, google_cloud_retail_v2_search_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
1074
|
+
command = make_simple_command(:post, 'v2/{+placement}:search', options)
|
1075
|
+
command.request_representation = Google::Apis::RetailV2::GoogleCloudRetailV2SearchRequest::Representation
|
1076
|
+
command.request_object = google_cloud_retail_v2_search_request_object
|
1077
|
+
command.response_representation = Google::Apis::RetailV2::GoogleCloudRetailV2SearchResponse::Representation
|
1078
|
+
command.response_class = Google::Apis::RetailV2::GoogleCloudRetailV2SearchResponse
|
1079
|
+
command.params['placement'] = placement unless placement.nil?
|
1080
|
+
command.query['fields'] = fields unless fields.nil?
|
1081
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1082
|
+
execute_or_queue_command(command, &block)
|
1083
|
+
end
|
1084
|
+
|
918
1085
|
# Writes a single user event from the browser. This uses a GET request to due to
|
919
1086
|
# browser restriction of POST-ing to a 3rd party domain. This method is used
|
920
1087
|
# only by the Retail API JavaScript pixel and Google Tag Manager. Users should
|
@@ -1037,13 +1204,14 @@ module Google
|
|
1037
1204
|
execute_or_queue_command(command, &block)
|
1038
1205
|
end
|
1039
1206
|
|
1040
|
-
#
|
1041
|
-
#
|
1042
|
-
#
|
1207
|
+
# Starts a user event rejoin operation with latest product catalog. Events will
|
1208
|
+
# not be annotated with detailed product information if product is missing from
|
1209
|
+
# the catalog at the time the user event is ingested, and these events are
|
1043
1210
|
# stored as unjoined events with a limited usage on training and serving. This
|
1044
|
-
#
|
1211
|
+
# method can be used to start a join operation on specified events with latest
|
1045
1212
|
# version of product catalog. It can also be used to correct events joined with
|
1046
|
-
# wrong product catalog.
|
1213
|
+
# the wrong product catalog. A rejoin operation can take hours or days to
|
1214
|
+
# complete.
|
1047
1215
|
# @param [String] parent
|
1048
1216
|
# Required. The parent catalog resource name, such as `projects/1234/locations/
|
1049
1217
|
# global/catalogs/default_catalog`.
|
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.33.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_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.33.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: []
|