google-cloud-retail-v2 0.4.2 → 0.6.1
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/client.rb +26 -18
- data/lib/google/cloud/retail/v2/catalog_service_pb.rb +2 -2
- data/lib/google/cloud/retail/v2/catalog_service_services_pb.rb +5 -5
- data/lib/google/cloud/retail/v2/common_pb.rb +2 -2
- data/lib/google/cloud/retail/v2/completion_service/client.rb +29 -23
- data/lib/google/cloud/retail/v2/completion_service/operations.rb +20 -12
- data/lib/google/cloud/retail/v2/completion_service.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 +7 -7
- data/lib/google/cloud/retail/v2/import_config_pb.rb +2 -2
- data/lib/google/cloud/retail/v2/prediction_service/client.rb +7 -5
- 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 +66 -43
- data/lib/google/cloud/retail/v2/product_service/operations.rb +20 -12
- data/lib/google/cloud/retail/v2/product_service_pb.rb +3 -2
- data/lib/google/cloud/retail/v2/product_service_services_pb.rb +7 -7
- data/lib/google/cloud/retail/v2/purge_config_pb.rb +2 -2
- data/lib/google/cloud/retail/v2/search_service/client.rb +74 -45
- data/lib/google/cloud/retail/v2/search_service.rb +2 -2
- data/lib/google/cloud/retail/v2/search_service_pb.rb +11 -2
- data/lib/google/cloud/retail/v2/search_service_services_pb.rb +5 -5
- data/lib/google/cloud/retail/v2/user_event_pb.rb +2 -2
- data/lib/google/cloud/retail/v2/user_event_service/client.rb +37 -17
- data/lib/google/cloud/retail/v2/user_event_service/operations.rb +20 -12
- 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 +6 -5
- data/proto_docs/google/cloud/retail/v2/completion_service.rb +14 -12
- data/proto_docs/google/cloud/retail/v2/import_config.rb +5 -5
- data/proto_docs/google/cloud/retail/v2/product.rb +23 -17
- data/proto_docs/google/cloud/retail/v2/product_service.rb +8 -8
- data/proto_docs/google/cloud/retail/v2/search_service.rb +141 -74
- data/proto_docs/google/cloud/retail/v2/user_event.rb +19 -7
- metadata +2 -2
@@ -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"
|
@@ -66,12 +67,18 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
|
|
66
67
|
end
|
67
68
|
add_message "google.cloud.retail.v2.SearchRequest.QueryExpansionSpec" do
|
68
69
|
optional :condition, :enum, 1, "google.cloud.retail.v2.SearchRequest.QueryExpansionSpec.Condition"
|
70
|
+
optional :pin_unexpanded_results, :bool, 2
|
69
71
|
end
|
70
72
|
add_enum "google.cloud.retail.v2.SearchRequest.QueryExpansionSpec.Condition" do
|
71
73
|
value :CONDITION_UNSPECIFIED, 0
|
72
74
|
value :DISABLED, 1
|
73
75
|
value :AUTO, 3
|
74
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
|
75
82
|
add_message "google.cloud.retail.v2.SearchResponse" do
|
76
83
|
repeated :results, :message, 1, "google.cloud.retail.v2.SearchResponse.SearchResult"
|
77
84
|
repeated :facets, :message, 2, "google.cloud.retail.v2.SearchResponse.Facet"
|
@@ -103,6 +110,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
|
|
103
110
|
end
|
104
111
|
add_message "google.cloud.retail.v2.SearchResponse.QueryExpansionInfo" do
|
105
112
|
optional :expanded_query, :bool, 1
|
113
|
+
optional :pinned_result_count, :int64, 2
|
106
114
|
end
|
107
115
|
end
|
108
116
|
end
|
@@ -120,6 +128,7 @@ module Google
|
|
120
128
|
SearchRequest::BoostSpec::ConditionBoostSpec = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.SearchRequest.BoostSpec.ConditionBoostSpec").msgclass
|
121
129
|
SearchRequest::QueryExpansionSpec = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.SearchRequest.QueryExpansionSpec").msgclass
|
122
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
|
123
132
|
SearchResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.SearchResponse").msgclass
|
124
133
|
SearchResponse::SearchResult = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.SearchResponse.SearchResult").msgclass
|
125
134
|
SearchResponse::Facet = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.SearchResponse.Facet").msgclass
|
@@ -27,11 +27,11 @@ 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
|
-
include GRPC::GenericService
|
34
|
+
include ::GRPC::GenericService
|
35
35
|
|
36
36
|
self.marshal_class_method = :encode
|
37
37
|
self.unmarshal_class_method = :decode
|
@@ -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
|
|
@@ -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
|
@@ -64,9 +64,19 @@ module Google
|
|
64
64
|
end
|
65
65
|
default_config = Client::Configuration.new parent_config
|
66
66
|
|
67
|
-
default_config.timeout =
|
67
|
+
default_config.timeout = 5.0
|
68
68
|
default_config.retry_policy = {
|
69
|
-
initial_delay: 0.1, max_delay:
|
69
|
+
initial_delay: 0.1, max_delay: 5.0, multiplier: 1.3, retry_codes: [14, 4]
|
70
|
+
}
|
71
|
+
|
72
|
+
default_config.rpcs.purge_user_events.timeout = 30.0
|
73
|
+
default_config.rpcs.purge_user_events.retry_policy = {
|
74
|
+
initial_delay: 0.1, max_delay: 30.0, multiplier: 1.3, retry_codes: [14, 4]
|
75
|
+
}
|
76
|
+
|
77
|
+
default_config.rpcs.import_user_events.timeout = 300.0
|
78
|
+
default_config.rpcs.import_user_events.retry_policy = {
|
79
|
+
initial_delay: 0.1, max_delay: 300.0, multiplier: 1.3, retry_codes: [14, 4]
|
70
80
|
}
|
71
81
|
|
72
82
|
default_config
|
@@ -210,9 +220,11 @@ module Google
|
|
210
220
|
gapic_version: ::Google::Cloud::Retail::V2::VERSION
|
211
221
|
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
212
222
|
|
213
|
-
header_params = {
|
214
|
-
|
215
|
-
|
223
|
+
header_params = {}
|
224
|
+
if request.parent
|
225
|
+
header_params["parent"] = request.parent
|
226
|
+
end
|
227
|
+
|
216
228
|
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
217
229
|
metadata[:"x-goog-request-params"] ||= request_params_header
|
218
230
|
|
@@ -295,9 +307,11 @@ module Google
|
|
295
307
|
gapic_version: ::Google::Cloud::Retail::V2::VERSION
|
296
308
|
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
297
309
|
|
298
|
-
header_params = {
|
299
|
-
|
300
|
-
|
310
|
+
header_params = {}
|
311
|
+
if request.parent
|
312
|
+
header_params["parent"] = request.parent
|
313
|
+
end
|
314
|
+
|
301
315
|
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
302
316
|
metadata[:"x-goog-request-params"] ||= request_params_header
|
303
317
|
|
@@ -396,9 +410,11 @@ module Google
|
|
396
410
|
gapic_version: ::Google::Cloud::Retail::V2::VERSION
|
397
411
|
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
398
412
|
|
399
|
-
header_params = {
|
400
|
-
|
401
|
-
|
413
|
+
header_params = {}
|
414
|
+
if request.parent
|
415
|
+
header_params["parent"] = request.parent
|
416
|
+
end
|
417
|
+
|
402
418
|
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
403
419
|
metadata[:"x-goog-request-params"] ||= request_params_header
|
404
420
|
|
@@ -476,9 +492,11 @@ module Google
|
|
476
492
|
gapic_version: ::Google::Cloud::Retail::V2::VERSION
|
477
493
|
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
478
494
|
|
479
|
-
header_params = {
|
480
|
-
|
481
|
-
|
495
|
+
header_params = {}
|
496
|
+
if request.parent
|
497
|
+
header_params["parent"] = request.parent
|
498
|
+
end
|
499
|
+
|
482
500
|
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
483
501
|
metadata[:"x-goog-request-params"] ||= request_params_header
|
484
502
|
|
@@ -557,9 +575,11 @@ module Google
|
|
557
575
|
gapic_version: ::Google::Cloud::Retail::V2::VERSION
|
558
576
|
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
559
577
|
|
560
|
-
header_params = {
|
561
|
-
|
562
|
-
|
578
|
+
header_params = {}
|
579
|
+
if request.parent
|
580
|
+
header_params["parent"] = request.parent
|
581
|
+
end
|
582
|
+
|
563
583
|
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
564
584
|
metadata[:"x-goog-request-params"] ||= request_params_header
|
565
585
|
|
@@ -160,9 +160,11 @@ module Google
|
|
160
160
|
gapic_version: ::Google::Cloud::Retail::V2::VERSION
|
161
161
|
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
162
162
|
|
163
|
-
header_params = {
|
164
|
-
|
165
|
-
|
163
|
+
header_params = {}
|
164
|
+
if request.name
|
165
|
+
header_params["name"] = request.name
|
166
|
+
end
|
167
|
+
|
166
168
|
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
167
169
|
metadata[:"x-goog-request-params"] ||= request_params_header
|
168
170
|
|
@@ -232,9 +234,11 @@ module Google
|
|
232
234
|
gapic_version: ::Google::Cloud::Retail::V2::VERSION
|
233
235
|
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
234
236
|
|
235
|
-
header_params = {
|
236
|
-
|
237
|
-
|
237
|
+
header_params = {}
|
238
|
+
if request.name
|
239
|
+
header_params["name"] = request.name
|
240
|
+
end
|
241
|
+
|
238
242
|
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
239
243
|
metadata[:"x-goog-request-params"] ||= request_params_header
|
240
244
|
|
@@ -304,9 +308,11 @@ module Google
|
|
304
308
|
gapic_version: ::Google::Cloud::Retail::V2::VERSION
|
305
309
|
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
306
310
|
|
307
|
-
header_params = {
|
308
|
-
|
309
|
-
|
311
|
+
header_params = {}
|
312
|
+
if request.name
|
313
|
+
header_params["name"] = request.name
|
314
|
+
end
|
315
|
+
|
310
316
|
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
311
317
|
metadata[:"x-goog-request-params"] ||= request_params_header
|
312
318
|
|
@@ -381,9 +387,11 @@ module Google
|
|
381
387
|
gapic_version: ::Google::Cloud::Retail::V2::VERSION
|
382
388
|
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
383
389
|
|
384
|
-
header_params = {
|
385
|
-
|
386
|
-
|
390
|
+
header_params = {}
|
391
|
+
if request.name
|
392
|
+
header_params["name"] = request.name
|
393
|
+
end
|
394
|
+
|
387
395
|
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
388
396
|
metadata[:"x-goog-request-params"] ||= request_params_header
|
389
397
|
|
@@ -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,9 +174,10 @@ 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
|
179
|
-
# "store1" or "REGION-2". Otherwise, an INVALID_ARGUMENT error is
|
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
|
179
|
+
# as "store1" or "REGION-2". Otherwise, an INVALID_ARGUMENT error is
|
180
|
+
# returned.
|
180
181
|
class FulfillmentInfo
|
181
182
|
include ::Google::Protobuf::MessageExts
|
182
183
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -421,7 +422,7 @@ module Google
|
|
421
422
|
# ID of the promotion. For example, "free gift".
|
422
423
|
#
|
423
424
|
# The value value must be a UTF-8 encoded string with a length limit of 128
|
424
|
-
# characters, and match the pattern: [a-zA-Z][a-zA-Z0-9_]
|
425
|
+
# characters, and match the pattern: `[a-zA-Z][a-zA-Z0-9_]*`. For example,
|
425
426
|
# id0LikeThis or ID_1_LIKE_THIS. Otherwise, an INVALID_ARGUMENT error is
|
426
427
|
# returned.
|
427
428
|
#
|
@@ -55,18 +55,18 @@ module Google
|
|
55
55
|
# @return [::String]
|
56
56
|
# The device type context for completion suggestions.
|
57
57
|
# It is useful to apply different suggestions on different device types, e.g.
|
58
|
-
# DESKTOP
|
58
|
+
# `DESKTOP`, `MOBILE`. If it is empty, the suggestions are across all device
|
59
59
|
# types.
|
60
60
|
#
|
61
61
|
# Supported formats:
|
62
62
|
#
|
63
|
-
# * UNKNOWN_DEVICE_TYPE
|
63
|
+
# * `UNKNOWN_DEVICE_TYPE`
|
64
64
|
#
|
65
|
-
# * DESKTOP
|
65
|
+
# * `DESKTOP`
|
66
66
|
#
|
67
|
-
# * MOBILE
|
67
|
+
# * `MOBILE`
|
68
68
|
#
|
69
|
-
# * A customized string starts with OTHER_
|
69
|
+
# * A customized string starts with `OTHER_`, e.g. `OTHER_IPHONE`.
|
70
70
|
# @!attribute [rw] dataset
|
71
71
|
# @return [::String]
|
72
72
|
# Determines which dataset to use for fetching completion. "user-data" will
|
@@ -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}
|
@@ -150,7 +150,7 @@ module Google
|
|
150
150
|
# Unique identifier provided by client, within the ancestor
|
151
151
|
# dataset scope. Ensures idempotency and used for request deduplication.
|
152
152
|
# Server-generated if unspecified. Up to 128 characters long and must match
|
153
|
-
# the pattern:
|
153
|
+
# the pattern: `[a-zA-Z0-9_]+`. This is returned as [Operation.name][] in
|
154
154
|
# {::Google::Cloud::Retail::V2::ImportMetadata ImportMetadata}.
|
155
155
|
#
|
156
156
|
# Only supported when
|
@@ -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
|
@@ -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
|
@@ -120,6 +123,9 @@ module Google
|
|
120
123
|
# This field must be a UTF-8 encoded string with a length limit of 128
|
121
124
|
# characters. Otherwise, an INVALID_ARGUMENT error is returned.
|
122
125
|
#
|
126
|
+
# This field must be a Unigram. Otherwise, an INVALID_ARGUMENT error is
|
127
|
+
# returned.
|
128
|
+
#
|
123
129
|
# Google Merchant Center property
|
124
130
|
# [gtin](https://support.google.com/merchants/answer/6324461).
|
125
131
|
# Schema.org property
|
@@ -230,15 +236,11 @@ module Google
|
|
230
236
|
# This field needs to pass all below criteria, otherwise an INVALID_ARGUMENT
|
231
237
|
# error is returned:
|
232
238
|
#
|
233
|
-
# * Max entries count: 200
|
234
|
-
# {::Google::Cloud::Retail::V2::Product::Type::VARIANT Type.VARIANT}.
|
239
|
+
# * Max entries count: 200.
|
235
240
|
# * The key must be a UTF-8 encoded string with a length limit of 128
|
236
241
|
# 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
242
|
# * For indexable attribute, the key must match the pattern:
|
241
|
-
# [a-zA-Z0-9][a-zA-Z0-9_]
|
243
|
+
# `[a-zA-Z0-9][a-zA-Z0-9_]*`. For example, key0LikeThis or KEY_1_LIKE_THIS.
|
242
244
|
# @!attribute [rw] tags
|
243
245
|
# @return [::Array<::String>]
|
244
246
|
# Custom tags associated with the product.
|
@@ -346,7 +348,7 @@ module Google
|
|
346
348
|
# @return [::Array<::String>]
|
347
349
|
# The material of the product. For example, "leather", "wooden".
|
348
350
|
#
|
349
|
-
# A maximum of
|
351
|
+
# A maximum of 20 values are allowed. Each value must be a UTF-8 encoded
|
350
352
|
# string with a length limit of 128 characters. Otherwise, an
|
351
353
|
# INVALID_ARGUMENT error is returned.
|
352
354
|
#
|
@@ -358,7 +360,7 @@ module Google
|
|
358
360
|
# The pattern or graphic print of the product. For example, "striped", "polka
|
359
361
|
# dot", "paisley".
|
360
362
|
#
|
361
|
-
# A maximum of
|
363
|
+
# A maximum of 20 values are allowed per
|
362
364
|
# {::Google::Cloud::Retail::V2::Product Product}. Each value must be a UTF-8
|
363
365
|
# encoded string with a length limit of 128 characters. Otherwise, an
|
364
366
|
# INVALID_ARGUMENT error is returned.
|
@@ -445,8 +447,12 @@ module Google
|
|
445
447
|
# * {::Google::Cloud::Retail::V2::Product#name name}
|
446
448
|
# * {::Google::Cloud::Retail::V2::Product#color_info color_info}
|
447
449
|
#
|
448
|
-
# Maximum number of paths is
|
450
|
+
# Maximum number of paths is 30. Otherwise, an INVALID_ARGUMENT error is
|
449
451
|
# returned.
|
452
|
+
#
|
453
|
+
# Note: Returning more fields in
|
454
|
+
# {::Google::Cloud::Retail::V2::SearchResponse SearchResponse} may increase
|
455
|
+
# response payload size and serving latency.
|
450
456
|
# @!attribute [r] variants
|
451
457
|
# @return [::Array<::Google::Cloud::Retail::V2::Product>]
|
452
458
|
# Output only. Product variants grouped together on primary product which
|
@@ -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
|
@@ -355,7 +355,7 @@ module Google
|
|
355
355
|
#
|
356
356
|
# At least 1 value is required, and a maximum of 2000 values are allowed.
|
357
357
|
# Each value must be a string with a length limit of 10 characters, matching
|
358
|
-
# the pattern [a-zA-Z0-9_-]
|
358
|
+
# the pattern `[a-zA-Z0-9_-]+`, such as "store1" or "REGION-2". Otherwise, an
|
359
359
|
# INVALID_ARGUMENT error is returned.
|
360
360
|
#
|
361
361
|
# If the total number of place IDs exceeds 2000 for this
|
@@ -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
|
@@ -436,7 +436,7 @@ module Google
|
|
436
436
|
#
|
437
437
|
# At least 1 value is required, and a maximum of 2000 values are allowed.
|
438
438
|
# Each value must be a string with a length limit of 10 characters, matching
|
439
|
-
# the pattern [a-zA-Z0-9_-]
|
439
|
+
# the pattern `[a-zA-Z0-9_-]+`, such as "store1" or "REGION-2". Otherwise, an
|
440
440
|
# INVALID_ARGUMENT error is returned.
|
441
441
|
# @!attribute [rw] remove_time
|
442
442
|
# @return [::Google::Protobuf::Timestamp]
|
@@ -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
|