google-cloud-retail-v2 0.6.4 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e5a649dac660528f0cc6df350433fadbebeb4667b242626fcc0132c9f0991764
-  data.tar.gz: 7eeb345615247cc8d5615e82fc552e33da8e97dfce7de9a86a178ce4eb6bdca9
+  metadata.gz: f199a731870887e4a82c0ed6e57baa1b0053c16ae645de55956210981675e9e0
+  data.tar.gz: 97989b41ed188ee4457af6bbede9fb0cfcdcb567d7704d2d24df474cdd9fe7b7
 SHA512:
-  metadata.gz: c7c62e299e7df843e466cbec3e49396114c482470af10c9c7b2af946711f7e3d48cf260e7f99583299609da6af3d84cc5750a8c56105f35c733f02ebe8f53219
-  data.tar.gz: 8d9424d295d578b88ab237281ae148794a12460ce96d8a5ed996c69c442414ab3849ba312967f15ebed17ea5d923ca159952b8eb9be7169dad7f52e5ea160e59
+  metadata.gz: 9d6d6b0b4810c7f0745417563ca640bec1921bd4dc1ad6a9e5d5c56c0f87b7d218a29f31b4a7014ba722de9637de11efaa6231618e5c3dc579739df27cbc63ce
+  data.tar.gz: d8db9acbb06dd6a91c5a39ba0bb6be1057f44bb5c4299c8e9c4f68e9bd1489429881ac987371e556ae8d259b0e4d93ecb29eef43510d2d68d13419936d3c1bee

data/README.md

@@ -37,7 +37,7 @@ request = ::Google::Cloud::Retail::V2::ListCatalogsRequest.new # (request fields
 response = client.list_catalogs request
 ```
 
-View the [Client Library Documentation](https://googleapis.dev/ruby/google-cloud-retail-v2/latest)
+View the [Client Library Documentation](https://cloud.google.com/ruby/docs/reference/google-cloud-retail-v2/latest)
 for class and method documentation.
 
 See also the [Product Documentation](https://cloud.google.com/retail/docs/apis)
@@ -69,16 +69,21 @@ module GRPC
 end
 ```
 
+
+## Google Cloud Samples
+
+To browse ready to use code samples check [Google Cloud Samples](https://cloud.google.com/docs/samples).
+
 ## Supported Ruby Versions
 
-This library is supported on Ruby 2.5+.
+This library is supported on Ruby 2.6+.
 
 Google provides official support for Ruby versions that are actively supported
 by Ruby Core—that is, Ruby versions that are either in normal maintenance or
-in security maintenance, and not end of life. Currently, this means Ruby 2.5
-and later. Older versions of Ruby _may_ still work, but are unsupported and not
-recommended. See https://www.ruby-lang.org/en/downloads/branches/ for details
-about the Ruby support schedule.
+in security maintenance, and not end of life. Older versions of Ruby _may_
+still work, but are unsupported and not recommended. See
+https://www.ruby-lang.org/en/downloads/branches/ for details about the Ruby
+support schedule.
 
 ## Which client should I use?
 

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

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

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

@@ -397,10 +397,6 @@ module Google
             # * UserEventService will only join events with products from branch
             #   \\{newBranch}.
             #
-            # 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.
-            #
             # @overload set_default_branch(request, options = nil)
             #   Pass arguments to `set_default_branch` via a request object, either of type
             #   {::Google::Cloud::Retail::V2::SetDefaultBranchRequest} or an equivalent Hash.
@@ -411,7 +407,7 @@ module Google
             #   @param options [::Gapic::CallOptions, ::Hash]
             #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
             #
-            # @overload set_default_branch(catalog: nil, branch_id: nil, note: nil)
+            # @overload set_default_branch(catalog: nil, branch_id: nil, note: nil, force: nil)
             #   Pass arguments to `set_default_branch` 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).
@@ -424,6 +420,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.
             #   @param note [::String]
             #     Some note on this request, this can be retrieved by
             #     {::Google::Cloud::Retail::V2::CatalogService::Client#get_default_branch CatalogService.GetDefaultBranch}
@@ -431,6 +431,10 @@ 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.
+            #   @param force [::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.
             #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [::Google::Protobuf::Empty]
@@ -501,10 +505,6 @@ module Google
             # {::Google::Cloud::Retail::V2::CatalogService::Client#set_default_branch CatalogService.SetDefaultBranch}
             # method under a specified parent catalog.
             #
-            # 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.
-            #
             # @overload get_default_branch(request, options = nil)
             #   Pass arguments to `get_default_branch` via a request object, either of type
             #   {::Google::Cloud::Retail::V2::GetDefaultBranchRequest} or an equivalent Hash.

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

@@ -1,6 +1,8 @@
 # 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'
@@ -9,7 +11,6 @@ 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
@@ -30,6 +31,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       optional :catalog, :string, 1
       optional :branch_id, :string, 2
       optional :note, :string, 3
+      optional :force, :bool, 4
     end
     add_message "google.cloud.retail.v2.GetDefaultBranchRequest" do
       optional :catalog, :string, 1

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

@@ -71,18 +71,10 @@ module Google
             #   (if branch is not explicitly set).
             # * UserEventService will only join events with products from branch
             #   {newBranch}.
-            #
-            # 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.
             rpc :SetDefaultBranch, ::Google::Cloud::Retail::V2::SetDefaultBranchRequest, ::Google::Protobuf::Empty
             # Get which branch is currently default branch set by
             # [CatalogService.SetDefaultBranch][google.cloud.retail.v2.CatalogService.SetDefaultBranch]
             # method under a specified parent catalog.
-            #
-            # 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.
             rpc :GetDefaultBranch, ::Google::Cloud::Retail::V2::GetDefaultBranchRequest, ::Google::Cloud::Retail::V2::GetDefaultBranchResponse
           end
 

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

@@ -1,10 +1,10 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/cloud/retail/v2/common.proto
 
-require 'google/api/annotations_pb'
+require 'google/protobuf'
+
 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
@@ -65,8 +65,11 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       optional :user_agent, :string, 3
       optional :direct_user_request, :bool, 4
     end
-    add_message "google.cloud.retail.v2.Promotion" do
-      optional :promotion_id, :string, 1
+    add_message "google.cloud.retail.v2.LocalInventory" do
+      optional :place_id, :string, 1
+      optional :price_info, :message, 2, "google.cloud.retail.v2.PriceInfo"
+      map :attributes, :string, :message, 3, "google.cloud.retail.v2.CustomAttribute"
+      repeated :fulfillment_types, :string, 4
     end
   end
 end
@@ -85,7 +88,7 @@ module Google
         PriceInfo::PriceRange = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.PriceInfo.PriceRange").msgclass
         Rating = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.Rating").msgclass
         UserInfo = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.UserInfo").msgclass
-        Promotion = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.Promotion").msgclass
+        LocalInventory = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.LocalInventory").msgclass
       end
     end
   end

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

@@ -30,8 +30,7 @@ module Google
           # Auto-completion service for retail.
           #
           # 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
@@ -170,8 +169,7 @@ module Google
             # Completes the specified prefix with keyword suggestions.
             #
             # 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 complete_query(request, options = nil)
             #   Pass arguments to `complete_query` via a request object, either of type
@@ -198,21 +196,20 @@ module Google
             #
             #     The maximum number of allowed characters is 255.
             #   @param visitor_id [::String]
-            #     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.
+            #     Required field. 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.
             #
             #     The field must be a UTF-8 encoded string with a length limit of 128
             #     characters. Otherwise, an INVALID_ARGUMENT error is returned.
             #   @param language_codes [::Array<::String>]
-            #     The list of languages of the query. This is
-            #     the BCP-47 language code, such as "en-US" or "sr-Latn".
-            #     For more information, see
-            #     [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47).
-            #
-            #     The maximum number of allowed characters is 255.
-            #     Only "en-US" is currently supported.
+            #     The language filters applied to the output suggestions. If set, it should
+            #     contain the language of the query. If not set, suggestions are returned
+            #     without considering language restrictions. This is the BCP-47 language
+            #     code, such as "en-US" or "sr-Latn". For more information, see [Tags for
+            #     Identifying Languages](https://tools.ietf.org/html/bcp47). The maximum
+            #     number of language codes is 3.
             #   @param device_type [::String]
             #     The device type context for completion suggestions.
             #     It is useful to apply different suggestions on different device types, e.g.
@@ -239,9 +236,9 @@ module Google
             #
             #     * user-data
             #
-            #     * cloud-retail
-            #       This option requires additional allowlisting. Before using cloud-retail,
-            #       contact Cloud Retail support team first.
+            #     * cloud-retail:
+            #       This option requires enabling auto-learning function first. See
+            #       [guidelines](https://cloud.google.com/retail/docs/completion-overview#generated-completion-dataset).
             #   @param max_suggestions [::Integer]
             #     Completion max suggestions. If left unset or set to 0, then will fallback
             #     to the configured value [CompletionConfig.max_suggestions][].
@@ -316,11 +313,13 @@ module Google
             ##
             # Bulk import of processed completion dataset.
             #
-            # Request processing may be synchronous. Partial updating is not supported.
+            # Request processing is asynchronous. Partial updating is not supported.
+            #
+            # The operation is successfully finished only after the imported suggestions
+            # are indexed successfully and ready for serving. The process takes hours.
             #
             # 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 import_completion_data(request, options = nil)
             #   Pass arguments to `import_completion_data` via a request object, either of type

data/lib/google/cloud/retail/v2/completion_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/completion_service.rb

@@ -35,8 +35,7 @@ module Google
         # Auto-completion service for retail.
         #
         # 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/completion_service_pb.rb

@@ -1,6 +1,8 @@
 # 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'
@@ -8,7 +10,6 @@ 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

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

@@ -27,8 +27,7 @@ module Google
           # Auto-completion service for retail.
           #
           # 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,16 +39,17 @@ module Google
             # Completes the specified prefix with keyword suggestions.
             #
             # 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 :CompleteQuery, ::Google::Cloud::Retail::V2::CompleteQueryRequest, ::Google::Cloud::Retail::V2::CompleteQueryResponse
             # Bulk import of processed completion dataset.
             #
-            # Request processing may be synchronous. Partial updating is not supported.
+            # Request processing is asynchronous. Partial updating is not supported.
+            #
+            # The operation is successfully finished only after the imported suggestions
+            # are indexed successfully and ready for serving. The process takes hours.
             #
             # 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 :ImportCompletionData, ::Google::Cloud::Retail::V2::ImportCompletionDataRequest, ::Google::Longrunning::Operation
           end
 

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

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

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

@@ -182,6 +182,16 @@ module Google
             #     they took to trigger the predict request. Note that this user event detail
             #     won't be ingested to userEvent logs. Thus, a separate userEvent write
             #     request is required for event logging.
+            #
+            #     Don't set
+            #     {::Google::Cloud::Retail::V2::UserEvent#visitor_id UserEvent.visitor_id} or
+            #     {::Google::Cloud::Retail::V2::UserInfo#user_id UserInfo.user_id} to the same
+            #     fixed ID for different users. If you are trying to receive non-personalized
+            #     recommendations (not recommended; this can negatively impact model
+            #     performance), instead set
+            #     {::Google::Cloud::Retail::V2::UserEvent#visitor_id UserEvent.visitor_id} to a
+            #     random unique ID and leave
+            #     {::Google::Cloud::Retail::V2::UserInfo#user_id UserInfo.user_id} unset.
             #   @param page_size [::Integer]
             #     Maximum number of results to return per page. Set this property
             #     to the number of prediction results needed. If zero, the service will
@@ -213,9 +223,12 @@ module Google
             #      * filterOutOfStockItems  tag=(-"promotional")
             #      * filterOutOfStockItems
             #
-            #     If your filter blocks all prediction results, nothing will be returned. If
-            #     you want generic (unfiltered) popular products to be returned instead, set
-            #     `strictFiltering` to false in `PredictRequest.params`.
+            #     If your filter blocks all prediction results, the API will return generic
+            #     (unfiltered) popular products. If you only want results strictly matching
+            #     the filters, set `strictFiltering` to True in `PredictRequest.params` to
+            #     receive empty results instead.
+            #     Note that the API will never return items with storageStatus of "EXPIRED"
+            #     or "DELETED" regardless of filter choices.
             #   @param validate_only [::Boolean]
             #     Use validate only mode for this prediction query. If set to true, a
             #     dummy model will be used that returns arbitrary products.
@@ -253,7 +266,7 @@ module Google
             #     * 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
+            #       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

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

@@ -1,12 +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

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

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