google-apis-retail_v2beta 0.13.0 → 0.17.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 +16 -0
- data/lib/google/apis/retail_v2beta/classes.rb +101 -90
- data/lib/google/apis/retail_v2beta/gem_version.rb +2 -2
- data/lib/google/apis/retail_v2beta/representations.rb +14 -0
- data/lib/google/apis/retail_v2beta/service.rb +30 -26
- data/lib/google/apis/retail_v2beta.rb +1 -1
- 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: 4fd013fd4fc5cdcec6d875f028c31c8a7883ab01c9c8c75a96790e1e6547173b
|
4
|
+
data.tar.gz: 37056899deda1505455a89ad0d7018c41ec20fc9c6b1b664a97805f3ac880e88
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: a125dcfda3425378657adf3a5783bb5a2c8d69e2115134ca6b71147ebcd3e2627c21b4f817f2ead77fb04e1b186c36435689344627734250ce9637081b757298
|
7
|
+
data.tar.gz: 273fc1c6173619e5056bf4f38e525f63962bf0e469512d49d90090e07a7abf0d79208f595a2ab5481b5b3a36b14879f4ed56726e169e26af0091044084e5da04
|
data/CHANGELOG.md
CHANGED
@@ -1,5 +1,21 @@
|
|
1
1
|
# Release history for google-apis-retail_v2beta
|
2
2
|
|
3
|
+
### v0.17.0 (2021-10-05)
|
4
|
+
|
5
|
+
* Regenerated from discovery document revision 20210930
|
6
|
+
|
7
|
+
### v0.16.0 (2021-09-25)
|
8
|
+
|
9
|
+
* Regenerated from discovery document revision 20210924
|
10
|
+
|
11
|
+
### v0.15.0 (2021-09-08)
|
12
|
+
|
13
|
+
* Regenerated from discovery document revision 20210906
|
14
|
+
|
15
|
+
### v0.14.0 (2021-09-01)
|
16
|
+
|
17
|
+
* Regenerated from discovery document revision 20210819
|
18
|
+
|
3
19
|
### v0.13.0 (2021-07-24)
|
4
20
|
|
5
21
|
* Regenerated from discovery document revision 20210723
|
@@ -647,6 +647,20 @@ module Google
|
|
647
647
|
end
|
648
648
|
end
|
649
649
|
|
650
|
+
# Metadata related to the EnrollSolution method. This will be returned by the
|
651
|
+
# google.longrunning.Operation.metadata field.
|
652
|
+
class GoogleCloudRetailV2alphaEnrollSolutionMetadata
|
653
|
+
include Google::Apis::Core::Hashable
|
654
|
+
|
655
|
+
def initialize(**args)
|
656
|
+
update!(**args)
|
657
|
+
end
|
658
|
+
|
659
|
+
# Update properties of this object
|
660
|
+
def update!(**args)
|
661
|
+
end
|
662
|
+
end
|
663
|
+
|
650
664
|
# Configuration of destination for Export related errors.
|
651
665
|
class GoogleCloudRetailV2alphaExportErrorsConfig
|
652
666
|
include Google::Apis::Core::Hashable
|
@@ -1087,8 +1101,8 @@ module Google
|
|
1087
1101
|
|
1088
1102
|
# If set to true, and the Product is not found, the fulfillment information will
|
1089
1103
|
# still be processed and retained for at most 1 day and processed once the
|
1090
|
-
# Product is created. If set to false,
|
1091
|
-
#
|
1104
|
+
# Product is created. If set to false, a NOT_FOUND error is returned if the
|
1105
|
+
# Product is not found.
|
1092
1106
|
# Corresponds to the JSON property `allowMissing`
|
1093
1107
|
# @return [Boolean]
|
1094
1108
|
attr_accessor :allow_missing
|
@@ -1304,8 +1318,8 @@ module Google
|
|
1304
1318
|
# The color display names, which may be different from standard color family
|
1305
1319
|
# names, such as the color aliases used in the website frontend. Normally it is
|
1306
1320
|
# expected to have only 1 color. May consider using single "Mixed" instead of
|
1307
|
-
# multiple values. A maximum of
|
1308
|
-
# encoded string with a length limit of 128 characters. Otherwise, an
|
1321
|
+
# multiple values. A maximum of 25 colors are allowed. Each value must be a UTF-
|
1322
|
+
# 8 encoded string with a length limit of 128 characters. Otherwise, an
|
1309
1323
|
# INVALID_ARGUMENT error is returned. Google Merchant Center property [color](
|
1310
1324
|
# https://support.google.com/merchants/answer/6324487). Schema.org property [
|
1311
1325
|
# Product.color](https://schema.org/color).
|
@@ -1341,9 +1355,9 @@ module Google
|
|
1341
1355
|
# @return [Array<Google::Apis::RetailV2beta::GoogleCloudRetailV2betaCompleteQueryResponseCompletionResult>]
|
1342
1356
|
attr_accessor :completion_results
|
1343
1357
|
|
1344
|
-
# Matched recent searches of this user.
|
1345
|
-
# Contact Retail
|
1346
|
-
# interested in enabling it. This feature is only available when
|
1358
|
+
# Matched recent searches of this user. The maximum number of recent searches is
|
1359
|
+
# 10. This field is a restricted feature. Contact Retail Search support team if
|
1360
|
+
# you are interested in enabling it. This feature is only available when
|
1347
1361
|
# CompleteQueryRequest.visitor_id field is set and UserEvent is imported. The
|
1348
1362
|
# recent searches satisfy the follow rules: * They are ordered from latest to
|
1349
1363
|
# oldest. * They are matched with CompleteQueryRequest.query case insensitively.
|
@@ -1623,8 +1637,8 @@ module Google
|
|
1623
1637
|
|
1624
1638
|
# The IDs for this type, such as the store IDs for FulfillmentInfo.type.pickup-
|
1625
1639
|
# in-store or the region IDs for FulfillmentInfo.type.same-day-delivery. A
|
1626
|
-
# maximum of
|
1627
|
-
# limit of
|
1640
|
+
# maximum of 3000 values are allowed. Each value must be a string with a length
|
1641
|
+
# limit of 30 characters, matching the pattern [a-zA-Z0-9_-]+, such as "store1"
|
1628
1642
|
# or "REGION-2". Otherwise, an INVALID_ARGUMENT error is returned.
|
1629
1643
|
# Corresponds to the JSON property `placeIds`
|
1630
1644
|
# @return [Array<String>]
|
@@ -2402,12 +2416,10 @@ module Google
|
|
2402
2416
|
# product, or age of a customer. For example: `` "vendor": `"text": ["vendor123",
|
2403
2417
|
# "vendor456"]`, "lengths_cm": `"numbers":[2.3, 15.4]`, "heights_cm": `"numbers"
|
2404
2418
|
# :[8.1, 6.4]` ``. This field needs to pass all below criteria, otherwise an
|
2405
|
-
# INVALID_ARGUMENT error is returned: * Max entries count: 200
|
2406
|
-
#
|
2407
|
-
#
|
2408
|
-
#
|
2409
|
-
# key must match the pattern: a-zA-Z0-9*. For example, key0LikeThis or
|
2410
|
-
# KEY_1_LIKE_THIS.
|
2419
|
+
# INVALID_ARGUMENT error is returned: * Max entries count: 200. * The key must
|
2420
|
+
# be a UTF-8 encoded string with a length limit of 128 characters. * For
|
2421
|
+
# indexable attribute, the key must match the pattern: a-zA-Z0-9*. For example,
|
2422
|
+
# key0LikeThis or KEY_1_LIKE_THIS.
|
2411
2423
|
# Corresponds to the JSON property `attributes`
|
2412
2424
|
# @return [Hash<String,Google::Apis::RetailV2beta::GoogleCloudRetailV2betaCustomAttribute>]
|
2413
2425
|
attr_accessor :attributes
|
@@ -2499,8 +2511,10 @@ module Google
|
|
2499
2511
|
# The timestamp when this product becomes unavailable for SearchService.Search.
|
2500
2512
|
# If it is set, the Product is not available for SearchService.Search after
|
2501
2513
|
# expire_time. However, the product can still be retrieved by ProductService.
|
2502
|
-
# GetProduct and ProductService.ListProducts.
|
2503
|
-
#
|
2514
|
+
# GetProduct and ProductService.ListProducts. expire_time must be later than
|
2515
|
+
# available_time and publish_time, otherwise an INVALID_ARGUMENT error is thrown.
|
2516
|
+
# Google Merchant Center property [expiration_date](https://support.google.com/
|
2517
|
+
# merchants/answer/6324499).
|
2504
2518
|
# Corresponds to the JSON property `expireTime`
|
2505
2519
|
# @return [String]
|
2506
2520
|
attr_accessor :expire_time
|
@@ -2514,7 +2528,8 @@ module Google
|
|
2514
2528
|
|
2515
2529
|
# The Global Trade Item Number (GTIN) of the product. This field must be a UTF-8
|
2516
2530
|
# encoded string with a length limit of 128 characters. Otherwise, an
|
2517
|
-
# INVALID_ARGUMENT error is returned.
|
2531
|
+
# INVALID_ARGUMENT error is returned. This field must be a Unigram. Otherwise,
|
2532
|
+
# an INVALID_ARGUMENT error is returned. Google Merchant Center property [gtin](
|
2518
2533
|
# https://support.google.com/merchants/answer/6324461). Schema.org property [
|
2519
2534
|
# Product.isbn](https://schema.org/isbn) or [Product.gtin8](https://schema.org/
|
2520
2535
|
# gtin8) or [Product.gtin12](https://schema.org/gtin12) or [Product.gtin13](
|
@@ -2553,7 +2568,7 @@ module Google
|
|
2553
2568
|
# @return [String]
|
2554
2569
|
attr_accessor :language_code
|
2555
2570
|
|
2556
|
-
# The material of the product. For example, "leather", "wooden". A maximum of
|
2571
|
+
# The material of the product. For example, "leather", "wooden". A maximum of 20
|
2557
2572
|
# values are allowed. Each value must be a UTF-8 encoded string with a length
|
2558
2573
|
# limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.
|
2559
2574
|
# Google Merchant Center property [material](https://support.google.com/
|
@@ -2565,13 +2580,12 @@ module Google
|
|
2565
2580
|
|
2566
2581
|
# Immutable. Full resource name of the product, such as `projects/*/locations/
|
2567
2582
|
# global/catalogs/default_catalog/branches/default_branch/products/product_id`.
|
2568
|
-
# The branch ID must be "default_branch".
|
2569
2583
|
# Corresponds to the JSON property `name`
|
2570
2584
|
# @return [String]
|
2571
2585
|
attr_accessor :name
|
2572
2586
|
|
2573
2587
|
# The pattern or graphic print of the product. For example, "striped", "polka
|
2574
|
-
# dot", "paisley". A maximum of
|
2588
|
+
# dot", "paisley". A maximum of 20 values are allowed per Product. Each value
|
2575
2589
|
# must be a UTF-8 encoded string with a length limit of 128 characters.
|
2576
2590
|
# Otherwise, an INVALID_ARGUMENT error is returned. Google Merchant Center
|
2577
2591
|
# property [pattern](https://support.google.com/merchants/answer/6324483).
|
@@ -2627,8 +2641,9 @@ module Google
|
|
2627
2641
|
# attribute, as specified in attributes. For Type.PRIMARY and Type.COLLECTION,
|
2628
2642
|
# the following fields are always returned in SearchResponse by default: * name
|
2629
2643
|
# For Type.VARIANT, the following fields are always returned in by default: *
|
2630
|
-
# name * color_info Maximum number of paths is
|
2631
|
-
# INVALID_ARGUMENT error is returned.
|
2644
|
+
# name * color_info Maximum number of paths is 30. Otherwise, an
|
2645
|
+
# INVALID_ARGUMENT error is returned. Note: Returning more fields in
|
2646
|
+
# SearchResponse may increase response payload size and serving latency.
|
2632
2647
|
# Corresponds to the JSON property `retrievableFields`
|
2633
2648
|
# @return [String]
|
2634
2649
|
attr_accessor :retrievable_fields
|
@@ -3126,8 +3141,8 @@ module Google
|
|
3126
3141
|
|
3127
3142
|
# If set to true, and the Product is not found, the fulfillment information will
|
3128
3143
|
# still be processed and retained for at most 1 day and processed once the
|
3129
|
-
# Product is created. If set to false,
|
3130
|
-
#
|
3144
|
+
# Product is created. If set to false, a NOT_FOUND error is returned if the
|
3145
|
+
# Product is not found.
|
3131
3146
|
# Corresponds to the JSON property `allowMissing`
|
3132
3147
|
# @return [Boolean]
|
3133
3148
|
attr_accessor :allow_missing
|
@@ -3228,9 +3243,9 @@ module Google
|
|
3228
3243
|
|
3229
3244
|
# The filter syntax consists of an expression language for constructing a
|
3230
3245
|
# predicate from one or more fields of the products being filtered. Filter
|
3231
|
-
# expression is case-sensitive. See more details at this [user guide](
|
3232
|
-
#
|
3233
|
-
# INVALID_ARGUMENT is returned.
|
3246
|
+
# expression is case-sensitive. See more details at this [user guide](https://
|
3247
|
+
# cloud.google.com/retail/docs/filter-and-order#filter). If this field is
|
3248
|
+
# unrecognizable, an INVALID_ARGUMENT is returned.
|
3234
3249
|
# Corresponds to the JSON property `filter`
|
3235
3250
|
# @return [String]
|
3236
3251
|
attr_accessor :filter
|
@@ -3245,9 +3260,9 @@ module Google
|
|
3245
3260
|
|
3246
3261
|
# The order in which products are returned. Products can be ordered by a field
|
3247
3262
|
# in an Product object. Leave it unset if ordered by relevance. OrderBy
|
3248
|
-
# expression is case-sensitive. See more details at this [user guide](
|
3249
|
-
#
|
3250
|
-
# INVALID_ARGUMENT is returned.
|
3263
|
+
# expression is case-sensitive. See more details at this [user guide](https://
|
3264
|
+
# cloud.google.com/retail/docs/filter-and-order#order). If this field is
|
3265
|
+
# unrecognizable, an INVALID_ARGUMENT is returned.
|
3251
3266
|
# Corresponds to the JSON property `orderBy`
|
3252
3267
|
# @return [String]
|
3253
3268
|
attr_accessor :order_by
|
@@ -3297,25 +3312,25 @@ module Google
|
|
3297
3312
|
# The keys to fetch and rollup the matching variant Products attributes. The
|
3298
3313
|
# attributes from all the matching variant Products are merged and de-duplicated.
|
3299
3314
|
# Notice that rollup variant Products attributes will lead to extra query
|
3300
|
-
# latency. Maximum number of keys is 10. For
|
3301
|
-
#
|
3302
|
-
#
|
3303
|
-
#
|
3304
|
-
#
|
3305
|
-
#
|
3306
|
-
#
|
3307
|
-
# shipToStore.id, where id is any FulfillmentInfo.
|
3308
|
-
#
|
3309
|
-
# for type
|
3310
|
-
# id is any FulfillmentInfo.
|
3311
|
-
# * customFulfillment1.id, where id is any FulfillmentInfo.
|
3312
|
-
# FulfillmentInfo.
|
3313
|
-
# FulfillmentInfo.
|
3314
|
-
# customFulfillment3.id, where id is any FulfillmentInfo.
|
3315
|
-
# FulfillmentInfo.
|
3316
|
-
# FulfillmentInfo.
|
3317
|
-
# customFulfillment5.id, where id is any FulfillmentInfo.
|
3318
|
-
# FulfillmentInfo.
|
3315
|
+
# latency. Maximum number of keys is 10. For FulfillmentInfo, a fulfillment type
|
3316
|
+
# and a fulfillment ID must be provided in the format of "fulfillmentType.
|
3317
|
+
# fulfillmentId". E.g., in "pickupInStore.store123", "pickupInStore" is
|
3318
|
+
# fulfillment type and "store123" is the store ID. Supported keys are: *
|
3319
|
+
# colorFamilies * price * originalPrice * discount * attributes.key, where key
|
3320
|
+
# is any key in the Product.attributes map. * pickupInStore.id, where id is any
|
3321
|
+
# FulfillmentInfo.place_ids for FulfillmentInfo.type "pickup-in-store". *
|
3322
|
+
# shipToStore.id, where id is any FulfillmentInfo.place_ids for FulfillmentInfo.
|
3323
|
+
# type "ship-to-store". * sameDayDelivery.id, where id is any FulfillmentInfo.
|
3324
|
+
# place_ids for FulfillmentInfo.type "same-day-delivery". * nextDayDelivery.id,
|
3325
|
+
# where id is any FulfillmentInfo.place_ids for FulfillmentInfo.type "next-day-
|
3326
|
+
# delivery". * customFulfillment1.id, where id is any FulfillmentInfo.place_ids
|
3327
|
+
# for FulfillmentInfo.type "custom-type-1". * customFulfillment2.id, where id is
|
3328
|
+
# any FulfillmentInfo.place_ids for FulfillmentInfo.type "custom-type-2". *
|
3329
|
+
# customFulfillment3.id, where id is any FulfillmentInfo.place_ids for
|
3330
|
+
# FulfillmentInfo.type "custom-type-3". * customFulfillment4.id, where id is any
|
3331
|
+
# FulfillmentInfo.place_ids for FulfillmentInfo.type "custom-type-4". *
|
3332
|
+
# customFulfillment5.id, where id is any FulfillmentInfo.place_ids for
|
3333
|
+
# FulfillmentInfo.type "custom-type-5". If this field is set to an invalid value
|
3319
3334
|
# other than these, an INVALID_ARGUMENT error is returned.
|
3320
3335
|
# Corresponds to the JSON property `variantRollupKeys`
|
3321
3336
|
# @return [Array<String>]
|
@@ -3399,8 +3414,8 @@ module Google
|
|
3399
3414
|
# An expression which specifies a boost condition. The syntax and supported
|
3400
3415
|
# fields are the same as a filter expression. See SearchRequest.filter for
|
3401
3416
|
# detail syntax and limitations. Examples: * To boost products with product ID "
|
3402
|
-
# product_1" or "product_2", and color "Red" or "Blue": *(id: ANY("product_1", "
|
3403
|
-
# product_2"))
|
3417
|
+
# product_1" or "product_2", and color "Red" or "Blue": * (id: ANY("product_1", "
|
3418
|
+
# product_2")) AND (colorFamilies: ANY("Red","Blue"))
|
3404
3419
|
# Corresponds to the JSON property `condition`
|
3405
3420
|
# @return [String]
|
3406
3421
|
attr_accessor :condition
|
@@ -3522,33 +3537,13 @@ module Google
|
|
3522
3537
|
|
3523
3538
|
# Required. Supported textual and numerical facet keys in Product object, over
|
3524
3539
|
# which the facet values are computed. Facet key is case-sensitive. Allowed
|
3525
|
-
# facet keys when FacetKey.query is not specified: * textual_field =
|
3526
|
-
#
|
3527
|
-
#
|
3528
|
-
#
|
3529
|
-
#
|
3530
|
-
#
|
3531
|
-
# *
|
3532
|
-
# patterns. * | "patterns"; *# The Product.conditions. * | "conditions"; *# The
|
3533
|
-
# textual custom attribute in Product object. Key can * *# be any key in the
|
3534
|
-
# Product.attributes map * *# if the attribute values are textual. * *# map. * |
|
3535
|
-
# "attributes.key"; *# The FulfillmentInfo.ids for type *# FulfillmentInfo.Type.
|
3536
|
-
# PICKUP_IN_STORE. * | "pickupInStore"; *# The FulfillmentInfo.ids for type *#
|
3537
|
-
# FulfillmentInfo.Type.SHIP_TO_STORE. * | "shipToStore"; *# The FulfillmentInfo.
|
3538
|
-
# ids for type *# FulfillmentInfo.Type.SAME_DAY_DELIVERY. * | "sameDayDelivery";
|
3539
|
-
# *# The FulfillmentInfo.ids for type *# FulfillmentInfo.Type.NEXT_DAY_DELIVERY.
|
3540
|
-
# * | "nextDayDelivery"; *# The FulfillmentInfo.ids for type *# FulfillmentInfo.
|
3541
|
-
# Type.CUSTOM_TYPE_1. * | "customFulfillment1"; *# The FulfillmentInfo.ids for
|
3542
|
-
# type *# FulfillmentInfo.Type.CUSTOM_TYPE_2. * | "customFulfillment2"; *# The
|
3543
|
-
# FulfillmentInfo.ids for type *# FulfillmentInfo.Type.CUSTOM_TYPE_3. * | "
|
3544
|
-
# customFulfillment3"; *# The FulfillmentInfo.ids for type *# FulfillmentInfo.
|
3545
|
-
# Type.CUSTOM_TYPE_4. * | "customFulfillment4"; *# The FulfillmentInfo.ids for
|
3546
|
-
# type *# FulfillmentInfo.Type.CUSTOM_TYPE_5. * | "customFulfillment5"; *
|
3547
|
-
# numerical_field = *# The PriceInfo.price. * "price"; *# The discount. Computed
|
3548
|
-
# by (original_price-price)/price * "discount"; *# The Rating.average_rating. * "
|
3549
|
-
# rating"; *# The Rating.rating_count. * "ratingCount"; *# The numerical custom
|
3550
|
-
# attribute in Product object. Key can * *# be any key in the Product.attributes
|
3551
|
-
# map * *# if the attribute values are numerical. * | "attributes.key";
|
3540
|
+
# facet keys when FacetKey.query is not specified: * textual_field = * "brands" *
|
3541
|
+
# "categories" * "genders" * "ageGroups" * "availability" * "colorFamilies" * "
|
3542
|
+
# colors" * "sizes" * "materials" * "patterns" * "conditions" * "attributes.key"
|
3543
|
+
# * "pickupInStore" * "shipToStore" * "sameDayDelivery" * "nextDayDelivery" * "
|
3544
|
+
# customFulfillment1" * "customFulfillment2" * "customFulfillment3" * "
|
3545
|
+
# customFulfillment4" * "customFulfillment5" * numerical_field = * "price" * "
|
3546
|
+
# discount" * "rating" * "ratingCount" * "attributes.key"
|
3552
3547
|
# Corresponds to the JSON property `key`
|
3553
3548
|
# @return [String]
|
3554
3549
|
attr_accessor :key
|
@@ -3558,7 +3553,7 @@ module Google
|
|
3558
3553
|
# which means order by Facet.FacetValue.value descending. Only applies to
|
3559
3554
|
# textual facets. If not set, textual values are sorted in [natural order](https:
|
3560
3555
|
# //en.wikipedia.org/wiki/Natural_sort_order); numerical intervals are sorted in
|
3561
|
-
# the order given by FacetSpec.FacetKey.intervals; FulfillmentInfo.
|
3556
|
+
# the order given by FacetSpec.FacetKey.intervals; FulfillmentInfo.place_ids are
|
3562
3557
|
# sorted in the order given by FacetSpec.FacetKey.restricted_values.
|
3563
3558
|
# Corresponds to the JSON property `orderBy`
|
3564
3559
|
# @return [String]
|
@@ -3624,6 +3619,14 @@ module Google
|
|
3624
3619
|
# @return [String]
|
3625
3620
|
attr_accessor :condition
|
3626
3621
|
|
3622
|
+
# Whether to pin unexpanded results. If this field is set to true, unexpanded
|
3623
|
+
# products are always at the top of the search results, followed by the expanded
|
3624
|
+
# results.
|
3625
|
+
# Corresponds to the JSON property `pinUnexpandedResults`
|
3626
|
+
# @return [Boolean]
|
3627
|
+
attr_accessor :pin_unexpanded_results
|
3628
|
+
alias_method :pin_unexpanded_results?, :pin_unexpanded_results
|
3629
|
+
|
3627
3630
|
def initialize(**args)
|
3628
3631
|
update!(**args)
|
3629
3632
|
end
|
@@ -3631,6 +3634,7 @@ module Google
|
|
3631
3634
|
# Update properties of this object
|
3632
3635
|
def update!(**args)
|
3633
3636
|
@condition = args[:condition] if args.key?(:condition)
|
3637
|
+
@pin_unexpanded_results = args[:pin_unexpanded_results] if args.key?(:pin_unexpanded_results)
|
3634
3638
|
end
|
3635
3639
|
end
|
3636
3640
|
|
@@ -3777,6 +3781,12 @@ module Google
|
|
3777
3781
|
attr_accessor :expanded_query
|
3778
3782
|
alias_method :expanded_query?, :expanded_query
|
3779
3783
|
|
3784
|
+
# Number of pinned results. This field will only be set when expansion happens
|
3785
|
+
# and SearchRequest.QueryExpansionSpec.pin_unexpanded_results is set to true.
|
3786
|
+
# Corresponds to the JSON property `pinnedResultCount`
|
3787
|
+
# @return [Fixnum]
|
3788
|
+
attr_accessor :pinned_result_count
|
3789
|
+
|
3780
3790
|
def initialize(**args)
|
3781
3791
|
update!(**args)
|
3782
3792
|
end
|
@@ -3784,6 +3794,7 @@ module Google
|
|
3784
3794
|
# Update properties of this object
|
3785
3795
|
def update!(**args)
|
3786
3796
|
@expanded_query = args[:expanded_query] if args.key?(:expanded_query)
|
3797
|
+
@pinned_result_count = args[:pinned_result_count] if args.key?(:pinned_result_count)
|
3787
3798
|
end
|
3788
3799
|
end
|
3789
3800
|
|
@@ -3825,10 +3836,10 @@ module Google
|
|
3825
3836
|
# protobuf.ListValue. For example, if there are two variants with colors "red"
|
3826
3837
|
# and "blue", the rollup values are ` key: "colorFamilies" value ` list_value `
|
3827
3838
|
# values ` string_value: "red" ` values ` string_value: "blue" ` ` ` ` For
|
3828
|
-
#
|
3829
|
-
#
|
3830
|
-
#
|
3831
|
-
#
|
3839
|
+
# FulfillmentInfo, the rollup values is a double value with type google.protobuf.
|
3840
|
+
# Value. For example, ``key: "pickupInStore.store1" value ` number_value: 10 ```
|
3841
|
+
# means a there are 10 variants in this product are available in the store "
|
3842
|
+
# store1".
|
3832
3843
|
# Corresponds to the JSON property `variantRollupValues`
|
3833
3844
|
# @return [Hash<String,Object>]
|
3834
3845
|
attr_accessor :variant_rollup_values
|
@@ -3897,8 +3908,8 @@ module Google
|
|
3897
3908
|
|
3898
3909
|
# If set to true, and the Product with name Product.name is not found, the
|
3899
3910
|
# inventory update will still be processed and retained for at most 1 day until
|
3900
|
-
# the Product is created. If set to false,
|
3901
|
-
#
|
3911
|
+
# the Product is created. If set to false, a NOT_FOUND error is returned if the
|
3912
|
+
# Product is not found.
|
3902
3913
|
# Corresponds to the JSON property `allowMissing`
|
3903
3914
|
# @return [Boolean]
|
3904
3915
|
attr_accessor :allow_missing
|
@@ -3982,7 +3993,7 @@ module Google
|
|
3982
3993
|
# @return [String]
|
3983
3994
|
attr_accessor :attribution_token
|
3984
3995
|
|
3985
|
-
# The
|
3996
|
+
# The ID or name of the associated shopping cart. This ID is used to associate
|
3986
3997
|
# multiple items added or present in the cart before purchase. This can only be
|
3987
3998
|
# set for `add-to-cart`, `purchase-complete`, or `shopping-cart-page-view`
|
3988
3999
|
# events.
|
@@ -4063,7 +4074,7 @@ module Google
|
|
4063
4074
|
# @return [Array<String>]
|
4064
4075
|
attr_accessor :page_categories
|
4065
4076
|
|
4066
|
-
# A unique
|
4077
|
+
# A unique ID of a web page view. This should be kept the same for all user
|
4067
4078
|
# events triggered from the same pageview. For example, an item detail page view
|
4068
4079
|
# could trigger multiple events as the user is browsing the page. The `
|
4069
4080
|
# pageViewId` property should be kept the same for all these events so that they
|
@@ -4077,11 +4088,11 @@ module Google
|
|
4077
4088
|
# The main product details related to the event. This field is required for the
|
4078
4089
|
# following event types: * `add-to-cart` * `detail-page-view` * `purchase-
|
4079
4090
|
# complete` In a `search` event, this field represents the products returned to
|
4080
|
-
# the end user on the current page (the end user may have not finished
|
4091
|
+
# the end user on the current page (the end user may have not finished browsing
|
4081
4092
|
# the whole page yet). When a new page is returned to the end user, after
|
4082
4093
|
# pagination/filtering/ordering even for the same query, a new `search` event
|
4083
4094
|
# with different product_details is desired. The end user may have not finished
|
4084
|
-
#
|
4095
|
+
# browsing the whole page yet.
|
4085
4096
|
# Corresponds to the JSON property `productDetails`
|
4086
4097
|
# @return [Array<Google::Apis::RetailV2beta::GoogleCloudRetailV2betaProductDetail>]
|
4087
4098
|
attr_accessor :product_details
|
@@ -16,13 +16,13 @@ module Google
|
|
16
16
|
module Apis
|
17
17
|
module RetailV2beta
|
18
18
|
# Version of the google-apis-retail_v2beta gem
|
19
|
-
GEM_VERSION = "0.
|
19
|
+
GEM_VERSION = "0.17.0"
|
20
20
|
|
21
21
|
# Version of the code generator used to generate this client
|
22
22
|
GENERATOR_VERSION = "0.4.0"
|
23
23
|
|
24
24
|
# Revision of the discovery document this client was generated from
|
25
|
-
REVISION = "
|
25
|
+
REVISION = "20210930"
|
26
26
|
end
|
27
27
|
end
|
28
28
|
end
|
@@ -172,6 +172,12 @@ module Google
|
|
172
172
|
include Google::Apis::Core::JsonObjectSupport
|
173
173
|
end
|
174
174
|
|
175
|
+
class GoogleCloudRetailV2alphaEnrollSolutionMetadata
|
176
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
177
|
+
|
178
|
+
include Google::Apis::Core::JsonObjectSupport
|
179
|
+
end
|
180
|
+
|
175
181
|
class GoogleCloudRetailV2alphaExportErrorsConfig
|
176
182
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
177
183
|
|
@@ -960,6 +966,12 @@ module Google
|
|
960
966
|
end
|
961
967
|
end
|
962
968
|
|
969
|
+
class GoogleCloudRetailV2alphaEnrollSolutionMetadata
|
970
|
+
# @private
|
971
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
972
|
+
end
|
973
|
+
end
|
974
|
+
|
963
975
|
class GoogleCloudRetailV2alphaExportErrorsConfig
|
964
976
|
# @private
|
965
977
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -1707,6 +1719,7 @@ module Google
|
|
1707
1719
|
# @private
|
1708
1720
|
class Representation < Google::Apis::Core::JsonRepresentation
|
1709
1721
|
property :condition, as: 'condition'
|
1722
|
+
property :pin_unexpanded_results, as: 'pinUnexpandedResults'
|
1710
1723
|
end
|
1711
1724
|
end
|
1712
1725
|
|
@@ -1751,6 +1764,7 @@ module Google
|
|
1751
1764
|
# @private
|
1752
1765
|
class Representation < Google::Apis::Core::JsonRepresentation
|
1753
1766
|
property :expanded_query, as: 'expandedQuery'
|
1767
|
+
property :pinned_result_count, :numeric_string => true, as: 'pinnedResultCount'
|
1754
1768
|
end
|
1755
1769
|
end
|
1756
1770
|
|
@@ -52,18 +52,19 @@ 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.
|
56
|
-
#
|
55
|
+
# available for users who have Retail Search enabled. Please submit a form [here]
|
56
|
+
# (https://cloud.google.com/contact) to contact cloud sales if you are
|
57
|
+
# interested in using Retail Search.
|
57
58
|
# @param [String] catalog
|
58
59
|
# Required. Catalog for which the completion is performed. Full resource name of
|
59
60
|
# catalog, such as `projects/*/locations/global/catalogs/default_catalog`.
|
60
61
|
# @param [String] dataset
|
61
62
|
# Determines which dataset to use for fetching completion. "user-data" will use
|
62
|
-
# the imported dataset through ImportCompletionData. "cloud-
|
63
|
-
# dataset generated by cloud retail based on user events.
|
64
|
-
# will use the "user-data". Current supported values: * user-
|
65
|
-
# This option
|
66
|
-
# retail
|
63
|
+
# the imported dataset through CompletionService.ImportCompletionData. "cloud-
|
64
|
+
# retail" will use the dataset generated by cloud retail based on user events.
|
65
|
+
# If leave empty, it will use the "user-data". Current supported values: * user-
|
66
|
+
# data * cloud-retail This option requires additional allowlisting. Before using
|
67
|
+
# cloud-retail, contact Cloud Retail support team first.
|
67
68
|
# @param [String] device_type
|
68
69
|
# The device type context for completion suggestions. It is useful to apply
|
69
70
|
# different suggestions on different device types, e.g. DESKTOP, MOBILE. If it
|
@@ -76,8 +77,9 @@ module Google
|
|
76
77
|
# (https://tools.ietf.org/html/bcp47). The maximum number of allowed characters
|
77
78
|
# is 255. Only "en-US" is currently supported.
|
78
79
|
# @param [Fixnum] max_suggestions
|
79
|
-
# Completion max suggestions.
|
80
|
-
#
|
80
|
+
# Completion max suggestions. If left unset or set to 0, then will fallback to
|
81
|
+
# the configured value CompletionConfig.max_suggestions. The maximum allowed max
|
82
|
+
# suggestions is 20. If it is set higher, it will be capped by 20.
|
81
83
|
# @param [String] query
|
82
84
|
# Required. The query used to generate suggestions. The maximum number of
|
83
85
|
# allowed characters is 255.
|
@@ -123,8 +125,9 @@ module Google
|
|
123
125
|
|
124
126
|
# Get which branch is currently default branch set by CatalogService.
|
125
127
|
# SetDefaultBranch method under a specified parent catalog. This feature is only
|
126
|
-
# available for users who have Retail Search enabled.
|
127
|
-
#
|
128
|
+
# available for users who have Retail Search enabled. Please submit a form [here]
|
129
|
+
# (https://cloud.google.com/contact) to contact cloud sales if you are
|
130
|
+
# interested in using Retail Search.
|
128
131
|
# @param [String] catalog
|
129
132
|
# The parent catalog resource name, such as `projects/*/locations/global/
|
130
133
|
# catalogs/default_catalog`.
|
@@ -254,8 +257,8 @@ module Google
|
|
254
257
|
# SearchService will only return product IDs from branch `newBranch` (if branch
|
255
258
|
# is not explicitly set). * UserEventService will only join events with products
|
256
259
|
# from branch `newBranch`. This feature is only available for users who have
|
257
|
-
# Retail Search enabled.
|
258
|
-
#
|
260
|
+
# Retail Search enabled. Please submit a form [here](https://cloud.google.com/
|
261
|
+
# contact) to contact cloud sales if you are interested in using Retail Search.
|
259
262
|
# @param [String] catalog
|
260
263
|
# Full resource name of the catalog, such as `projects/*/locations/global/
|
261
264
|
# catalogs/default_catalog`.
|
@@ -326,8 +329,9 @@ module Google
|
|
326
329
|
# enqueued and processed downstream. As a consequence, when a response is
|
327
330
|
# returned, the added place IDs are not immediately manifested in the Product
|
328
331
|
# queried by GetProduct or ListProducts. This feature is only available for
|
329
|
-
# users who have Retail Search enabled.
|
330
|
-
#
|
332
|
+
# users who have Retail Search enabled. Please submit a form [here](https://
|
333
|
+
# cloud.google.com/contact) to contact cloud sales if you are interested in
|
334
|
+
# using Retail Search.
|
331
335
|
# @param [String] product
|
332
336
|
# Required. Full resource name of Product, such as `projects/*/locations/global/
|
333
337
|
# catalogs/default_catalog/branches/default_branch/products/some_product_id`. If
|
@@ -585,7 +589,6 @@ module Google
|
|
585
589
|
# @param [String] name
|
586
590
|
# Immutable. Full resource name of the product, such as `projects/*/locations/
|
587
591
|
# global/catalogs/default_catalog/branches/default_branch/products/product_id`.
|
588
|
-
# The branch ID must be "default_branch".
|
589
592
|
# @param [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaProduct] google_cloud_retail_v2beta_product_object
|
590
593
|
# @param [Boolean] allow_missing
|
591
594
|
# If set to true, and the Product is not found, a new Product will be created.
|
@@ -633,8 +636,9 @@ module Google
|
|
633
636
|
# enqueued and processed downstream. As a consequence, when a response is
|
634
637
|
# returned, the removed place IDs are not immediately manifested in the Product
|
635
638
|
# queried by GetProduct or ListProducts. This feature is only available for
|
636
|
-
# users who have Retail Search enabled.
|
637
|
-
#
|
639
|
+
# users who have Retail Search enabled. Please submit a form [here](https://
|
640
|
+
# cloud.google.com/contact) to contact cloud sales if you are interested in
|
641
|
+
# using Retail Search.
|
638
642
|
# @param [String] product
|
639
643
|
# Required. Full resource name of Product, such as `projects/*/locations/global/
|
640
644
|
# catalogs/default_catalog/branches/default_branch/products/some_product_id`. If
|
@@ -686,13 +690,12 @@ module Google
|
|
686
690
|
# UpdateProductRequest.set_mask, then any existing inventory information will be
|
687
691
|
# preserved. Pre-existing inventory information can only be updated with
|
688
692
|
# SetInventory, AddFulfillmentPlaces, and RemoveFulfillmentPlaces. This feature
|
689
|
-
# is only available for users who have Retail Search enabled.
|
690
|
-
#
|
691
|
-
# Retail Search.
|
693
|
+
# is only available for users who have Retail Search enabled. Please submit a
|
694
|
+
# form [here](https://cloud.google.com/contact) to contact cloud sales if you
|
695
|
+
# are interested in using Retail Search.
|
692
696
|
# @param [String] name
|
693
697
|
# Immutable. Full resource name of the product, such as `projects/*/locations/
|
694
698
|
# global/catalogs/default_catalog/branches/default_branch/products/product_id`.
|
695
|
-
# The branch ID must be "default_branch".
|
696
699
|
# @param [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaSetInventoryRequest] google_cloud_retail_v2beta_set_inventory_request_object
|
697
700
|
# @param [String] fields
|
698
701
|
# Selector specifying which fields to include in a partial response.
|
@@ -725,8 +728,9 @@ module Google
|
|
725
728
|
|
726
729
|
# Bulk import of processed completion dataset. Request processing may be
|
727
730
|
# synchronous. Partial updating is not supported. This feature is only available
|
728
|
-
# for users who have Retail Search enabled.
|
729
|
-
#
|
731
|
+
# for users who have Retail Search enabled. Please submit a form [here](https://
|
732
|
+
# cloud.google.com/contact) to contact cloud sales if you are interested in
|
733
|
+
# using Retail Search.
|
730
734
|
# @param [String] parent
|
731
735
|
# Required. The catalog which the suggestions dataset belongs to. Format: `
|
732
736
|
# projects/1234/locations/global/catalogs/default_catalog`.
|
@@ -877,8 +881,8 @@ module Google
|
|
877
881
|
end
|
878
882
|
|
879
883
|
# Performs a search. This feature is only available for users who have Retail
|
880
|
-
# Search enabled.
|
881
|
-
# you are interested in using Retail Search.
|
884
|
+
# Search enabled. Please submit a form [here](https://cloud.google.com/contact)
|
885
|
+
# to contact cloud sales if you are interested in using Retail Search.
|
882
886
|
# @param [String] placement
|
883
887
|
# Required. The resource name of the search engine placement, such as `projects/*
|
884
888
|
# /locations/global/catalogs/default_catalog/placements/default_search`. This
|
@@ -31,7 +31,7 @@ module Google
|
|
31
31
|
# This is NOT the gem version.
|
32
32
|
VERSION = 'V2beta'
|
33
33
|
|
34
|
-
# See, edit, configure, and delete your Google Cloud
|
34
|
+
# See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account.
|
35
35
|
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'
|
36
36
|
end
|
37
37
|
end
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: google-apis-retail_v2beta
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.
|
4
|
+
version: 0.17.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: 2021-
|
11
|
+
date: 2021-10-11 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/master/generated/google-apis-retail_v2beta/CHANGELOG.md
|
61
|
-
documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2beta/v0.
|
61
|
+
documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2beta/v0.17.0
|
62
62
|
source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/master/generated/google-apis-retail_v2beta
|
63
63
|
post_install_message:
|
64
64
|
rdoc_options: []
|