google-cloud-retail-v2 0.4.2 → 0.5.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/google/cloud/retail/v2/catalog_service/client.rb +4 -4
- data/lib/google/cloud/retail/v2/catalog_service_services_pb.rb +4 -4
- data/lib/google/cloud/retail/v2/completion_service/client.rb +12 -10
- data/lib/google/cloud/retail/v2/completion_service.rb +2 -2
- data/lib/google/cloud/retail/v2/completion_service_services_pb.rb +6 -6
- data/lib/google/cloud/retail/v2/product_service/client.rb +6 -6
- data/lib/google/cloud/retail/v2/product_service_services_pb.rb +6 -6
- data/lib/google/cloud/retail/v2/search_service/client.rb +54 -33
- data/lib/google/cloud/retail/v2/search_service.rb +2 -2
- data/lib/google/cloud/retail/v2/search_service_pb.rb +2 -0
- data/lib/google/cloud/retail/v2/search_service_services_pb.rb +4 -4
- data/lib/google/cloud/retail/v2/version.rb +1 -1
- data/proto_docs/google/cloud/retail/v2/completion_service.rb +9 -7
- data/proto_docs/google/cloud/retail/v2/import_config.rb +4 -4
- data/proto_docs/google/cloud/retail/v2/product.rb +7 -7
- data/proto_docs/google/cloud/retail/v2/search_service.rb +98 -68
- data/proto_docs/google/cloud/retail/v2/user_event.rb +15 -3
- metadata +2 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 4362ee1ee1297de1e4f20da8c2e02d5b20a38f5334da03e58db621276d2d767b
|
|
4
|
+
data.tar.gz: 7de1bf1b00e922ab9b07c4b7912161f3af7dce3cd46fb4bf4f139d4dd53fba1d
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 1dca8e4dc874b55df773716b5115820d4e4f528a88673cf55107acaae041fd3aa8ee236b5bfaa20244172ae23a9b92053dfb10c77c6ee252610c635f19cc35a9
|
|
7
|
+
data.tar.gz: 66bc9026d1216894564f36f5fe8ed093225e7213ed85e3571dce187a4b9ab672023b51706d727ca4acee795ced47cbcfdb9e1aab84146ca75866546ffc15a8e4
|
|
@@ -358,8 +358,8 @@ module Google
|
|
|
358
358
|
# \\{newBranch}.
|
|
359
359
|
#
|
|
360
360
|
# This feature is only available for users who have Retail Search enabled.
|
|
361
|
-
#
|
|
362
|
-
# interested in using Retail Search.
|
|
361
|
+
# Please submit a form [here](https://cloud.google.com/contact) to contact
|
|
362
|
+
# cloud sales if you are interested in using Retail Search.
|
|
363
363
|
#
|
|
364
364
|
# @overload set_default_branch(request, options = nil)
|
|
365
365
|
# Pass arguments to `set_default_branch` via a request object, either of type
|
|
@@ -445,8 +445,8 @@ module Google
|
|
|
445
445
|
# method under a specified parent catalog.
|
|
446
446
|
#
|
|
447
447
|
# This feature is only available for users who have Retail Search enabled.
|
|
448
|
-
#
|
|
449
|
-
# interested in using Retail Search.
|
|
448
|
+
# Please submit a form [here](https://cloud.google.com/contact) to contact
|
|
449
|
+
# cloud sales if you are interested in using Retail Search.
|
|
450
450
|
#
|
|
451
451
|
# @overload get_default_branch(request, options = nil)
|
|
452
452
|
# Pass arguments to `get_default_branch` via a request object, either of type
|
|
@@ -73,16 +73,16 @@ module Google
|
|
|
73
73
|
# {newBranch}.
|
|
74
74
|
#
|
|
75
75
|
# This feature is only available for users who have Retail Search enabled.
|
|
76
|
-
#
|
|
77
|
-
# interested in using Retail Search.
|
|
76
|
+
# Please submit a form [here](https://cloud.google.com/contact) to contact
|
|
77
|
+
# cloud sales if you are interested in using Retail Search.
|
|
78
78
|
rpc :SetDefaultBranch, ::Google::Cloud::Retail::V2::SetDefaultBranchRequest, ::Google::Protobuf::Empty
|
|
79
79
|
# Get which branch is currently default branch set by
|
|
80
80
|
# [CatalogService.SetDefaultBranch][google.cloud.retail.v2.CatalogService.SetDefaultBranch]
|
|
81
81
|
# method under a specified parent catalog.
|
|
82
82
|
#
|
|
83
83
|
# This feature is only available for users who have Retail Search enabled.
|
|
84
|
-
#
|
|
85
|
-
# interested in using Retail Search.
|
|
84
|
+
# Please submit a form [here](https://cloud.google.com/contact) to contact
|
|
85
|
+
# cloud sales if you are interested in using Retail Search.
|
|
86
86
|
rpc :GetDefaultBranch, ::Google::Cloud::Retail::V2::GetDefaultBranchRequest, ::Google::Cloud::Retail::V2::GetDefaultBranchResponse
|
|
87
87
|
end
|
|
88
88
|
|
|
@@ -30,8 +30,8 @@ module Google
|
|
|
30
30
|
# Auto-completion service for retail.
|
|
31
31
|
#
|
|
32
32
|
# This feature is only available for users who have Retail Search enabled.
|
|
33
|
-
#
|
|
34
|
-
# interested in using Retail Search.
|
|
33
|
+
# Please submit a form [here](https://cloud.google.com/contact) to contact
|
|
34
|
+
# cloud sales if you are interested in using Retail Search.
|
|
35
35
|
#
|
|
36
36
|
class Client
|
|
37
37
|
include Paths
|
|
@@ -169,8 +169,8 @@ module Google
|
|
|
169
169
|
# Completes the specified prefix with keyword suggestions.
|
|
170
170
|
#
|
|
171
171
|
# This feature is only available for users who have Retail Search enabled.
|
|
172
|
-
#
|
|
173
|
-
# interested in using Retail Search.
|
|
172
|
+
# Please submit a form [here](https://cloud.google.com/contact) to contact
|
|
173
|
+
# cloud sales if you are interested in using Retail Search.
|
|
174
174
|
#
|
|
175
175
|
# @overload complete_query(request, options = nil)
|
|
176
176
|
# Pass arguments to `complete_query` via a request object, either of type
|
|
@@ -239,12 +239,14 @@ module Google
|
|
|
239
239
|
# * user-data
|
|
240
240
|
#
|
|
241
241
|
# * cloud-retail
|
|
242
|
-
# This option
|
|
243
|
-
# contact
|
|
242
|
+
# This option requires additional allowlisting. Before using cloud-retail,
|
|
243
|
+
# contact Cloud Retail support team first.
|
|
244
244
|
# @param max_suggestions [::Integer]
|
|
245
|
-
# Completion max suggestions.
|
|
245
|
+
# Completion max suggestions. If left unset or set to 0, then will fallback
|
|
246
|
+
# to the configured value [CompletionConfig.max_suggestions][].
|
|
246
247
|
#
|
|
247
|
-
# The maximum allowed max suggestions is 20.
|
|
248
|
+
# The maximum allowed max suggestions is 20. If it is set higher, it will be
|
|
249
|
+
# capped by 20.
|
|
248
250
|
#
|
|
249
251
|
# @yield [response, operation] Access the result along with the RPC operation
|
|
250
252
|
# @yieldparam response [::Google::Cloud::Retail::V2::CompleteQueryResponse]
|
|
@@ -299,8 +301,8 @@ module Google
|
|
|
299
301
|
# Request processing may be synchronous. Partial updating is not supported.
|
|
300
302
|
#
|
|
301
303
|
# This feature is only available for users who have Retail Search enabled.
|
|
302
|
-
#
|
|
303
|
-
# interested in using Retail Search.
|
|
304
|
+
# Please submit a form [here](https://cloud.google.com/contact) to contact
|
|
305
|
+
# cloud sales if you are interested in using Retail Search.
|
|
304
306
|
#
|
|
305
307
|
# @overload import_completion_data(request, options = nil)
|
|
306
308
|
# Pass arguments to `import_completion_data` via a request object, either of type
|
|
@@ -35,8 +35,8 @@ module Google
|
|
|
35
35
|
# Auto-completion service for retail.
|
|
36
36
|
#
|
|
37
37
|
# This feature is only available for users who have Retail Search enabled.
|
|
38
|
-
#
|
|
39
|
-
# interested in using Retail Search.
|
|
38
|
+
# Please submit a form [here](https://cloud.google.com/contact) to contact
|
|
39
|
+
# cloud sales if you are interested in using Retail Search.
|
|
40
40
|
#
|
|
41
41
|
# To load this service and instantiate a client:
|
|
42
42
|
#
|
|
@@ -27,8 +27,8 @@ module Google
|
|
|
27
27
|
# Auto-completion service for retail.
|
|
28
28
|
#
|
|
29
29
|
# This feature is only available for users who have Retail Search enabled.
|
|
30
|
-
#
|
|
31
|
-
# interested in using Retail Search.
|
|
30
|
+
# Please submit a form [here](https://cloud.google.com/contact) to contact
|
|
31
|
+
# cloud sales if you are interested in using Retail Search.
|
|
32
32
|
class Service
|
|
33
33
|
|
|
34
34
|
include GRPC::GenericService
|
|
@@ -40,16 +40,16 @@ module Google
|
|
|
40
40
|
# Completes the specified prefix with keyword suggestions.
|
|
41
41
|
#
|
|
42
42
|
# This feature is only available for users who have Retail Search enabled.
|
|
43
|
-
#
|
|
44
|
-
# interested in using Retail Search.
|
|
43
|
+
# Please submit a form [here](https://cloud.google.com/contact) to contact
|
|
44
|
+
# cloud sales if you are interested in using Retail Search.
|
|
45
45
|
rpc :CompleteQuery, ::Google::Cloud::Retail::V2::CompleteQueryRequest, ::Google::Cloud::Retail::V2::CompleteQueryResponse
|
|
46
46
|
# Bulk import of processed completion dataset.
|
|
47
47
|
#
|
|
48
48
|
# Request processing may be synchronous. Partial updating is not supported.
|
|
49
49
|
#
|
|
50
50
|
# This feature is only available for users who have Retail Search enabled.
|
|
51
|
-
#
|
|
52
|
-
# interested in using Retail Search.
|
|
51
|
+
# Please submit a form [here](https://cloud.google.com/contact) to contact
|
|
52
|
+
# cloud sales if you are interested in using Retail Search.
|
|
53
53
|
rpc :ImportCompletionData, ::Google::Cloud::Retail::V2::ImportCompletionDataRequest, ::Google::Longrunning::Operation
|
|
54
54
|
end
|
|
55
55
|
|
|
@@ -792,8 +792,8 @@ module Google
|
|
|
792
792
|
# {::Google::Cloud::Retail::V2::ProductService::Client#remove_fulfillment_places RemoveFulfillmentPlaces}.
|
|
793
793
|
#
|
|
794
794
|
# This feature is only available for users who have Retail Search enabled.
|
|
795
|
-
#
|
|
796
|
-
# interested in using Retail Search.
|
|
795
|
+
# Please submit a form [here](https://cloud.google.com/contact) to contact
|
|
796
|
+
# cloud sales if you are interested in using Retail Search.
|
|
797
797
|
#
|
|
798
798
|
# @overload set_inventory(request, options = nil)
|
|
799
799
|
# Pass arguments to `set_inventory` via a request object, either of type
|
|
@@ -927,8 +927,8 @@ module Google
|
|
|
927
927
|
# {::Google::Cloud::Retail::V2::ProductService::Client#list_products ListProducts}.
|
|
928
928
|
#
|
|
929
929
|
# This feature is only available for users who have Retail Search enabled.
|
|
930
|
-
#
|
|
931
|
-
# interested in using Retail Search.
|
|
930
|
+
# Please submit a form [here](https://cloud.google.com/contact) to contact
|
|
931
|
+
# cloud sales if you are interested in using Retail Search.
|
|
932
932
|
#
|
|
933
933
|
# @overload add_fulfillment_places(request, options = nil)
|
|
934
934
|
# Pass arguments to `add_fulfillment_places` via a request object, either of type
|
|
@@ -1063,8 +1063,8 @@ module Google
|
|
|
1063
1063
|
# {::Google::Cloud::Retail::V2::ProductService::Client#list_products ListProducts}.
|
|
1064
1064
|
#
|
|
1065
1065
|
# This feature is only available for users who have Retail Search enabled.
|
|
1066
|
-
#
|
|
1067
|
-
# interested in using Retail Search.
|
|
1066
|
+
# Please submit a form [here](https://cloud.google.com/contact) to contact
|
|
1067
|
+
# cloud sales if you are interested in using Retail Search.
|
|
1068
1068
|
#
|
|
1069
1069
|
# @overload remove_fulfillment_places(request, options = nil)
|
|
1070
1070
|
# Pass arguments to `remove_fulfillment_places` via a request object, either of type
|
|
@@ -90,8 +90,8 @@ module Google
|
|
|
90
90
|
# [RemoveFulfillmentPlaces][google.cloud.retail.v2.ProductService.RemoveFulfillmentPlaces].
|
|
91
91
|
#
|
|
92
92
|
# This feature is only available for users who have Retail Search enabled.
|
|
93
|
-
#
|
|
94
|
-
# interested in using Retail Search.
|
|
93
|
+
# Please submit a form [here](https://cloud.google.com/contact) to contact
|
|
94
|
+
# cloud sales if you are interested in using Retail Search.
|
|
95
95
|
rpc :SetInventory, ::Google::Cloud::Retail::V2::SetInventoryRequest, ::Google::Longrunning::Operation
|
|
96
96
|
# Incrementally adds place IDs to
|
|
97
97
|
# [Product.fulfillment_info.place_ids][google.cloud.retail.v2.FulfillmentInfo.place_ids].
|
|
@@ -106,8 +106,8 @@ module Google
|
|
|
106
106
|
# [ListProducts][google.cloud.retail.v2.ProductService.ListProducts].
|
|
107
107
|
#
|
|
108
108
|
# This feature is only available for users who have Retail Search enabled.
|
|
109
|
-
#
|
|
110
|
-
# interested in using Retail Search.
|
|
109
|
+
# Please submit a form [here](https://cloud.google.com/contact) to contact
|
|
110
|
+
# cloud sales if you are interested in using Retail Search.
|
|
111
111
|
rpc :AddFulfillmentPlaces, ::Google::Cloud::Retail::V2::AddFulfillmentPlacesRequest, ::Google::Longrunning::Operation
|
|
112
112
|
# Incrementally removes place IDs from a
|
|
113
113
|
# [Product.fulfillment_info.place_ids][google.cloud.retail.v2.FulfillmentInfo.place_ids].
|
|
@@ -122,8 +122,8 @@ module Google
|
|
|
122
122
|
# [ListProducts][google.cloud.retail.v2.ProductService.ListProducts].
|
|
123
123
|
#
|
|
124
124
|
# This feature is only available for users who have Retail Search enabled.
|
|
125
|
-
#
|
|
126
|
-
# interested in using Retail Search.
|
|
125
|
+
# Please submit a form [here](https://cloud.google.com/contact) to contact
|
|
126
|
+
# cloud sales if you are interested in using Retail Search.
|
|
127
127
|
rpc :RemoveFulfillmentPlaces, ::Google::Cloud::Retail::V2::RemoveFulfillmentPlacesRequest, ::Google::Longrunning::Operation
|
|
128
128
|
end
|
|
129
129
|
|
|
@@ -30,8 +30,8 @@ module Google
|
|
|
30
30
|
# Service for search.
|
|
31
31
|
#
|
|
32
32
|
# This feature is only available for users who have Retail Search enabled.
|
|
33
|
-
#
|
|
34
|
-
# interested in using Retail Search.
|
|
33
|
+
# Please submit a form [here](https://cloud.google.com/contact) to contact
|
|
34
|
+
# cloud sales if you are interested in using Retail Search.
|
|
35
35
|
#
|
|
36
36
|
class Client
|
|
37
37
|
include Paths
|
|
@@ -157,8 +157,8 @@ module Google
|
|
|
157
157
|
# Performs a search.
|
|
158
158
|
#
|
|
159
159
|
# This feature is only available for users who have Retail Search enabled.
|
|
160
|
-
#
|
|
161
|
-
# interested in using Retail Search.
|
|
160
|
+
# Please submit a form [here](https://cloud.google.com/contact) to contact
|
|
161
|
+
# cloud sales if you are interested in using Retail Search.
|
|
162
162
|
#
|
|
163
163
|
# @overload search(request, options = nil)
|
|
164
164
|
# Pass arguments to `search` via a request object, either of type
|
|
@@ -230,7 +230,8 @@ module Google
|
|
|
230
230
|
# @param filter [::String]
|
|
231
231
|
# The filter syntax consists of an expression language for constructing a
|
|
232
232
|
# predicate from one or more fields of the products being filtered. Filter
|
|
233
|
-
# expression is case-sensitive.
|
|
233
|
+
# expression is case-sensitive. See more details at this [user
|
|
234
|
+
# guide](/retail/private/docs/filter-and-order#filter).
|
|
234
235
|
#
|
|
235
236
|
# If this field is unrecognizable, an INVALID_ARGUMENT is returned.
|
|
236
237
|
# @param canonical_filter [::String]
|
|
@@ -246,7 +247,9 @@ module Google
|
|
|
246
247
|
# @param order_by [::String]
|
|
247
248
|
# The order in which products are returned. Products can be ordered by
|
|
248
249
|
# a field in an {::Google::Cloud::Retail::V2::Product Product} object. Leave it
|
|
249
|
-
# unset if ordered by relevance. OrderBy expression is case-sensitive.
|
|
250
|
+
# unset if ordered by relevance. OrderBy expression is case-sensitive. See
|
|
251
|
+
# more details at this [user
|
|
252
|
+
# guide](/retail/private/docs/filter-and-order#order).
|
|
250
253
|
#
|
|
251
254
|
# If this field is unrecognizable, an INVALID_ARGUMENT is returned.
|
|
252
255
|
# @param facet_specs [::Array<::Google::Cloud::Retail::V2::SearchRequest::FacetSpec, ::Hash>]
|
|
@@ -258,14 +261,15 @@ module Google
|
|
|
258
261
|
# The specification for dynamically generated facets. Notice that only
|
|
259
262
|
# textual facets can be dynamically generated.
|
|
260
263
|
#
|
|
261
|
-
# This feature requires additional allowlisting. Contact Retail
|
|
262
|
-
#
|
|
263
|
-
# facet feature.
|
|
264
|
+
# This feature requires additional allowlisting. Contact Retail Search
|
|
265
|
+
# support team if you are interested in using dynamic facet feature.
|
|
264
266
|
# @param boost_spec [::Google::Cloud::Retail::V2::SearchRequest::BoostSpec, ::Hash]
|
|
265
|
-
# Boost specification to boost certain products.
|
|
267
|
+
# Boost specification to boost certain products. See more details at this
|
|
268
|
+
# [user guide](/retail/private/docs/boosting).
|
|
266
269
|
# @param query_expansion_spec [::Google::Cloud::Retail::V2::SearchRequest::QueryExpansionSpec, ::Hash]
|
|
267
270
|
# The query expansion specification that specifies the conditions under which
|
|
268
|
-
# query expansion will occur.
|
|
271
|
+
# query expansion will occur. See more details at this [user
|
|
272
|
+
# guide](/retail/private/docs/result-size#query_expansion).
|
|
269
273
|
# @param variant_rollup_keys [::Array<::String>]
|
|
270
274
|
# The keys to fetch and rollup the matching
|
|
271
275
|
# {::Google::Cloud::Retail::V2::Product::Type::VARIANT variant}
|
|
@@ -276,10 +280,9 @@ module Google
|
|
|
276
280
|
# {::Google::Cloud::Retail::V2::Product Product}s attributes will lead to extra
|
|
277
281
|
# query latency. Maximum number of keys is 10.
|
|
278
282
|
#
|
|
279
|
-
# For
|
|
280
|
-
#
|
|
281
|
-
#
|
|
282
|
-
# "fulfillmentType.filfillmentId". E.g., in "pickupInStore.store123",
|
|
283
|
+
# For {::Google::Cloud::Retail::V2::FulfillmentInfo FulfillmentInfo}, a
|
|
284
|
+
# fulfillment type and a fulfillment ID must be provided in the format of
|
|
285
|
+
# "fulfillmentType.fulfillmentId". E.g., in "pickupInStore.store123",
|
|
283
286
|
# "pickupInStore" is fulfillment type and "store123" is the store ID.
|
|
284
287
|
#
|
|
285
288
|
# Supported keys are:
|
|
@@ -290,24 +293,42 @@ module Google
|
|
|
290
293
|
# * discount
|
|
291
294
|
# * attributes.key, where key is any key in the
|
|
292
295
|
# {::Google::Cloud::Retail::V2::Product#attributes Product.attributes} map.
|
|
293
|
-
# * pickupInStore.id, where id is any
|
|
294
|
-
#
|
|
295
|
-
#
|
|
296
|
-
#
|
|
297
|
-
# *
|
|
298
|
-
#
|
|
299
|
-
#
|
|
300
|
-
#
|
|
301
|
-
# *
|
|
302
|
-
#
|
|
303
|
-
#
|
|
304
|
-
#
|
|
305
|
-
# *
|
|
306
|
-
#
|
|
307
|
-
#
|
|
308
|
-
#
|
|
309
|
-
# *
|
|
310
|
-
#
|
|
296
|
+
# * pickupInStore.id, where id is any
|
|
297
|
+
# {::Google::Cloud::Retail::V2::FulfillmentInfo#place_ids FulfillmentInfo.place_ids}
|
|
298
|
+
# for {::Google::Cloud::Retail::V2::FulfillmentInfo#type FulfillmentInfo.type}
|
|
299
|
+
# "pickup-in-store".
|
|
300
|
+
# * shipToStore.id, where id is any
|
|
301
|
+
# {::Google::Cloud::Retail::V2::FulfillmentInfo#place_ids FulfillmentInfo.place_ids}
|
|
302
|
+
# for {::Google::Cloud::Retail::V2::FulfillmentInfo#type FulfillmentInfo.type}
|
|
303
|
+
# "ship-to-store".
|
|
304
|
+
# * sameDayDelivery.id, where id is any
|
|
305
|
+
# {::Google::Cloud::Retail::V2::FulfillmentInfo#place_ids FulfillmentInfo.place_ids}
|
|
306
|
+
# for {::Google::Cloud::Retail::V2::FulfillmentInfo#type FulfillmentInfo.type}
|
|
307
|
+
# "same-day-delivery".
|
|
308
|
+
# * nextDayDelivery.id, where id is any
|
|
309
|
+
# {::Google::Cloud::Retail::V2::FulfillmentInfo#place_ids FulfillmentInfo.place_ids}
|
|
310
|
+
# for {::Google::Cloud::Retail::V2::FulfillmentInfo#type FulfillmentInfo.type}
|
|
311
|
+
# "next-day-delivery".
|
|
312
|
+
# * customFulfillment1.id, where id is any
|
|
313
|
+
# {::Google::Cloud::Retail::V2::FulfillmentInfo#place_ids FulfillmentInfo.place_ids}
|
|
314
|
+
# for {::Google::Cloud::Retail::V2::FulfillmentInfo#type FulfillmentInfo.type}
|
|
315
|
+
# "custom-type-1".
|
|
316
|
+
# * customFulfillment2.id, where id is any
|
|
317
|
+
# {::Google::Cloud::Retail::V2::FulfillmentInfo#place_ids FulfillmentInfo.place_ids}
|
|
318
|
+
# for {::Google::Cloud::Retail::V2::FulfillmentInfo#type FulfillmentInfo.type}
|
|
319
|
+
# "custom-type-2".
|
|
320
|
+
# * customFulfillment3.id, where id is any
|
|
321
|
+
# {::Google::Cloud::Retail::V2::FulfillmentInfo#place_ids FulfillmentInfo.place_ids}
|
|
322
|
+
# for {::Google::Cloud::Retail::V2::FulfillmentInfo#type FulfillmentInfo.type}
|
|
323
|
+
# "custom-type-3".
|
|
324
|
+
# * customFulfillment4.id, where id is any
|
|
325
|
+
# {::Google::Cloud::Retail::V2::FulfillmentInfo#place_ids FulfillmentInfo.place_ids}
|
|
326
|
+
# for {::Google::Cloud::Retail::V2::FulfillmentInfo#type FulfillmentInfo.type}
|
|
327
|
+
# "custom-type-4".
|
|
328
|
+
# * customFulfillment5.id, where id is any
|
|
329
|
+
# {::Google::Cloud::Retail::V2::FulfillmentInfo#place_ids FulfillmentInfo.place_ids}
|
|
330
|
+
# for {::Google::Cloud::Retail::V2::FulfillmentInfo#type FulfillmentInfo.type}
|
|
331
|
+
# "custom-type-5".
|
|
311
332
|
#
|
|
312
333
|
# If this field is set to an invalid value other than these, an
|
|
313
334
|
# INVALID_ARGUMENT error is returned.
|
|
@@ -34,8 +34,8 @@ module Google
|
|
|
34
34
|
# Service for search.
|
|
35
35
|
#
|
|
36
36
|
# This feature is only available for users who have Retail Search enabled.
|
|
37
|
-
#
|
|
38
|
-
# interested in using Retail Search.
|
|
37
|
+
# Please submit a form [here](https://cloud.google.com/contact) to contact
|
|
38
|
+
# cloud sales if you are interested in using Retail Search.
|
|
39
39
|
#
|
|
40
40
|
# To load this service and instantiate a client:
|
|
41
41
|
#
|
|
@@ -66,6 +66,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
|
|
|
66
66
|
end
|
|
67
67
|
add_message "google.cloud.retail.v2.SearchRequest.QueryExpansionSpec" do
|
|
68
68
|
optional :condition, :enum, 1, "google.cloud.retail.v2.SearchRequest.QueryExpansionSpec.Condition"
|
|
69
|
+
optional :pin_unexpanded_results, :bool, 2
|
|
69
70
|
end
|
|
70
71
|
add_enum "google.cloud.retail.v2.SearchRequest.QueryExpansionSpec.Condition" do
|
|
71
72
|
value :CONDITION_UNSPECIFIED, 0
|
|
@@ -103,6 +104,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
|
|
|
103
104
|
end
|
|
104
105
|
add_message "google.cloud.retail.v2.SearchResponse.QueryExpansionInfo" do
|
|
105
106
|
optional :expanded_query, :bool, 1
|
|
107
|
+
optional :pinned_result_count, :int64, 2
|
|
106
108
|
end
|
|
107
109
|
end
|
|
108
110
|
end
|
|
@@ -27,8 +27,8 @@ module Google
|
|
|
27
27
|
# Service for search.
|
|
28
28
|
#
|
|
29
29
|
# This feature is only available for users who have Retail Search enabled.
|
|
30
|
-
#
|
|
31
|
-
# interested in using Retail Search.
|
|
30
|
+
# Please submit a form [here](https://cloud.google.com/contact) to contact
|
|
31
|
+
# cloud sales if you are interested in using Retail Search.
|
|
32
32
|
class Service
|
|
33
33
|
|
|
34
34
|
include GRPC::GenericService
|
|
@@ -40,8 +40,8 @@ module Google
|
|
|
40
40
|
# Performs a search.
|
|
41
41
|
#
|
|
42
42
|
# This feature is only available for users who have Retail Search enabled.
|
|
43
|
-
#
|
|
44
|
-
# interested in using Retail Search.
|
|
43
|
+
# Please submit a form [here](https://cloud.google.com/contact) to contact
|
|
44
|
+
# cloud sales if you are interested in using Retail Search.
|
|
45
45
|
rpc :Search, ::Google::Cloud::Retail::V2::SearchRequest, ::Google::Cloud::Retail::V2::SearchResponse
|
|
46
46
|
end
|
|
47
47
|
|
|
@@ -80,13 +80,15 @@ module Google
|
|
|
80
80
|
# * user-data
|
|
81
81
|
#
|
|
82
82
|
# * cloud-retail
|
|
83
|
-
# This option
|
|
84
|
-
# contact
|
|
83
|
+
# This option requires additional allowlisting. Before using cloud-retail,
|
|
84
|
+
# contact Cloud Retail support team first.
|
|
85
85
|
# @!attribute [rw] max_suggestions
|
|
86
86
|
# @return [::Integer]
|
|
87
|
-
# Completion max suggestions.
|
|
87
|
+
# Completion max suggestions. If left unset or set to 0, then will fallback
|
|
88
|
+
# to the configured value [CompletionConfig.max_suggestions][].
|
|
88
89
|
#
|
|
89
|
-
# The maximum allowed max suggestions is 20.
|
|
90
|
+
# The maximum allowed max suggestions is 20. If it is set higher, it will be
|
|
91
|
+
# capped by 20.
|
|
90
92
|
class CompleteQueryRequest
|
|
91
93
|
include ::Google::Protobuf::MessageExts
|
|
92
94
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
@@ -105,9 +107,9 @@ module Google
|
|
|
105
107
|
# performance.
|
|
106
108
|
# @!attribute [rw] recent_search_results
|
|
107
109
|
# @return [::Array<::Google::Cloud::Retail::V2::CompleteQueryResponse::RecentSearchResult>]
|
|
108
|
-
# Matched recent searches of this user.
|
|
109
|
-
#
|
|
110
|
-
# interested in enabling it.
|
|
110
|
+
# Matched recent searches of this user. The maximum number of recent searches
|
|
111
|
+
# is 10. This field is a restricted feature. Contact Retail Search support
|
|
112
|
+
# team if you are interested in enabling it.
|
|
111
113
|
#
|
|
112
114
|
# This feature is only available when
|
|
113
115
|
# {::Google::Cloud::Retail::V2::CompleteQueryRequest#visitor_id CompleteQueryRequest.visitor_id}
|
|
@@ -201,13 +201,13 @@ module Google
|
|
|
201
201
|
# Can only be while using
|
|
202
202
|
# {::Google::Cloud::Retail::V2::BigQuerySource BigQuerySource}.
|
|
203
203
|
#
|
|
204
|
-
# Add the IAM permission
|
|
204
|
+
# Add the IAM permission "BigQuery Data Viewer" for
|
|
205
205
|
# cloud-retail-customer-data-access@system.gserviceaccount.com before
|
|
206
206
|
# using this feature otherwise an error is thrown.
|
|
207
207
|
#
|
|
208
208
|
# This feature is only available for users who have Retail Search enabled.
|
|
209
|
-
#
|
|
210
|
-
# interested in using Retail Search.
|
|
209
|
+
# Please submit a form [here](https://cloud.google.com/contact) to contact
|
|
210
|
+
# cloud sales if you are interested in using Retail Search.
|
|
211
211
|
FULL = 2
|
|
212
212
|
end
|
|
213
213
|
end
|
|
@@ -284,7 +284,7 @@ module Google
|
|
|
284
284
|
# @return [::Google::Cloud::Retail::V2::BigQuerySource]
|
|
285
285
|
# Required. BigQuery input source.
|
|
286
286
|
#
|
|
287
|
-
# Add the IAM permission
|
|
287
|
+
# Add the IAM permission "BigQuery Data Viewer" for
|
|
288
288
|
# cloud-retail-customer-data-access@system.gserviceaccount.com before
|
|
289
289
|
# using this feature otherwise an error is thrown.
|
|
290
290
|
class CompletionDataInputConfig
|
|
@@ -230,13 +230,9 @@ module Google
|
|
|
230
230
|
# This field needs to pass all below criteria, otherwise an INVALID_ARGUMENT
|
|
231
231
|
# error is returned:
|
|
232
232
|
#
|
|
233
|
-
# * Max entries count: 200
|
|
234
|
-
# {::Google::Cloud::Retail::V2::Product::Type::VARIANT Type.VARIANT}.
|
|
233
|
+
# * Max entries count: 200.
|
|
235
234
|
# * The key must be a UTF-8 encoded string with a length limit of 128
|
|
236
235
|
# characters.
|
|
237
|
-
# * Max indexable entries count: 200 by default; 40 for
|
|
238
|
-
# {::Google::Cloud::Retail::V2::Product::Type::VARIANT Type.VARIANT}.
|
|
239
|
-
# * Max searchable entries count: 30.
|
|
240
236
|
# * For indexable attribute, the key must match the pattern:
|
|
241
237
|
# [a-zA-Z0-9][a-zA-Z0-9_]*. For example, key0LikeThis or KEY_1_LIKE_THIS.
|
|
242
238
|
# @!attribute [rw] tags
|
|
@@ -346,7 +342,7 @@ module Google
|
|
|
346
342
|
# @return [::Array<::String>]
|
|
347
343
|
# The material of the product. For example, "leather", "wooden".
|
|
348
344
|
#
|
|
349
|
-
# A maximum of
|
|
345
|
+
# A maximum of 20 values are allowed. Each value must be a UTF-8 encoded
|
|
350
346
|
# string with a length limit of 128 characters. Otherwise, an
|
|
351
347
|
# INVALID_ARGUMENT error is returned.
|
|
352
348
|
#
|
|
@@ -445,8 +441,12 @@ module Google
|
|
|
445
441
|
# * {::Google::Cloud::Retail::V2::Product#name name}
|
|
446
442
|
# * {::Google::Cloud::Retail::V2::Product#color_info color_info}
|
|
447
443
|
#
|
|
448
|
-
# Maximum number of paths is
|
|
444
|
+
# Maximum number of paths is 30. Otherwise, an INVALID_ARGUMENT error is
|
|
449
445
|
# returned.
|
|
446
|
+
#
|
|
447
|
+
# Note: Returning more fields in
|
|
448
|
+
# {::Google::Cloud::Retail::V2::SearchResponse SearchResponse} may increase
|
|
449
|
+
# response payload size and serving latency.
|
|
450
450
|
# @!attribute [r] variants
|
|
451
451
|
# @return [::Array<::Google::Cloud::Retail::V2::Product>]
|
|
452
452
|
# Output only. Product variants grouped together on primary product which
|
|
@@ -87,7 +87,8 @@ module Google
|
|
|
87
87
|
# @return [::String]
|
|
88
88
|
# The filter syntax consists of an expression language for constructing a
|
|
89
89
|
# predicate from one or more fields of the products being filtered. Filter
|
|
90
|
-
# expression is case-sensitive.
|
|
90
|
+
# expression is case-sensitive. See more details at this [user
|
|
91
|
+
# guide](/retail/private/docs/filter-and-order#filter).
|
|
91
92
|
#
|
|
92
93
|
# If this field is unrecognizable, an INVALID_ARGUMENT is returned.
|
|
93
94
|
# @!attribute [rw] canonical_filter
|
|
@@ -105,7 +106,9 @@ module Google
|
|
|
105
106
|
# @return [::String]
|
|
106
107
|
# The order in which products are returned. Products can be ordered by
|
|
107
108
|
# a field in an {::Google::Cloud::Retail::V2::Product Product} object. Leave it
|
|
108
|
-
# unset if ordered by relevance. OrderBy expression is case-sensitive.
|
|
109
|
+
# unset if ordered by relevance. OrderBy expression is case-sensitive. See
|
|
110
|
+
# more details at this [user
|
|
111
|
+
# guide](/retail/private/docs/filter-and-order#order).
|
|
109
112
|
#
|
|
110
113
|
# If this field is unrecognizable, an INVALID_ARGUMENT is returned.
|
|
111
114
|
# @!attribute [rw] facet_specs
|
|
@@ -119,16 +122,17 @@ module Google
|
|
|
119
122
|
# The specification for dynamically generated facets. Notice that only
|
|
120
123
|
# textual facets can be dynamically generated.
|
|
121
124
|
#
|
|
122
|
-
# This feature requires additional allowlisting. Contact Retail
|
|
123
|
-
#
|
|
124
|
-
# facet feature.
|
|
125
|
+
# This feature requires additional allowlisting. Contact Retail Search
|
|
126
|
+
# support team if you are interested in using dynamic facet feature.
|
|
125
127
|
# @!attribute [rw] boost_spec
|
|
126
128
|
# @return [::Google::Cloud::Retail::V2::SearchRequest::BoostSpec]
|
|
127
|
-
# Boost specification to boost certain products.
|
|
129
|
+
# Boost specification to boost certain products. See more details at this
|
|
130
|
+
# [user guide](/retail/private/docs/boosting).
|
|
128
131
|
# @!attribute [rw] query_expansion_spec
|
|
129
132
|
# @return [::Google::Cloud::Retail::V2::SearchRequest::QueryExpansionSpec]
|
|
130
133
|
# The query expansion specification that specifies the conditions under which
|
|
131
|
-
# query expansion will occur.
|
|
134
|
+
# query expansion will occur. See more details at this [user
|
|
135
|
+
# guide](/retail/private/docs/result-size#query_expansion).
|
|
132
136
|
# @!attribute [rw] variant_rollup_keys
|
|
133
137
|
# @return [::Array<::String>]
|
|
134
138
|
# The keys to fetch and rollup the matching
|
|
@@ -140,10 +144,9 @@ module Google
|
|
|
140
144
|
# {::Google::Cloud::Retail::V2::Product Product}s attributes will lead to extra
|
|
141
145
|
# query latency. Maximum number of keys is 10.
|
|
142
146
|
#
|
|
143
|
-
# For
|
|
144
|
-
#
|
|
145
|
-
#
|
|
146
|
-
# "fulfillmentType.filfillmentId". E.g., in "pickupInStore.store123",
|
|
147
|
+
# For {::Google::Cloud::Retail::V2::FulfillmentInfo FulfillmentInfo}, a
|
|
148
|
+
# fulfillment type and a fulfillment ID must be provided in the format of
|
|
149
|
+
# "fulfillmentType.fulfillmentId". E.g., in "pickupInStore.store123",
|
|
147
150
|
# "pickupInStore" is fulfillment type and "store123" is the store ID.
|
|
148
151
|
#
|
|
149
152
|
# Supported keys are:
|
|
@@ -154,24 +157,42 @@ module Google
|
|
|
154
157
|
# * discount
|
|
155
158
|
# * attributes.key, where key is any key in the
|
|
156
159
|
# {::Google::Cloud::Retail::V2::Product#attributes Product.attributes} map.
|
|
157
|
-
# * pickupInStore.id, where id is any
|
|
158
|
-
#
|
|
159
|
-
#
|
|
160
|
-
#
|
|
161
|
-
# *
|
|
162
|
-
#
|
|
163
|
-
#
|
|
164
|
-
#
|
|
165
|
-
# *
|
|
166
|
-
#
|
|
167
|
-
#
|
|
168
|
-
#
|
|
169
|
-
# *
|
|
170
|
-
#
|
|
171
|
-
#
|
|
172
|
-
#
|
|
173
|
-
# *
|
|
174
|
-
#
|
|
160
|
+
# * pickupInStore.id, where id is any
|
|
161
|
+
# {::Google::Cloud::Retail::V2::FulfillmentInfo#place_ids FulfillmentInfo.place_ids}
|
|
162
|
+
# for {::Google::Cloud::Retail::V2::FulfillmentInfo#type FulfillmentInfo.type}
|
|
163
|
+
# "pickup-in-store".
|
|
164
|
+
# * shipToStore.id, where id is any
|
|
165
|
+
# {::Google::Cloud::Retail::V2::FulfillmentInfo#place_ids FulfillmentInfo.place_ids}
|
|
166
|
+
# for {::Google::Cloud::Retail::V2::FulfillmentInfo#type FulfillmentInfo.type}
|
|
167
|
+
# "ship-to-store".
|
|
168
|
+
# * sameDayDelivery.id, where id is any
|
|
169
|
+
# {::Google::Cloud::Retail::V2::FulfillmentInfo#place_ids FulfillmentInfo.place_ids}
|
|
170
|
+
# for {::Google::Cloud::Retail::V2::FulfillmentInfo#type FulfillmentInfo.type}
|
|
171
|
+
# "same-day-delivery".
|
|
172
|
+
# * nextDayDelivery.id, where id is any
|
|
173
|
+
# {::Google::Cloud::Retail::V2::FulfillmentInfo#place_ids FulfillmentInfo.place_ids}
|
|
174
|
+
# for {::Google::Cloud::Retail::V2::FulfillmentInfo#type FulfillmentInfo.type}
|
|
175
|
+
# "next-day-delivery".
|
|
176
|
+
# * customFulfillment1.id, where id is any
|
|
177
|
+
# {::Google::Cloud::Retail::V2::FulfillmentInfo#place_ids FulfillmentInfo.place_ids}
|
|
178
|
+
# for {::Google::Cloud::Retail::V2::FulfillmentInfo#type FulfillmentInfo.type}
|
|
179
|
+
# "custom-type-1".
|
|
180
|
+
# * customFulfillment2.id, where id is any
|
|
181
|
+
# {::Google::Cloud::Retail::V2::FulfillmentInfo#place_ids FulfillmentInfo.place_ids}
|
|
182
|
+
# for {::Google::Cloud::Retail::V2::FulfillmentInfo#type FulfillmentInfo.type}
|
|
183
|
+
# "custom-type-2".
|
|
184
|
+
# * customFulfillment3.id, where id is any
|
|
185
|
+
# {::Google::Cloud::Retail::V2::FulfillmentInfo#place_ids FulfillmentInfo.place_ids}
|
|
186
|
+
# for {::Google::Cloud::Retail::V2::FulfillmentInfo#type FulfillmentInfo.type}
|
|
187
|
+
# "custom-type-3".
|
|
188
|
+
# * customFulfillment4.id, where id is any
|
|
189
|
+
# {::Google::Cloud::Retail::V2::FulfillmentInfo#place_ids FulfillmentInfo.place_ids}
|
|
190
|
+
# for {::Google::Cloud::Retail::V2::FulfillmentInfo#type FulfillmentInfo.type}
|
|
191
|
+
# "custom-type-4".
|
|
192
|
+
# * customFulfillment5.id, where id is any
|
|
193
|
+
# {::Google::Cloud::Retail::V2::FulfillmentInfo#place_ids FulfillmentInfo.place_ids}
|
|
194
|
+
# for {::Google::Cloud::Retail::V2::FulfillmentInfo#type FulfillmentInfo.type}
|
|
195
|
+
# "custom-type-5".
|
|
175
196
|
#
|
|
176
197
|
# If this field is set to an invalid value other than these, an
|
|
177
198
|
# INVALID_ARGUMENT error is returned.
|
|
@@ -269,35 +290,35 @@ module Google
|
|
|
269
290
|
# {::Google::Cloud::Retail::V2::SearchRequest::FacetSpec::FacetKey#query FacetKey.query}
|
|
270
291
|
# is not specified:
|
|
271
292
|
#
|
|
272
|
-
#
|
|
273
|
-
#
|
|
274
|
-
#
|
|
275
|
-
#
|
|
276
|
-
#
|
|
277
|
-
#
|
|
278
|
-
#
|
|
279
|
-
#
|
|
280
|
-
#
|
|
281
|
-
#
|
|
282
|
-
#
|
|
283
|
-
#
|
|
284
|
-
#
|
|
285
|
-
#
|
|
286
|
-
#
|
|
287
|
-
#
|
|
288
|
-
#
|
|
289
|
-
#
|
|
290
|
-
#
|
|
291
|
-
#
|
|
292
|
-
#
|
|
293
|
-
#
|
|
293
|
+
# * textual_field =
|
|
294
|
+
# * "brands"
|
|
295
|
+
# * "categories"
|
|
296
|
+
# * "genders"
|
|
297
|
+
# * "ageGroups"
|
|
298
|
+
# * "availability"
|
|
299
|
+
# * "colorFamilies"
|
|
300
|
+
# * "colors"
|
|
301
|
+
# * "sizes"
|
|
302
|
+
# * "materials"
|
|
303
|
+
# * "patterns"
|
|
304
|
+
# * "conditions"
|
|
305
|
+
# * "attributes.key"
|
|
306
|
+
# * "pickupInStore"
|
|
307
|
+
# * "shipToStore"
|
|
308
|
+
# * "sameDayDelivery"
|
|
309
|
+
# * "nextDayDelivery"
|
|
310
|
+
# * "customFulfillment1"
|
|
311
|
+
# * "customFulfillment2"
|
|
312
|
+
# * "customFulfillment3"
|
|
313
|
+
# * "customFulfillment4"
|
|
314
|
+
# * "customFulfillment5"
|
|
294
315
|
#
|
|
295
|
-
#
|
|
296
|
-
#
|
|
297
|
-
#
|
|
298
|
-
#
|
|
299
|
-
#
|
|
300
|
-
#
|
|
316
|
+
# * numerical_field =
|
|
317
|
+
# * "price"
|
|
318
|
+
# * "discount"
|
|
319
|
+
# * "rating"
|
|
320
|
+
# * "ratingCount"
|
|
321
|
+
# * "attributes.key"
|
|
301
322
|
# @!attribute [rw] intervals
|
|
302
323
|
# @return [::Array<::Google::Cloud::Retail::V2::Interval>]
|
|
303
324
|
# Set only if values should be bucketized into intervals. Must be set
|
|
@@ -361,7 +382,8 @@ module Google
|
|
|
361
382
|
# order](https://en.wikipedia.org/wiki/Natural_sort_order); numerical
|
|
362
383
|
# intervals are sorted in the order given by
|
|
363
384
|
# {::Google::Cloud::Retail::V2::SearchRequest::FacetSpec::FacetKey#intervals FacetSpec.FacetKey.intervals};
|
|
364
|
-
#
|
|
385
|
+
# {::Google::Cloud::Retail::V2::FulfillmentInfo#place_ids FulfillmentInfo.place_ids}
|
|
386
|
+
# are sorted in the order given by
|
|
365
387
|
# {::Google::Cloud::Retail::V2::SearchRequest::FacetSpec::FacetKey#restricted_values FacetSpec.FacetKey.restricted_values}.
|
|
366
388
|
# @!attribute [rw] query
|
|
367
389
|
# @return [::String]
|
|
@@ -437,12 +459,11 @@ module Google
|
|
|
437
459
|
# Examples:
|
|
438
460
|
#
|
|
439
461
|
# * To boost products with product ID "product_1" or "product_2", and
|
|
440
|
-
# color
|
|
441
|
-
#
|
|
442
|
-
# (id: ANY("product_1", "product_2"))
|
|
443
|
-
# AND
|
|
444
|
-
# (colorFamilies: ANY("Red", "Blue"))
|
|
445
|
-
# ```
|
|
462
|
+
# color
|
|
463
|
+
# "Red" or "Blue":<br>
|
|
464
|
+
# *(id: ANY("product_1", "product_2"))<br>*
|
|
465
|
+
# *AND<br>*
|
|
466
|
+
# *(colorFamilies: ANY("Red", "Blue"))<br>*
|
|
446
467
|
# @!attribute [rw] boost
|
|
447
468
|
# @return [::Float]
|
|
448
469
|
# Strength of the condition boost, which should be in [-1, 1]. Negative
|
|
@@ -474,6 +495,11 @@ module Google
|
|
|
474
495
|
# @return [::Google::Cloud::Retail::V2::SearchRequest::QueryExpansionSpec::Condition]
|
|
475
496
|
# The condition under which query expansion should occur. Default to
|
|
476
497
|
# {::Google::Cloud::Retail::V2::SearchRequest::QueryExpansionSpec::Condition::DISABLED Condition.DISABLED}.
|
|
498
|
+
# @!attribute [rw] pin_unexpanded_results
|
|
499
|
+
# @return [::Boolean]
|
|
500
|
+
# Whether to pin unexpanded results. If this field is set to true,
|
|
501
|
+
# unexpanded products are always at the top of the search results, followed
|
|
502
|
+
# by the expanded results.
|
|
477
503
|
class QueryExpansionSpec
|
|
478
504
|
include ::Google::Protobuf::MessageExts
|
|
479
505
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
@@ -605,10 +631,9 @@ module Google
|
|
|
605
631
|
# }
|
|
606
632
|
# }
|
|
607
633
|
#
|
|
608
|
-
# For
|
|
609
|
-
#
|
|
610
|
-
#
|
|
611
|
-
# {::Google::Protobuf::Value google.protobuf.Value}. For example:
|
|
634
|
+
# For {::Google::Cloud::Retail::V2::FulfillmentInfo FulfillmentInfo}, the rollup
|
|
635
|
+
# values is a double value with type
|
|
636
|
+
# {::Google::Protobuf::Value google.protobuf.Value}. For example,
|
|
612
637
|
# `{key: "pickupInStore.store1" value { number_value: 10 }}` means a there
|
|
613
638
|
# are 10 variants in this product are available in the store "store1".
|
|
614
639
|
class SearchResult
|
|
@@ -670,6 +695,11 @@ module Google
|
|
|
670
695
|
# @!attribute [rw] expanded_query
|
|
671
696
|
# @return [::Boolean]
|
|
672
697
|
# Bool describing whether query expansion has occurred.
|
|
698
|
+
# @!attribute [rw] pinned_result_count
|
|
699
|
+
# @return [::Integer]
|
|
700
|
+
# Number of pinned results. This field will only be set when expansion
|
|
701
|
+
# happens and [SearchRequest.query_expansion_spec.pin_unexpanded_results][]
|
|
702
|
+
# is set to true.
|
|
673
703
|
class QueryExpansionInfo
|
|
674
704
|
include ::Google::Protobuf::MessageExts
|
|
675
705
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
@@ -260,9 +260,21 @@ module Google
|
|
|
260
260
|
# @return [::Google::Cloud::Retail::V2::Product]
|
|
261
261
|
# Required. {::Google::Cloud::Retail::V2::Product Product} information.
|
|
262
262
|
#
|
|
263
|
-
#
|
|
264
|
-
#
|
|
265
|
-
#
|
|
263
|
+
# Required field(s):
|
|
264
|
+
#
|
|
265
|
+
# * {::Google::Cloud::Retail::V2::Product#id Product.id}
|
|
266
|
+
#
|
|
267
|
+
# Optional override field(s):
|
|
268
|
+
#
|
|
269
|
+
# * {::Google::Cloud::Retail::V2::Product#price_info Product.price_info}
|
|
270
|
+
#
|
|
271
|
+
# If any supported optional fields are provided, we will treat them as a full
|
|
272
|
+
# override when looking up product information from the catalog. Thus, it is
|
|
273
|
+
# important to ensure that the overriding fields are accurate and
|
|
274
|
+
# complete.
|
|
275
|
+
#
|
|
276
|
+
# All other product fields are ignored and instead populated via catalog
|
|
277
|
+
# lookup after event ingestion.
|
|
266
278
|
# @!attribute [rw] quantity
|
|
267
279
|
# @return [::Google::Protobuf::Int32Value]
|
|
268
280
|
# Quantity of the product associated with the user event.
|
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: google-cloud-retail-v2
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.
|
|
4
|
+
version: 0.5.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-08-
|
|
11
|
+
date: 2021-08-23 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: gapic-common
|