google-cloud-retail-v2 0.3.1 → 0.4.2

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

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+# Copyright 2021 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+require "googleauth"
+
+module Google
+  module Cloud
+    module Retail
+      module V2
+        module SearchService
+          # Credentials for the SearchService API.
+          class Credentials < ::Google::Auth::Credentials
+            self.scope = [
+              "https://www.googleapis.com/auth/cloud-platform"
+            ]
+            self.env_vars = [
+              "RETAIL_CREDENTIALS",
+              "RETAIL_KEYFILE",
+              "GOOGLE_CLOUD_CREDENTIALS",
+              "GOOGLE_CLOUD_KEYFILE",
+              "GCLOUD_KEYFILE",
+              "RETAIL_CREDENTIALS_JSON",
+              "RETAIL_KEYFILE_JSON",
+              "GOOGLE_CLOUD_CREDENTIALS_JSON",
+              "GOOGLE_CLOUD_KEYFILE_JSON",
+              "GCLOUD_KEYFILE_JSON"
+            ]
+            self.paths = [
+              "~/.config/google_cloud/application_default_credentials.json"
+            ]
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+# Copyright 2021 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module Retail
+      module V2
+        module SearchService
+          # Path helper methods for the SearchService API.
+          module Paths
+            ##
+            # Create a fully-qualified Branch resource string.
+            #
+            # The resource will be in the following format:
+            #
+            # `projects/{project}/locations/{location}/catalogs/{catalog}/branches/{branch}`
+            #
+            # @param project [String]
+            # @param location [String]
+            # @param catalog [String]
+            # @param branch [String]
+            #
+            # @return [::String]
+            def branch_path project:, location:, catalog:, branch:
+              raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
+              raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
+              raise ::ArgumentError, "catalog cannot contain /" if catalog.to_s.include? "/"
+
+              "projects/#{project}/locations/#{location}/catalogs/#{catalog}/branches/#{branch}"
+            end
+
+            extend self
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,131 @@
+# 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'
+require 'google/api/resource_pb'
+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'
+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
+      optional :placement, :string, 1
+      optional :branch, :string, 2
+      optional :query, :string, 3
+      optional :visitor_id, :string, 4
+      optional :user_info, :message, 5, "google.cloud.retail.v2.UserInfo"
+      optional :page_size, :int32, 7
+      optional :page_token, :string, 8
+      optional :offset, :int32, 9
+      optional :filter, :string, 10
+      optional :canonical_filter, :string, 28
+      optional :order_by, :string, 11
+      repeated :facet_specs, :message, 12, "google.cloud.retail.v2.SearchRequest.FacetSpec"
+      optional :dynamic_facet_spec, :message, 21, "google.cloud.retail.v2.SearchRequest.DynamicFacetSpec"
+      optional :boost_spec, :message, 13, "google.cloud.retail.v2.SearchRequest.BoostSpec"
+      optional :query_expansion_spec, :message, 14, "google.cloud.retail.v2.SearchRequest.QueryExpansionSpec"
+      repeated :variant_rollup_keys, :string, 17
+      repeated :page_categories, :string, 23
+    end
+    add_message "google.cloud.retail.v2.SearchRequest.FacetSpec" do
+      optional :facet_key, :message, 1, "google.cloud.retail.v2.SearchRequest.FacetSpec.FacetKey"
+      optional :limit, :int32, 2
+      repeated :excluded_filter_keys, :string, 3
+      optional :enable_dynamic_position, :bool, 4
+    end
+    add_message "google.cloud.retail.v2.SearchRequest.FacetSpec.FacetKey" do
+      optional :key, :string, 1
+      repeated :intervals, :message, 2, "google.cloud.retail.v2.Interval"
+      repeated :restricted_values, :string, 3
+      repeated :prefixes, :string, 8
+      repeated :contains, :string, 9
+      optional :order_by, :string, 4
+      optional :query, :string, 5
+    end
+    add_message "google.cloud.retail.v2.SearchRequest.DynamicFacetSpec" do
+      optional :mode, :enum, 1, "google.cloud.retail.v2.SearchRequest.DynamicFacetSpec.Mode"
+    end
+    add_enum "google.cloud.retail.v2.SearchRequest.DynamicFacetSpec.Mode" do
+      value :MODE_UNSPECIFIED, 0
+      value :DISABLED, 1
+      value :ENABLED, 2
+    end
+    add_message "google.cloud.retail.v2.SearchRequest.BoostSpec" do
+      repeated :condition_boost_specs, :message, 1, "google.cloud.retail.v2.SearchRequest.BoostSpec.ConditionBoostSpec"
+    end
+    add_message "google.cloud.retail.v2.SearchRequest.BoostSpec.ConditionBoostSpec" do
+      optional :condition, :string, 1
+      optional :boost, :float, 2
+    end
+    add_message "google.cloud.retail.v2.SearchRequest.QueryExpansionSpec" do
+      optional :condition, :enum, 1, "google.cloud.retail.v2.SearchRequest.QueryExpansionSpec.Condition"
+    end
+    add_enum "google.cloud.retail.v2.SearchRequest.QueryExpansionSpec.Condition" do
+      value :CONDITION_UNSPECIFIED, 0
+      value :DISABLED, 1
+      value :AUTO, 3
+    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"
+      optional :total_size, :int32, 3
+      optional :corrected_query, :string, 4
+      optional :attribution_token, :string, 5
+      optional :next_page_token, :string, 6
+      optional :query_expansion_info, :message, 7, "google.cloud.retail.v2.SearchResponse.QueryExpansionInfo"
+      optional :redirect_uri, :string, 10
+    end
+    add_message "google.cloud.retail.v2.SearchResponse.SearchResult" do
+      optional :id, :string, 1
+      optional :product, :message, 2, "google.cloud.retail.v2.Product"
+      optional :matching_variant_count, :int32, 3
+      map :matching_variant_fields, :string, :message, 4, "google.protobuf.FieldMask"
+      map :variant_rollup_values, :string, :message, 5, "google.protobuf.Value"
+    end
+    add_message "google.cloud.retail.v2.SearchResponse.Facet" do
+      optional :key, :string, 1
+      repeated :values, :message, 2, "google.cloud.retail.v2.SearchResponse.Facet.FacetValue"
+      optional :dynamic_facet, :bool, 3
+    end
+    add_message "google.cloud.retail.v2.SearchResponse.Facet.FacetValue" do
+      optional :count, :int64, 3
+      oneof :facet_value do
+        optional :value, :string, 1
+        optional :interval, :message, 2, "google.cloud.retail.v2.Interval"
+      end
+    end
+    add_message "google.cloud.retail.v2.SearchResponse.QueryExpansionInfo" do
+      optional :expanded_query, :bool, 1
+    end
+  end
+end
+
+module Google
+  module Cloud
+    module Retail
+      module V2
+        SearchRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.SearchRequest").msgclass
+        SearchRequest::FacetSpec = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.SearchRequest.FacetSpec").msgclass
+        SearchRequest::FacetSpec::FacetKey = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.SearchRequest.FacetSpec.FacetKey").msgclass
+        SearchRequest::DynamicFacetSpec = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.SearchRequest.DynamicFacetSpec").msgclass
+        SearchRequest::DynamicFacetSpec::Mode = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.SearchRequest.DynamicFacetSpec.Mode").enummodule
+        SearchRequest::BoostSpec = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.SearchRequest.BoostSpec").msgclass
+        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
+        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
+        SearchResponse::Facet::FacetValue = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.SearchResponse.Facet.FacetValue").msgclass
+        SearchResponse::QueryExpansionInfo = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.SearchResponse.QueryExpansionInfo").msgclass
+      end
+    end
+  end
+end

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

@@ -0,0 +1,53 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# Source: google/cloud/retail/v2/search_service.proto for package 'Google.Cloud.Retail.V2'
+# Original file comments:
+# Copyright 2020 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'grpc'
+require 'google/cloud/retail/v2/search_service_pb'
+
+module Google
+  module Cloud
+    module Retail
+      module V2
+        module SearchService
+          # Service for search.
+          #
+          # This feature is only available for users who have Retail Search enabled.
+          # Contact Retail Support (retail-search-support@google.com) if you are
+          # interested in using Retail Search.
+          class Service
+
+            include GRPC::GenericService
+
+            self.marshal_class_method = :encode
+            self.unmarshal_class_method = :decode
+            self.service_name = 'google.cloud.retail.v2.SearchService'
+
+            # Performs a search.
+            #
+            # This feature is only available for users who have Retail Search enabled.
+            # Contact Retail Support (retail-search-support@google.com) if you are
+            # interested in using Retail Search.
+            rpc :Search, ::Google::Cloud::Retail::V2::SearchRequest, ::Google::Cloud::Retail::V2::SearchResponse
+          end
+
+          Stub = Service.rpc_stub_class
+        end
+      end
+    end
+  end
+end

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

@@ -14,14 +14,19 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
     add_message "google.cloud.retail.v2.UserEvent" do
       optional :event_type, :string, 1
       optional :visitor_id, :string, 2
+      optional :session_id, :string, 21
       optional :event_time, :message, 3, "google.protobuf.Timestamp"
       repeated :experiment_ids, :string, 4
       optional :attribution_token, :string, 5
       repeated :product_details, :message, 6, "google.cloud.retail.v2.ProductDetail"
+      optional :completion_detail, :message, 22, "google.cloud.retail.v2.CompletionDetail"
       map :attributes, :string, :message, 7, "google.cloud.retail.v2.CustomAttribute"
       optional :cart_id, :string, 8
       optional :purchase_transaction, :message, 9, "google.cloud.retail.v2.PurchaseTransaction"
       optional :search_query, :string, 10
+      optional :filter, :string, 16
+      optional :order_by, :string, 17
+      optional :offset, :int32, 18
       repeated :page_categories, :string, 11
       optional :user_info, :message, 12, "google.cloud.retail.v2.UserInfo"
       optional :uri, :string, 13
@@ -32,6 +37,11 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       optional :product, :message, 1, "google.cloud.retail.v2.Product"
       optional :quantity, :message, 2, "google.protobuf.Int32Value"
     end
+    add_message "google.cloud.retail.v2.CompletionDetail" do
+      optional :completion_attribution_token, :string, 1
+      optional :selected_suggestion, :string, 2
+      optional :selected_position, :int32, 3
+    end
     add_message "google.cloud.retail.v2.PurchaseTransaction" do
       optional :id, :string, 1
       optional :revenue, :float, 2
@@ -48,6 +58,7 @@ module Google
       module V2
         UserEvent = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.UserEvent").msgclass
         ProductDetail = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.ProductDetail").msgclass
+        CompletionDetail = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.CompletionDetail").msgclass
         PurchaseTransaction = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.PurchaseTransaction").msgclass
       end
     end

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

@@ -41,13 +41,12 @@ module Google
             # See {::Google::Cloud::Retail::V2::UserEventService::Client::Configuration}
             # for a description of the configuration fields.
             #
-            # ## Example
+            # @example
             #
-            # To modify the configuration for all UserEventService clients:
-            #
-            #     ::Google::Cloud::Retail::V2::UserEventService::Client.configure do |config|
-            #       config.timeout = 10.0
-            #     end
+            #   # Modify the configuration for all UserEventService clients
+            #   ::Google::Cloud::Retail::V2::UserEventService::Client.configure do |config|
+            #     config.timeout = 10.0
+            #   end
             #
             # @yield [config] Configure the Client client.
             # @yieldparam config [Client::Configuration]
@@ -67,10 +66,7 @@ module Google
 
                 default_config.timeout = 60.0
                 default_config.retry_policy = {
-                  initial_delay: 0.1,
-                max_delay: 60.0,
-                multiplier: 1.3,
-                retry_codes: [14, 4]
+                  initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
                 }
 
                 default_config
@@ -102,19 +98,15 @@ module Google
             ##
             # Create a new UserEventService client object.
             #
-            # ## Examples
-            #
-            # To create a new UserEventService client with the default
-            # configuration:
-            #
-            #     client = ::Google::Cloud::Retail::V2::UserEventService::Client.new
+            # @example
             #
-            # To create a new UserEventService client with a custom
-            # configuration:
+            #   # Create a client using the default configuration
+            #   client = ::Google::Cloud::Retail::V2::UserEventService::Client.new
             #
-            #     client = ::Google::Cloud::Retail::V2::UserEventService::Client.new do |config|
-            #       config.timeout = 10.0
-            #     end
+            #   # Create a client using a custom configuration
+            #   client = ::Google::Cloud::Retail::V2::UserEventService::Client.new do |config|
+            #     config.timeout = 10.0
+            #   end
             #
             # @yield [config] Configure the UserEventService client.
             # @yieldparam config [Client::Configuration]
@@ -134,14 +126,13 @@ module Google
 
               # Create credentials
               credentials = @config.credentials
-              # Use self-signed JWT if the scope and endpoint are unchanged from default,
+              # Use self-signed JWT if the endpoint is unchanged from default,
               # but only if the default endpoint does not have a region prefix.
-              enable_self_signed_jwt = @config.scope == Client.configure.scope &&
-                                       @config.endpoint == Client.configure.endpoint &&
+              enable_self_signed_jwt = @config.endpoint == Client.configure.endpoint &&
                                        !@config.endpoint.split(".").first.include?("-")
               credentials ||= Credentials.default scope: @config.scope,
                                                   enable_self_signed_jwt: enable_self_signed_jwt
-              if credentials.is_a?(String) || credentials.is_a?(Hash)
+              if credentials.is_a?(::String) || credentials.is_a?(::Hash)
                 credentials = Credentials.new credentials, scope: @config.scope
               end
               @quota_project_id = @config.quota_project
@@ -228,7 +219,9 @@ module Google
               options.apply_defaults timeout:      @config.rpcs.write_user_event.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.write_user_event.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @user_event_service_stub.call_rpc :write_user_event, request, options: options do |response, operation|
@@ -311,7 +304,9 @@ module Google
               options.apply_defaults timeout:      @config.rpcs.collect_user_event.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.collect_user_event.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @user_event_service_stub.call_rpc :collect_user_event, request, options: options do |response, operation|
@@ -346,7 +341,7 @@ module Google
             #   @param parent [::String]
             #     Required. The resource name of the catalog under which the events are
             #     created. The format is
-            #     "projects/$\\{projectId}/locations/global/catalogs/$\\{catalogId}"
+            #     `projects/${projectId}/locations/global/catalogs/${catalogId}`
             #   @param filter [::String]
             #     Required. The filter string to specify the events to be deleted with a
             #     length limit of 5,000 characters. Empty string filter is not allowed. The
@@ -410,7 +405,9 @@ module Google
               options.apply_defaults timeout:      @config.rpcs.purge_user_events.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.purge_user_events.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @user_event_service_stub.call_rpc :purge_user_events, request, options: options do |response, operation|
@@ -488,7 +485,9 @@ module Google
               options.apply_defaults timeout:      @config.rpcs.import_user_events.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.import_user_events.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @user_event_service_stub.call_rpc :import_user_events, request, options: options do |response, operation|
@@ -567,7 +566,9 @@ module Google
               options.apply_defaults timeout:      @config.rpcs.rejoin_user_events.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.rejoin_user_events.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @user_event_service_stub.call_rpc :rejoin_user_events, request, options: options do |response, operation|
@@ -592,22 +593,21 @@ module Google
             # Configuration can be applied globally to all clients, or to a single client
             # on construction.
             #
-            # # Examples
-            #
-            # To modify the global config, setting the timeout for write_user_event
-            # to 20 seconds, and all remaining timeouts to 10 seconds:
-            #
-            #     ::Google::Cloud::Retail::V2::UserEventService::Client.configure do |config|
-            #       config.timeout = 10.0
-            #       config.rpcs.write_user_event.timeout = 20.0
-            #     end
-            #
-            # To apply the above configuration only to a new client:
-            #
-            #     client = ::Google::Cloud::Retail::V2::UserEventService::Client.new do |config|
-            #       config.timeout = 10.0
-            #       config.rpcs.write_user_event.timeout = 20.0
-            #     end
+            # @example
+            #
+            #   # Modify the global config, setting the timeout for
+            #   # write_user_event to 20 seconds,
+            #   # and all remaining timeouts to 10 seconds.
+            #   ::Google::Cloud::Retail::V2::UserEventService::Client.configure do |config|
+            #     config.timeout = 10.0
+            #     config.rpcs.write_user_event.timeout = 20.0
+            #   end
+            #
+            #   # Apply the above configuration only to a new client.
+            #   client = ::Google::Cloud::Retail::V2::UserEventService::Client.new do |config|
+            #     config.timeout = 10.0
+            #     config.rpcs.write_user_event.timeout = 20.0
+            #   end
             #
             # @!attribute [rw] endpoint
             #   The hostname or hostname:port of the service endpoint.