google-cloud-retail-v2 0.5.1 → 0.6.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_pb.rb +2 -2
- data/lib/google/cloud/retail/v2/catalog_service_pb.rb +2 -2
- data/lib/google/cloud/retail/v2/catalog_service_services_pb.rb +1 -1
- data/lib/google/cloud/retail/v2/common_pb.rb +2 -2
- data/lib/google/cloud/retail/v2/completion_service_pb.rb +2 -2
- data/lib/google/cloud/retail/v2/completion_service_services_pb.rb +1 -1
- data/lib/google/cloud/retail/v2/import_config_pb.rb +2 -2
- data/lib/google/cloud/retail/v2/prediction_service_pb.rb +2 -2
- data/lib/google/cloud/retail/v2/prediction_service_services_pb.rb +1 -1
- data/lib/google/cloud/retail/v2/product_pb.rb +2 -2
- data/lib/google/cloud/retail/v2/product_service/client.rb +5 -5
- data/lib/google/cloud/retail/v2/product_service_pb.rb +3 -2
- data/lib/google/cloud/retail/v2/product_service_services_pb.rb +1 -1
- data/lib/google/cloud/retail/v2/purge_config_pb.rb +2 -2
- data/lib/google/cloud/retail/v2/search_service/client.rb +22 -11
- data/lib/google/cloud/retail/v2/search_service_pb.rb +9 -2
- data/lib/google/cloud/retail/v2/search_service_services_pb.rb +1 -1
- data/lib/google/cloud/retail/v2/user_event_pb.rb +2 -2
- data/lib/google/cloud/retail/v2/user_event_service_pb.rb +2 -2
- data/lib/google/cloud/retail/v2/user_event_service_services_pb.rb +1 -1
- data/lib/google/cloud/retail/v2/version.rb +1 -1
- data/proto_docs/google/api/httpbody.rb +7 -3
- data/proto_docs/google/cloud/retail/v2/common.rb +3 -3
- data/proto_docs/google/cloud/retail/v2/product.rb +11 -8
- data/proto_docs/google/cloud/retail/v2/product_service.rb +6 -6
- data/proto_docs/google/cloud/retail/v2/search_service.rb +54 -11
- data/proto_docs/google/cloud/retail/v2/user_event.rb +4 -4
- 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: e3c54ec4291ffd18e3937aded888310475087affcd33884b0c861915dc5ebcc6
|
4
|
+
data.tar.gz: cf991b3ef78d6a416ef9ee8c73484eccc232423727c4432ed921ff17ea5785a1
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: c91db3290823a29c95972da1f7dfbc08c9af44d5c1e538044a11d1087b5a319b6b5ed7dce3759000dc6d928e43549e9057ee3cade11c9c5760ccaa070c99147b
|
7
|
+
data.tar.gz: e81be02bca288b3cb0763c4a6497ad55bedfcf427f057f6e4a83694281df9a15d6140b1439463de41e64a1a8e0310dd768fd299f985a7031c882a43ad55afdd1
|
@@ -1,13 +1,13 @@
|
|
1
1
|
# Generated by the protocol buffer compiler. DO NOT EDIT!
|
2
2
|
# source: google/cloud/retail/v2/catalog.proto
|
3
3
|
|
4
|
-
require 'google/protobuf'
|
5
|
-
|
6
4
|
require 'google/api/annotations_pb'
|
7
5
|
require 'google/api/field_behavior_pb'
|
8
6
|
require 'google/api/resource_pb'
|
9
7
|
require 'google/cloud/retail/v2/common_pb'
|
10
8
|
require 'google/cloud/retail/v2/import_config_pb'
|
9
|
+
require 'google/protobuf'
|
10
|
+
|
11
11
|
Google::Protobuf::DescriptorPool.generated_pool.build do
|
12
12
|
add_file("google/cloud/retail/v2/catalog.proto", :syntax => :proto3) do
|
13
13
|
add_message "google.cloud.retail.v2.ProductLevelConfig" do
|
@@ -1,8 +1,6 @@
|
|
1
1
|
# Generated by the protocol buffer compiler. DO NOT EDIT!
|
2
2
|
# source: google/cloud/retail/v2/catalog_service.proto
|
3
3
|
|
4
|
-
require 'google/protobuf'
|
5
|
-
|
6
4
|
require 'google/api/annotations_pb'
|
7
5
|
require 'google/api/client_pb'
|
8
6
|
require 'google/api/field_behavior_pb'
|
@@ -11,6 +9,8 @@ require 'google/cloud/retail/v2/catalog_pb'
|
|
11
9
|
require 'google/protobuf/empty_pb'
|
12
10
|
require 'google/protobuf/field_mask_pb'
|
13
11
|
require 'google/protobuf/timestamp_pb'
|
12
|
+
require 'google/protobuf'
|
13
|
+
|
14
14
|
Google::Protobuf::DescriptorPool.generated_pool.build do
|
15
15
|
add_file("google/cloud/retail/v2/catalog_service.proto", :syntax => :proto3) do
|
16
16
|
add_message "google.cloud.retail.v2.ListCatalogsRequest" do
|
@@ -1,11 +1,11 @@
|
|
1
1
|
# Generated by the protocol buffer compiler. DO NOT EDIT!
|
2
2
|
# source: google/cloud/retail/v2/common.proto
|
3
3
|
|
4
|
-
require 'google/protobuf'
|
5
|
-
|
6
4
|
require 'google/api/annotations_pb'
|
7
5
|
require 'google/api/field_behavior_pb'
|
8
6
|
require 'google/protobuf/timestamp_pb'
|
7
|
+
require 'google/protobuf'
|
8
|
+
|
9
9
|
Google::Protobuf::DescriptorPool.generated_pool.build do
|
10
10
|
add_file("google/cloud/retail/v2/common.proto", :syntax => :proto3) do
|
11
11
|
add_message "google.cloud.retail.v2.Audience" do
|
@@ -1,8 +1,6 @@
|
|
1
1
|
# Generated by the protocol buffer compiler. DO NOT EDIT!
|
2
2
|
# source: google/cloud/retail/v2/completion_service.proto
|
3
3
|
|
4
|
-
require 'google/protobuf'
|
5
|
-
|
6
4
|
require 'google/api/annotations_pb'
|
7
5
|
require 'google/api/client_pb'
|
8
6
|
require 'google/api/field_behavior_pb'
|
@@ -10,6 +8,8 @@ require 'google/api/resource_pb'
|
|
10
8
|
require 'google/cloud/retail/v2/common_pb'
|
11
9
|
require 'google/cloud/retail/v2/import_config_pb'
|
12
10
|
require 'google/longrunning/operations_pb'
|
11
|
+
require 'google/protobuf'
|
12
|
+
|
13
13
|
Google::Protobuf::DescriptorPool.generated_pool.build do
|
14
14
|
add_file("google/cloud/retail/v2/completion_service.proto", :syntax => :proto3) do
|
15
15
|
add_message "google.cloud.retail.v2.CompleteQueryRequest" do
|
@@ -1,8 +1,6 @@
|
|
1
1
|
# Generated by the protocol buffer compiler. DO NOT EDIT!
|
2
2
|
# source: google/cloud/retail/v2/import_config.proto
|
3
3
|
|
4
|
-
require 'google/protobuf'
|
5
|
-
|
6
4
|
require 'google/api/annotations_pb'
|
7
5
|
require 'google/api/field_behavior_pb'
|
8
6
|
require 'google/api/resource_pb'
|
@@ -12,6 +10,8 @@ require 'google/protobuf/field_mask_pb'
|
|
12
10
|
require 'google/protobuf/timestamp_pb'
|
13
11
|
require 'google/rpc/status_pb'
|
14
12
|
require 'google/type/date_pb'
|
13
|
+
require 'google/protobuf'
|
14
|
+
|
15
15
|
Google::Protobuf::DescriptorPool.generated_pool.build do
|
16
16
|
add_file("google/cloud/retail/v2/import_config.proto", :syntax => :proto3) do
|
17
17
|
add_message "google.cloud.retail.v2.GcsSource" do
|
@@ -1,13 +1,13 @@
|
|
1
1
|
# Generated by the protocol buffer compiler. DO NOT EDIT!
|
2
2
|
# source: google/cloud/retail/v2/prediction_service.proto
|
3
3
|
|
4
|
-
require 'google/protobuf'
|
5
|
-
|
6
4
|
require 'google/api/annotations_pb'
|
7
5
|
require 'google/api/client_pb'
|
8
6
|
require 'google/api/field_behavior_pb'
|
9
7
|
require 'google/cloud/retail/v2/user_event_pb'
|
10
8
|
require 'google/protobuf/struct_pb'
|
9
|
+
require 'google/protobuf'
|
10
|
+
|
11
11
|
Google::Protobuf::DescriptorPool.generated_pool.build do
|
12
12
|
add_file("google/cloud/retail/v2/prediction_service.proto", :syntax => :proto3) do
|
13
13
|
add_message "google.cloud.retail.v2.PredictRequest" do
|
@@ -1,8 +1,6 @@
|
|
1
1
|
# Generated by the protocol buffer compiler. DO NOT EDIT!
|
2
2
|
# source: google/cloud/retail/v2/product.proto
|
3
3
|
|
4
|
-
require 'google/protobuf'
|
5
|
-
|
6
4
|
require 'google/api/annotations_pb'
|
7
5
|
require 'google/api/field_behavior_pb'
|
8
6
|
require 'google/api/resource_pb'
|
@@ -11,6 +9,8 @@ require 'google/protobuf/duration_pb'
|
|
11
9
|
require 'google/protobuf/field_mask_pb'
|
12
10
|
require 'google/protobuf/timestamp_pb'
|
13
11
|
require 'google/protobuf/wrappers_pb'
|
12
|
+
require 'google/protobuf'
|
13
|
+
|
14
14
|
Google::Protobuf::DescriptorPool.generated_pool.build do
|
15
15
|
add_file("google/cloud/retail/v2/product.proto", :syntax => :proto3) do
|
16
16
|
add_message "google.cloud.retail.v2.Product" do
|
@@ -867,7 +867,7 @@ module Google
|
|
867
867
|
# {::Google::Cloud::Retail::V2::Product#name Product.name} is not found, the
|
868
868
|
# inventory update will still be processed and retained for at most 1 day
|
869
869
|
# until the {::Google::Cloud::Retail::V2::Product Product} is created. If set to
|
870
|
-
# false,
|
870
|
+
# false, a NOT_FOUND error is returned if the
|
871
871
|
# {::Google::Cloud::Retail::V2::Product Product} is not found.
|
872
872
|
#
|
873
873
|
# @yield [response, operation] Access the result along with the RPC operation
|
@@ -1002,8 +1002,8 @@ module Google
|
|
1002
1002
|
# If set to true, and the {::Google::Cloud::Retail::V2::Product Product} is not
|
1003
1003
|
# found, the fulfillment information will still be processed and retained for
|
1004
1004
|
# at most 1 day and processed once the
|
1005
|
-
# {::Google::Cloud::Retail::V2::Product Product} is created. If set to false,
|
1006
|
-
#
|
1005
|
+
# {::Google::Cloud::Retail::V2::Product Product} is created. If set to false, a
|
1006
|
+
# NOT_FOUND error is returned if the
|
1007
1007
|
# {::Google::Cloud::Retail::V2::Product Product} is not found.
|
1008
1008
|
#
|
1009
1009
|
# @yield [response, operation] Access the result along with the RPC operation
|
@@ -1133,8 +1133,8 @@ module Google
|
|
1133
1133
|
# If set to true, and the {::Google::Cloud::Retail::V2::Product Product} is not
|
1134
1134
|
# found, the fulfillment information will still be processed and retained for
|
1135
1135
|
# at most 1 day and processed once the
|
1136
|
-
# {::Google::Cloud::Retail::V2::Product Product} is created. If set to false,
|
1137
|
-
#
|
1136
|
+
# {::Google::Cloud::Retail::V2::Product Product} is created. If set to false, a
|
1137
|
+
# NOT_FOUND error is returned if the
|
1138
1138
|
# {::Google::Cloud::Retail::V2::Product Product} is not found.
|
1139
1139
|
#
|
1140
1140
|
# @yield [response, operation] Access the result along with the RPC operation
|
@@ -1,12 +1,11 @@
|
|
1
1
|
# Generated by the protocol buffer compiler. DO NOT EDIT!
|
2
2
|
# source: google/cloud/retail/v2/product_service.proto
|
3
3
|
|
4
|
-
require 'google/protobuf'
|
5
|
-
|
6
4
|
require 'google/api/annotations_pb'
|
7
5
|
require 'google/api/client_pb'
|
8
6
|
require 'google/api/field_behavior_pb'
|
9
7
|
require 'google/api/resource_pb'
|
8
|
+
require 'google/cloud/retail/v2/common_pb'
|
10
9
|
require 'google/cloud/retail/v2/import_config_pb'
|
11
10
|
require 'google/cloud/retail/v2/product_pb'
|
12
11
|
require 'google/cloud/retail/v2/purge_config_pb'
|
@@ -14,6 +13,8 @@ require 'google/longrunning/operations_pb'
|
|
14
13
|
require 'google/protobuf/empty_pb'
|
15
14
|
require 'google/protobuf/field_mask_pb'
|
16
15
|
require 'google/protobuf/timestamp_pb'
|
16
|
+
require 'google/protobuf'
|
17
|
+
|
17
18
|
Google::Protobuf::DescriptorPool.generated_pool.build do
|
18
19
|
add_file("google/cloud/retail/v2/product_service.proto", :syntax => :proto3) do
|
19
20
|
add_message "google.cloud.retail.v2.CreateProductRequest" do
|
@@ -1,10 +1,10 @@
|
|
1
1
|
# Generated by the protocol buffer compiler. DO NOT EDIT!
|
2
2
|
# source: google/cloud/retail/v2/purge_config.proto
|
3
3
|
|
4
|
-
require 'google/protobuf'
|
5
|
-
|
6
4
|
require 'google/api/annotations_pb'
|
7
5
|
require 'google/api/field_behavior_pb'
|
6
|
+
require 'google/protobuf'
|
7
|
+
|
8
8
|
Google::Protobuf::DescriptorPool.generated_pool.build do
|
9
9
|
add_file("google/cloud/retail/v2/purge_config.proto", :syntax => :proto3) do
|
10
10
|
add_message "google.cloud.retail.v2.PurgeMetadata" do
|
@@ -170,7 +170,7 @@ module Google
|
|
170
170
|
# @param options [::Gapic::CallOptions, ::Hash]
|
171
171
|
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
172
172
|
#
|
173
|
-
# @overload search(placement: nil, branch: nil, query: nil, visitor_id: nil, user_info: nil, page_size: nil, page_token: nil, offset: nil, filter: nil, canonical_filter: nil, order_by: nil, facet_specs: nil, dynamic_facet_spec: nil, boost_spec: nil, query_expansion_spec: nil, variant_rollup_keys: nil, page_categories: nil)
|
173
|
+
# @overload search(placement: nil, branch: nil, query: nil, visitor_id: nil, user_info: nil, page_size: nil, page_token: nil, offset: nil, filter: nil, canonical_filter: nil, order_by: nil, facet_specs: nil, dynamic_facet_spec: nil, boost_spec: nil, query_expansion_spec: nil, variant_rollup_keys: nil, page_categories: nil, search_mode: nil)
|
174
174
|
# Pass arguments to `search` via keyword arguments. Note that at
|
175
175
|
# least one keyword argument is required. To specify no parameters, or to keep all
|
176
176
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
@@ -178,12 +178,8 @@ module Google
|
|
178
178
|
# @param placement [::String]
|
179
179
|
# Required. The resource name of the search engine placement, such as
|
180
180
|
# `projects/*/locations/global/catalogs/default_catalog/placements/default_search`.
|
181
|
-
# This field is used to identify the
|
182
|
-
# the search.
|
183
|
-
#
|
184
|
-
# We currently support one placement with the following ID:
|
185
|
-
#
|
186
|
-
# * `default_search`.
|
181
|
+
# This field is used to identify the serving configuration name and the set
|
182
|
+
# of models that will be used to make the search.
|
187
183
|
# @param branch [::String]
|
188
184
|
# The branch resource name, such as
|
189
185
|
# `projects/*/locations/global/catalogs/default_catalog/branches/0`.
|
@@ -230,7 +226,8 @@ module Google
|
|
230
226
|
# @param filter [::String]
|
231
227
|
# The filter syntax consists of an expression language for constructing a
|
232
228
|
# predicate from one or more fields of the products being filtered. Filter
|
233
|
-
# expression is case-sensitive.
|
229
|
+
# expression is case-sensitive. See more details at this [user
|
230
|
+
# guide](https://cloud.google.com/retail/docs/filter-and-order#filter).
|
234
231
|
#
|
235
232
|
# If this field is unrecognizable, an INVALID_ARGUMENT is returned.
|
236
233
|
# @param canonical_filter [::String]
|
@@ -246,7 +243,9 @@ module Google
|
|
246
243
|
# @param order_by [::String]
|
247
244
|
# The order in which products are returned. Products can be ordered by
|
248
245
|
# a field in an {::Google::Cloud::Retail::V2::Product Product} object. Leave it
|
249
|
-
# unset if ordered by relevance. OrderBy expression is case-sensitive.
|
246
|
+
# unset if ordered by relevance. OrderBy expression is case-sensitive. See
|
247
|
+
# more details at this [user
|
248
|
+
# guide](https://cloud.google.com/retail/docs/filter-and-order#order).
|
250
249
|
#
|
251
250
|
# If this field is unrecognizable, an INVALID_ARGUMENT is returned.
|
252
251
|
# @param facet_specs [::Array<::Google::Cloud::Retail::V2::SearchRequest::FacetSpec, ::Hash>]
|
@@ -261,10 +260,18 @@ module Google
|
|
261
260
|
# This feature requires additional allowlisting. Contact Retail Search
|
262
261
|
# support team if you are interested in using dynamic facet feature.
|
263
262
|
# @param boost_spec [::Google::Cloud::Retail::V2::SearchRequest::BoostSpec, ::Hash]
|
264
|
-
# Boost specification to boost certain products.
|
263
|
+
# Boost specification to boost certain products. See more details at this
|
264
|
+
# [user guide](https://cloud.google.com/retail/docs/boosting).
|
265
|
+
#
|
266
|
+
# Notice that if both [ServingConfig.boost_control_ids][] and
|
267
|
+
# [SearchRequest.boost_spec] are set, the boost conditions from both places
|
268
|
+
# are evaluated. If a search request matches multiple boost conditions,
|
269
|
+
# the final boost score is equal to the sum of the boost scores from all
|
270
|
+
# matched boost conditions.
|
265
271
|
# @param query_expansion_spec [::Google::Cloud::Retail::V2::SearchRequest::QueryExpansionSpec, ::Hash]
|
266
272
|
# The query expansion specification that specifies the conditions under which
|
267
|
-
# query expansion will occur.
|
273
|
+
# query expansion will occur. See more details at this [user
|
274
|
+
# guide](https://cloud.google.com/retail/docs/result-size#query_expansion).
|
268
275
|
# @param variant_rollup_keys [::Array<::String>]
|
269
276
|
# The keys to fetch and rollup the matching
|
270
277
|
# {::Google::Cloud::Retail::V2::Product::Type::VARIANT variant}
|
@@ -286,6 +293,7 @@ module Google
|
|
286
293
|
# * price
|
287
294
|
# * originalPrice
|
288
295
|
# * discount
|
296
|
+
# * inventory(place_id,price)
|
289
297
|
# * attributes.key, where key is any key in the
|
290
298
|
# {::Google::Cloud::Retail::V2::Product#attributes Product.attributes} map.
|
291
299
|
# * pickupInStore.id, where id is any
|
@@ -340,6 +348,9 @@ module Google
|
|
340
348
|
# Category pages include special pages such as sales or promotions. For
|
341
349
|
# instance, a special sale page may have the category hierarchy:
|
342
350
|
# "pageCategories" : ["Sales > 2017 Black Friday Deals"].
|
351
|
+
# @param search_mode [::Google::Cloud::Retail::V2::SearchRequest::SearchMode]
|
352
|
+
# The search mode of the search request. If not specified, a single search
|
353
|
+
# request triggers both product search and faceted search.
|
343
354
|
#
|
344
355
|
# @yield [response, operation] Access the result along with the RPC operation
|
345
356
|
# @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::Retail::V2::SearchResponse::SearchResult>]
|
@@ -1,8 +1,6 @@
|
|
1
1
|
# Generated by the protocol buffer compiler. DO NOT EDIT!
|
2
2
|
# source: google/cloud/retail/v2/search_service.proto
|
3
3
|
|
4
|
-
require 'google/protobuf'
|
5
|
-
|
6
4
|
require 'google/api/annotations_pb'
|
7
5
|
require 'google/api/client_pb'
|
8
6
|
require 'google/api/field_behavior_pb'
|
@@ -13,6 +11,8 @@ require 'google/protobuf/field_mask_pb'
|
|
13
11
|
require 'google/protobuf/struct_pb'
|
14
12
|
require 'google/protobuf/timestamp_pb'
|
15
13
|
require 'google/protobuf/wrappers_pb'
|
14
|
+
require 'google/protobuf'
|
15
|
+
|
16
16
|
Google::Protobuf::DescriptorPool.generated_pool.build do
|
17
17
|
add_file("google/cloud/retail/v2/search_service.proto", :syntax => :proto3) do
|
18
18
|
add_message "google.cloud.retail.v2.SearchRequest" do
|
@@ -33,6 +33,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
|
|
33
33
|
optional :query_expansion_spec, :message, 14, "google.cloud.retail.v2.SearchRequest.QueryExpansionSpec"
|
34
34
|
repeated :variant_rollup_keys, :string, 17
|
35
35
|
repeated :page_categories, :string, 23
|
36
|
+
optional :search_mode, :enum, 31, "google.cloud.retail.v2.SearchRequest.SearchMode"
|
36
37
|
end
|
37
38
|
add_message "google.cloud.retail.v2.SearchRequest.FacetSpec" do
|
38
39
|
optional :facet_key, :message, 1, "google.cloud.retail.v2.SearchRequest.FacetSpec.FacetKey"
|
@@ -73,6 +74,11 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
|
|
73
74
|
value :DISABLED, 1
|
74
75
|
value :AUTO, 3
|
75
76
|
end
|
77
|
+
add_enum "google.cloud.retail.v2.SearchRequest.SearchMode" do
|
78
|
+
value :SEARCH_MODE_UNSPECIFIED, 0
|
79
|
+
value :PRODUCT_SEARCH_ONLY, 1
|
80
|
+
value :FACETED_SEARCH_ONLY, 2
|
81
|
+
end
|
76
82
|
add_message "google.cloud.retail.v2.SearchResponse" do
|
77
83
|
repeated :results, :message, 1, "google.cloud.retail.v2.SearchResponse.SearchResult"
|
78
84
|
repeated :facets, :message, 2, "google.cloud.retail.v2.SearchResponse.Facet"
|
@@ -122,6 +128,7 @@ module Google
|
|
122
128
|
SearchRequest::BoostSpec::ConditionBoostSpec = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.SearchRequest.BoostSpec.ConditionBoostSpec").msgclass
|
123
129
|
SearchRequest::QueryExpansionSpec = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.SearchRequest.QueryExpansionSpec").msgclass
|
124
130
|
SearchRequest::QueryExpansionSpec::Condition = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.SearchRequest.QueryExpansionSpec.Condition").enummodule
|
131
|
+
SearchRequest::SearchMode = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.SearchRequest.SearchMode").enummodule
|
125
132
|
SearchResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.SearchResponse").msgclass
|
126
133
|
SearchResponse::SearchResult = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.SearchResponse.SearchResult").msgclass
|
127
134
|
SearchResponse::Facet = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.SearchResponse.Facet").msgclass
|
@@ -1,14 +1,14 @@
|
|
1
1
|
# Generated by the protocol buffer compiler. DO NOT EDIT!
|
2
2
|
# source: google/cloud/retail/v2/user_event.proto
|
3
3
|
|
4
|
-
require 'google/protobuf'
|
5
|
-
|
6
4
|
require 'google/api/annotations_pb'
|
7
5
|
require 'google/api/field_behavior_pb'
|
8
6
|
require 'google/cloud/retail/v2/common_pb'
|
9
7
|
require 'google/cloud/retail/v2/product_pb'
|
10
8
|
require 'google/protobuf/timestamp_pb'
|
11
9
|
require 'google/protobuf/wrappers_pb'
|
10
|
+
require 'google/protobuf'
|
11
|
+
|
12
12
|
Google::Protobuf::DescriptorPool.generated_pool.build do
|
13
13
|
add_file("google/cloud/retail/v2/user_event.proto", :syntax => :proto3) do
|
14
14
|
add_message "google.cloud.retail.v2.UserEvent" do
|
@@ -1,8 +1,6 @@
|
|
1
1
|
# Generated by the protocol buffer compiler. DO NOT EDIT!
|
2
2
|
# source: google/cloud/retail/v2/user_event_service.proto
|
3
3
|
|
4
|
-
require 'google/protobuf'
|
5
|
-
|
6
4
|
require 'google/api/annotations_pb'
|
7
5
|
require 'google/api/client_pb'
|
8
6
|
require 'google/api/field_behavior_pb'
|
@@ -11,6 +9,8 @@ require 'google/cloud/retail/v2/import_config_pb'
|
|
11
9
|
require 'google/cloud/retail/v2/purge_config_pb'
|
12
10
|
require 'google/cloud/retail/v2/user_event_pb'
|
13
11
|
require 'google/longrunning/operations_pb'
|
12
|
+
require 'google/protobuf'
|
13
|
+
|
14
14
|
Google::Protobuf::DescriptorPool.generated_pool.build do
|
15
15
|
add_file("google/cloud/retail/v2/user_event_service.proto", :syntax => :proto3) do
|
16
16
|
add_message "google.cloud.retail.v2.WriteUserEventRequest" do
|
@@ -39,12 +39,15 @@ module Google
|
|
39
39
|
#
|
40
40
|
# // The raw HTTP body is bound to this field.
|
41
41
|
# google.api.HttpBody http_body = 2;
|
42
|
+
#
|
42
43
|
# }
|
43
44
|
#
|
44
45
|
# service ResourceService {
|
45
|
-
# rpc GetResource(GetResourceRequest)
|
46
|
-
#
|
47
|
-
# (google.
|
46
|
+
# rpc GetResource(GetResourceRequest)
|
47
|
+
# returns (google.api.HttpBody);
|
48
|
+
# rpc UpdateResource(google.api.HttpBody)
|
49
|
+
# returns (google.protobuf.Empty);
|
50
|
+
#
|
48
51
|
# }
|
49
52
|
#
|
50
53
|
# Example with streaming methods:
|
@@ -54,6 +57,7 @@ module Google
|
|
54
57
|
# returns (stream google.api.HttpBody);
|
55
58
|
# rpc UpdateCalendar(stream google.api.HttpBody)
|
56
59
|
# returns (stream google.api.HttpBody);
|
60
|
+
#
|
57
61
|
# }
|
58
62
|
#
|
59
63
|
# Use of this type only changes how the request and response bodies are
|
@@ -80,7 +80,7 @@ module Google
|
|
80
80
|
# it is expected to have only 1 color. May consider using single "Mixed"
|
81
81
|
# instead of multiple values.
|
82
82
|
#
|
83
|
-
# A maximum of
|
83
|
+
# A maximum of 25 colors are allowed. Each value must be a UTF-8 encoded
|
84
84
|
# string with a length limit of 128 characters. Otherwise, an
|
85
85
|
# INVALID_ARGUMENT error is returned.
|
86
86
|
#
|
@@ -174,8 +174,8 @@ module Google
|
|
174
174
|
# or the region IDs for
|
175
175
|
# {::Google::Cloud::Retail::V2::FulfillmentInfo#type FulfillmentInfo.type.same-day-delivery}.
|
176
176
|
#
|
177
|
-
# A maximum of
|
178
|
-
# length limit of
|
177
|
+
# A maximum of 3000 values are allowed. Each value must be a string with a
|
178
|
+
# length limit of 30 characters, matching the pattern [a-zA-Z0-9_-]+, such as
|
179
179
|
# "store1" or "REGION-2". Otherwise, an INVALID_ARGUMENT error is returned.
|
180
180
|
class FulfillmentInfo
|
181
181
|
include ::Google::Protobuf::MessageExts
|
@@ -37,18 +37,23 @@ module Google
|
|
37
37
|
# and
|
38
38
|
# {::Google::Cloud::Retail::V2::ProductService::Client#list_products ProductService.ListProducts}.
|
39
39
|
#
|
40
|
+
# {::Google::Cloud::Retail::V2::Product#expire_time expire_time} must be later
|
41
|
+
# than {::Google::Cloud::Retail::V2::Product#available_time available_time} and
|
42
|
+
# {::Google::Cloud::Retail::V2::Product#publish_time publish_time}, otherwise an
|
43
|
+
# INVALID_ARGUMENT error is thrown.
|
44
|
+
#
|
40
45
|
# Google Merchant Center property
|
41
46
|
# [expiration_date](https://support.google.com/merchants/answer/6324499).
|
42
47
|
# @!attribute [rw] ttl
|
43
48
|
# @return [::Google::Protobuf::Duration]
|
44
49
|
# Input only. The TTL (time to live) of the product.
|
45
50
|
#
|
46
|
-
# If it is set,
|
47
|
-
# is set as
|
48
|
-
# {::Google::Cloud::Retail::V2::Product#ttl ttl}. The
|
49
|
-
# {::Google::Cloud::Retail::V2::Product#expire_time expire_time} is
|
50
|
-
# the output and {::Google::Cloud::Retail::V2::Product#ttl ttl} is
|
51
|
-
# when retrieving the {::Google::Cloud::Retail::V2::Product Product}.
|
51
|
+
# If it is set, it must be a non-negative value, and
|
52
|
+
# {::Google::Cloud::Retail::V2::Product#expire_time expire_time} is set as
|
53
|
+
# current timestamp plus {::Google::Cloud::Retail::V2::Product#ttl ttl}. The
|
54
|
+
# derived {::Google::Cloud::Retail::V2::Product#expire_time expire_time} is
|
55
|
+
# returned in the output and {::Google::Cloud::Retail::V2::Product#ttl ttl} is
|
56
|
+
# left blank when retrieving the {::Google::Cloud::Retail::V2::Product Product}.
|
52
57
|
#
|
53
58
|
# If it is set, the product is not available for
|
54
59
|
# {::Google::Cloud::Retail::V2::SearchService::Client#search SearchService.Search} after
|
@@ -61,8 +66,6 @@ module Google
|
|
61
66
|
# @return [::String]
|
62
67
|
# Immutable. Full resource name of the product, such as
|
63
68
|
# `projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/product_id`.
|
64
|
-
#
|
65
|
-
# The branch ID must be "default_branch".
|
66
69
|
# @!attribute [rw] id
|
67
70
|
# @return [::String]
|
68
71
|
# Immutable. {::Google::Cloud::Retail::V2::Product Product} identifier, which is
|
@@ -290,7 +290,7 @@ module Google
|
|
290
290
|
# {::Google::Cloud::Retail::V2::Product#name Product.name} is not found, the
|
291
291
|
# inventory update will still be processed and retained for at most 1 day
|
292
292
|
# until the {::Google::Cloud::Retail::V2::Product Product} is created. If set to
|
293
|
-
# false,
|
293
|
+
# false, a NOT_FOUND error is returned if the
|
294
294
|
# {::Google::Cloud::Retail::V2::Product Product} is not found.
|
295
295
|
class SetInventoryRequest
|
296
296
|
include ::Google::Protobuf::MessageExts
|
@@ -371,8 +371,8 @@ module Google
|
|
371
371
|
# If set to true, and the {::Google::Cloud::Retail::V2::Product Product} is not
|
372
372
|
# found, the fulfillment information will still be processed and retained for
|
373
373
|
# at most 1 day and processed once the
|
374
|
-
# {::Google::Cloud::Retail::V2::Product Product} is created. If set to false,
|
375
|
-
#
|
374
|
+
# {::Google::Cloud::Retail::V2::Product Product} is created. If set to false, a
|
375
|
+
# NOT_FOUND error is returned if the
|
376
376
|
# {::Google::Cloud::Retail::V2::Product Product} is not found.
|
377
377
|
class AddFulfillmentPlacesRequest
|
378
378
|
include ::Google::Protobuf::MessageExts
|
@@ -387,7 +387,7 @@ module Google
|
|
387
387
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
388
388
|
end
|
389
389
|
|
390
|
-
# Response of the
|
390
|
+
# Response of the AddFulfillmentPlacesRequest. Currently empty because
|
391
391
|
# there is no meaningful response populated from the [AddFulfillmentPlaces][]
|
392
392
|
# method.
|
393
393
|
class AddFulfillmentPlacesResponse
|
@@ -448,8 +448,8 @@ module Google
|
|
448
448
|
# If set to true, and the {::Google::Cloud::Retail::V2::Product Product} is not
|
449
449
|
# found, the fulfillment information will still be processed and retained for
|
450
450
|
# at most 1 day and processed once the
|
451
|
-
# {::Google::Cloud::Retail::V2::Product Product} is created. If set to false,
|
452
|
-
#
|
451
|
+
# {::Google::Cloud::Retail::V2::Product Product} is created. If set to false, a
|
452
|
+
# NOT_FOUND error is returned if the
|
453
453
|
# {::Google::Cloud::Retail::V2::Product Product} is not found.
|
454
454
|
class RemoveFulfillmentPlacesRequest
|
455
455
|
include ::Google::Protobuf::MessageExts
|
@@ -27,12 +27,8 @@ module Google
|
|
27
27
|
# @return [::String]
|
28
28
|
# Required. The resource name of the search engine placement, such as
|
29
29
|
# `projects/*/locations/global/catalogs/default_catalog/placements/default_search`.
|
30
|
-
# This field is used to identify the
|
31
|
-
# the search.
|
32
|
-
#
|
33
|
-
# We currently support one placement with the following ID:
|
34
|
-
#
|
35
|
-
# * `default_search`.
|
30
|
+
# This field is used to identify the serving configuration name and the set
|
31
|
+
# of models that will be used to make the search.
|
36
32
|
# @!attribute [rw] branch
|
37
33
|
# @return [::String]
|
38
34
|
# The branch resource name, such as
|
@@ -87,7 +83,8 @@ module Google
|
|
87
83
|
# @return [::String]
|
88
84
|
# The filter syntax consists of an expression language for constructing a
|
89
85
|
# predicate from one or more fields of the products being filtered. Filter
|
90
|
-
# expression is case-sensitive.
|
86
|
+
# expression is case-sensitive. See more details at this [user
|
87
|
+
# guide](https://cloud.google.com/retail/docs/filter-and-order#filter).
|
91
88
|
#
|
92
89
|
# If this field is unrecognizable, an INVALID_ARGUMENT is returned.
|
93
90
|
# @!attribute [rw] canonical_filter
|
@@ -105,7 +102,9 @@ module Google
|
|
105
102
|
# @return [::String]
|
106
103
|
# The order in which products are returned. Products can be ordered by
|
107
104
|
# a field in an {::Google::Cloud::Retail::V2::Product Product} object. Leave it
|
108
|
-
# unset if ordered by relevance. OrderBy expression is case-sensitive.
|
105
|
+
# unset if ordered by relevance. OrderBy expression is case-sensitive. See
|
106
|
+
# more details at this [user
|
107
|
+
# guide](https://cloud.google.com/retail/docs/filter-and-order#order).
|
109
108
|
#
|
110
109
|
# If this field is unrecognizable, an INVALID_ARGUMENT is returned.
|
111
110
|
# @!attribute [rw] facet_specs
|
@@ -123,11 +122,19 @@ module Google
|
|
123
122
|
# support team if you are interested in using dynamic facet feature.
|
124
123
|
# @!attribute [rw] boost_spec
|
125
124
|
# @return [::Google::Cloud::Retail::V2::SearchRequest::BoostSpec]
|
126
|
-
# Boost specification to boost certain products.
|
125
|
+
# Boost specification to boost certain products. See more details at this
|
126
|
+
# [user guide](https://cloud.google.com/retail/docs/boosting).
|
127
|
+
#
|
128
|
+
# Notice that if both [ServingConfig.boost_control_ids][] and
|
129
|
+
# [SearchRequest.boost_spec] are set, the boost conditions from both places
|
130
|
+
# are evaluated. If a search request matches multiple boost conditions,
|
131
|
+
# the final boost score is equal to the sum of the boost scores from all
|
132
|
+
# matched boost conditions.
|
127
133
|
# @!attribute [rw] query_expansion_spec
|
128
134
|
# @return [::Google::Cloud::Retail::V2::SearchRequest::QueryExpansionSpec]
|
129
135
|
# The query expansion specification that specifies the conditions under which
|
130
|
-
# query expansion will occur.
|
136
|
+
# query expansion will occur. See more details at this [user
|
137
|
+
# guide](https://cloud.google.com/retail/docs/result-size#query_expansion).
|
131
138
|
# @!attribute [rw] variant_rollup_keys
|
132
139
|
# @return [::Array<::String>]
|
133
140
|
# The keys to fetch and rollup the matching
|
@@ -150,6 +157,7 @@ module Google
|
|
150
157
|
# * price
|
151
158
|
# * originalPrice
|
152
159
|
# * discount
|
160
|
+
# * inventory(place_id,price)
|
153
161
|
# * attributes.key, where key is any key in the
|
154
162
|
# {::Google::Cloud::Retail::V2::Product#attributes Product.attributes} map.
|
155
163
|
# * pickupInStore.id, where id is any
|
@@ -205,6 +213,10 @@ module Google
|
|
205
213
|
# Category pages include special pages such as sales or promotions. For
|
206
214
|
# instance, a special sale page may have the category hierarchy:
|
207
215
|
# "pageCategories" : ["Sales > 2017 Black Friday Deals"].
|
216
|
+
# @!attribute [rw] search_mode
|
217
|
+
# @return [::Google::Cloud::Retail::V2::SearchRequest::SearchMode]
|
218
|
+
# The search mode of the search request. If not specified, a single search
|
219
|
+
# request triggers both product search and faceted search.
|
208
220
|
class SearchRequest
|
209
221
|
include ::Google::Protobuf::MessageExts
|
210
222
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -314,6 +326,7 @@ module Google
|
|
314
326
|
# * "rating"
|
315
327
|
# * "ratingCount"
|
316
328
|
# * "attributes.key"
|
329
|
+
# * "inventory(place_id,price)"
|
317
330
|
# @!attribute [rw] intervals
|
318
331
|
# @return [::Array<::Google::Cloud::Retail::V2::Interval>]
|
319
332
|
# Set only if values should be bucketized into intervals. Must be set
|
@@ -513,6 +526,35 @@ module Google
|
|
513
526
|
AUTO = 3
|
514
527
|
end
|
515
528
|
end
|
529
|
+
|
530
|
+
# The search mode of each search request.
|
531
|
+
module SearchMode
|
532
|
+
# Default value. In this case both product search and faceted search will
|
533
|
+
# be performed. Both [SearchResponse.SearchResult] and
|
534
|
+
# [SearchResponse.Facet] will be returned.
|
535
|
+
SEARCH_MODE_UNSPECIFIED = 0
|
536
|
+
|
537
|
+
# Only product search will be performed. The faceted search will be
|
538
|
+
# disabled.
|
539
|
+
#
|
540
|
+
# Only [SearchResponse.SearchResult] will be returned.
|
541
|
+
# [SearchResponse.Facet] will not be returned, even if
|
542
|
+
# {::Google::Cloud::Retail::V2::SearchRequest#facet_specs SearchRequest.facet_specs}
|
543
|
+
# or
|
544
|
+
# {::Google::Cloud::Retail::V2::SearchRequest#dynamic_facet_spec SearchRequest.dynamic_facet_spec}
|
545
|
+
# is set.
|
546
|
+
PRODUCT_SEARCH_ONLY = 1
|
547
|
+
|
548
|
+
# Only faceted search will be performed. The product search will be
|
549
|
+
# disabled.
|
550
|
+
#
|
551
|
+
# When in this mode, one or both of [SearchRequest.facet_spec][] and
|
552
|
+
# {::Google::Cloud::Retail::V2::SearchRequest#dynamic_facet_spec SearchRequest.dynamic_facet_spec}
|
553
|
+
# should be set. Otherwise, an INVALID_ARGUMENT error is returned. Only
|
554
|
+
# [SearchResponse.Facet] will be returned. [SearchResponse.SearchResult]
|
555
|
+
# will not be returned.
|
556
|
+
FACETED_SEARCH_ONLY = 2
|
557
|
+
end
|
516
558
|
end
|
517
559
|
|
518
560
|
# Response message for
|
@@ -692,7 +734,8 @@ module Google
|
|
692
734
|
# @!attribute [rw] pinned_result_count
|
693
735
|
# @return [::Integer]
|
694
736
|
# Number of pinned results. This field will only be set when expansion
|
695
|
-
# happens and
|
737
|
+
# happens and
|
738
|
+
# {::Google::Cloud::Retail::V2::SearchRequest::QueryExpansionSpec#pin_unexpanded_results SearchRequest.QueryExpansionSpec.pin_unexpanded_results}
|
696
739
|
# is set to true.
|
697
740
|
class QueryExpansionInfo
|
698
741
|
include ::Google::Protobuf::MessageExts
|
@@ -110,12 +110,12 @@ module Google
|
|
110
110
|
# * `purchase-complete`
|
111
111
|
#
|
112
112
|
# In a `search` event, this field represents the products returned to the end
|
113
|
-
# user on the current page (the end user may have not finished
|
113
|
+
# user on the current page (the end user may have not finished browsing the
|
114
114
|
# whole page yet). When a new page is returned to the end user, after
|
115
115
|
# pagination/filtering/ordering even for the same query, a new `search` event
|
116
116
|
# with different
|
117
117
|
# {::Google::Cloud::Retail::V2::UserEvent#product_details product_details} is
|
118
|
-
# desired. The end user may have not finished
|
118
|
+
# desired. The end user may have not finished browsing the whole page yet.
|
119
119
|
# @!attribute [rw] completion_detail
|
120
120
|
# @return [::Google::Cloud::Retail::V2::CompletionDetail]
|
121
121
|
# The main completion details related to the event.
|
@@ -136,7 +136,7 @@ module Google
|
|
136
136
|
# search, and etc.
|
137
137
|
# @!attribute [rw] cart_id
|
138
138
|
# @return [::String]
|
139
|
-
# The
|
139
|
+
# The ID or name of the associated shopping cart. This ID is used
|
140
140
|
# to associate multiple items added or present in the cart before purchase.
|
141
141
|
#
|
142
142
|
# This can only be set for `add-to-cart`, `purchase-complete`, or
|
@@ -231,7 +231,7 @@ module Google
|
|
231
231
|
# Tag Manager, this value is filled in automatically.
|
232
232
|
# @!attribute [rw] page_view_id
|
233
233
|
# @return [::String]
|
234
|
-
# A unique
|
234
|
+
# A unique ID of a web page view.
|
235
235
|
#
|
236
236
|
# This should be kept the same for all user events triggered from the same
|
237
237
|
# pageview. For example, an item detail page view could trigger multiple
|
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.6.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-21 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: gapic-common
|