google-cloud-retail-v2 0.3.2 → 0.4.0

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

@@ -343,7 +343,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

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

@@ -24,6 +24,25 @@ module Google
         module UserEventService
           # Path helper methods for the UserEventService API.
           module Paths
+            ##
+            # Create a fully-qualified Catalog resource string.
+            #
+            # The resource will be in the following format:
+            #
+            # `projects/{project}/locations/{location}/catalogs/{catalog}`
+            #
+            # @param project [String]
+            # @param location [String]
+            # @param catalog [String]
+            #
+            # @return [::String]
+            def catalog_path project:, location:, catalog:
+              raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
+              raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
+
+              "projects/#{project}/locations/#{location}/catalogs/#{catalog}"
+            end
+
             ##
             # Create a fully-qualified Product resource string.
             #

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

@@ -21,7 +21,7 @@ module Google
   module Cloud
     module Retail
       module V2
-        VERSION = "0.3.2"
+        VERSION = "0.4.0"
       end
     end
   end

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

@@ -48,9 +48,9 @@ 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 catalog
-        #     levels](/retail/recommendations-ai/docs/catalog#catalog-levels) for more
-        #     details.
+        #     See [Using product
+        #     levels](https://cloud.google.com/retail/recommendations-ai/docs/catalog#product-levels)
+        #     for more details.
         # @!attribute [rw] merchant_center_product_id_field
         #   @return [::String]
         #     Which field of [Merchant Center
@@ -70,9 +70,9 @@ module Google
         #     {::Google::Cloud::Retail::V2::ProductLevelConfig#ingestion_product_type ingestion_product_type}
         #     is `variant`, an INVALID_ARGUMENT error is returned.
         #
-        #     See [Using catalog
-        #     levels](/retail/recommendations-ai/docs/catalog#catalog-levels) for more
-        #     details.
+        #     See [Using product
+        #     levels](https://cloud.google.com/retail/recommendations-ai/docs/catalog#product-levels)
+        #     for more details.
         class ProductLevelConfig
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods

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

@@ -89,10 +89,7 @@ module Google
         # @!attribute [rw] update_mask
         #   @return [::Google::Protobuf::FieldMask]
         #     Indicates which fields in the provided
-        #     {::Google::Cloud::Retail::V2::Catalog Catalog} to update. If not set, will only
-        #     update the
-        #     {::Google::Cloud::Retail::V2::Catalog#product_level_config Catalog.product_level_config}
-        #     field, which is also the only currently supported field to update.
+        #     {::Google::Cloud::Retail::V2::Catalog Catalog} to update.
         #
         #     If an unsupported or unknown field is provided, an INVALID_ARGUMENT error
         #     is returned.
@@ -100,6 +97,58 @@ module Google
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
+
+        # Request message to set a specified branch as new default_branch.
+        # @!attribute [rw] catalog
+        #   @return [::String]
+        #     Full resource name of the catalog, such as
+        #     `projects/*/locations/global/catalogs/default_catalog`.
+        # @!attribute [rw] branch_id
+        #   @return [::String]
+        #     The final component of the resource name of a branch.
+        #
+        #     This field must be one of "0", "1" or "2". Otherwise, an INVALID_ARGUMENT
+        #     error is returned.
+        # @!attribute [rw] note
+        #   @return [::String]
+        #     Some note on this request, this can be retrieved by
+        #     {::Google::Cloud::Retail::V2::CatalogService::Client#get_default_branch CatalogService.GetDefaultBranch}
+        #     before next valid default branch set occurs.
+        #
+        #     This field must be a UTF-8 encoded string with a length limit of 1,000
+        #     characters. Otherwise, an INVALID_ARGUMENT error is returned.
+        class SetDefaultBranchRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message to show which branch is currently the default branch.
+        # @!attribute [rw] catalog
+        #   @return [::String]
+        #     The parent catalog resource name, such as
+        #     `projects/*/locations/global/catalogs/default_catalog`.
+        class GetDefaultBranchRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Response message of
+        # {::Google::Cloud::Retail::V2::CatalogService::Client#get_default_branch CatalogService.GetDefaultBranch}.
+        # @!attribute [rw] branch
+        #   @return [::String]
+        #     Full resource name of the branch id currently set as default branch.
+        # @!attribute [rw] set_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     The time when this branch is set to default.
+        # @!attribute [rw] note
+        #   @return [::String]
+        #     This corresponds to
+        #     {::Google::Cloud::Retail::V2::SetDefaultBranchRequest#note SetDefaultBranchRequest.note}
+        #     field, when this branch was set as default.
+        class GetDefaultBranchResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
       end
     end
   end