google-cloud-retail-v2 0.11.0 → 0.12.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.
Files changed (44) hide show
  1. checksums.yaml +4 -4
  2. data/AUTHENTICATION.md +1 -1
  3. data/README.md +1 -1
  4. data/lib/google/cloud/retail/v2/catalog_pb.rb +14 -0
  5. data/lib/google/cloud/retail/v2/catalog_service/client.rb +1 -1
  6. data/lib/google/cloud/retail/v2/catalog_service.rb +1 -1
  7. data/lib/google/cloud/retail/v2/completion_service/client.rb +7 -5
  8. data/lib/google/cloud/retail/v2/completion_service.rb +2 -2
  9. data/lib/google/cloud/retail/v2/completion_service_services_pb.rb +3 -3
  10. data/lib/google/cloud/retail/v2/control_service.rb +1 -1
  11. data/lib/google/cloud/retail/v2/prediction_service/client.rb +7 -8
  12. data/lib/google/cloud/retail/v2/prediction_service.rb +1 -1
  13. data/lib/google/cloud/retail/v2/prediction_service_pb.rb +1 -0
  14. data/lib/google/cloud/retail/v2/product_service/client.rb +48 -38
  15. data/lib/google/cloud/retail/v2/product_service.rb +1 -1
  16. data/lib/google/cloud/retail/v2/product_service_services_pb.rb +48 -38
  17. data/lib/google/cloud/retail/v2/search_service/client.rb +4 -4
  18. data/lib/google/cloud/retail/v2/search_service.rb +2 -2
  19. data/lib/google/cloud/retail/v2/search_service_services_pb.rb +2 -2
  20. data/lib/google/cloud/retail/v2/serving_config_pb.rb +7 -0
  21. data/lib/google/cloud/retail/v2/serving_config_service/client.rb +5 -5
  22. data/lib/google/cloud/retail/v2/serving_config_service.rb +1 -1
  23. data/lib/google/cloud/retail/v2/user_event_service/client.rb +25 -12
  24. data/lib/google/cloud/retail/v2/user_event_service.rb +1 -1
  25. data/lib/google/cloud/retail/v2/user_event_service_pb.rb +6 -0
  26. data/lib/google/cloud/retail/v2/user_event_service_services_pb.rb +8 -8
  27. data/lib/google/cloud/retail/v2/version.rb +1 -1
  28. data/lib/google/cloud/retail/v2.rb +2 -2
  29. data/proto_docs/google/api/client.rb +318 -0
  30. data/proto_docs/google/api/launch_stage.rb +71 -0
  31. data/proto_docs/google/cloud/retail/v2/catalog.rb +51 -13
  32. data/proto_docs/google/cloud/retail/v2/catalog_service.rb +1 -1
  33. data/proto_docs/google/cloud/retail/v2/common.rb +5 -3
  34. data/proto_docs/google/cloud/retail/v2/completion_service.rb +4 -2
  35. data/proto_docs/google/cloud/retail/v2/control.rb +2 -3
  36. data/proto_docs/google/cloud/retail/v2/prediction_service.rb +7 -8
  37. data/proto_docs/google/cloud/retail/v2/product.rb +27 -5
  38. data/proto_docs/google/cloud/retail/v2/search_service.rb +15 -8
  39. data/proto_docs/google/cloud/retail/v2/serving_config.rb +32 -15
  40. data/proto_docs/google/cloud/retail/v2/serving_config_service.rb +5 -5
  41. data/proto_docs/google/cloud/retail/v2/user_event.rb +1 -1
  42. data/proto_docs/google/cloud/retail/v2/user_event_service.rb +24 -8
  43. data/proto_docs/google/rpc/status.rb +4 -2
  44. metadata +6 -4
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: ac1d9a4731b52436b27d039833a64947536a4d01829e67222514a50e3155319d
4
- data.tar.gz: 6f48023be7da11258abc4354a2b9e413bcd095057be10ab0fe42cc2b7380bb60
3
+ metadata.gz: d4df763185ea268c1b76c5bd40fbf66332d5deefae96183fede94683c06f7eea
4
+ data.tar.gz: 1ade5fffb7896518d8ef4411b3ba02ae8225d91002ce0e59d5b340fe2cde3df5
5
5
  SHA512:
6
- metadata.gz: 23f52514bc53344d461a35b5b3e726ef5099af6eb4afa04c9550c13e78db52a51964fb5fc4444db98c3e0bc54946e67e0763b7213f85c58cab6625b33ef19656
7
- data.tar.gz: 72a0285df4a4304728b0b17c1bd457593631f7286dc193058db05dd448c58ef971fe5ce12fc00c5776f8313213ac82d265715e27d533fbd67878a88e14470305
6
+ metadata.gz: 49ef27a2292d149e7fb763b13b07f41fe1bf5af5ebde1dbcfe6ba5cbb01c9586637f05b6fbe30c4b3ba24715dd3a458a573e7a74f63254b2a676f3cbe4233d9e
7
+ data.tar.gz: a135a6f28d70aec5096240f03713e65c35d5ca92022ccadd142ac7cf1e90b04b659141b32b342f79b5633406b517afb064f68db0978422d982f06a964a7e2973
data/AUTHENTICATION.md CHANGED
@@ -114,7 +114,7 @@ credentials are discovered.
114
114
  To configure your system for this, simply:
115
115
 
116
116
  1. [Download and install the Cloud SDK](https://cloud.google.com/sdk)
117
- 2. Authenticate using OAuth 2.0 `$ gcloud auth login`
117
+ 2. Authenticate using OAuth 2.0 `$ gcloud auth application-default login`
118
118
  3. Write code as if already authenticated.
119
119
 
120
120
  **NOTE:** This is _not_ recommended for running in production. The Cloud SDK
data/README.md CHANGED
@@ -46,7 +46,7 @@ for general usage information.
46
46
  ## Enabling Logging
47
47
 
48
48
  To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library.
49
- The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/stdlib/libdoc/logger/rdoc/Logger.html) as shown below,
49
+ The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/current/stdlibs/logger/Logger.html) as shown below,
50
50
  or a [`Google::Cloud::Logging::Logger`](https://googleapis.dev/ruby/google-cloud-logging/latest)
51
51
  that will write logs to [Cloud Logging](https://cloud.google.com/logging/). See [grpc/logconfig.rb](https://github.com/grpc/grpc/blob/master/src/ruby/lib/grpc/logconfig.rb)
52
52
  and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information.
@@ -21,6 +21,8 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
21
21
  optional :indexable_option, :enum, 5, "google.cloud.retail.v2.CatalogAttribute.IndexableOption"
22
22
  optional :dynamic_facetable_option, :enum, 6, "google.cloud.retail.v2.CatalogAttribute.DynamicFacetableOption"
23
23
  optional :searchable_option, :enum, 7, "google.cloud.retail.v2.CatalogAttribute.SearchableOption"
24
+ optional :exact_searchable_option, :enum, 11, "google.cloud.retail.v2.CatalogAttribute.ExactSearchableOption"
25
+ optional :retrievable_option, :enum, 12, "google.cloud.retail.v2.CatalogAttribute.RetrievableOption"
24
26
  end
25
27
  add_enum "google.cloud.retail.v2.CatalogAttribute.AttributeType" do
26
28
  value :UNKNOWN, 0
@@ -42,6 +44,16 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
42
44
  value :SEARCHABLE_ENABLED, 1
43
45
  value :SEARCHABLE_DISABLED, 2
44
46
  end
47
+ add_enum "google.cloud.retail.v2.CatalogAttribute.ExactSearchableOption" do
48
+ value :EXACT_SEARCHABLE_OPTION_UNSPECIFIED, 0
49
+ value :EXACT_SEARCHABLE_ENABLED, 1
50
+ value :EXACT_SEARCHABLE_DISABLED, 2
51
+ end
52
+ add_enum "google.cloud.retail.v2.CatalogAttribute.RetrievableOption" do
53
+ value :RETRIEVABLE_OPTION_UNSPECIFIED, 0
54
+ value :RETRIEVABLE_ENABLED, 1
55
+ value :RETRIEVABLE_DISABLED, 2
56
+ end
45
57
  add_message "google.cloud.retail.v2.AttributesConfig" do
46
58
  optional :name, :string, 1
47
59
  map :catalog_attributes, :string, :message, 2, "google.cloud.retail.v2.CatalogAttribute"
@@ -78,6 +90,8 @@ module Google
78
90
  CatalogAttribute::IndexableOption = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.CatalogAttribute.IndexableOption").enummodule
79
91
  CatalogAttribute::DynamicFacetableOption = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.CatalogAttribute.DynamicFacetableOption").enummodule
80
92
  CatalogAttribute::SearchableOption = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.CatalogAttribute.SearchableOption").enummodule
93
+ CatalogAttribute::ExactSearchableOption = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.CatalogAttribute.ExactSearchableOption").enummodule
94
+ CatalogAttribute::RetrievableOption = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.CatalogAttribute.RetrievableOption").enummodule
81
95
  AttributesConfig = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.AttributesConfig").msgclass
82
96
  CompletionConfig = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.CompletionConfig").msgclass
83
97
  Catalog = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.Catalog").msgclass
@@ -608,7 +608,7 @@ module Google
608
608
  #
609
609
  # @param name [::String]
610
610
  # Required. Full CompletionConfig resource name. Format:
611
- # projects/\\{project_number}/locations/\\{location_id}/catalogs/\\{catalog_id}/completionConfig
611
+ # `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/completionConfig`
612
612
  #
613
613
  # @yield [response, operation] Access the result along with the RPC operation
614
614
  # @yieldparam response [::Google::Cloud::Retail::V2::CompletionConfig]
@@ -33,7 +33,7 @@ module Google
33
33
  ##
34
34
  # Service for managing catalog configuration.
35
35
  #
36
- # To load this service and instantiate a client:
36
+ # @example Load this service and instantiate a gRPC client
37
37
  #
38
38
  # require "google/cloud/retail/v2/catalog_service"
39
39
  # client = ::Google::Cloud::Retail::V2::CatalogService::Client.new
@@ -30,7 +30,7 @@ module Google
30
30
  # Auto-completion service for retail.
31
31
  #
32
32
  # This feature is only available for users who have Retail Search enabled.
33
- # Please enable Retail Search on Cloud Console before using this feature.
33
+ # Enable Retail Search on Cloud Console before using this feature.
34
34
  #
35
35
  class Client
36
36
  include Paths
@@ -169,7 +169,7 @@ module Google
169
169
  # Completes the specified prefix with keyword suggestions.
170
170
  #
171
171
  # This feature is only available for users who have Retail Search enabled.
172
- # Please enable Retail Search on Cloud Console before using this feature.
172
+ # Enable Retail Search on Cloud Console before using this feature.
173
173
  #
174
174
  # @overload complete_query(request, options = nil)
175
175
  # Pass arguments to `complete_query` via a request object, either of type
@@ -214,8 +214,10 @@ module Google
214
214
  # Identifying Languages](https://tools.ietf.org/html/bcp47). The maximum
215
215
  # number of language codes is 3.
216
216
  # @param device_type [::String]
217
- # The device type context for completion suggestions.
218
- # It is useful to apply different suggestions on different device types, e.g.
217
+ # The device type context for completion suggestions. We recommend that you
218
+ # leave this field empty.
219
+ #
220
+ # It can apply different suggestions on different device types, e.g.
219
221
  # `DESKTOP`, `MOBILE`. If it is empty, the suggestions are across all device
220
222
  # types.
221
223
  #
@@ -323,7 +325,7 @@ module Google
323
325
  # are indexed successfully and ready for serving. The process takes hours.
324
326
  #
325
327
  # This feature is only available for users who have Retail Search enabled.
326
- # Please enable Retail Search on Cloud Console before using this feature.
328
+ # Enable Retail Search on Cloud Console before using this feature.
327
329
  #
328
330
  # @overload import_completion_data(request, options = nil)
329
331
  # Pass arguments to `import_completion_data` via a request object, either of type
@@ -35,9 +35,9 @@ module Google
35
35
  # Auto-completion service for retail.
36
36
  #
37
37
  # This feature is only available for users who have Retail Search enabled.
38
- # Please enable Retail Search on Cloud Console before using this feature.
38
+ # Enable Retail Search on Cloud Console before using this feature.
39
39
  #
40
- # To load this service and instantiate a client:
40
+ # @example Load this service and instantiate a gRPC client
41
41
  #
42
42
  # require "google/cloud/retail/v2/completion_service"
43
43
  # client = ::Google::Cloud::Retail::V2::CompletionService::Client.new
@@ -27,7 +27,7 @@ module Google
27
27
  # Auto-completion service for retail.
28
28
  #
29
29
  # This feature is only available for users who have Retail Search enabled.
30
- # Please enable Retail Search on Cloud Console before using this feature.
30
+ # Enable Retail Search on Cloud Console before using this feature.
31
31
  class Service
32
32
 
33
33
  include ::GRPC::GenericService
@@ -39,7 +39,7 @@ module Google
39
39
  # Completes the specified prefix with keyword suggestions.
40
40
  #
41
41
  # This feature is only available for users who have Retail Search enabled.
42
- # Please enable Retail Search on Cloud Console before using this feature.
42
+ # Enable Retail Search on Cloud Console before using this feature.
43
43
  rpc :CompleteQuery, ::Google::Cloud::Retail::V2::CompleteQueryRequest, ::Google::Cloud::Retail::V2::CompleteQueryResponse
44
44
  # Bulk import of processed completion dataset.
45
45
  #
@@ -49,7 +49,7 @@ module Google
49
49
  # are indexed successfully and ready for serving. The process takes hours.
50
50
  #
51
51
  # This feature is only available for users who have Retail Search enabled.
52
- # Please enable Retail Search on Cloud Console before using this feature.
52
+ # Enable Retail Search on Cloud Console before using this feature.
53
53
  rpc :ImportCompletionData, ::Google::Cloud::Retail::V2::ImportCompletionDataRequest, ::Google::Longrunning::Operation
54
54
  end
55
55
 
@@ -33,7 +33,7 @@ module Google
33
33
  ##
34
34
  # Service for modifying Control.
35
35
  #
36
- # To load this service and instantiate a client:
36
+ # @example Load this service and instantiate a gRPC client
37
37
  #
38
38
  # require "google/cloud/retail/v2/control_service"
39
39
  # client = ::Google::Cloud::Retail::V2::ControlService::Client.new
@@ -177,7 +177,7 @@ module Google
177
177
  # The ID of the Recommendations AI serving config or placement.
178
178
  # Before you can request predictions from your model, you must create at
179
179
  # least one serving config or placement for it. For more information, see
180
- # [Managing serving configurations]
180
+ # [Manage serving configs]
181
181
  # (https://cloud.google.com/retail/docs/manage-configs).
182
182
  #
183
183
  # The full list of available serving configs can be seen at
@@ -228,12 +228,11 @@ module Google
228
228
  # * filterOutOfStockItems tag=(-"promotional")
229
229
  # * filterOutOfStockItems
230
230
  #
231
- # If your filter blocks all prediction results, the API will return generic
232
- # (unfiltered) popular products. If you only want results strictly matching
233
- # the filters, set `strictFiltering` to True in `PredictRequest.params` to
234
- # receive empty results instead.
235
- # Note that the API will never return items with storageStatus of "EXPIRED"
236
- # or "DELETED" regardless of filter choices.
231
+ # If your filter blocks all prediction results, the API will return *no*
232
+ # results. If instead you want empty result sets to return generic
233
+ # (unfiltered) popular products, set `strictFiltering` to False in
234
+ # `PredictRequest.params`. Note that the API will never return items with
235
+ # storageStatus of "EXPIRED" or "DELETED" regardless of filter choices.
237
236
  #
238
237
  # If `filterSyntaxV2` is set to true under the `params` field, then
239
238
  # attribute-based expressions are expected instead of the above described
@@ -258,7 +257,7 @@ module Google
258
257
  # * `returnScore`: Boolean. If set to true, the prediction 'score'
259
258
  # corresponding to each returned product will be set in the
260
259
  # `results.metadata` field in the prediction response. The given
261
- # 'score' indicates the probability of an product being clicked/purchased
260
+ # 'score' indicates the probability of a product being clicked/purchased
262
261
  # given the user's context and history.
263
262
  # * `strictFiltering`: Boolean. True by default. If set to false, the service
264
263
  # will return generic (unfiltered) popular products instead of empty if
@@ -33,7 +33,7 @@ module Google
33
33
  ##
34
34
  # Service for making recommendation prediction.
35
35
  #
36
- # To load this service and instantiate a client:
36
+ # @example Load this service and instantiate a gRPC client
37
37
  #
38
38
  # require "google/cloud/retail/v2/prediction_service"
39
39
  # client = ::Google::Cloud::Retail::V2::PredictionService::Client.new
@@ -6,6 +6,7 @@ require 'google/protobuf'
6
6
  require 'google/api/annotations_pb'
7
7
  require 'google/api/client_pb'
8
8
  require 'google/api/field_behavior_pb'
9
+ require 'google/api/resource_pb'
9
10
  require 'google/cloud/retail/v2/user_event_pb'
10
11
  require 'google/protobuf/struct_pb'
11
12
 
@@ -880,9 +880,9 @@ module Google
880
880
  #
881
881
  # This process is asynchronous and does not require the
882
882
  # {::Google::Cloud::Retail::V2::Product Product} to exist before updating
883
- # fulfillment information. If the request is valid, the update will be
884
- # enqueued and processed downstream. As a consequence, when a response is
885
- # returned, updates are not immediately manifested in the
883
+ # fulfillment information. If the request is valid, the update is enqueued
884
+ # and processed downstream. As a consequence, when a response is returned,
885
+ # updates are not immediately manifested in the
886
886
  # {::Google::Cloud::Retail::V2::Product Product} queried by
887
887
  # {::Google::Cloud::Retail::V2::ProductService::Client#get_product ProductService.GetProduct}
888
888
  # or
@@ -892,10 +892,10 @@ module Google
892
892
  # {::Google::Cloud::Retail::V2::ProductService::Client#create_product ProductService.CreateProduct}
893
893
  # and
894
894
  # {::Google::Cloud::Retail::V2::ProductService::Client#update_product ProductService.UpdateProduct},
895
- # the specified inventory field value(s) will overwrite any existing value(s)
895
+ # the specified inventory field value(s) overwrite any existing value(s)
896
896
  # while ignoring the last update time for this field. Furthermore, the last
897
- # update time for the specified inventory fields will be overwritten to the
898
- # time of the
897
+ # update times for the specified inventory fields are overwritten by the
898
+ # times of the
899
899
  # {::Google::Cloud::Retail::V2::ProductService::Client#create_product ProductService.CreateProduct}
900
900
  # or
901
901
  # {::Google::Cloud::Retail::V2::ProductService::Client#update_product ProductService.UpdateProduct}
@@ -903,11 +903,11 @@ module Google
903
903
  #
904
904
  # If no inventory fields are set in
905
905
  # {::Google::Cloud::Retail::V2::CreateProductRequest#product CreateProductRequest.product},
906
- # then any pre-existing inventory information for this product will be used.
906
+ # then any pre-existing inventory information for this product is used.
907
907
  #
908
908
  # If no inventory fields are set in
909
909
  # {::Google::Cloud::Retail::V2::SetInventoryRequest#set_mask SetInventoryRequest.set_mask},
910
- # then any existing inventory information will be preserved.
910
+ # then any existing inventory information is preserved.
911
911
  #
912
912
  # Pre-existing inventory information can only be updated with
913
913
  # {::Google::Cloud::Retail::V2::ProductService::Client#set_inventory ProductService.SetInventory},
@@ -915,15 +915,17 @@ module Google
915
915
  # and
916
916
  # {::Google::Cloud::Retail::V2::ProductService::Client#remove_fulfillment_places ProductService.RemoveFulfillmentPlaces}.
917
917
  #
918
- # The returned [Operation][]s will be obsolete after 1 day, and
919
- # [GetOperation][] API will return NOT_FOUND afterwards.
918
+ # The returned {::Google::Longrunning::Operation Operation}s is obsolete after
919
+ # one day, and the GetOperation
920
+ # API returns `NOT_FOUND` afterwards.
920
921
  #
921
- # If conflicting updates are issued, the [Operation][]s associated with the
922
- # stale updates will not be marked as [done][Operation.done] until being
923
- # obsolete.
922
+ # If conflicting updates are issued, the
923
+ # {::Google::Longrunning::Operation Operation}s associated with the stale
924
+ # updates are not marked as {::Google::Longrunning::Operation#done done} until
925
+ # they are obsolete.
924
926
  #
925
927
  # This feature is only available for users who have Retail Search enabled.
926
- # Please enable Retail Search on Cloud Console before using this feature.
928
+ # Enable Retail Search on Cloud Console before using this feature.
927
929
  #
928
930
  # @overload set_inventory(request, options = nil)
929
931
  # Pass arguments to `set_inventory` via a request object, either of type
@@ -1105,15 +1107,17 @@ module Google
1105
1107
  # or
1106
1108
  # {::Google::Cloud::Retail::V2::ProductService::Client#list_products ProductService.ListProducts}.
1107
1109
  #
1108
- # The returned [Operation][]s will be obsolete after 1 day, and
1109
- # [GetOperation][] API will return NOT_FOUND afterwards.
1110
+ # The returned {::Google::Longrunning::Operation Operation}s will be obsolete
1111
+ # after 1 day, and GetOperation
1112
+ # API will return NOT_FOUND afterwards.
1110
1113
  #
1111
- # If conflicting updates are issued, the [Operation][]s associated with the
1112
- # stale updates will not be marked as [done][Operation.done] until being
1113
- # obsolete.
1114
+ # If conflicting updates are issued, the
1115
+ # {::Google::Longrunning::Operation Operation}s associated with the stale
1116
+ # updates will not be marked as {::Google::Longrunning::Operation#done done}
1117
+ # until being obsolete.
1114
1118
  #
1115
1119
  # This feature is only available for users who have Retail Search enabled.
1116
- # Please enable Retail Search on Cloud Console before using this feature.
1120
+ # Enable Retail Search on Cloud Console before using this feature.
1117
1121
  #
1118
1122
  # @overload add_fulfillment_places(request, options = nil)
1119
1123
  # Pass arguments to `add_fulfillment_places` via a request object, either of type
@@ -1273,15 +1277,17 @@ module Google
1273
1277
  # or
1274
1278
  # {::Google::Cloud::Retail::V2::ProductService::Client#list_products ProductService.ListProducts}.
1275
1279
  #
1276
- # The returned [Operation][]s will be obsolete after 1 day, and
1277
- # [GetOperation][] API will return NOT_FOUND afterwards.
1280
+ # The returned {::Google::Longrunning::Operation Operation}s will be obsolete
1281
+ # after 1 day, and GetOperation
1282
+ # API will return NOT_FOUND afterwards.
1278
1283
  #
1279
- # If conflicting updates are issued, the [Operation][]s associated with the
1280
- # stale updates will not be marked as [done][Operation.done] until being
1281
- # obsolete.
1284
+ # If conflicting updates are issued, the
1285
+ # {::Google::Longrunning::Operation Operation}s associated with the stale
1286
+ # updates will not be marked as {::Google::Longrunning::Operation#done done}
1287
+ # until being obsolete.
1282
1288
  #
1283
1289
  # This feature is only available for users who have Retail Search enabled.
1284
- # Please enable Retail Search on Cloud Console before using this feature.
1290
+ # Enable Retail Search on Cloud Console before using this feature.
1285
1291
  #
1286
1292
  # @overload remove_fulfillment_places(request, options = nil)
1287
1293
  # Pass arguments to `remove_fulfillment_places` via a request object, either of type
@@ -1443,15 +1449,17 @@ module Google
1443
1449
  # {::Google::Cloud::Retail::V2::ProductService::Client#update_product ProductService.UpdateProduct}
1444
1450
  # has no effect on local inventories.
1445
1451
  #
1446
- # The returned [Operation][]s will be obsolete after 1 day, and
1447
- # [GetOperation][] API will return NOT_FOUND afterwards.
1452
+ # The returned {::Google::Longrunning::Operation Operation}s will be obsolete
1453
+ # after 1 day, and GetOperation
1454
+ # API will return NOT_FOUND afterwards.
1448
1455
  #
1449
- # If conflicting updates are issued, the [Operation][]s associated with the
1450
- # stale updates will not be marked as [done][Operation.done] until being
1451
- # obsolete.
1456
+ # If conflicting updates are issued, the
1457
+ # {::Google::Longrunning::Operation Operation}s associated with the stale
1458
+ # updates will not be marked as {::Google::Longrunning::Operation#done done}
1459
+ # until being obsolete.
1452
1460
  #
1453
1461
  # This feature is only available for users who have Retail Search enabled.
1454
- # Please enable Retail Search on Cloud Console before using this feature.
1462
+ # Enable Retail Search on Cloud Console before using this feature.
1455
1463
  #
1456
1464
  # @overload add_local_inventories(request, options = nil)
1457
1465
  # Pass arguments to `add_local_inventories` via a request object, either of type
@@ -1598,15 +1606,17 @@ module Google
1598
1606
  # {::Google::Cloud::Retail::V2::ProductService::Client#update_product ProductService.UpdateProduct}
1599
1607
  # has no effect on local inventories.
1600
1608
  #
1601
- # The returned [Operation][]s will be obsolete after 1 day, and
1602
- # [GetOperation][] API will return NOT_FOUND afterwards.
1609
+ # The returned {::Google::Longrunning::Operation Operation}s will be obsolete
1610
+ # after 1 day, and GetOperation
1611
+ # API will return NOT_FOUND afterwards.
1603
1612
  #
1604
- # If conflicting updates are issued, the [Operation][]s associated with the
1605
- # stale updates will not be marked as [done][Operation.done] until being
1606
- # obsolete.
1613
+ # If conflicting updates are issued, the
1614
+ # {::Google::Longrunning::Operation Operation}s associated with the stale
1615
+ # updates will not be marked as {::Google::Longrunning::Operation#done done}
1616
+ # until being obsolete.
1607
1617
  #
1608
1618
  # This feature is only available for users who have Retail Search enabled.
1609
- # Please enable Retail Search on Cloud Console before using this feature.
1619
+ # Enable Retail Search on Cloud Console before using this feature.
1610
1620
  #
1611
1621
  # @overload remove_local_inventories(request, options = nil)
1612
1622
  # Pass arguments to `remove_local_inventories` via a request object, either of type
@@ -35,7 +35,7 @@ module Google
35
35
  # Service for ingesting {::Google::Cloud::Retail::V2::Product Product} information
36
36
  # of the customer's website.
37
37
  #
38
- # To load this service and instantiate a client:
38
+ # @example Load this service and instantiate a gRPC client
39
39
  #
40
40
  # require "google/cloud/retail/v2/product_service"
41
41
  # client = ::Google::Cloud::Retail::V2::ProductService::Client.new
@@ -58,9 +58,9 @@ module Google
58
58
  #
59
59
  # This process is asynchronous and does not require the
60
60
  # [Product][google.cloud.retail.v2.Product] to exist before updating
61
- # fulfillment information. If the request is valid, the update will be
62
- # enqueued and processed downstream. As a consequence, when a response is
63
- # returned, updates are not immediately manifested in the
61
+ # fulfillment information. If the request is valid, the update is enqueued
62
+ # and processed downstream. As a consequence, when a response is returned,
63
+ # updates are not immediately manifested in the
64
64
  # [Product][google.cloud.retail.v2.Product] queried by
65
65
  # [ProductService.GetProduct][google.cloud.retail.v2.ProductService.GetProduct]
66
66
  # or
@@ -70,10 +70,10 @@ module Google
70
70
  # [ProductService.CreateProduct][google.cloud.retail.v2.ProductService.CreateProduct]
71
71
  # and
72
72
  # [ProductService.UpdateProduct][google.cloud.retail.v2.ProductService.UpdateProduct],
73
- # the specified inventory field value(s) will overwrite any existing value(s)
73
+ # the specified inventory field value(s) overwrite any existing value(s)
74
74
  # while ignoring the last update time for this field. Furthermore, the last
75
- # update time for the specified inventory fields will be overwritten to the
76
- # time of the
75
+ # update times for the specified inventory fields are overwritten by the
76
+ # times of the
77
77
  # [ProductService.CreateProduct][google.cloud.retail.v2.ProductService.CreateProduct]
78
78
  # or
79
79
  # [ProductService.UpdateProduct][google.cloud.retail.v2.ProductService.UpdateProduct]
@@ -81,11 +81,11 @@ module Google
81
81
  #
82
82
  # If no inventory fields are set in
83
83
  # [CreateProductRequest.product][google.cloud.retail.v2.CreateProductRequest.product],
84
- # then any pre-existing inventory information for this product will be used.
84
+ # then any pre-existing inventory information for this product is used.
85
85
  #
86
86
  # If no inventory fields are set in
87
87
  # [SetInventoryRequest.set_mask][google.cloud.retail.v2.SetInventoryRequest.set_mask],
88
- # then any existing inventory information will be preserved.
88
+ # then any existing inventory information is preserved.
89
89
  #
90
90
  # Pre-existing inventory information can only be updated with
91
91
  # [ProductService.SetInventory][google.cloud.retail.v2.ProductService.SetInventory],
@@ -93,15 +93,17 @@ module Google
93
93
  # and
94
94
  # [ProductService.RemoveFulfillmentPlaces][google.cloud.retail.v2.ProductService.RemoveFulfillmentPlaces].
95
95
  #
96
- # The returned [Operation][]s will be obsolete after 1 day, and
97
- # [GetOperation][] API will return NOT_FOUND afterwards.
96
+ # The returned [Operation][google.longrunning.Operation]s is obsolete after
97
+ # one day, and the [GetOperation][google.longrunning.Operations.GetOperation]
98
+ # API returns `NOT_FOUND` afterwards.
98
99
  #
99
- # If conflicting updates are issued, the [Operation][]s associated with the
100
- # stale updates will not be marked as [done][Operation.done] until being
101
- # obsolete.
100
+ # If conflicting updates are issued, the
101
+ # [Operation][google.longrunning.Operation]s associated with the stale
102
+ # updates are not marked as [done][google.longrunning.Operation.done] until
103
+ # they are obsolete.
102
104
  #
103
105
  # This feature is only available for users who have Retail Search enabled.
104
- # Please enable Retail Search on Cloud Console before using this feature.
106
+ # Enable Retail Search on Cloud Console before using this feature.
105
107
  rpc :SetInventory, ::Google::Cloud::Retail::V2::SetInventoryRequest, ::Google::Longrunning::Operation
106
108
  # Incrementally adds place IDs to
107
109
  # [Product.fulfillment_info.place_ids][google.cloud.retail.v2.FulfillmentInfo.place_ids].
@@ -116,15 +118,17 @@ module Google
116
118
  # or
117
119
  # [ProductService.ListProducts][google.cloud.retail.v2.ProductService.ListProducts].
118
120
  #
119
- # The returned [Operation][]s will be obsolete after 1 day, and
120
- # [GetOperation][] API will return NOT_FOUND afterwards.
121
+ # The returned [Operation][google.longrunning.Operation]s will be obsolete
122
+ # after 1 day, and [GetOperation][google.longrunning.Operations.GetOperation]
123
+ # API will return NOT_FOUND afterwards.
121
124
  #
122
- # If conflicting updates are issued, the [Operation][]s associated with the
123
- # stale updates will not be marked as [done][Operation.done] until being
124
- # obsolete.
125
+ # If conflicting updates are issued, the
126
+ # [Operation][google.longrunning.Operation]s associated with the stale
127
+ # updates will not be marked as [done][google.longrunning.Operation.done]
128
+ # until being obsolete.
125
129
  #
126
130
  # This feature is only available for users who have Retail Search enabled.
127
- # Please enable Retail Search on Cloud Console before using this feature.
131
+ # Enable Retail Search on Cloud Console before using this feature.
128
132
  rpc :AddFulfillmentPlaces, ::Google::Cloud::Retail::V2::AddFulfillmentPlacesRequest, ::Google::Longrunning::Operation
129
133
  # Incrementally removes place IDs from a
130
134
  # [Product.fulfillment_info.place_ids][google.cloud.retail.v2.FulfillmentInfo.place_ids].
@@ -139,15 +143,17 @@ module Google
139
143
  # or
140
144
  # [ProductService.ListProducts][google.cloud.retail.v2.ProductService.ListProducts].
141
145
  #
142
- # The returned [Operation][]s will be obsolete after 1 day, and
143
- # [GetOperation][] API will return NOT_FOUND afterwards.
146
+ # The returned [Operation][google.longrunning.Operation]s will be obsolete
147
+ # after 1 day, and [GetOperation][google.longrunning.Operations.GetOperation]
148
+ # API will return NOT_FOUND afterwards.
144
149
  #
145
- # If conflicting updates are issued, the [Operation][]s associated with the
146
- # stale updates will not be marked as [done][Operation.done] until being
147
- # obsolete.
150
+ # If conflicting updates are issued, the
151
+ # [Operation][google.longrunning.Operation]s associated with the stale
152
+ # updates will not be marked as [done][google.longrunning.Operation.done]
153
+ # until being obsolete.
148
154
  #
149
155
  # This feature is only available for users who have Retail Search enabled.
150
- # Please enable Retail Search on Cloud Console before using this feature.
156
+ # Enable Retail Search on Cloud Console before using this feature.
151
157
  rpc :RemoveFulfillmentPlaces, ::Google::Cloud::Retail::V2::RemoveFulfillmentPlacesRequest, ::Google::Longrunning::Operation
152
158
  # Updates local inventory information for a
153
159
  # [Product][google.cloud.retail.v2.Product] at a list of places, while
@@ -169,15 +175,17 @@ module Google
169
175
  # [ProductService.UpdateProduct][google.cloud.retail.v2.ProductService.UpdateProduct]
170
176
  # has no effect on local inventories.
171
177
  #
172
- # The returned [Operation][]s will be obsolete after 1 day, and
173
- # [GetOperation][] API will return NOT_FOUND afterwards.
178
+ # The returned [Operation][google.longrunning.Operation]s will be obsolete
179
+ # after 1 day, and [GetOperation][google.longrunning.Operations.GetOperation]
180
+ # API will return NOT_FOUND afterwards.
174
181
  #
175
- # If conflicting updates are issued, the [Operation][]s associated with the
176
- # stale updates will not be marked as [done][Operation.done] until being
177
- # obsolete.
182
+ # If conflicting updates are issued, the
183
+ # [Operation][google.longrunning.Operation]s associated with the stale
184
+ # updates will not be marked as [done][google.longrunning.Operation.done]
185
+ # until being obsolete.
178
186
  #
179
187
  # This feature is only available for users who have Retail Search enabled.
180
- # Please enable Retail Search on Cloud Console before using this feature.
188
+ # Enable Retail Search on Cloud Console before using this feature.
181
189
  rpc :AddLocalInventories, ::Google::Cloud::Retail::V2::AddLocalInventoriesRequest, ::Google::Longrunning::Operation
182
190
  # Remove local inventory information for a
183
191
  # [Product][google.cloud.retail.v2.Product] at a list of places at a removal
@@ -197,15 +205,17 @@ module Google
197
205
  # [ProductService.UpdateProduct][google.cloud.retail.v2.ProductService.UpdateProduct]
198
206
  # has no effect on local inventories.
199
207
  #
200
- # The returned [Operation][]s will be obsolete after 1 day, and
201
- # [GetOperation][] API will return NOT_FOUND afterwards.
208
+ # The returned [Operation][google.longrunning.Operation]s will be obsolete
209
+ # after 1 day, and [GetOperation][google.longrunning.Operations.GetOperation]
210
+ # API will return NOT_FOUND afterwards.
202
211
  #
203
- # If conflicting updates are issued, the [Operation][]s associated with the
204
- # stale updates will not be marked as [done][Operation.done] until being
205
- # obsolete.
212
+ # If conflicting updates are issued, the
213
+ # [Operation][google.longrunning.Operation]s associated with the stale
214
+ # updates will not be marked as [done][google.longrunning.Operation.done]
215
+ # until being obsolete.
206
216
  #
207
217
  # This feature is only available for users who have Retail Search enabled.
208
- # Please enable Retail Search on Cloud Console before using this feature.
218
+ # Enable Retail Search on Cloud Console before using this feature.
209
219
  rpc :RemoveLocalInventories, ::Google::Cloud::Retail::V2::RemoveLocalInventoriesRequest, ::Google::Longrunning::Operation
210
220
  end
211
221
 
@@ -30,7 +30,7 @@ module Google
30
30
  # Service for search.
31
31
  #
32
32
  # This feature is only available for users who have Retail Search enabled.
33
- # Please enable Retail Search on Cloud Console before using this feature.
33
+ # Enable Retail Search on Cloud Console before using this feature.
34
34
  #
35
35
  class Client
36
36
  include Paths
@@ -156,7 +156,7 @@ module Google
156
156
  # Performs a search.
157
157
  #
158
158
  # This feature is only available for users who have Retail Search enabled.
159
- # Please enable Retail Search on Cloud Console before using this feature.
159
+ # Enable Retail Search on Cloud Console before using this feature.
160
160
  #
161
161
  # @overload search(request, options = nil)
162
162
  # Pass arguments to `search` via a request object, either of type
@@ -178,7 +178,7 @@ module Google
178
178
  # `projects/*/locations/global/catalogs/default_catalog/servingConfigs/default_serving_config`
179
179
  # or the name of the legacy placement resource, such as
180
180
  # `projects/*/locations/global/catalogs/default_catalog/placements/default_search`.
181
- # This field is used to identify the serving configuration name and the set
181
+ # This field is used to identify the serving config name and the set
182
182
  # of models that will be used to make the search.
183
183
  # @param branch [::String]
184
184
  # The branch resource name, such as
@@ -363,7 +363,7 @@ module Google
363
363
  # {::Google::Cloud::Retail::V2::UserEvent#page_categories UserEvent.page_categories};
364
364
  #
365
365
  # To represent full path of category, use '>' sign to separate different
366
- # hierarchies. If '>' is part of the category name, please replace it with
366
+ # hierarchies. If '>' is part of the category name, replace it with
367
367
  # other character(s).
368
368
  #
369
369
  # Category pages include special pages such as sales or promotions. For
@@ -34,9 +34,9 @@ module Google
34
34
  # Service for search.
35
35
  #
36
36
  # This feature is only available for users who have Retail Search enabled.
37
- # Please enable Retail Search on Cloud Console before using this feature.
37
+ # Enable Retail Search on Cloud Console before using this feature.
38
38
  #
39
- # To load this service and instantiate a client:
39
+ # @example Load this service and instantiate a gRPC client
40
40
  #
41
41
  # require "google/cloud/retail/v2/search_service"
42
42
  # client = ::Google::Cloud::Retail::V2::SearchService::Client.new