google-cloud-retail-v2 0.5.0 → 0.6.2

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

@@ -21,7 +21,7 @@ module Google
   module Cloud
     module Retail
       module V2
-        VERSION = "0.5.0"
+        VERSION = "0.6.2"
       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,9 +174,10 @@ 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
-        #     "store1" or "REGION-2". Otherwise, an INVALID_ARGUMENT error is returned.
+        #     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
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -421,7 +422,7 @@ module Google
         #     ID of the promotion. For example, "free gift".
         #
         #     The value value must be a UTF-8 encoded string with a length limit of 128
-        #     characters, and match the pattern: [a-zA-Z][a-zA-Z0-9_]*. For example,
+        #     characters, and match the pattern: `[a-zA-Z][a-zA-Z0-9_]*`. For example,
         #     id0LikeThis or ID_1_LIKE_THIS. Otherwise, an INVALID_ARGUMENT error is
         #     returned.
         #

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

@@ -55,18 +55,18 @@ module Google
         #   @return [::String]
         #     The device type context for completion suggestions.
         #     It is useful to apply different suggestions on different device types, e.g.
-        #     DESKTOP, MOBILE. If it is empty, the suggestions are across all device
+        #     `DESKTOP`, `MOBILE`. If it is empty, the suggestions are across all device
         #     types.
         #
         #     Supported formats:
         #
-        #     * UNKNOWN_DEVICE_TYPE
+        #     * `UNKNOWN_DEVICE_TYPE`
         #
-        #     * DESKTOP
+        #     * `DESKTOP`
         #
-        #     * MOBILE
+        #     * `MOBILE`
         #
-        #     * A customized string starts with OTHER_, e.g. OTHER_IPHONE.
+        #     * A customized string starts with `OTHER_`, e.g. `OTHER_IPHONE`.
         # @!attribute [rw] dataset
         #   @return [::String]
         #     Determines which dataset to use for fetching completion. "user-data" will

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

@@ -150,7 +150,7 @@ module Google
         #     Unique identifier provided by client, within the ancestor
         #     dataset scope. Ensures idempotency and used for request deduplication.
         #     Server-generated if unspecified. Up to 128 characters long and must match
-        #     the pattern: "[a-zA-Z0-9_]+". This is returned as [Operation.name][] in
+        #     the pattern: `[a-zA-Z0-9_]+`. This is returned as [Operation.name][] in
         #     {::Google::Cloud::Retail::V2::ImportMetadata ImportMetadata}.
         #
         #     Only supported when

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
@@ -120,6 +123,9 @@ module Google
         #     This field must be a UTF-8 encoded string with a length limit of 128
         #     characters. Otherwise, an INVALID_ARGUMENT error is returned.
         #
+        #     This field must be a Unigram. Otherwise, an INVALID_ARGUMENT error is
+        #     returned.
+        #
         #     Google Merchant Center property
         #     [gtin](https://support.google.com/merchants/answer/6324461).
         #     Schema.org property
@@ -234,7 +240,7 @@ module Google
         #     * The key must be a UTF-8 encoded string with a length limit of 128
         #       characters.
         #     * For indexable attribute, the key must match the pattern:
-        #       [a-zA-Z0-9][a-zA-Z0-9_]*. For example, key0LikeThis or KEY_1_LIKE_THIS.
+        #       `[a-zA-Z0-9][a-zA-Z0-9_]*`. For example, key0LikeThis or KEY_1_LIKE_THIS.
         # @!attribute [rw] tags
         #   @return [::Array<::String>]
         #     Custom tags associated with the product.
@@ -354,7 +360,7 @@ module Google
         #     The pattern or graphic print of the product. For example, "striped", "polka
         #     dot", "paisley".
         #
-        #     A maximum of 5 values are allowed per
+        #     A maximum of 20 values are allowed per
         #     {::Google::Cloud::Retail::V2::Product Product}. Each value must be a UTF-8
         #     encoded string with a length limit of 128 characters. Otherwise, an
         #     INVALID_ARGUMENT error is returned.

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
@@ -355,7 +355,7 @@ module Google
         #
         #     At least 1 value is required, and 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 "store1" or "REGION-2". Otherwise, an
+        #     the pattern `[a-zA-Z0-9_-]+`, such as "store1" or "REGION-2". Otherwise, an
         #     INVALID_ARGUMENT error is returned.
         #
         #     If the total number of place IDs exceeds 2000 for this
@@ -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
@@ -436,7 +436,7 @@ module Google
         #
         #     At least 1 value is required, and 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 "store1" or "REGION-2". Otherwise, an
+        #     the pattern `[a-zA-Z0-9_-]+`, such as "store1" or "REGION-2". Otherwise, an
         #     INVALID_ARGUMENT error is returned.
         # @!attribute [rw] remove_time
         #   @return [::Google::Protobuf::Timestamp]
@@ -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
@@ -88,7 +84,7 @@ module Google
         #     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. See more details at this [user
-        #     guide](/retail/private/docs/filter-and-order#filter).
+        #     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
@@ -108,7 +104,7 @@ module Google
         #     a field in an {::Google::Cloud::Retail::V2::Product Product} object. Leave it
         #     unset if ordered by relevance. OrderBy expression is case-sensitive. See
         #     more details at this [user
-        #     guide](/retail/private/docs/filter-and-order#order).
+        #     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
@@ -127,12 +123,18 @@ module Google
         # @!attribute [rw] boost_spec
         #   @return [::Google::Cloud::Retail::V2::SearchRequest::BoostSpec]
         #     Boost specification to boost certain products. See more details at this
-        #     [user guide](/retail/private/docs/boosting).
+        #     [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. See more details at this [user
-        #     guide](/retail/private/docs/result-size#query_expansion).
+        #     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
@@ -155,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
@@ -210,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
@@ -319,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
@@ -460,10 +468,9 @@ module Google
             #
             #     * To boost products with product ID "product_1" or "product_2", and
             #     color
-            #       "Red" or "Blue":<br>
-            #       *(id: ANY("product_1", "product_2"))<br>*
-            #       *AND<br>*
-            #       *(colorFamilies: ANY("Red", "Blue"))<br>*
+            #       "Red" or "Blue":
+            #         * (id: ANY("product_1", "product_2")) AND (colorFamilies:
+            #         ANY("Red","Blue"))
             # @!attribute [rw] boost
             #   @return [::Float]
             #     Strength of the condition boost, which should be in [-1, 1]. Negative
@@ -519,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
@@ -698,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.0
+  version: 0.6.2
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-08-23 00:00:00.000000000 Z
+date: 2021-11-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common