google-cloud-retail-v2 0.7.0 → 0.10.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +10 -5
- data/lib/google/cloud/retail/v2/catalog_pb.rb +2 -1
- data/lib/google/cloud/retail/v2/catalog_service_pb.rb +2 -1
- data/lib/google/cloud/retail/v2/common_pb.rb +2 -1
- data/lib/google/cloud/retail/v2/completion_service/client.rb +6 -3
- data/lib/google/cloud/retail/v2/completion_service/operations.rb +3 -0
- data/lib/google/cloud/retail/v2/completion_service_pb.rb +2 -1
- data/lib/google/cloud/retail/v2/import_config_pb.rb +2 -1
- data/lib/google/cloud/retail/v2/prediction_service/client.rb +39 -14
- data/lib/google/cloud/retail/v2/prediction_service_pb.rb +3 -1
- data/lib/google/cloud/retail/v2/product_pb.rb +2 -1
- data/lib/google/cloud/retail/v2/product_service/client.rb +63 -35
- data/lib/google/cloud/retail/v2/product_service/operations.rb +3 -0
- data/lib/google/cloud/retail/v2/product_service_pb.rb +2 -1
- data/lib/google/cloud/retail/v2/product_service_services_pb.rb +34 -25
- data/lib/google/cloud/retail/v2/purge_config_pb.rb +2 -1
- data/lib/google/cloud/retail/v2/search_service/client.rb +37 -8
- data/lib/google/cloud/retail/v2/search_service_pb.rb +18 -1
- data/lib/google/cloud/retail/v2/user_event_pb.rb +2 -1
- data/lib/google/cloud/retail/v2/user_event_service/operations.rb +3 -0
- data/lib/google/cloud/retail/v2/user_event_service_pb.rb +2 -1
- data/lib/google/cloud/retail/v2/version.rb +1 -1
- data/proto_docs/google/cloud/retail/v2/catalog.rb +8 -8
- data/proto_docs/google/cloud/retail/v2/common.rb +22 -10
- data/proto_docs/google/cloud/retail/v2/completion_service.rb +16 -5
- data/proto_docs/google/cloud/retail/v2/import_config.rb +9 -2
- data/proto_docs/google/cloud/retail/v2/prediction_service.rb +40 -15
- data/proto_docs/google/cloud/retail/v2/product.rb +2 -2
- data/proto_docs/google/cloud/retail/v2/product_service.rb +73 -29
- data/proto_docs/google/cloud/retail/v2/search_service.rb +141 -29
- data/proto_docs/google/cloud/retail/v2/user_event.rb +6 -3
- data/proto_docs/google/protobuf/any.rb +3 -3
- data/proto_docs/google/protobuf/empty.rb +0 -2
- data/proto_docs/google/protobuf/struct.rb +2 -2
- metadata +12 -12
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 4d1c1b9f050a34949ddbbf2216e42a2fcede56547eb053e243c0f4b398798951
|
|
4
|
+
data.tar.gz: d5748a0e343c717fb44675eb87e4d80ae5afba3e6a222250eca1fc1303d33dea
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 910e5dc16ed89bd22106fe89d5a48baac5fc4d8d9cc8204485a36adc00effcf1c47702de41b457d3ff89cc2c0b609cb7882389800ee8a6e208caa6699b5851bb
|
|
7
|
+
data.tar.gz: fa5329eb5145faf2d00bd0117077d8bd297d05bfd98f429302202470b89693ed0813bcbcfe1d871842de50f403ab35524db49bf80a065f558fddb3859314a2d9
|
data/README.md
CHANGED
|
@@ -69,16 +69,21 @@ module GRPC
|
|
|
69
69
|
end
|
|
70
70
|
```
|
|
71
71
|
|
|
72
|
+
|
|
73
|
+
## Google Cloud Samples
|
|
74
|
+
|
|
75
|
+
To browse ready to use code samples check [Google Cloud Samples](https://cloud.google.com/docs/samples).
|
|
76
|
+
|
|
72
77
|
## Supported Ruby Versions
|
|
73
78
|
|
|
74
|
-
This library is supported on Ruby 2.
|
|
79
|
+
This library is supported on Ruby 2.6+.
|
|
75
80
|
|
|
76
81
|
Google provides official support for Ruby versions that are actively supported
|
|
77
82
|
by Ruby Core—that is, Ruby versions that are either in normal maintenance or
|
|
78
|
-
in security maintenance, and not end of life.
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
83
|
+
in security maintenance, and not end of life. Older versions of Ruby _may_
|
|
84
|
+
still work, but are unsupported and not recommended. See
|
|
85
|
+
https://www.ruby-lang.org/en/downloads/branches/ for details about the Ruby
|
|
86
|
+
support schedule.
|
|
82
87
|
|
|
83
88
|
## Which client should I use?
|
|
84
89
|
|
|
@@ -1,9 +1,10 @@
|
|
|
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
|
+
|
|
4
6
|
require 'google/api/field_behavior_pb'
|
|
5
7
|
require 'google/api/resource_pb'
|
|
6
|
-
require 'google/protobuf'
|
|
7
8
|
|
|
8
9
|
Google::Protobuf::DescriptorPool.generated_pool.build do
|
|
9
10
|
add_file("google/cloud/retail/v2/catalog.proto", :syntax => :proto3) do
|
|
@@ -1,6 +1,8 @@
|
|
|
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
|
+
|
|
4
6
|
require 'google/api/annotations_pb'
|
|
5
7
|
require 'google/api/client_pb'
|
|
6
8
|
require 'google/api/field_behavior_pb'
|
|
@@ -9,7 +11,6 @@ require 'google/cloud/retail/v2/catalog_pb'
|
|
|
9
11
|
require 'google/protobuf/empty_pb'
|
|
10
12
|
require 'google/protobuf/field_mask_pb'
|
|
11
13
|
require 'google/protobuf/timestamp_pb'
|
|
12
|
-
require 'google/protobuf'
|
|
13
14
|
|
|
14
15
|
Google::Protobuf::DescriptorPool.generated_pool.build do
|
|
15
16
|
add_file("google/cloud/retail/v2/catalog_service.proto", :syntax => :proto3) do
|
|
@@ -1,9 +1,10 @@
|
|
|
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
|
+
|
|
4
6
|
require 'google/api/field_behavior_pb'
|
|
5
7
|
require 'google/protobuf/timestamp_pb'
|
|
6
|
-
require 'google/protobuf'
|
|
7
8
|
|
|
8
9
|
Google::Protobuf::DescriptorPool.generated_pool.build do
|
|
9
10
|
add_file("google/cloud/retail/v2/common.proto", :syntax => :proto3) do
|
|
@@ -204,6 +204,9 @@ module Google
|
|
|
204
204
|
# The field must be a UTF-8 encoded string with a length limit of 128
|
|
205
205
|
# characters. Otherwise, an INVALID_ARGUMENT error is returned.
|
|
206
206
|
# @param language_codes [::Array<::String>]
|
|
207
|
+
# Note that this field applies for `user-data` dataset only. For requests
|
|
208
|
+
# with `cloud-retail` dataset, setting this field has no effect.
|
|
209
|
+
#
|
|
207
210
|
# The language filters applied to the output suggestions. If set, it should
|
|
208
211
|
# contain the language of the query. If not set, suggestions are returned
|
|
209
212
|
# without considering language restrictions. This is the BCP-47 language
|
|
@@ -236,9 +239,9 @@ module Google
|
|
|
236
239
|
#
|
|
237
240
|
# * user-data
|
|
238
241
|
#
|
|
239
|
-
# * cloud-retail
|
|
240
|
-
# This option requires
|
|
241
|
-
#
|
|
242
|
+
# * cloud-retail:
|
|
243
|
+
# This option requires enabling auto-learning function first. See
|
|
244
|
+
# [guidelines](https://cloud.google.com/retail/docs/completion-overview#generated-completion-dataset).
|
|
242
245
|
# @param max_suggestions [::Integer]
|
|
243
246
|
# Completion max suggestions. If left unset or set to 0, then will fallback
|
|
244
247
|
# to the configured value [CompletionConfig.max_suggestions][].
|
|
@@ -1,6 +1,8 @@
|
|
|
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
|
+
|
|
4
6
|
require 'google/api/annotations_pb'
|
|
5
7
|
require 'google/api/client_pb'
|
|
6
8
|
require 'google/api/field_behavior_pb'
|
|
@@ -8,7 +10,6 @@ require 'google/api/resource_pb'
|
|
|
8
10
|
require 'google/cloud/retail/v2/common_pb'
|
|
9
11
|
require 'google/cloud/retail/v2/import_config_pb'
|
|
10
12
|
require 'google/longrunning/operations_pb'
|
|
11
|
-
require 'google/protobuf'
|
|
12
13
|
|
|
13
14
|
Google::Protobuf::DescriptorPool.generated_pool.build do
|
|
14
15
|
add_file("google/cloud/retail/v2/completion_service.proto", :syntax => :proto3) do
|
|
@@ -1,6 +1,8 @@
|
|
|
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
|
+
|
|
4
6
|
require 'google/api/field_behavior_pb'
|
|
5
7
|
require 'google/api/resource_pb'
|
|
6
8
|
require 'google/cloud/retail/v2/product_pb'
|
|
@@ -9,7 +11,6 @@ require 'google/protobuf/field_mask_pb'
|
|
|
9
11
|
require 'google/protobuf/timestamp_pb'
|
|
10
12
|
require 'google/rpc/status_pb'
|
|
11
13
|
require 'google/type/date_pb'
|
|
12
|
-
require 'google/protobuf'
|
|
13
14
|
|
|
14
15
|
Google::Protobuf::DescriptorPool.generated_pool.build do
|
|
15
16
|
add_file("google/cloud/retail/v2/import_config.proto", :syntax => :proto3) do
|
|
@@ -169,26 +169,41 @@ module Google
|
|
|
169
169
|
#
|
|
170
170
|
# @param placement [::String]
|
|
171
171
|
# Required. Full resource name of the format:
|
|
172
|
-
#
|
|
173
|
-
#
|
|
174
|
-
#
|
|
175
|
-
#
|
|
176
|
-
#
|
|
177
|
-
#
|
|
178
|
-
#
|
|
179
|
-
#
|
|
172
|
+
# `{placement=projects/*/locations/global/catalogs/default_catalog/servingConfigs/*}`
|
|
173
|
+
# or
|
|
174
|
+
# `{placement=projects/*/locations/global/catalogs/default_catalog/placements/*}`.
|
|
175
|
+
# We recommend using the `servingConfigs` resource. `placements` is a legacy
|
|
176
|
+
# resource.
|
|
177
|
+
# The ID of the Recommendations AI serving config or placement.
|
|
178
|
+
# Before you can request predictions from your model, you must create at
|
|
179
|
+
# least one serving config or placement for it. For more information, see
|
|
180
|
+
# [Managing serving configurations]
|
|
181
|
+
# (https://cloud.google.com/retail/docs/manage-configs).
|
|
182
|
+
#
|
|
183
|
+
# The full list of available serving configs can be seen at
|
|
184
|
+
# https://console.cloud.google.com/ai/retail/catalogs/default_catalog/configs
|
|
180
185
|
# @param user_event [::Google::Cloud::Retail::V2::UserEvent, ::Hash]
|
|
181
186
|
# Required. Context about the user, what they are looking at and what action
|
|
182
187
|
# they took to trigger the predict request. Note that this user event detail
|
|
183
188
|
# won't be ingested to userEvent logs. Thus, a separate userEvent write
|
|
184
189
|
# request is required for event logging.
|
|
190
|
+
#
|
|
191
|
+
# Don't set
|
|
192
|
+
# {::Google::Cloud::Retail::V2::UserEvent#visitor_id UserEvent.visitor_id} or
|
|
193
|
+
# {::Google::Cloud::Retail::V2::UserInfo#user_id UserInfo.user_id} to the same
|
|
194
|
+
# fixed ID for different users. If you are trying to receive non-personalized
|
|
195
|
+
# recommendations (not recommended; this can negatively impact model
|
|
196
|
+
# performance), instead set
|
|
197
|
+
# {::Google::Cloud::Retail::V2::UserEvent#visitor_id UserEvent.visitor_id} to a
|
|
198
|
+
# random unique ID and leave
|
|
199
|
+
# {::Google::Cloud::Retail::V2::UserInfo#user_id UserInfo.user_id} unset.
|
|
185
200
|
# @param page_size [::Integer]
|
|
186
|
-
# Maximum number of results to return
|
|
187
|
-
#
|
|
188
|
-
#
|
|
189
|
-
#
|
|
201
|
+
# Maximum number of results to return. Set this property to the number of
|
|
202
|
+
# prediction results needed. If zero, the service will choose a reasonable
|
|
203
|
+
# default. The maximum allowed value is 100. Values above 100 will be coerced
|
|
204
|
+
# to 100.
|
|
190
205
|
# @param page_token [::String]
|
|
191
|
-
#
|
|
206
|
+
# This field is not used; leave it unset.
|
|
192
207
|
# @param filter [::String]
|
|
193
208
|
# Filter for restricting prediction results with a length limit of 5,000
|
|
194
209
|
# characters. Accepts values for tags and the `filterOutOfStockItems` flag.
|
|
@@ -219,6 +234,14 @@ module Google
|
|
|
219
234
|
# receive empty results instead.
|
|
220
235
|
# Note that the API will never return items with storageStatus of "EXPIRED"
|
|
221
236
|
# or "DELETED" regardless of filter choices.
|
|
237
|
+
#
|
|
238
|
+
# If `filterSyntaxV2` is set to true under the `params` field, then
|
|
239
|
+
# attribute-based expressions are expected instead of the above described
|
|
240
|
+
# tag-based syntax. Examples:
|
|
241
|
+
#
|
|
242
|
+
# * (colors: ANY("Red", "Blue")) AND NOT (categories: ANY("Phones"))
|
|
243
|
+
# * (availability: ANY("IN_STOCK")) AND
|
|
244
|
+
# (colors: ANY("Red") OR categories: ANY("Phones"))
|
|
222
245
|
# @param validate_only [::Boolean]
|
|
223
246
|
# Use validate only mode for this prediction query. If set to true, a
|
|
224
247
|
# dummy model will be used that returns arbitrary products.
|
|
@@ -250,13 +273,15 @@ module Google
|
|
|
250
273
|
# 'medium-diversity', 'high-diversity', 'auto-diversity'}. This gives
|
|
251
274
|
# request-level control and adjusts prediction results based on product
|
|
252
275
|
# category.
|
|
276
|
+
# * `filterSyntaxV2`: Boolean. False by default. If set to true, the `filter`
|
|
277
|
+
# field is interpreteted according to the new, attribute-based syntax.
|
|
253
278
|
# @param labels [::Hash{::String => ::String}]
|
|
254
279
|
# The labels applied to a resource must meet the following requirements:
|
|
255
280
|
#
|
|
256
281
|
# * Each resource can have multiple labels, up to a maximum of 64.
|
|
257
282
|
# * Each label must be a key-value pair.
|
|
258
283
|
# * Keys have a minimum length of 1 character and a maximum length of 63
|
|
259
|
-
# characters
|
|
284
|
+
# characters and cannot be empty. Values can be empty and have a maximum
|
|
260
285
|
# length of 63 characters.
|
|
261
286
|
# * Keys and values can contain only lowercase letters, numeric characters,
|
|
262
287
|
# underscores, and dashes. All characters must use UTF-8 encoding, and
|
|
@@ -1,12 +1,14 @@
|
|
|
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
|
+
|
|
4
6
|
require 'google/api/annotations_pb'
|
|
5
7
|
require 'google/api/client_pb'
|
|
6
8
|
require 'google/api/field_behavior_pb'
|
|
9
|
+
require 'google/api/resource_pb'
|
|
7
10
|
require 'google/cloud/retail/v2/user_event_pb'
|
|
8
11
|
require 'google/protobuf/struct_pb'
|
|
9
|
-
require 'google/protobuf'
|
|
10
12
|
|
|
11
13
|
Google::Protobuf::DescriptorPool.generated_pool.build do
|
|
12
14
|
add_file("google/cloud/retail/v2/prediction_service.proto", :syntax => :proto3) do
|
|
@@ -1,6 +1,8 @@
|
|
|
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
|
+
|
|
4
6
|
require 'google/api/field_behavior_pb'
|
|
5
7
|
require 'google/api/resource_pb'
|
|
6
8
|
require 'google/cloud/retail/v2/common_pb'
|
|
@@ -9,7 +11,6 @@ require 'google/protobuf/duration_pb'
|
|
|
9
11
|
require 'google/protobuf/field_mask_pb'
|
|
10
12
|
require 'google/protobuf/timestamp_pb'
|
|
11
13
|
require 'google/protobuf/wrappers_pb'
|
|
12
|
-
require 'google/protobuf'
|
|
13
14
|
|
|
14
15
|
Google::Protobuf::DescriptorPool.generated_pool.build do
|
|
15
16
|
add_file("google/cloud/retail/v2/product.proto", :syntax => :proto3) do
|
|
@@ -566,6 +566,11 @@ module Google
|
|
|
566
566
|
#
|
|
567
567
|
# If an unsupported or unknown field is provided, an INVALID_ARGUMENT error
|
|
568
568
|
# is returned.
|
|
569
|
+
#
|
|
570
|
+
# The attribute key can be updated by setting the mask path as
|
|
571
|
+
# "attributes.$\\{key_name}". If a key name is present in the mask but not in
|
|
572
|
+
# the patching product from the request, this key will be deleted after the
|
|
573
|
+
# update.
|
|
569
574
|
# @param allow_missing [::Boolean]
|
|
570
575
|
# If set to true, and the {::Google::Cloud::Retail::V2::Product Product} is not
|
|
571
576
|
# found, a new {::Google::Cloud::Retail::V2::Product Product} will be created. In
|
|
@@ -743,7 +748,7 @@ module Google
|
|
|
743
748
|
##
|
|
744
749
|
# Bulk import of multiple {::Google::Cloud::Retail::V2::Product Product}s.
|
|
745
750
|
#
|
|
746
|
-
# Request processing may be synchronous.
|
|
751
|
+
# Request processing may be synchronous.
|
|
747
752
|
# Non-existing items are created.
|
|
748
753
|
#
|
|
749
754
|
# Note that it is possible for a subset of the
|
|
@@ -784,11 +789,18 @@ module Google
|
|
|
784
789
|
# imported. Defaults to
|
|
785
790
|
# {::Google::Cloud::Retail::V2::ImportProductsRequest::ReconciliationMode::INCREMENTAL ReconciliationMode.INCREMENTAL}.
|
|
786
791
|
# @param notification_pubsub_topic [::String]
|
|
787
|
-
# Pub/Sub topic for receiving notification. If this field is set,
|
|
792
|
+
# Full Pub/Sub topic name for receiving notification. If this field is set,
|
|
788
793
|
# when the import is finished, a notification will be sent to
|
|
789
794
|
# specified Pub/Sub topic. The message data will be JSON string of a
|
|
790
795
|
# {::Google::Longrunning::Operation Operation}.
|
|
791
|
-
#
|
|
796
|
+
#
|
|
797
|
+
# Format of the Pub/Sub topic is `projects/{project}/topics/{topic}`. It has
|
|
798
|
+
# to be within the same project as
|
|
799
|
+
# {::Google::Cloud::Retail::V2::ImportProductsRequest#parent ImportProductsRequest.parent}.
|
|
800
|
+
# Make sure that both
|
|
801
|
+
# `cloud-retail-customer-data-access@system.gserviceaccount.com` and
|
|
802
|
+
# `service-<project number>@gcp-sa-retail.iam.gserviceaccount.com`
|
|
803
|
+
# have the `pubsub.topics.publish` IAM permission on the topic.
|
|
792
804
|
#
|
|
793
805
|
# Only supported when
|
|
794
806
|
# {::Google::Cloud::Retail::V2::ImportProductsRequest#reconciliation_mode ImportProductsRequest.reconciliation_mode}
|
|
@@ -877,18 +889,21 @@ module Google
|
|
|
877
889
|
# enqueued and processed downstream. As a consequence, when a response is
|
|
878
890
|
# returned, updates are not immediately manifested in the
|
|
879
891
|
# {::Google::Cloud::Retail::V2::Product Product} queried by
|
|
880
|
-
# {::Google::Cloud::Retail::V2::ProductService::Client#get_product GetProduct}
|
|
881
|
-
#
|
|
892
|
+
# {::Google::Cloud::Retail::V2::ProductService::Client#get_product ProductService.GetProduct}
|
|
893
|
+
# or
|
|
894
|
+
# {::Google::Cloud::Retail::V2::ProductService::Client#list_products ProductService.ListProducts}.
|
|
882
895
|
#
|
|
883
896
|
# When inventory is updated with
|
|
884
|
-
# {::Google::Cloud::Retail::V2::ProductService::Client#create_product CreateProduct}
|
|
885
|
-
#
|
|
886
|
-
#
|
|
897
|
+
# {::Google::Cloud::Retail::V2::ProductService::Client#create_product ProductService.CreateProduct}
|
|
898
|
+
# and
|
|
899
|
+
# {::Google::Cloud::Retail::V2::ProductService::Client#update_product ProductService.UpdateProduct},
|
|
900
|
+
# the specified inventory field value(s) will overwrite any existing value(s)
|
|
887
901
|
# while ignoring the last update time for this field. Furthermore, the last
|
|
888
902
|
# update time for the specified inventory fields will be overwritten to the
|
|
889
903
|
# time of the
|
|
890
|
-
# {::Google::Cloud::Retail::V2::ProductService::Client#create_product CreateProduct}
|
|
891
|
-
#
|
|
904
|
+
# {::Google::Cloud::Retail::V2::ProductService::Client#create_product ProductService.CreateProduct}
|
|
905
|
+
# or
|
|
906
|
+
# {::Google::Cloud::Retail::V2::ProductService::Client#update_product ProductService.UpdateProduct}
|
|
892
907
|
# request.
|
|
893
908
|
#
|
|
894
909
|
# If no inventory fields are set in
|
|
@@ -900,10 +915,10 @@ module Google
|
|
|
900
915
|
# then any existing inventory information will be preserved.
|
|
901
916
|
#
|
|
902
917
|
# Pre-existing inventory information can only be updated with
|
|
903
|
-
# {::Google::Cloud::Retail::V2::ProductService::Client#set_inventory SetInventory},
|
|
904
|
-
# {::Google::Cloud::Retail::V2::ProductService::Client#add_fulfillment_places AddFulfillmentPlaces},
|
|
918
|
+
# {::Google::Cloud::Retail::V2::ProductService::Client#set_inventory ProductService.SetInventory},
|
|
919
|
+
# {::Google::Cloud::Retail::V2::ProductService::Client#add_fulfillment_places ProductService.AddFulfillmentPlaces},
|
|
905
920
|
# and
|
|
906
|
-
# {::Google::Cloud::Retail::V2::ProductService::Client#remove_fulfillment_places RemoveFulfillmentPlaces}.
|
|
921
|
+
# {::Google::Cloud::Retail::V2::ProductService::Client#remove_fulfillment_places ProductService.RemoveFulfillmentPlaces}.
|
|
907
922
|
#
|
|
908
923
|
# This feature is only available for users who have Retail Search enabled.
|
|
909
924
|
# Please enable Retail Search on Cloud Console before using this feature.
|
|
@@ -926,6 +941,7 @@ module Google
|
|
|
926
941
|
# @param inventory [::Google::Cloud::Retail::V2::Product, ::Hash]
|
|
927
942
|
# Required. The inventory information to update. The allowable fields to
|
|
928
943
|
# update are:
|
|
944
|
+
#
|
|
929
945
|
# * {::Google::Cloud::Retail::V2::Product#price_info Product.price_info}
|
|
930
946
|
# * {::Google::Cloud::Retail::V2::Product#availability Product.availability}
|
|
931
947
|
# * {::Google::Cloud::Retail::V2::Product#available_quantity Product.available_quantity}
|
|
@@ -933,8 +949,9 @@ module Google
|
|
|
933
949
|
# The updated inventory fields must be specified in
|
|
934
950
|
# {::Google::Cloud::Retail::V2::SetInventoryRequest#set_mask SetInventoryRequest.set_mask}.
|
|
935
951
|
#
|
|
936
|
-
# If
|
|
937
|
-
#
|
|
952
|
+
# If
|
|
953
|
+
# {::Google::Cloud::Retail::V2::Product#name SetInventoryRequest.inventory.name}
|
|
954
|
+
# is empty or invalid, an INVALID_ARGUMENT error is returned.
|
|
938
955
|
#
|
|
939
956
|
# If the caller does not have permission to update the
|
|
940
957
|
# {::Google::Cloud::Retail::V2::Product Product} named in
|
|
@@ -957,7 +974,8 @@ module Google
|
|
|
957
974
|
# * Adds "fulfillment_info" in
|
|
958
975
|
# {::Google::Cloud::Retail::V2::SetInventoryRequest#set_mask SetInventoryRequest.set_mask}
|
|
959
976
|
# * Specifies only the desired fulfillment types and corresponding place IDs
|
|
960
|
-
# to update in
|
|
977
|
+
# to update in
|
|
978
|
+
# {::Google::Cloud::Retail::V2::Product#fulfillment_info SetInventoryRequest.inventory.fulfillment_info}
|
|
961
979
|
#
|
|
962
980
|
# The caller can clear all place IDs from a subset of fulfillment types in
|
|
963
981
|
# the following ways:
|
|
@@ -965,9 +983,9 @@ module Google
|
|
|
965
983
|
# * Adds "fulfillment_info" in
|
|
966
984
|
# {::Google::Cloud::Retail::V2::SetInventoryRequest#set_mask SetInventoryRequest.set_mask}
|
|
967
985
|
# * Specifies only the desired fulfillment types to clear in
|
|
968
|
-
#
|
|
986
|
+
# {::Google::Cloud::Retail::V2::Product#fulfillment_info SetInventoryRequest.inventory.fulfillment_info}
|
|
969
987
|
# * Checks that only the desired fulfillment info types have empty
|
|
970
|
-
#
|
|
988
|
+
# {::Google::Cloud::Retail::V2::FulfillmentInfo#place_ids SetInventoryRequest.inventory.fulfillment_info.place_ids}
|
|
971
989
|
#
|
|
972
990
|
# The last update time is recorded for the following inventory fields:
|
|
973
991
|
# * {::Google::Cloud::Retail::V2::Product#price_info Product.price_info}
|
|
@@ -976,7 +994,9 @@ module Google
|
|
|
976
994
|
# * {::Google::Cloud::Retail::V2::Product#fulfillment_info Product.fulfillment_info}
|
|
977
995
|
#
|
|
978
996
|
# If a full overwrite of inventory information while ignoring timestamps is
|
|
979
|
-
# needed,
|
|
997
|
+
# needed,
|
|
998
|
+
# {::Google::Cloud::Retail::V2::ProductService::Client#update_product ProductService.UpdateProduct}
|
|
999
|
+
# should be invoked instead.
|
|
980
1000
|
# @param set_mask [::Google::Protobuf::FieldMask, ::Hash]
|
|
981
1001
|
# Indicates which inventory fields in the provided
|
|
982
1002
|
# {::Google::Cloud::Retail::V2::Product Product} to update.
|
|
@@ -1079,8 +1099,9 @@ module Google
|
|
|
1079
1099
|
# enqueued and processed downstream. As a consequence, when a response is
|
|
1080
1100
|
# returned, the added place IDs are not immediately manifested in the
|
|
1081
1101
|
# {::Google::Cloud::Retail::V2::Product Product} queried by
|
|
1082
|
-
# {::Google::Cloud::Retail::V2::ProductService::Client#get_product GetProduct}
|
|
1083
|
-
#
|
|
1102
|
+
# {::Google::Cloud::Retail::V2::ProductService::Client#get_product ProductService.GetProduct}
|
|
1103
|
+
# or
|
|
1104
|
+
# {::Google::Cloud::Retail::V2::ProductService::Client#list_products ProductService.ListProducts}.
|
|
1084
1105
|
#
|
|
1085
1106
|
# This feature is only available for users who have Retail Search enabled.
|
|
1086
1107
|
# Please enable Retail Search on Cloud Console before using this feature.
|
|
@@ -1127,7 +1148,8 @@ module Google
|
|
|
1127
1148
|
# If this field is set to an invalid value other than these, an
|
|
1128
1149
|
# INVALID_ARGUMENT error is returned.
|
|
1129
1150
|
#
|
|
1130
|
-
# This field directly corresponds to
|
|
1151
|
+
# This field directly corresponds to
|
|
1152
|
+
# {::Google::Cloud::Retail::V2::FulfillmentInfo#type Product.fulfillment_info.type}.
|
|
1131
1153
|
# @param place_ids [::Array<::String>]
|
|
1132
1154
|
# Required. The IDs for this
|
|
1133
1155
|
# {::Google::Cloud::Retail::V2::AddFulfillmentPlacesRequest#type type}, such as
|
|
@@ -1238,8 +1260,9 @@ module Google
|
|
|
1238
1260
|
# enqueued and processed downstream. As a consequence, when a response is
|
|
1239
1261
|
# returned, the removed place IDs are not immediately manifested in the
|
|
1240
1262
|
# {::Google::Cloud::Retail::V2::Product Product} queried by
|
|
1241
|
-
# {::Google::Cloud::Retail::V2::ProductService::Client#get_product GetProduct}
|
|
1242
|
-
#
|
|
1263
|
+
# {::Google::Cloud::Retail::V2::ProductService::Client#get_product ProductService.GetProduct}
|
|
1264
|
+
# or
|
|
1265
|
+
# {::Google::Cloud::Retail::V2::ProductService::Client#list_products ProductService.ListProducts}.
|
|
1243
1266
|
#
|
|
1244
1267
|
# This feature is only available for users who have Retail Search enabled.
|
|
1245
1268
|
# Please enable Retail Search on Cloud Console before using this feature.
|
|
@@ -1286,7 +1309,8 @@ module Google
|
|
|
1286
1309
|
# If this field is set to an invalid value other than these, an
|
|
1287
1310
|
# INVALID_ARGUMENT error is returned.
|
|
1288
1311
|
#
|
|
1289
|
-
# This field directly corresponds to
|
|
1312
|
+
# This field directly corresponds to
|
|
1313
|
+
# {::Google::Cloud::Retail::V2::FulfillmentInfo#type Product.fulfillment_info.type}.
|
|
1290
1314
|
# @param place_ids [::Array<::String>]
|
|
1291
1315
|
# Required. The IDs for this
|
|
1292
1316
|
# {::Google::Cloud::Retail::V2::RemoveFulfillmentPlacesRequest#type type}, such as
|
|
@@ -1393,13 +1417,15 @@ module Google
|
|
|
1393
1417
|
# and processed downstream. As a consequence, when a response is returned,
|
|
1394
1418
|
# updates are not immediately manifested in the
|
|
1395
1419
|
# {::Google::Cloud::Retail::V2::Product Product} queried by
|
|
1396
|
-
# {::Google::Cloud::Retail::V2::ProductService::Client#get_product GetProduct}
|
|
1397
|
-
#
|
|
1420
|
+
# {::Google::Cloud::Retail::V2::ProductService::Client#get_product ProductService.GetProduct}
|
|
1421
|
+
# or
|
|
1422
|
+
# {::Google::Cloud::Retail::V2::ProductService::Client#list_products ProductService.ListProducts}.
|
|
1398
1423
|
#
|
|
1399
1424
|
# Local inventory information can only be modified using this method.
|
|
1400
|
-
# {::Google::Cloud::Retail::V2::ProductService::Client#create_product CreateProduct}
|
|
1401
|
-
#
|
|
1402
|
-
#
|
|
1425
|
+
# {::Google::Cloud::Retail::V2::ProductService::Client#create_product ProductService.CreateProduct}
|
|
1426
|
+
# and
|
|
1427
|
+
# {::Google::Cloud::Retail::V2::ProductService::Client#update_product ProductService.UpdateProduct}
|
|
1428
|
+
# has no effect on local inventories.
|
|
1403
1429
|
#
|
|
1404
1430
|
# This feature is only available for users who have Retail Search enabled.
|
|
1405
1431
|
# Please enable Retail Search on Cloud Console before using this feature.
|
|
@@ -1539,13 +1565,15 @@ module Google
|
|
|
1539
1565
|
# enqueued and processed downstream. As a consequence, when a response is
|
|
1540
1566
|
# returned, removals are not immediately manifested in the
|
|
1541
1567
|
# {::Google::Cloud::Retail::V2::Product Product} queried by
|
|
1542
|
-
# {::Google::Cloud::Retail::V2::ProductService::Client#get_product GetProduct}
|
|
1543
|
-
#
|
|
1568
|
+
# {::Google::Cloud::Retail::V2::ProductService::Client#get_product ProductService.GetProduct}
|
|
1569
|
+
# or
|
|
1570
|
+
# {::Google::Cloud::Retail::V2::ProductService::Client#list_products ProductService.ListProducts}.
|
|
1544
1571
|
#
|
|
1545
1572
|
# Local inventory information can only be removed using this method.
|
|
1546
|
-
# {::Google::Cloud::Retail::V2::ProductService::Client#create_product CreateProduct}
|
|
1547
|
-
#
|
|
1548
|
-
#
|
|
1573
|
+
# {::Google::Cloud::Retail::V2::ProductService::Client#create_product ProductService.CreateProduct}
|
|
1574
|
+
# and
|
|
1575
|
+
# {::Google::Cloud::Retail::V2::ProductService::Client#update_product ProductService.UpdateProduct}
|
|
1576
|
+
# has no effect on local inventories.
|
|
1549
1577
|
#
|
|
1550
1578
|
# This feature is only available for users who have Retail Search enabled.
|
|
1551
1579
|
# Please enable Retail Search on Cloud Console before using this feature.
|
|
@@ -1,6 +1,8 @@
|
|
|
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
|
+
|
|
4
6
|
require 'google/api/annotations_pb'
|
|
5
7
|
require 'google/api/client_pb'
|
|
6
8
|
require 'google/api/field_behavior_pb'
|
|
@@ -12,7 +14,6 @@ require 'google/longrunning/operations_pb'
|
|
|
12
14
|
require 'google/protobuf/empty_pb'
|
|
13
15
|
require 'google/protobuf/field_mask_pb'
|
|
14
16
|
require 'google/protobuf/timestamp_pb'
|
|
15
|
-
require 'google/protobuf'
|
|
16
17
|
|
|
17
18
|
Google::Protobuf::DescriptorPool.generated_pool.build do
|
|
18
19
|
add_file("google/cloud/retail/v2/product_service.proto", :syntax => :proto3) do
|