google-cloud-recommendation_engine-v1beta1 0.1.0

data/lib/google/cloud/recommendationengine/v1beta1/prediction_apikey_registry_service_services_pb.rb

@@ -0,0 +1,53 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# Source: google/cloud/recommendationengine/v1beta1/prediction_apikey_registry_service.proto for package 'Google.Cloud.RecommendationEngine.V1beta1'
+# 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/recommendationengine/v1beta1/prediction_apikey_registry_service_pb'
+
+module Google
+  module Cloud
+    module RecommendationEngine
+      module V1beta1
+        module PredictionApiKeyRegistry
+          # Service for registering API keys for use with the `predict` method. If you
+          # use an API key to request predictions, you must first register the API key.
+          # Otherwise, your prediction request is rejected. If you use OAuth to
+          # authenticate your `predict` method call, you do not need to register an API
+          # key. You can register up to 20 API keys per project.
+          class Service
+
+            include GRPC::GenericService
+
+            self.marshal_class_method = :encode
+            self.unmarshal_class_method = :decode
+            self.service_name = 'google.cloud.recommendationengine.v1beta1.PredictionApiKeyRegistry'
+
+            # Register an API key for use with predict method.
+            rpc :CreatePredictionApiKeyRegistration, ::Google::Cloud::RecommendationEngine::V1beta1::CreatePredictionApiKeyRegistrationRequest, ::Google::Cloud::RecommendationEngine::V1beta1::PredictionApiKeyRegistration
+            # List the registered apiKeys for use with predict method.
+            rpc :ListPredictionApiKeyRegistrations, ::Google::Cloud::RecommendationEngine::V1beta1::ListPredictionApiKeyRegistrationsRequest, ::Google::Cloud::RecommendationEngine::V1beta1::ListPredictionApiKeyRegistrationsResponse
+            # Unregister an apiKey from using for predict method.
+            rpc :DeletePredictionApiKeyRegistration, ::Google::Cloud::RecommendationEngine::V1beta1::DeletePredictionApiKeyRegistrationRequest, ::Google::Protobuf::Empty
+          end
+
+          Stub = Service.rpc_stub_class
+        end
+      end
+    end
+  end
+end

data/lib/google/cloud/recommendationengine/v1beta1/prediction_service_pb.rb

@@ -0,0 +1,49 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: google/cloud/recommendationengine/v1beta1/prediction_service.proto
+
+require 'google/protobuf'
+
+require 'google/api/annotations_pb'
+require 'google/api/field_behavior_pb'
+require 'google/api/resource_pb'
+require 'google/cloud/recommendationengine/v1beta1/user_event_pb'
+require 'google/protobuf/struct_pb'
+require 'google/api/client_pb'
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_file("google/cloud/recommendationengine/v1beta1/prediction_service.proto", :syntax => :proto3) do
+    add_message "google.cloud.recommendationengine.v1beta1.PredictRequest" do
+      optional :name, :string, 1
+      optional :user_event, :message, 2, "google.cloud.recommendationengine.v1beta1.UserEvent"
+      optional :page_size, :int32, 7
+      optional :page_token, :string, 8
+      optional :filter, :string, 3
+      optional :dry_run, :bool, 4
+      map :params, :string, :message, 6, "google.protobuf.Value"
+      map :labels, :string, :string, 9
+    end
+    add_message "google.cloud.recommendationengine.v1beta1.PredictResponse" do
+      repeated :results, :message, 1, "google.cloud.recommendationengine.v1beta1.PredictResponse.PredictionResult"
+      optional :recommendation_token, :string, 2
+      repeated :items_missing_in_catalog, :string, 3
+      optional :dry_run, :bool, 4
+      map :metadata, :string, :message, 5, "google.protobuf.Value"
+      optional :next_page_token, :string, 6
+    end
+    add_message "google.cloud.recommendationengine.v1beta1.PredictResponse.PredictionResult" do
+      optional :id, :string, 1
+      map :item_metadata, :string, :message, 2, "google.protobuf.Value"
+    end
+  end
+end
+
+module Google
+  module Cloud
+    module RecommendationEngine
+      module V1beta1
+        PredictRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recommendationengine.v1beta1.PredictRequest").msgclass
+        PredictResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recommendationengine.v1beta1.PredictResponse").msgclass
+        PredictResponse::PredictionResult = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recommendationengine.v1beta1.PredictResponse.PredictionResult").msgclass
+      end
+    end
+  end
+end

data/lib/google/cloud/recommendationengine/v1beta1/prediction_service_services_pb.rb

@@ -0,0 +1,48 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# Source: google/cloud/recommendationengine/v1beta1/prediction_service.proto for package 'Google.Cloud.RecommendationEngine.V1beta1'
+# 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/recommendationengine/v1beta1/prediction_service_pb'
+
+module Google
+  module Cloud
+    module RecommendationEngine
+      module V1beta1
+        module PredictionService
+          # Service for making recommendation prediction.
+          class Service
+
+            include GRPC::GenericService
+
+            self.marshal_class_method = :encode
+            self.unmarshal_class_method = :decode
+            self.service_name = 'google.cloud.recommendationengine.v1beta1.PredictionService'
+
+            # Makes a recommendation prediction. If using API Key based authentication,
+            # the API Key must be registered using the
+            # [PredictionApiKeyRegistry][google.cloud.recommendationengine.v1beta1.PredictionApiKeyRegistry]
+            # service. [Learn more](/recommendations-ai/docs/setting-up#register-key).
+            rpc :Predict, ::Google::Cloud::RecommendationEngine::V1beta1::PredictRequest, ::Google::Cloud::RecommendationEngine::V1beta1::PredictResponse
+          end
+
+          Stub = Service.rpc_stub_class
+        end
+      end
+    end
+  end
+end

data/lib/google/cloud/recommendationengine/v1beta1/recommendationengine_resources_pb.rb

@@ -0,0 +1,19 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: google/cloud/recommendationengine/v1beta1/recommendationengine_resources.proto
+
+require 'google/protobuf'
+
+require 'google/api/resource_pb'
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_file("google/cloud/recommendationengine/v1beta1/recommendationengine_resources.proto", :syntax => :proto3) do
+  end
+end
+
+module Google
+  module Cloud
+    module RecommendationEngine
+      module V1beta1
+      end
+    end
+  end
+end

data/lib/google/cloud/recommendationengine/v1beta1/user_event_pb.rb

@@ -0,0 +1,84 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: google/cloud/recommendationengine/v1beta1/user_event.proto
+
+require 'google/protobuf'
+
+require 'google/api/field_behavior_pb'
+require 'google/cloud/recommendationengine/v1beta1/catalog_pb'
+require 'google/cloud/recommendationengine/v1beta1/common_pb'
+require 'google/protobuf/timestamp_pb'
+require 'google/api/annotations_pb'
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_file("google/cloud/recommendationengine/v1beta1/user_event.proto", :syntax => :proto3) do
+    add_message "google.cloud.recommendationengine.v1beta1.UserEvent" do
+      optional :event_type, :string, 1
+      optional :user_info, :message, 2, "google.cloud.recommendationengine.v1beta1.UserInfo"
+      optional :event_detail, :message, 3, "google.cloud.recommendationengine.v1beta1.EventDetail"
+      optional :product_event_detail, :message, 4, "google.cloud.recommendationengine.v1beta1.ProductEventDetail"
+      optional :event_time, :message, 5, "google.protobuf.Timestamp"
+      optional :event_source, :enum, 6, "google.cloud.recommendationengine.v1beta1.UserEvent.EventSource"
+    end
+    add_enum "google.cloud.recommendationengine.v1beta1.UserEvent.EventSource" do
+      value :EVENT_SOURCE_UNSPECIFIED, 0
+      value :AUTOML, 1
+      value :ECOMMERCE, 2
+      value :BATCH_UPLOAD, 3
+    end
+    add_message "google.cloud.recommendationengine.v1beta1.UserInfo" do
+      optional :visitor_id, :string, 1
+      optional :user_id, :string, 2
+      optional :ip_address, :string, 3
+      optional :user_agent, :string, 4
+      optional :direct_user_request, :bool, 5
+    end
+    add_message "google.cloud.recommendationengine.v1beta1.EventDetail" do
+      optional :uri, :string, 1
+      optional :referrer_uri, :string, 6
+      optional :page_view_id, :string, 2
+      repeated :experiment_ids, :string, 3
+      optional :recommendation_token, :string, 4
+      optional :event_attributes, :message, 5, "google.cloud.recommendationengine.v1beta1.FeatureMap"
+    end
+    add_message "google.cloud.recommendationengine.v1beta1.ProductEventDetail" do
+      optional :search_query, :string, 1
+      repeated :page_categories, :message, 2, "google.cloud.recommendationengine.v1beta1.CatalogItem.CategoryHierarchy"
+      repeated :product_details, :message, 3, "google.cloud.recommendationengine.v1beta1.ProductDetail"
+      optional :list_id, :string, 4
+      optional :cart_id, :string, 5
+      optional :purchase_transaction, :message, 6, "google.cloud.recommendationengine.v1beta1.PurchaseTransaction"
+    end
+    add_message "google.cloud.recommendationengine.v1beta1.PurchaseTransaction" do
+      optional :id, :string, 1
+      optional :revenue, :float, 2
+      map :taxes, :string, :float, 3
+      map :costs, :string, :float, 4
+      optional :currency_code, :string, 6
+    end
+    add_message "google.cloud.recommendationengine.v1beta1.ProductDetail" do
+      optional :id, :string, 1
+      optional :currency_code, :string, 2
+      optional :original_price, :float, 3
+      optional :display_price, :float, 4
+      optional :stock_state, :enum, 5, "google.cloud.recommendationengine.v1beta1.ProductCatalogItem.StockState"
+      optional :quantity, :int32, 6
+      optional :available_quantity, :int32, 7
+      optional :item_attributes, :message, 8, "google.cloud.recommendationengine.v1beta1.FeatureMap"
+    end
+  end
+end
+
+module Google
+  module Cloud
+    module RecommendationEngine
+      module V1beta1
+        UserEvent = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recommendationengine.v1beta1.UserEvent").msgclass
+        UserEvent::EventSource = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recommendationengine.v1beta1.UserEvent.EventSource").enummodule
+        UserInfo = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recommendationengine.v1beta1.UserInfo").msgclass
+        EventDetail = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recommendationengine.v1beta1.EventDetail").msgclass
+        ProductEventDetail = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recommendationengine.v1beta1.ProductEventDetail").msgclass
+        PurchaseTransaction = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recommendationengine.v1beta1.PurchaseTransaction").msgclass
+        ProductDetail = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recommendationengine.v1beta1.ProductDetail").msgclass
+      end
+    end
+  end
+end

data/lib/google/cloud/recommendationengine/v1beta1/user_event_service_pb.rb

@@ -0,0 +1,68 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: google/cloud/recommendationengine/v1beta1/user_event_service.proto
+
+require 'google/protobuf'
+
+require 'google/api/annotations_pb'
+require 'google/api/field_behavior_pb'
+require 'google/api/httpbody_pb'
+require 'google/api/resource_pb'
+require 'google/cloud/recommendationengine/v1beta1/import_pb'
+require 'google/cloud/recommendationengine/v1beta1/user_event_pb'
+require 'google/longrunning/operations_pb'
+require 'google/protobuf/timestamp_pb'
+require 'google/type/date_pb'
+require 'google/api/client_pb'
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_file("google/cloud/recommendationengine/v1beta1/user_event_service.proto", :syntax => :proto3) do
+    add_message "google.cloud.recommendationengine.v1beta1.PurgeUserEventsRequest" do
+      optional :parent, :string, 1
+      optional :filter, :string, 2
+      optional :force, :bool, 3
+    end
+    add_message "google.cloud.recommendationengine.v1beta1.PurgeUserEventsMetadata" do
+      optional :operation_name, :string, 1
+      optional :create_time, :message, 2, "google.protobuf.Timestamp"
+    end
+    add_message "google.cloud.recommendationengine.v1beta1.PurgeUserEventsResponse" do
+      optional :purged_events_count, :int64, 1
+      repeated :user_events_sample, :message, 2, "google.cloud.recommendationengine.v1beta1.UserEvent"
+    end
+    add_message "google.cloud.recommendationengine.v1beta1.WriteUserEventRequest" do
+      optional :parent, :string, 1
+      optional :user_event, :message, 2, "google.cloud.recommendationengine.v1beta1.UserEvent"
+    end
+    add_message "google.cloud.recommendationengine.v1beta1.CollectUserEventRequest" do
+      optional :parent, :string, 1
+      optional :user_event, :string, 2
+      optional :uri, :string, 3
+      optional :ets, :int64, 4
+    end
+    add_message "google.cloud.recommendationengine.v1beta1.ListUserEventsRequest" do
+      optional :parent, :string, 1
+      optional :page_size, :int32, 2
+      optional :page_token, :string, 3
+      optional :filter, :string, 4
+    end
+    add_message "google.cloud.recommendationengine.v1beta1.ListUserEventsResponse" do
+      repeated :user_events, :message, 1, "google.cloud.recommendationengine.v1beta1.UserEvent"
+      optional :next_page_token, :string, 2
+    end
+  end
+end
+
+module Google
+  module Cloud
+    module RecommendationEngine
+      module V1beta1
+        PurgeUserEventsRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recommendationengine.v1beta1.PurgeUserEventsRequest").msgclass
+        PurgeUserEventsMetadata = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recommendationengine.v1beta1.PurgeUserEventsMetadata").msgclass
+        PurgeUserEventsResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recommendationengine.v1beta1.PurgeUserEventsResponse").msgclass
+        WriteUserEventRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recommendationengine.v1beta1.WriteUserEventRequest").msgclass
+        CollectUserEventRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recommendationengine.v1beta1.CollectUserEventRequest").msgclass
+        ListUserEventsRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recommendationengine.v1beta1.ListUserEventsRequest").msgclass
+        ListUserEventsResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.recommendationengine.v1beta1.ListUserEventsResponse").msgclass
+      end
+    end
+  end
+end

data/lib/google/cloud/recommendationengine/v1beta1/user_event_service_services_pb.rb

@@ -0,0 +1,66 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# Source: google/cloud/recommendationengine/v1beta1/user_event_service.proto for package 'Google.Cloud.RecommendationEngine.V1beta1'
+# 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/recommendationengine/v1beta1/user_event_service_pb'
+
+module Google
+  module Cloud
+    module RecommendationEngine
+      module V1beta1
+        module UserEventService
+          # Service for ingesting end user actions on the customer website.
+          class Service
+
+            include GRPC::GenericService
+
+            self.marshal_class_method = :encode
+            self.unmarshal_class_method = :decode
+            self.service_name = 'google.cloud.recommendationengine.v1beta1.UserEventService'
+
+            # Writes a single user event.
+            rpc :WriteUserEvent, ::Google::Cloud::RecommendationEngine::V1beta1::WriteUserEventRequest, ::Google::Cloud::RecommendationEngine::V1beta1::UserEvent
+            # Writes a single user event from the browser. This uses a GET request to
+            # due to browser restriction of POST-ing to a 3rd party domain.
+            #
+            # This method is used only by the Recommendations AI JavaScript pixel.
+            # Users should not call this method directly.
+            rpc :CollectUserEvent, ::Google::Cloud::RecommendationEngine::V1beta1::CollectUserEventRequest, ::Google::Api::HttpBody
+            # Gets a list of user events within a time range, with potential filtering.
+            rpc :ListUserEvents, ::Google::Cloud::RecommendationEngine::V1beta1::ListUserEventsRequest, ::Google::Cloud::RecommendationEngine::V1beta1::ListUserEventsResponse
+            # Deletes permanently all user events specified by the filter provided.
+            # Depending on the number of events specified by the filter, this operation
+            # could take hours or days to complete. To test a filter, use the list
+            # command first.
+            rpc :PurgeUserEvents, ::Google::Cloud::RecommendationEngine::V1beta1::PurgeUserEventsRequest, ::Google::Longrunning::Operation
+            # Bulk import of User events. Request processing might be
+            # synchronous. Events that already exist are skipped.
+            # Use this method for backfilling historical user events.
+            #
+            # Operation.response is of type ImportResponse. Note that it is
+            # possible for a subset of the items to be successfully inserted.
+            # Operation.metadata is of type ImportMetadata.
+            rpc :ImportUserEvents, ::Google::Cloud::RecommendationEngine::V1beta1::ImportUserEventsRequest, ::Google::Longrunning::Operation
+          end
+
+          Stub = Service.rpc_stub_class
+        end
+      end
+    end
+  end
+end

data/proto_docs/README.md

@@ -0,0 +1,4 @@
+# Recommendations AI V1beta1 Protocol Buffer Documentation
+
+These files are for the YARD documentation of the generated protobuf files.
+They are not intended to be required or loaded at runtime.

data/proto_docs/google/api/field_behavior.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+# 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
+#
+#     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 Api
+    # An indicator of the behavior of a given field (for example, that a field
+    # is required in requests, or given as output but ignored as input).
+    # This **does not** change the behavior in protocol buffers itself; it only
+    # denotes the behavior and may affect how API tooling handles the field.
+    #
+    # Note: This enum **may** receive new values in the future.
+    module FieldBehavior
+      # Conventional default for enums. Do not use this.
+      FIELD_BEHAVIOR_UNSPECIFIED = 0
+
+      # Specifically denotes a field as optional.
+      # While all fields in protocol buffers are optional, this may be specified
+      # for emphasis if appropriate.
+      OPTIONAL = 1
+
+      # Denotes a field as required.
+      # This indicates that the field **must** be provided as part of the request,
+      # and failure to do so will cause an error (usually `INVALID_ARGUMENT`).
+      REQUIRED = 2
+
+      # Denotes a field as output only.
+      # This indicates that the field is provided in responses, but including the
+      # field in a request does nothing (the server *must* ignore it and
+      # *must not* throw an error as a result of the field's presence).
+      OUTPUT_ONLY = 3
+
+      # Denotes a field as input only.
+      # This indicates that the field is provided in requests, and the
+      # corresponding field is not included in output.
+      INPUT_ONLY = 4
+
+      # Denotes a field as immutable.
+      # This indicates that the field may be set once in a request to create a
+      # resource, but may not be changed thereafter.
+      IMMUTABLE = 5
+    end
+  end
+end