google-cloud-retail-v2 0.5.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 422025455c4fa8d251bfa6ce1ac4a943b1888ecc0efdbaf16803ea3545926a52
-  data.tar.gz: dfc946b2a39132d32a90da0defa43aab97f8e24009573e405e6e691ca2ab3a36
+  metadata.gz: e3c54ec4291ffd18e3937aded888310475087affcd33884b0c861915dc5ebcc6
+  data.tar.gz: cf991b3ef78d6a416ef9ee8c73484eccc232423727c4432ed921ff17ea5785a1
 SHA512:
-  metadata.gz: 82cb4d8e176954b73e53e73fd89ca45ef04655fa7e1fd57b2d1abf2e4801b22f937bd36d2fbd717d0db76477c25c6ada69c6e923d72ca384625194f07274a330
-  data.tar.gz: bfce46bb79939b1de5189510ff0230eedced58551f49de189104f2e47949965ce4c24d59df170bb85e4fdaf10921997682afada6412074f09ebce6d8388d905a
+  metadata.gz: c91db3290823a29c95972da1f7dfbc08c9af44d5c1e538044a11d1087b5a319b6b5ed7dce3759000dc6d928e43549e9057ee3cade11c9c5760ccaa070c99147b
+  data.tar.gz: e81be02bca288b3cb0763c4a6497ad55bedfcf427f057f6e4a83694281df9a15d6140b1439463de41e64a1a8e0310dd768fd299f985a7031c882a43ad55afdd1

data/lib/google/cloud/retail/v2/catalog_pb.rb

@@ -1,13 +1,13 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/cloud/retail/v2/catalog.proto
 
-require 'google/protobuf'
-
 require 'google/api/annotations_pb'
 require 'google/api/field_behavior_pb'
 require 'google/api/resource_pb'
 require 'google/cloud/retail/v2/common_pb'
 require 'google/cloud/retail/v2/import_config_pb'
+require 'google/protobuf'
+
 Google::Protobuf::DescriptorPool.generated_pool.build do
   add_file("google/cloud/retail/v2/catalog.proto", :syntax => :proto3) do
     add_message "google.cloud.retail.v2.ProductLevelConfig" do

data/lib/google/cloud/retail/v2/catalog_service_pb.rb

@@ -1,8 +1,6 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/cloud/retail/v2/catalog_service.proto
 
-require 'google/protobuf'
-
 require 'google/api/annotations_pb'
 require 'google/api/client_pb'
 require 'google/api/field_behavior_pb'
@@ -11,6 +9,8 @@ require 'google/cloud/retail/v2/catalog_pb'
 require 'google/protobuf/empty_pb'
 require 'google/protobuf/field_mask_pb'
 require 'google/protobuf/timestamp_pb'
+require 'google/protobuf'
+
 Google::Protobuf::DescriptorPool.generated_pool.build do
   add_file("google/cloud/retail/v2/catalog_service.proto", :syntax => :proto3) do
     add_message "google.cloud.retail.v2.ListCatalogsRequest" do

data/lib/google/cloud/retail/v2/catalog_service_services_pb.rb

@@ -27,7 +27,7 @@ module Google
           # Service for managing catalog configuration.
           class Service
 
-            include GRPC::GenericService
+            include ::GRPC::GenericService
 
             self.marshal_class_method = :encode
             self.unmarshal_class_method = :decode

data/lib/google/cloud/retail/v2/common_pb.rb

@@ -1,11 +1,11 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/cloud/retail/v2/common.proto
 
-require 'google/protobuf'
-
 require 'google/api/annotations_pb'
 require 'google/api/field_behavior_pb'
 require 'google/protobuf/timestamp_pb'
+require 'google/protobuf'
+
 Google::Protobuf::DescriptorPool.generated_pool.build do
   add_file("google/cloud/retail/v2/common.proto", :syntax => :proto3) do
     add_message "google.cloud.retail.v2.Audience" do

data/lib/google/cloud/retail/v2/completion_service_pb.rb

@@ -1,8 +1,6 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/cloud/retail/v2/completion_service.proto
 
-require 'google/protobuf'
-
 require 'google/api/annotations_pb'
 require 'google/api/client_pb'
 require 'google/api/field_behavior_pb'
@@ -10,6 +8,8 @@ require 'google/api/resource_pb'
 require 'google/cloud/retail/v2/common_pb'
 require 'google/cloud/retail/v2/import_config_pb'
 require 'google/longrunning/operations_pb'
+require 'google/protobuf'
+
 Google::Protobuf::DescriptorPool.generated_pool.build do
   add_file("google/cloud/retail/v2/completion_service.proto", :syntax => :proto3) do
     add_message "google.cloud.retail.v2.CompleteQueryRequest" do

data/lib/google/cloud/retail/v2/completion_service_services_pb.rb

@@ -31,7 +31,7 @@ module Google
           # cloud sales if you are interested in using Retail Search.
           class Service
 
-            include GRPC::GenericService
+            include ::GRPC::GenericService
 
             self.marshal_class_method = :encode
             self.unmarshal_class_method = :decode

data/lib/google/cloud/retail/v2/import_config_pb.rb

@@ -1,8 +1,6 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/cloud/retail/v2/import_config.proto
 
-require 'google/protobuf'
-
 require 'google/api/annotations_pb'
 require 'google/api/field_behavior_pb'
 require 'google/api/resource_pb'
@@ -12,6 +10,8 @@ require 'google/protobuf/field_mask_pb'
 require 'google/protobuf/timestamp_pb'
 require 'google/rpc/status_pb'
 require 'google/type/date_pb'
+require 'google/protobuf'
+
 Google::Protobuf::DescriptorPool.generated_pool.build do
   add_file("google/cloud/retail/v2/import_config.proto", :syntax => :proto3) do
     add_message "google.cloud.retail.v2.GcsSource" do

data/lib/google/cloud/retail/v2/prediction_service_pb.rb

@@ -1,13 +1,13 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/cloud/retail/v2/prediction_service.proto
 
-require 'google/protobuf'
-
 require 'google/api/annotations_pb'
 require 'google/api/client_pb'
 require 'google/api/field_behavior_pb'
 require 'google/cloud/retail/v2/user_event_pb'
 require 'google/protobuf/struct_pb'
+require 'google/protobuf'
+
 Google::Protobuf::DescriptorPool.generated_pool.build do
   add_file("google/cloud/retail/v2/prediction_service.proto", :syntax => :proto3) do
     add_message "google.cloud.retail.v2.PredictRequest" do

data/lib/google/cloud/retail/v2/prediction_service_services_pb.rb

@@ -27,7 +27,7 @@ module Google
           # Service for making recommendation prediction.
           class Service
 
-            include GRPC::GenericService
+            include ::GRPC::GenericService
 
             self.marshal_class_method = :encode
             self.unmarshal_class_method = :decode

data/lib/google/cloud/retail/v2/product_pb.rb

@@ -1,8 +1,6 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/cloud/retail/v2/product.proto
 
-require 'google/protobuf'
-
 require 'google/api/annotations_pb'
 require 'google/api/field_behavior_pb'
 require 'google/api/resource_pb'
@@ -11,6 +9,8 @@ require 'google/protobuf/duration_pb'
 require 'google/protobuf/field_mask_pb'
 require 'google/protobuf/timestamp_pb'
 require 'google/protobuf/wrappers_pb'
+require 'google/protobuf'
+
 Google::Protobuf::DescriptorPool.generated_pool.build do
   add_file("google/cloud/retail/v2/product.proto", :syntax => :proto3) do
     add_message "google.cloud.retail.v2.Product" do

data/lib/google/cloud/retail/v2/product_service/client.rb

@@ -867,7 +867,7 @@ module Google
             #     {::Google::Cloud::Retail::V2::Product#name Product.name} is not found, the
             #     inventory update will still be processed and retained for at most 1 day
             #     until the {::Google::Cloud::Retail::V2::Product Product} is created. If set to
-            #     false, an INVALID_ARGUMENT error is returned if the
+            #     false, a NOT_FOUND error is returned if the
             #     {::Google::Cloud::Retail::V2::Product Product} is not found.
             #
             # @yield [response, operation] Access the result along with the RPC operation
@@ -1002,8 +1002,8 @@ module Google
             #     If set to true, and the {::Google::Cloud::Retail::V2::Product Product} is not
             #     found, the fulfillment information will still be processed and retained for
             #     at most 1 day and processed once the
-            #     {::Google::Cloud::Retail::V2::Product Product} is created. If set to false, an
-            #     INVALID_ARGUMENT error is returned if the
+            #     {::Google::Cloud::Retail::V2::Product Product} is created. If set to false, a
+            #     NOT_FOUND error is returned if the
             #     {::Google::Cloud::Retail::V2::Product Product} is not found.
             #
             # @yield [response, operation] Access the result along with the RPC operation
@@ -1133,8 +1133,8 @@ module Google
             #     If set to true, and the {::Google::Cloud::Retail::V2::Product Product} is not
             #     found, the fulfillment information will still be processed and retained for
             #     at most 1 day and processed once the
-            #     {::Google::Cloud::Retail::V2::Product Product} is created. If set to false, an
-            #     INVALID_ARGUMENT error is returned if the
+            #     {::Google::Cloud::Retail::V2::Product Product} is created. If set to false, a
+            #     NOT_FOUND error is returned if the
             #     {::Google::Cloud::Retail::V2::Product Product} is not found.
             #
             # @yield [response, operation] Access the result along with the RPC operation

data/lib/google/cloud/retail/v2/product_service_pb.rb

@@ -1,12 +1,11 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/cloud/retail/v2/product_service.proto
 
-require 'google/protobuf'
-
 require 'google/api/annotations_pb'
 require 'google/api/client_pb'
 require 'google/api/field_behavior_pb'
 require 'google/api/resource_pb'
+require 'google/cloud/retail/v2/common_pb'
 require 'google/cloud/retail/v2/import_config_pb'
 require 'google/cloud/retail/v2/product_pb'
 require 'google/cloud/retail/v2/purge_config_pb'
@@ -14,6 +13,8 @@ require 'google/longrunning/operations_pb'
 require 'google/protobuf/empty_pb'
 require 'google/protobuf/field_mask_pb'
 require 'google/protobuf/timestamp_pb'
+require 'google/protobuf'
+
 Google::Protobuf::DescriptorPool.generated_pool.build do
   add_file("google/cloud/retail/v2/product_service.proto", :syntax => :proto3) do
     add_message "google.cloud.retail.v2.CreateProductRequest" do

data/lib/google/cloud/retail/v2/product_service_services_pb.rb

@@ -28,7 +28,7 @@ module Google
           # of the customer's website.
           class Service
 
-            include GRPC::GenericService
+            include ::GRPC::GenericService
 
             self.marshal_class_method = :encode
             self.unmarshal_class_method = :decode

data/lib/google/cloud/retail/v2/purge_config_pb.rb

@@ -1,10 +1,10 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/cloud/retail/v2/purge_config.proto
 
-require 'google/protobuf'
-
 require 'google/api/annotations_pb'
 require 'google/api/field_behavior_pb'
+require 'google/protobuf'
+
 Google::Protobuf::DescriptorPool.generated_pool.build do
   add_file("google/cloud/retail/v2/purge_config.proto", :syntax => :proto3) do
     add_message "google.cloud.retail.v2.PurgeMetadata" do

data/lib/google/cloud/retail/v2/search_service/client.rb

@@ -170,7 +170,7 @@ module Google
             #   @param options [::Gapic::CallOptions, ::Hash]
             #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
             #
-            # @overload search(placement: nil, branch: nil, query: nil, visitor_id: nil, user_info: nil, page_size: nil, page_token: nil, offset: nil, filter: nil, canonical_filter: nil, order_by: nil, facet_specs: nil, dynamic_facet_spec: nil, boost_spec: nil, query_expansion_spec: nil, variant_rollup_keys: nil, page_categories: nil)
+            # @overload search(placement: nil, branch: nil, query: nil, visitor_id: nil, user_info: nil, page_size: nil, page_token: nil, offset: nil, filter: nil, canonical_filter: nil, order_by: nil, facet_specs: nil, dynamic_facet_spec: nil, boost_spec: nil, query_expansion_spec: nil, variant_rollup_keys: nil, page_categories: nil, search_mode: nil)
             #   Pass arguments to `search` via keyword arguments. Note that at
             #   least one keyword argument is required. To specify no parameters, or to keep all
             #   the default parameter values, pass an empty Hash as a request object (see above).
@@ -178,12 +178,8 @@ module Google
             #   @param placement [::String]
             #     Required. The resource name of the search engine placement, such as
             #     `projects/*/locations/global/catalogs/default_catalog/placements/default_search`.
-            #     This field is used to identify the set of models that will be used to make
-            #     the search.
-            #
-            #     We currently support one placement with the following ID:
-            #
-            #     * `default_search`.
+            #     This field is used to identify the serving configuration name and the set
+            #     of models that will be used to make the search.
             #   @param branch [::String]
             #     The branch resource name, such as
             #     `projects/*/locations/global/catalogs/default_catalog/branches/0`.
@@ -230,7 +226,8 @@ module Google
             #   @param filter [::String]
             #     The filter syntax consists of an expression language for constructing a
             #     predicate from one or more fields of the products being filtered. Filter
-            #     expression is case-sensitive.
+            #     expression is case-sensitive. See more details at this [user
+            #     guide](https://cloud.google.com/retail/docs/filter-and-order#filter).
             #
             #     If this field is unrecognizable, an INVALID_ARGUMENT is returned.
             #   @param canonical_filter [::String]
@@ -246,7 +243,9 @@ module Google
             #   @param order_by [::String]
             #     The order in which products are returned. Products can be ordered by
             #     a field in an {::Google::Cloud::Retail::V2::Product Product} object. Leave it
-            #     unset if ordered by relevance. OrderBy expression is case-sensitive.
+            #     unset if ordered by relevance. OrderBy expression is case-sensitive. See
+            #     more details at this [user
+            #     guide](https://cloud.google.com/retail/docs/filter-and-order#order).
             #
             #     If this field is unrecognizable, an INVALID_ARGUMENT is returned.
             #   @param facet_specs [::Array<::Google::Cloud::Retail::V2::SearchRequest::FacetSpec, ::Hash>]
@@ -261,10 +260,18 @@ module Google
             #     This feature requires additional allowlisting. Contact Retail Search
             #     support team if you are interested in using dynamic facet feature.
             #   @param boost_spec [::Google::Cloud::Retail::V2::SearchRequest::BoostSpec, ::Hash]
-            #     Boost specification to boost certain products.
+            #     Boost specification to boost certain products. See more details at this
+            #     [user guide](https://cloud.google.com/retail/docs/boosting).
+            #
+            #     Notice that if both [ServingConfig.boost_control_ids][] and
+            #     [SearchRequest.boost_spec] are set, the boost conditions from both places
+            #     are evaluated. If a search request matches multiple boost conditions,
+            #     the final boost score is equal to the sum of the boost scores from all
+            #     matched boost conditions.
             #   @param query_expansion_spec [::Google::Cloud::Retail::V2::SearchRequest::QueryExpansionSpec, ::Hash]
             #     The query expansion specification that specifies the conditions under which
-            #     query expansion will occur.
+            #     query expansion will occur. See more details at this [user
+            #     guide](https://cloud.google.com/retail/docs/result-size#query_expansion).
             #   @param variant_rollup_keys [::Array<::String>]
             #     The keys to fetch and rollup the matching
             #     {::Google::Cloud::Retail::V2::Product::Type::VARIANT variant}
@@ -286,6 +293,7 @@ module Google
             #     * price
             #     * originalPrice
             #     * discount
+            #     * inventory(place_id,price)
             #     * attributes.key, where key is any key in the
             #       {::Google::Cloud::Retail::V2::Product#attributes Product.attributes} map.
             #     * pickupInStore.id, where id is any
@@ -340,6 +348,9 @@ module Google
             #     Category pages include special pages such as sales or promotions. For
             #     instance, a special sale page may have the category hierarchy:
             #     "pageCategories" : ["Sales > 2017 Black Friday Deals"].
+            #   @param search_mode [::Google::Cloud::Retail::V2::SearchRequest::SearchMode]
+            #     The search mode of the search request. If not specified, a single search
+            #     request triggers both product search and faceted search.
             #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::Retail::V2::SearchResponse::SearchResult>]

data/lib/google/cloud/retail/v2/search_service_pb.rb

@@ -1,8 +1,6 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/cloud/retail/v2/search_service.proto
 
-require 'google/protobuf'
-
 require 'google/api/annotations_pb'
 require 'google/api/client_pb'
 require 'google/api/field_behavior_pb'
@@ -13,6 +11,8 @@ require 'google/protobuf/field_mask_pb'
 require 'google/protobuf/struct_pb'
 require 'google/protobuf/timestamp_pb'
 require 'google/protobuf/wrappers_pb'
+require 'google/protobuf'
+
 Google::Protobuf::DescriptorPool.generated_pool.build do
   add_file("google/cloud/retail/v2/search_service.proto", :syntax => :proto3) do
     add_message "google.cloud.retail.v2.SearchRequest" do
@@ -33,6 +33,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       optional :query_expansion_spec, :message, 14, "google.cloud.retail.v2.SearchRequest.QueryExpansionSpec"
       repeated :variant_rollup_keys, :string, 17
       repeated :page_categories, :string, 23
+      optional :search_mode, :enum, 31, "google.cloud.retail.v2.SearchRequest.SearchMode"
     end
     add_message "google.cloud.retail.v2.SearchRequest.FacetSpec" do
       optional :facet_key, :message, 1, "google.cloud.retail.v2.SearchRequest.FacetSpec.FacetKey"
@@ -73,6 +74,11 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       value :DISABLED, 1
       value :AUTO, 3
     end
+    add_enum "google.cloud.retail.v2.SearchRequest.SearchMode" do
+      value :SEARCH_MODE_UNSPECIFIED, 0
+      value :PRODUCT_SEARCH_ONLY, 1
+      value :FACETED_SEARCH_ONLY, 2
+    end
     add_message "google.cloud.retail.v2.SearchResponse" do
       repeated :results, :message, 1, "google.cloud.retail.v2.SearchResponse.SearchResult"
       repeated :facets, :message, 2, "google.cloud.retail.v2.SearchResponse.Facet"
@@ -122,6 +128,7 @@ module Google
         SearchRequest::BoostSpec::ConditionBoostSpec = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.SearchRequest.BoostSpec.ConditionBoostSpec").msgclass
         SearchRequest::QueryExpansionSpec = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.SearchRequest.QueryExpansionSpec").msgclass
         SearchRequest::QueryExpansionSpec::Condition = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.SearchRequest.QueryExpansionSpec.Condition").enummodule
+        SearchRequest::SearchMode = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.SearchRequest.SearchMode").enummodule
         SearchResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.SearchResponse").msgclass
         SearchResponse::SearchResult = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.SearchResponse.SearchResult").msgclass
         SearchResponse::Facet = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.SearchResponse.Facet").msgclass

data/lib/google/cloud/retail/v2/search_service_services_pb.rb

@@ -31,7 +31,7 @@ module Google
           # cloud sales if you are interested in using Retail Search.
           class Service
 
-            include GRPC::GenericService
+            include ::GRPC::GenericService
 
             self.marshal_class_method = :encode
             self.unmarshal_class_method = :decode

data/lib/google/cloud/retail/v2/user_event_pb.rb

@@ -1,14 +1,14 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/cloud/retail/v2/user_event.proto
 
-require 'google/protobuf'
-
 require 'google/api/annotations_pb'
 require 'google/api/field_behavior_pb'
 require 'google/cloud/retail/v2/common_pb'
 require 'google/cloud/retail/v2/product_pb'
 require 'google/protobuf/timestamp_pb'
 require 'google/protobuf/wrappers_pb'
+require 'google/protobuf'
+
 Google::Protobuf::DescriptorPool.generated_pool.build do
   add_file("google/cloud/retail/v2/user_event.proto", :syntax => :proto3) do
     add_message "google.cloud.retail.v2.UserEvent" do

data/lib/google/cloud/retail/v2/user_event_service_pb.rb

@@ -1,8 +1,6 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/cloud/retail/v2/user_event_service.proto
 
-require 'google/protobuf'
-
 require 'google/api/annotations_pb'
 require 'google/api/client_pb'
 require 'google/api/field_behavior_pb'
@@ -11,6 +9,8 @@ require 'google/cloud/retail/v2/import_config_pb'
 require 'google/cloud/retail/v2/purge_config_pb'
 require 'google/cloud/retail/v2/user_event_pb'
 require 'google/longrunning/operations_pb'
+require 'google/protobuf'
+
 Google::Protobuf::DescriptorPool.generated_pool.build do
   add_file("google/cloud/retail/v2/user_event_service.proto", :syntax => :proto3) do
     add_message "google.cloud.retail.v2.WriteUserEventRequest" do

data/lib/google/cloud/retail/v2/user_event_service_services_pb.rb

@@ -27,7 +27,7 @@ module Google
           # Service for ingesting end user actions on the customer website.
           class Service
 
-            include GRPC::GenericService
+            include ::GRPC::GenericService
 
             self.marshal_class_method = :encode
             self.unmarshal_class_method = :decode

data/lib/google/cloud/retail/v2/version.rb

@@ -21,7 +21,7 @@ module Google
   module Cloud
     module Retail
       module V2
-        VERSION = "0.5.1"
+        VERSION = "0.6.0"
       end
     end
   end

data/proto_docs/google/api/httpbody.rb

@@ -39,12 +39,15 @@ module Google
     #
     #       // The raw HTTP body is bound to this field.
     #       google.api.HttpBody http_body = 2;
+    #
     #     }
     #
     #     service ResourceService {
-    #       rpc GetResource(GetResourceRequest) returns (google.api.HttpBody);
-    #       rpc UpdateResource(google.api.HttpBody) returns
-    #       (google.protobuf.Empty);
+    #       rpc GetResource(GetResourceRequest)
+    #         returns (google.api.HttpBody);
+    #       rpc UpdateResource(google.api.HttpBody)
+    #         returns (google.protobuf.Empty);
+    #
     #     }
     #
     # Example with streaming methods:
@@ -54,6 +57,7 @@ module Google
     #         returns (stream google.api.HttpBody);
     #       rpc UpdateCalendar(stream google.api.HttpBody)
     #         returns (stream google.api.HttpBody);
+    #
     #     }
     #
     # Use of this type only changes how the request and response bodies are

data/proto_docs/google/cloud/retail/v2/common.rb

@@ -80,7 +80,7 @@ module Google
         #     it is expected to have only 1 color. May consider using single "Mixed"
         #     instead of multiple values.
         #
-        #     A maximum of 5 colors are allowed. Each value must be a UTF-8 encoded
+        #     A maximum of 25 colors are allowed. Each value must be a UTF-8 encoded
         #     string with a length limit of 128 characters. Otherwise, an
         #     INVALID_ARGUMENT error is returned.
         #
@@ -174,8 +174,8 @@ module Google
         #     or the region IDs for
         #     {::Google::Cloud::Retail::V2::FulfillmentInfo#type FulfillmentInfo.type.same-day-delivery}.
         #
-        #     A maximum of 2000 values are allowed. Each value must be a string with a
-        #     length limit of 10 characters, matching the pattern [a-zA-Z0-9_-]+, such as
+        #     A maximum of 3000 values are allowed. Each value must be a string with a
+        #     length limit of 30 characters, matching the pattern [a-zA-Z0-9_-]+, such as
         #     "store1" or "REGION-2". Otherwise, an INVALID_ARGUMENT error is returned.
         class FulfillmentInfo
           include ::Google::Protobuf::MessageExts

data/proto_docs/google/cloud/retail/v2/product.rb

@@ -37,18 +37,23 @@ module Google
         #     and
         #     {::Google::Cloud::Retail::V2::ProductService::Client#list_products ProductService.ListProducts}.
         #
+        #     {::Google::Cloud::Retail::V2::Product#expire_time expire_time} must be later
+        #     than {::Google::Cloud::Retail::V2::Product#available_time available_time} and
+        #     {::Google::Cloud::Retail::V2::Product#publish_time publish_time}, otherwise an
+        #     INVALID_ARGUMENT error is thrown.
+        #
         #     Google Merchant Center property
         #     [expiration_date](https://support.google.com/merchants/answer/6324499).
         # @!attribute [rw] ttl
         #   @return [::Google::Protobuf::Duration]
         #     Input only. The TTL (time to live) of the product.
         #
-        #     If it is set, {::Google::Cloud::Retail::V2::Product#expire_time expire_time}
-        #     is set as current timestamp plus
-        #     {::Google::Cloud::Retail::V2::Product#ttl ttl}. The derived
-        #     {::Google::Cloud::Retail::V2::Product#expire_time expire_time} is returned in
-        #     the output and {::Google::Cloud::Retail::V2::Product#ttl ttl} is left blank
-        #     when retrieving the {::Google::Cloud::Retail::V2::Product Product}.
+        #     If it is set, it must be a non-negative value, and
+        #     {::Google::Cloud::Retail::V2::Product#expire_time expire_time} is set as
+        #     current timestamp plus {::Google::Cloud::Retail::V2::Product#ttl ttl}. The
+        #     derived {::Google::Cloud::Retail::V2::Product#expire_time expire_time} is
+        #     returned in the output and {::Google::Cloud::Retail::V2::Product#ttl ttl} is
+        #     left blank when retrieving the {::Google::Cloud::Retail::V2::Product Product}.
         #
         #     If it is set, the product is not available for
         #     {::Google::Cloud::Retail::V2::SearchService::Client#search SearchService.Search} after
@@ -61,8 +66,6 @@ module Google
         #   @return [::String]
         #     Immutable. Full resource name of the product, such as
         #     `projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/product_id`.
-        #
-        #     The branch ID must be "default_branch".
         # @!attribute [rw] id
         #   @return [::String]
         #     Immutable. {::Google::Cloud::Retail::V2::Product Product} identifier, which is

data/proto_docs/google/cloud/retail/v2/product_service.rb

@@ -290,7 +290,7 @@ module Google
         #     {::Google::Cloud::Retail::V2::Product#name Product.name} is not found, the
         #     inventory update will still be processed and retained for at most 1 day
         #     until the {::Google::Cloud::Retail::V2::Product Product} is created. If set to
-        #     false, an INVALID_ARGUMENT error is returned if the
+        #     false, a NOT_FOUND error is returned if the
         #     {::Google::Cloud::Retail::V2::Product Product} is not found.
         class SetInventoryRequest
           include ::Google::Protobuf::MessageExts
@@ -371,8 +371,8 @@ module Google
         #     If set to true, and the {::Google::Cloud::Retail::V2::Product Product} is not
         #     found, the fulfillment information will still be processed and retained for
         #     at most 1 day and processed once the
-        #     {::Google::Cloud::Retail::V2::Product Product} is created. If set to false, an
-        #     INVALID_ARGUMENT error is returned if the
+        #     {::Google::Cloud::Retail::V2::Product Product} is created. If set to false, a
+        #     NOT_FOUND error is returned if the
         #     {::Google::Cloud::Retail::V2::Product Product} is not found.
         class AddFulfillmentPlacesRequest
           include ::Google::Protobuf::MessageExts
@@ -387,7 +387,7 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
-        # Response of the RemoveFulfillmentPlacesRequest.  Currently empty because
+        # Response of the AddFulfillmentPlacesRequest.  Currently empty because
         # there is no meaningful response populated from the [AddFulfillmentPlaces][]
         # method.
         class AddFulfillmentPlacesResponse
@@ -448,8 +448,8 @@ module Google
         #     If set to true, and the {::Google::Cloud::Retail::V2::Product Product} is not
         #     found, the fulfillment information will still be processed and retained for
         #     at most 1 day and processed once the
-        #     {::Google::Cloud::Retail::V2::Product Product} is created. If set to false, an
-        #     INVALID_ARGUMENT error is returned if the
+        #     {::Google::Cloud::Retail::V2::Product Product} is created. If set to false, a
+        #     NOT_FOUND error is returned if the
         #     {::Google::Cloud::Retail::V2::Product Product} is not found.
         class RemoveFulfillmentPlacesRequest
           include ::Google::Protobuf::MessageExts

data/proto_docs/google/cloud/retail/v2/search_service.rb

@@ -27,12 +27,8 @@ module Google
         #   @return [::String]
         #     Required. The resource name of the search engine placement, such as
         #     `projects/*/locations/global/catalogs/default_catalog/placements/default_search`.
-        #     This field is used to identify the set of models that will be used to make
-        #     the search.
-        #
-        #     We currently support one placement with the following ID:
-        #
-        #     * `default_search`.
+        #     This field is used to identify the serving configuration name and the set
+        #     of models that will be used to make the search.
         # @!attribute [rw] branch
         #   @return [::String]
         #     The branch resource name, such as
@@ -87,7 +83,8 @@ module Google
         #   @return [::String]
         #     The filter syntax consists of an expression language for constructing a
         #     predicate from one or more fields of the products being filtered. Filter
-        #     expression is case-sensitive.
+        #     expression is case-sensitive. See more details at this [user
+        #     guide](https://cloud.google.com/retail/docs/filter-and-order#filter).
         #
         #     If this field is unrecognizable, an INVALID_ARGUMENT is returned.
         # @!attribute [rw] canonical_filter
@@ -105,7 +102,9 @@ module Google
         #   @return [::String]
         #     The order in which products are returned. Products can be ordered by
         #     a field in an {::Google::Cloud::Retail::V2::Product Product} object. Leave it
-        #     unset if ordered by relevance. OrderBy expression is case-sensitive.
+        #     unset if ordered by relevance. OrderBy expression is case-sensitive. See
+        #     more details at this [user
+        #     guide](https://cloud.google.com/retail/docs/filter-and-order#order).
         #
         #     If this field is unrecognizable, an INVALID_ARGUMENT is returned.
         # @!attribute [rw] facet_specs
@@ -123,11 +122,19 @@ module Google
         #     support team if you are interested in using dynamic facet feature.
         # @!attribute [rw] boost_spec
         #   @return [::Google::Cloud::Retail::V2::SearchRequest::BoostSpec]
-        #     Boost specification to boost certain products.
+        #     Boost specification to boost certain products. See more details at this
+        #     [user guide](https://cloud.google.com/retail/docs/boosting).
+        #
+        #     Notice that if both [ServingConfig.boost_control_ids][] and
+        #     [SearchRequest.boost_spec] are set, the boost conditions from both places
+        #     are evaluated. If a search request matches multiple boost conditions,
+        #     the final boost score is equal to the sum of the boost scores from all
+        #     matched boost conditions.
         # @!attribute [rw] query_expansion_spec
         #   @return [::Google::Cloud::Retail::V2::SearchRequest::QueryExpansionSpec]
         #     The query expansion specification that specifies the conditions under which
-        #     query expansion will occur.
+        #     query expansion will occur. See more details at this [user
+        #     guide](https://cloud.google.com/retail/docs/result-size#query_expansion).
         # @!attribute [rw] variant_rollup_keys
         #   @return [::Array<::String>]
         #     The keys to fetch and rollup the matching
@@ -150,6 +157,7 @@ module Google
         #     * price
         #     * originalPrice
         #     * discount
+        #     * inventory(place_id,price)
         #     * attributes.key, where key is any key in the
         #       {::Google::Cloud::Retail::V2::Product#attributes Product.attributes} map.
         #     * pickupInStore.id, where id is any
@@ -205,6 +213,10 @@ module Google
         #     Category pages include special pages such as sales or promotions. For
         #     instance, a special sale page may have the category hierarchy:
         #     "pageCategories" : ["Sales > 2017 Black Friday Deals"].
+        # @!attribute [rw] search_mode
+        #   @return [::Google::Cloud::Retail::V2::SearchRequest::SearchMode]
+        #     The search mode of the search request. If not specified, a single search
+        #     request triggers both product search and faceted search.
         class SearchRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -314,6 +326,7 @@ module Google
             #         * "rating"
             #         * "ratingCount"
             #         * "attributes.key"
+            #         * "inventory(place_id,price)"
             # @!attribute [rw] intervals
             #   @return [::Array<::Google::Cloud::Retail::V2::Interval>]
             #     Set only if values should be bucketized into intervals. Must be set
@@ -513,6 +526,35 @@ module Google
               AUTO = 3
             end
           end
+
+          # The search mode of each search request.
+          module SearchMode
+            # Default value. In this case both product search and faceted search will
+            # be performed. Both [SearchResponse.SearchResult] and
+            # [SearchResponse.Facet] will be returned.
+            SEARCH_MODE_UNSPECIFIED = 0
+
+            # Only product search will be performed. The faceted search will be
+            # disabled.
+            #
+            # Only [SearchResponse.SearchResult] will be returned.
+            # [SearchResponse.Facet] will not be returned, even if
+            # {::Google::Cloud::Retail::V2::SearchRequest#facet_specs SearchRequest.facet_specs}
+            # or
+            # {::Google::Cloud::Retail::V2::SearchRequest#dynamic_facet_spec SearchRequest.dynamic_facet_spec}
+            # is set.
+            PRODUCT_SEARCH_ONLY = 1
+
+            # Only faceted search will be performed. The product search will be
+            # disabled.
+            #
+            # When in this mode, one or both of [SearchRequest.facet_spec][] and
+            # {::Google::Cloud::Retail::V2::SearchRequest#dynamic_facet_spec SearchRequest.dynamic_facet_spec}
+            # should be set. Otherwise, an INVALID_ARGUMENT error is returned. Only
+            # [SearchResponse.Facet] will be returned. [SearchResponse.SearchResult]
+            # will not be returned.
+            FACETED_SEARCH_ONLY = 2
+          end
         end
 
         # Response message for
@@ -692,7 +734,8 @@ module Google
           # @!attribute [rw] pinned_result_count
           #   @return [::Integer]
           #     Number of pinned results. This field will only be set when expansion
-          #     happens and [SearchRequest.query_expansion_spec.pin_unexpanded_results][]
+          #     happens and
+          #     {::Google::Cloud::Retail::V2::SearchRequest::QueryExpansionSpec#pin_unexpanded_results SearchRequest.QueryExpansionSpec.pin_unexpanded_results}
           #     is set to true.
           class QueryExpansionInfo
             include ::Google::Protobuf::MessageExts

data/proto_docs/google/cloud/retail/v2/user_event.rb

@@ -110,12 +110,12 @@ module Google
         #     * `purchase-complete`
         #
         #     In a `search` event, this field represents the products returned to the end
-        #     user on the current page (the end user may have not finished broswing the
+        #     user on the current page (the end user may have not finished browsing the
         #     whole page yet). When a new page is returned to the end user, after
         #     pagination/filtering/ordering even for the same query, a new `search` event
         #     with different
         #     {::Google::Cloud::Retail::V2::UserEvent#product_details product_details} is
-        #     desired. The end user may have not finished broswing the whole page yet.
+        #     desired. The end user may have not finished browsing the whole page yet.
         # @!attribute [rw] completion_detail
         #   @return [::Google::Cloud::Retail::V2::CompletionDetail]
         #     The main completion details related to the event.
@@ -136,7 +136,7 @@ module Google
         #     search, and etc.
         # @!attribute [rw] cart_id
         #   @return [::String]
-        #     The id or name of the associated shopping cart. This id is used
+        #     The ID or name of the associated shopping cart. This ID is used
         #     to associate multiple items added or present in the cart before purchase.
         #
         #     This can only be set for `add-to-cart`, `purchase-complete`, or
@@ -231,7 +231,7 @@ module Google
         #     Tag Manager, this value is filled in automatically.
         # @!attribute [rw] page_view_id
         #   @return [::String]
-        #     A unique id of a web page view.
+        #     A unique ID of a web page view.
         #
         #     This should be kept the same for all user events triggered from the same
         #     pageview. For example, an item detail page view could trigger multiple

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-retail-v2
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.6.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-08-27 00:00:00.000000000 Z
+date: 2021-10-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common