google-cloud-retail-v2 0.6.4 → 0.9.0

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

@@ -1,10 +1,11 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/cloud/retail/v2/purge_config.proto
 
-require 'google/api/annotations_pb'
-require 'google/api/field_behavior_pb'
 require 'google/protobuf'
 
+require 'google/api/field_behavior_pb'
+require 'google/api/resource_pb'
+
 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

@@ -30,8 +30,7 @@ module Google
           # Service for search.
           #
           # This feature is only available for users who have Retail Search enabled.
-          # Please submit a form [here](https://cloud.google.com/contact) to contact
-          # cloud sales if you are interested in using Retail Search.
+          # Please enable Retail Search on Cloud Console before using this feature.
           #
           class Client
             include Paths
@@ -157,8 +156,7 @@ module Google
             # Performs a search.
             #
             # This feature is only available for users who have Retail Search enabled.
-            # Please submit a form [here](https://cloud.google.com/contact) to contact
-            # cloud sales if you are interested in using Retail Search.
+            # Please enable Retail Search on Cloud Console before using this feature.
             #
             # @overload search(request, options = nil)
             #   Pass arguments to `search` via a request object, either of type
@@ -170,7 +168,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, search_mode: 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, personalization_spec: nil, labels: nil, spell_correction_spec: 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).
@@ -188,12 +186,20 @@ module Google
             #     products under the default branch.
             #   @param query [::String]
             #     Raw search query.
+            #
+            #     If this field is empty, the request is considered a category browsing
+            #     request and returned results are based on
+            #     {::Google::Cloud::Retail::V2::SearchRequest#filter filter} and
+            #     {::Google::Cloud::Retail::V2::SearchRequest#page_categories page_categories}.
             #   @param visitor_id [::String]
             #     Required. A unique identifier for tracking visitors. For example, this
             #     could be implemented with an HTTP cookie, which should be able to uniquely
             #     identify a visitor on a single device. This unique identifier should not
             #     change if the visitor logs in or out of the website.
             #
+            #     This should be the same identifier as
+            #     {::Google::Cloud::Retail::V2::UserEvent#visitor_id UserEvent.visitor_id}.
+            #
             #     The field must be a UTF-8 encoded string with a length limit of 128
             #     characters. Otherwise, an INVALID_ARGUMENT error is returned.
             #   @param user_info [::Google::Cloud::Retail::V2::UserInfo, ::Hash]
@@ -231,6 +237,9 @@ module Google
             #
             #     If this field is unrecognizable, an INVALID_ARGUMENT is returned.
             #   @param canonical_filter [::String]
+            #     The default filter that is applied when a user performs a search without
+            #     checking any filters on the search page.
+            #
             #     The filter applied to every search request when quality improvement such as
             #     query expansion is needed. For example, if a query does not have enough
             #     results, an expanded query with
@@ -254,20 +263,20 @@ module Google
             #     A maximum of 100 values are allowed. Otherwise, an INVALID_ARGUMENT error
             #     is returned.
             #   @param dynamic_facet_spec [::Google::Cloud::Retail::V2::SearchRequest::DynamicFacetSpec, ::Hash]
+            #     Deprecated. Refer to https://cloud.google.com/retail/docs/configs#dynamic
+            #     to enable dynamic facets. Do not set this field.
+            #
             #     The specification for dynamically generated facets. Notice that only
             #     textual facets can be dynamically generated.
-            #
-            #     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. 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.
+            #     {::Google::Cloud::Retail::V2::SearchRequest#boost_spec 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. See more details at this [user
@@ -275,12 +284,15 @@ module Google
             #   @param variant_rollup_keys [::Array<::String>]
             #     The keys to fetch and rollup the matching
             #     {::Google::Cloud::Retail::V2::Product::Type::VARIANT variant}
-            #     {::Google::Cloud::Retail::V2::Product Product}s attributes. The attributes from
-            #     all the matching {::Google::Cloud::Retail::V2::Product::Type::VARIANT variant}
-            #     {::Google::Cloud::Retail::V2::Product Product}s are merged and de-duplicated.
-            #     Notice that rollup {::Google::Cloud::Retail::V2::Product::Type::VARIANT variant}
-            #     {::Google::Cloud::Retail::V2::Product Product}s attributes will lead to extra
-            #     query latency. Maximum number of keys is 10.
+            #     {::Google::Cloud::Retail::V2::Product Product}s attributes,
+            #     {::Google::Cloud::Retail::V2::FulfillmentInfo FulfillmentInfo} or
+            #     {::Google::Cloud::Retail::V2::LocalInventory LocalInventory}s attributes. The
+            #     attributes from all the matching
+            #     {::Google::Cloud::Retail::V2::Product::Type::VARIANT variant}
+            #     {::Google::Cloud::Retail::V2::Product Product}s or
+            #     {::Google::Cloud::Retail::V2::LocalInventory LocalInventory}s are merged and
+            #     de-duplicated. Notice that rollup attributes will lead to extra query
+            #     latency. Maximum number of keys is 30.
             #
             #     For {::Google::Cloud::Retail::V2::FulfillmentInfo FulfillmentInfo}, a
             #     fulfillment type and a fulfillment ID must be provided in the format of
@@ -295,8 +307,10 @@ module Google
             #     * discount
             #     * variantId
             #     * inventory(place_id,price)
+            #     * inventory(place_id,original_price)
             #     * inventory(place_id,attributes.key), where key is any key in the
-            #       [Product.inventories.attributes][] map.
+            #       {::Google::Cloud::Retail::V2::LocalInventory#attributes Product.local_inventories.attributes}
+            #       map.
             #     * attributes.key, where key is any key in the
             #       {::Google::Cloud::Retail::V2::Product#attributes Product.attributes} map.
             #     * pickupInStore.id, where id is any
@@ -354,6 +368,29 @@ module Google
             #   @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.
+            #   @param personalization_spec [::Google::Cloud::Retail::V2::SearchRequest::PersonalizationSpec, ::Hash]
+            #     The specification for personalization.
+            #   @param labels [::Hash{::String => ::String}]
+            #     The labels applied to a resource must meet the following requirements:
+            #
+            #     * Each resource can have multiple labels, up to a maximum of 64.
+            #     * Each label must be a key-value pair.
+            #     * Keys have a minimum length of 1 character and a maximum length of 63
+            #       characters and cannot be empty. Values can be empty and have a maximum
+            #       length of 63 characters.
+            #     * Keys and values can contain only lowercase letters, numeric characters,
+            #       underscores, and dashes. All characters must use UTF-8 encoding, and
+            #       international characters are allowed.
+            #     * The key portion of a label must be unique. However, you can use the same
+            #       key with multiple resources.
+            #     * Keys must start with a lowercase letter or international character.
+            #
+            #     See [Google Cloud
+            #     Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
+            #     for more details.
+            #   @param spell_correction_spec [::Google::Cloud::Retail::V2::SearchRequest::SpellCorrectionSpec, ::Hash]
+            #     The spell correction specification that specifies the mode under
+            #     which spell correction will take effect.
             #
             # @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.rb

@@ -34,8 +34,7 @@ module Google
         # Service for search.
         #
         # This feature is only available for users who have Retail Search enabled.
-        # Please submit a form [here](https://cloud.google.com/contact) to contact
-        # cloud sales if you are interested in using Retail Search.
+        # Please enable Retail Search on Cloud Console before using this feature.
         #
         # To load this service and instantiate a client:
         #

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

@@ -1,6 +1,8 @@
 # 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'
@@ -9,9 +11,6 @@ require 'google/cloud/retail/v2/common_pb'
 require 'google/cloud/retail/v2/product_pb'
 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
@@ -34,6 +33,9 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       repeated :variant_rollup_keys, :string, 17
       repeated :page_categories, :string, 23
       optional :search_mode, :enum, 31, "google.cloud.retail.v2.SearchRequest.SearchMode"
+      optional :personalization_spec, :message, 32, "google.cloud.retail.v2.SearchRequest.PersonalizationSpec"
+      map :labels, :string, :string, 34
+      proto3_optional :spell_correction_spec, :message, 35, "google.cloud.retail.v2.SearchRequest.SpellCorrectionSpec"
     end
     add_message "google.cloud.retail.v2.SearchRequest.FacetSpec" do
       optional :facet_key, :message, 1, "google.cloud.retail.v2.SearchRequest.FacetSpec.FacetKey"
@@ -60,6 +62,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
     end
     add_message "google.cloud.retail.v2.SearchRequest.BoostSpec" do
       repeated :condition_boost_specs, :message, 1, "google.cloud.retail.v2.SearchRequest.BoostSpec.ConditionBoostSpec"
+      proto3_optional :skip_boost_spec_validation, :bool, 2
     end
     add_message "google.cloud.retail.v2.SearchRequest.BoostSpec.ConditionBoostSpec" do
       optional :condition, :string, 1
@@ -74,6 +77,22 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       value :DISABLED, 1
       value :AUTO, 3
     end
+    add_message "google.cloud.retail.v2.SearchRequest.PersonalizationSpec" do
+      optional :mode, :enum, 1, "google.cloud.retail.v2.SearchRequest.PersonalizationSpec.Mode"
+    end
+    add_enum "google.cloud.retail.v2.SearchRequest.PersonalizationSpec.Mode" do
+      value :MODE_UNSPECIFIED, 0
+      value :AUTO, 1
+      value :DISABLED, 2
+    end
+    add_message "google.cloud.retail.v2.SearchRequest.SpellCorrectionSpec" do
+      optional :mode, :enum, 1, "google.cloud.retail.v2.SearchRequest.SpellCorrectionSpec.Mode"
+    end
+    add_enum "google.cloud.retail.v2.SearchRequest.SpellCorrectionSpec.Mode" do
+      value :MODE_UNSPECIFIED, 0
+      value :SUGGESTION_ONLY, 1
+      value :AUTO, 2
+    end
     add_enum "google.cloud.retail.v2.SearchRequest.SearchMode" do
       value :SEARCH_MODE_UNSPECIFIED, 0
       value :PRODUCT_SEARCH_ONLY, 1
@@ -88,6 +107,8 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       optional :next_page_token, :string, 6
       optional :query_expansion_info, :message, 7, "google.cloud.retail.v2.SearchResponse.QueryExpansionInfo"
       optional :redirect_uri, :string, 10
+      repeated :applied_controls, :string, 12
+      repeated :invalid_condition_boost_specs, :message, 14, "google.cloud.retail.v2.SearchRequest.BoostSpec.ConditionBoostSpec"
     end
     add_message "google.cloud.retail.v2.SearchResponse.SearchResult" do
       optional :id, :string, 1
@@ -128,6 +149,10 @@ 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::PersonalizationSpec = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.SearchRequest.PersonalizationSpec").msgclass
+        SearchRequest::PersonalizationSpec::Mode = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.SearchRequest.PersonalizationSpec.Mode").enummodule
+        SearchRequest::SpellCorrectionSpec = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.SearchRequest.SpellCorrectionSpec").msgclass
+        SearchRequest::SpellCorrectionSpec::Mode = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.SearchRequest.SpellCorrectionSpec.Mode").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

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

@@ -27,8 +27,7 @@ module Google
           # Service for search.
           #
           # This feature is only available for users who have Retail Search enabled.
-          # Please submit a form [here](https://cloud.google.com/contact) to contact
-          # cloud sales if you are interested in using Retail Search.
+          # Please enable Retail Search on Cloud Console before using this feature.
           class Service
 
             include ::GRPC::GenericService
@@ -40,8 +39,7 @@ module Google
             # Performs a search.
             #
             # This feature is only available for users who have Retail Search enabled.
-            # Please submit a form [here](https://cloud.google.com/contact) to contact
-            # cloud sales if you are interested in using Retail Search.
+            # Please enable Retail Search on Cloud Console before using this feature.
             rpc :Search, ::Google::Cloud::Retail::V2::SearchRequest, ::Google::Cloud::Retail::V2::SearchResponse
           end
 

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

@@ -1,13 +1,13 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/cloud/retail/v2/user_event.proto
 
-require 'google/api/annotations_pb'
+require 'google/protobuf'
+
 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

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

@@ -593,13 +593,14 @@ module Google
             end
 
             ##
-            # Triggers a user event rejoin operation with latest product catalog. Events
+            # Starts a user event rejoin operation with latest product catalog. Events
             # will not be annotated with detailed product information if product is
             # missing from the catalog at the time the user event is ingested, and these
             # events are stored as unjoined events with a limited usage on training and
-            # serving. This API can be used to trigger a 'join' operation on specified
+            # serving. This method can be used to start a join operation on specified
             # events with latest version of product catalog. It can also be used to
-            # correct events joined with wrong product catalog.
+            # correct events joined with the wrong product catalog. A rejoin operation
+            # can take hours or days to complete.
             #
             # @overload rejoin_user_events(request, options = nil)
             #   Pass arguments to `rejoin_user_events` via a request object, either of type

data/lib/google/cloud/retail/v2/user_event_service/operations.rb

@@ -95,6 +95,9 @@ module Google
                 channel_args: @config.channel_args,
                 interceptors: @config.interceptors
               )
+
+              # Used by an LRO wrapper for some methods of this service
+              @operations_client = self
             end
 
             # Service calls

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

@@ -1,15 +1,17 @@
 # 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'
 require 'google/api/httpbody_pb'
+require 'google/api/resource_pb'
 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

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

@@ -54,13 +54,14 @@ module Google
             # possible for a subset of the items to be successfully inserted.
             # Operation.metadata is of type ImportMetadata.
             rpc :ImportUserEvents, ::Google::Cloud::Retail::V2::ImportUserEventsRequest, ::Google::Longrunning::Operation
-            # Triggers a user event rejoin operation with latest product catalog. Events
+            # Starts a user event rejoin operation with latest product catalog. Events
             # will not be annotated with detailed product information if product is
             # missing from the catalog at the time the user event is ingested, and these
             # events are stored as unjoined events with a limited usage on training and
-            # serving. This API can be used to trigger a 'join' operation on specified
+            # serving. This method can be used to start a join operation on specified
             # events with latest version of product catalog. It can also be used to
-            # correct events joined with wrong product catalog.
+            # correct events joined with the wrong product catalog. A rejoin operation
+            # can take hours or days to complete.
             rpc :RejoinUserEvents, ::Google::Cloud::Retail::V2::RejoinUserEventsRequest, ::Google::Longrunning::Operation
           end
 

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

@@ -21,7 +21,7 @@ module Google
   module Cloud
     module Retail
       module V2
-        VERSION = "0.6.4"
+        VERSION = "0.9.0"
       end
     end
   end

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

@@ -30,6 +30,8 @@ module Google
       ##
       # To load this package, including all its services, and instantiate a client:
       #
+      # @example
+      #
       #     require "google/cloud/retail/v2"
       #     client = ::Google::Cloud::Retail::V2::CatalogService::Client.new
       #

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

@@ -34,10 +34,10 @@ module Google
         #       default to
         #       {::Google::Cloud::Retail::V2::Product::Type::PRIMARY Product.Type.PRIMARY} if
         #       unset.
-        #     * `variant`: You can only ingest
-        #     {::Google::Cloud::Retail::V2::Product::Type::VARIANT Product.Type.VARIANT}
-        #     {::Google::Cloud::Retail::V2::Product Product}s.
-        #       This means
+        #     * `variant` (incompatible with Retail Search): You can only
+        #       ingest
+        #       {::Google::Cloud::Retail::V2::Product::Type::VARIANT Product.Type.VARIANT}
+        #       {::Google::Cloud::Retail::V2::Product Product}s. This means
         #       {::Google::Cloud::Retail::V2::Product#primary_product_id Product.primary_product_id}
         #       cannot be empty.
         #
@@ -48,8 +48,8 @@ module Google
         #     {::Google::Cloud::Retail::V2::ProductLevelConfig#merchant_center_product_id_field merchant_center_product_id_field}
         #     is `itemGroupId`, an INVALID_ARGUMENT error is returned.
         #
-        #     See [Using product
-        #     levels](https://cloud.google.com/retail/recommendations-ai/docs/catalog#product-levels)
+        #     See [Product
+        #     levels](https://cloud.google.com/retail/docs/catalog#product-levels)
         #     for more details.
         # @!attribute [rw] merchant_center_product_id_field
         #   @return [::String]
@@ -70,8 +70,8 @@ module Google
         #     {::Google::Cloud::Retail::V2::ProductLevelConfig#ingestion_product_type ingestion_product_type}
         #     is `variant`, an INVALID_ARGUMENT error is returned.
         #
-        #     See [Using product
-        #     levels](https://cloud.google.com/retail/recommendations-ai/docs/catalog#product-levels)
+        #     See [Product
+        #     levels](https://cloud.google.com/retail/docs/catalog#product-levels)
         #     for more details.
         class ProductLevelConfig
           include ::Google::Protobuf::MessageExts

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

@@ -109,6 +109,10 @@ module Google
         #
         #     This field must be one of "0", "1" or "2". Otherwise, an INVALID_ARGUMENT
         #     error is returned.
+        #
+        #     If there are no sufficient active products in the targeted branch and
+        #     {::Google::Cloud::Retail::V2::SetDefaultBranchRequest#force force} is not set, a
+        #     FAILED_PRECONDITION error is returned.
         # @!attribute [rw] note
         #   @return [::String]
         #     Some note on this request, this can be retrieved by
@@ -117,6 +121,11 @@ module Google
         #
         #     This field must be a UTF-8 encoded string with a length limit of 1,000
         #     characters. Otherwise, an INVALID_ARGUMENT error is returned.
+        # @!attribute [rw] force
+        #   @return [::Boolean]
+        #     If set to true, it permits switching to a branch with
+        #     {::Google::Cloud::Retail::V2::SetDefaultBranchRequest#branch_id branch_id} even
+        #     if it has no sufficient active products.
         class SetDefaultBranchRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods

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

@@ -99,9 +99,8 @@ module Google
         #     The textual values of this custom attribute. For example, `["yellow",
         #     "green"]` when the key is "color".
         #
-        #     At most 400 values are allowed. Empty values are not allowed. Each value
-        #     must be a UTF-8 encoded string with a length limit of 256 characters.
-        #     Otherwise, an INVALID_ARGUMENT error is returned.
+        #     Empty string is not allowed. Otherwise, an INVALID_ARGUMENT error is
+        #     returned.
         #
         #     Exactly one of {::Google::Cloud::Retail::V2::CustomAttribute#text text} or
         #     {::Google::Cloud::Retail::V2::CustomAttribute#numbers numbers} should be set.
@@ -111,14 +110,17 @@ module Google
         #     The numerical values of this custom attribute. For example, `[2.3, 15.4]`
         #     when the key is "lengths_cm".
         #
-        #     At most 400 values are allowed.Otherwise, an INVALID_ARGUMENT error is
-        #     returned.
-        #
         #     Exactly one of {::Google::Cloud::Retail::V2::CustomAttribute#text text} or
         #     {::Google::Cloud::Retail::V2::CustomAttribute#numbers numbers} should be set.
         #     Otherwise, an INVALID_ARGUMENT error is returned.
         # @!attribute [rw] searchable
         #   @return [::Boolean]
+        #     This field is normally ignored unless
+        #     [AttributesConfig.attribute_config_level][] of the
+        #     {::Google::Cloud::Retail::V2::Catalog Catalog} is set to the deprecated
+        #     'PRODUCT_LEVEL_ATTRIBUTE_CONFIG' mode. For information about product-level
+        #     attribute configuration, see [Configuration
+        #     modes](https://cloud.google.com/retail/docs/attribute-config#config-modes).
         #     If true, custom attribute values are searchable by text queries in
         #     {::Google::Cloud::Retail::V2::SearchService::Client#search SearchService.Search}.
         #
@@ -128,7 +130,13 @@ module Google
         #     set. Otherwise, a INVALID_ARGUMENT error is returned.
         # @!attribute [rw] indexable
         #   @return [::Boolean]
-        #     If true, custom attribute values are indexed, so that it can be filtered,
+        #     This field is normally ignored unless
+        #     [AttributesConfig.attribute_config_level][] of the
+        #     {::Google::Cloud::Retail::V2::Catalog Catalog} is set to the deprecated
+        #     'PRODUCT_LEVEL_ATTRIBUTE_CONFIG' mode. For information about product-level
+        #     attribute configuration, see [Configuration
+        #     modes](https://cloud.google.com/retail/docs/attribute-config#config-modes).
+        #     If true, custom attribute values are indexed, so that they can be filtered,
         #     faceted or boosted in
         #     {::Google::Cloud::Retail::V2::SearchService::Client#search SearchService.Search}.
         #
@@ -183,7 +191,10 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
-        # {::Google::Cloud::Retail::V2::Product Product} thumbnail/detail image.
+        # {::Google::Cloud::Retail::V2::Product Product} image. Recommendations AI and
+        # Retail Search do not use product images to improve prediction and search
+        # results. However, product images can be returned in results, and are shown in
+        # prediction or search previews in the console.
         # @!attribute [rw] uri
         #   @return [::String]
         #     Required. URI of the image.
@@ -250,11 +261,14 @@ module Google
         #
         #     Google Merchant Center property
         #     [price](https://support.google.com/merchants/answer/6324371). Schema.org
-        #     property [Offer.priceSpecification](https://schema.org/priceSpecification).
+        #     property [Offer.price](https://schema.org/price).
         # @!attribute [rw] original_price
         #   @return [::Float]
         #     Price of the product without any discount. If zero, by default set to be
-        #     the {::Google::Cloud::Retail::V2::PriceInfo#price price}.
+        #     the {::Google::Cloud::Retail::V2::PriceInfo#price price}. If set,
+        #     {::Google::Cloud::Retail::V2::PriceInfo#original_price original_price} should be
+        #     greater than or equal to {::Google::Cloud::Retail::V2::PriceInfo#price price},
+        #     otherwise an INVALID_ARGUMENT error is thrown.
         # @!attribute [rw] cost
         #   @return [::Float]
         #     The costs associated with the sale of a particular product. Used for gross
@@ -367,21 +381,30 @@ module Google
         # @!attribute [rw] user_id
         #   @return [::String]
         #     Highly recommended for logged-in users. Unique identifier for logged-in
-        #     user, such as a user name.
+        #     user, such as a user name. Don't set for anonymous users.
+        #
+        #     Always use a hashed value for this ID.
+        #
+        #     Don't set the field to the same fixed ID for different users. This mixes
+        #     the event history of those users together, which results in degraded
+        #     model quality.
         #
         #     The field must be a UTF-8 encoded string with a length limit of 128
         #     characters. Otherwise, an INVALID_ARGUMENT error is returned.
         # @!attribute [rw] ip_address
         #   @return [::String]
-        #     The end user's IP address. Required for getting
-        #     [SearchResponse.sponsored_results][google.cloud.retail.v2.SearchResponse.sponsored_results].
-        #     This field is used to extract location information for personalization.
+        #     The end user's IP address. This field is used to extract location
+        #     information for personalization.
         #
         #     This field must be either an IPv4 address (e.g. "104.133.9.80") or an IPv6
         #     address (e.g. "2001:0db8:85a3:0000:0000:8a2e:0370:7334"). Otherwise, an
         #     INVALID_ARGUMENT error is returned.
         #
-        #     This should not be set when using the JavaScript tag in
+        #     This should not be set when:
+        #
+        #     * setting
+        #     {::Google::Cloud::Retail::V2::SearchRequest#user_info SearchRequest.user_info}.
+        #     * using the JavaScript tag in
         #     {::Google::Cloud::Retail::V2::UserEventService::Client#collect_user_event UserEventService.CollectUserEvent}
         #     or if
         #     {::Google::Cloud::Retail::V2::UserInfo#direct_user_request direct_user_request}
@@ -416,21 +439,73 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
-        # Promotion information.
-        # @!attribute [rw] promotion_id
+        # The inventory information at a place (e.g. a store) identified
+        # by a place ID.
+        # @!attribute [rw] place_id
         #   @return [::String]
-        #     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,
-        #     id0LikeThis or ID_1_LIKE_THIS. Otherwise, an INVALID_ARGUMENT error is
-        #     returned.
+        #     The place ID for the current set of inventory information.
+        # @!attribute [rw] price_info
+        #   @return [::Google::Cloud::Retail::V2::PriceInfo]
+        #     Product price and cost information.
         #
         #     Google Merchant Center property
-        #     [promotion](https://support.google.com/merchants/answer/7050148).
-        class Promotion
+        #     [price](https://support.google.com/merchants/answer/6324371).
+        # @!attribute [rw] attributes
+        #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::Retail::V2::CustomAttribute}]
+        #     Additional local inventory attributes, for example, store name, promotion
+        #     tags, etc.
+        #
+        #     This field needs to pass all below criteria, otherwise an INVALID_ARGUMENT
+        #     error is returned:
+        #
+        #     * At most 30 attributes are allowed.
+        #     * The key must be a UTF-8 encoded string with a length limit of 32
+        #       characters.
+        #     * The key must match the pattern: `[a-zA-Z0-9][a-zA-Z0-9_]*`. For example,
+        #       key0LikeThis or KEY_1_LIKE_THIS.
+        #     * The attribute values must be of the same type (text or number).
+        #     * Only 1 value is allowed for each attribute.
+        #     * For text values, the length limit is 256 UTF-8 characters.
+        #     * The attribute does not support search. The `searchable` field should be
+        #       unset or set to false.
+        #     * The max summed total bytes of custom attribute keys and values per
+        #       product is 5MiB.
+        # @!attribute [rw] fulfillment_types
+        #   @return [::Array<::String>]
+        #     Input only. Supported fulfillment types. Valid fulfillment type values
+        #     include commonly used types (such as pickup in store and same day
+        #     delivery), and custom types. Customers have to map custom types to their
+        #     display names before rendering UI.
+        #
+        #     Supported values:
+        #
+        #     * "pickup-in-store"
+        #     * "ship-to-store"
+        #     * "same-day-delivery"
+        #     * "next-day-delivery"
+        #     * "custom-type-1"
+        #     * "custom-type-2"
+        #     * "custom-type-3"
+        #     * "custom-type-4"
+        #     * "custom-type-5"
+        #
+        #     If this field is set to an invalid value other than these, an
+        #     INVALID_ARGUMENT error is returned.
+        #
+        #     All the elements must be distinct. Otherwise, an INVALID_ARGUMENT error is
+        #     returned.
+        class LocalInventory
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # @!attribute [rw] key
+          #   @return [::String]
+          # @!attribute [rw] value
+          #   @return [::Google::Cloud::Retail::V2::CustomAttribute]
+          class AttributesEntry
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
         end
       end
     end