google-cloud-retail-v2 0.1.0

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

@@ -0,0 +1,117 @@
+# 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
+        # Request message for [CreateProduct][] method.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The parent catalog resource name, such as
+        #     "projects/*/locations/global/catalogs/default_catalog/branches/default_branch".
+        # @!attribute [rw] product
+        #   @return [::Google::Cloud::Retail::V2::Product]
+        #     Required. The {::Google::Cloud::Retail::V2::Product Product} to create.
+        # @!attribute [rw] product_id
+        #   @return [::String]
+        #     Required. The ID to use for the {::Google::Cloud::Retail::V2::Product Product},
+        #     which will become the final component of the
+        #     {::Google::Cloud::Retail::V2::Product#name Product.name}.
+        #
+        #     If the caller does not have permission to create the
+        #     {::Google::Cloud::Retail::V2::Product Product}, regardless of whether or not it
+        #     exists, a PERMISSION_DENIED error is returned.
+        #
+        #     This field must be unique among all
+        #     {::Google::Cloud::Retail::V2::Product Product}s with the same
+        #     {::Google::Cloud::Retail::V2::CreateProductRequest#parent parent}. Otherwise, an
+        #     ALREADY_EXISTS error is returned.
+        #
+        #     This field must be a UTF-8 encoded string with a length limit of 128
+        #     characters. Otherwise, an INVALID_ARGUMENT error is returned.
+        class CreateProductRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for [GetProduct][] method.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. Full resource name of {::Google::Cloud::Retail::V2::Product Product},
+        #     such as
+        #     "projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/some_product_id".
+        #
+        #     If the caller does not have permission to access the
+        #     {::Google::Cloud::Retail::V2::Product Product}, regardless of whether or not it
+        #     exists, a PERMISSION_DENIED error is returned.
+        #
+        #     If the requested {::Google::Cloud::Retail::V2::Product Product} does not exist,
+        #     a NOT_FOUND error is returned.
+        class GetProductRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for [UpdateProduct][] method.
+        # @!attribute [rw] product
+        #   @return [::Google::Cloud::Retail::V2::Product]
+        #     Required. The product to update/create.
+        #
+        #     If the caller does not have permission to update the
+        #     {::Google::Cloud::Retail::V2::Product Product}, regardless of whether or not it
+        #     exists, a PERMISSION_DENIED error is returned.
+        #
+        #     If the {::Google::Cloud::Retail::V2::Product Product} to update does not exist,
+        #     a NOT_FOUND error is returned.
+        # @!attribute [rw] update_mask
+        #   @return [::Google::Protobuf::FieldMask]
+        #     Indicates which fields in the provided
+        #     {::Google::Cloud::Retail::V2::Product Product} to update. The immutable and
+        #     output only fields are NOT supported. If not set, all supported fields (the
+        #     fields that are neither immutable nor output only) are updated.
+        #
+        #     If an unsupported or unknown field is provided, an INVALID_ARGUMENT error
+        #     is returned.
+        class UpdateProductRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for [DeleteProduct][] method.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. Full resource name of {::Google::Cloud::Retail::V2::Product Product},
+        #     such as
+        #     "projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/some_product_id".
+        #
+        #     If the caller does not have permission to delete the
+        #     {::Google::Cloud::Retail::V2::Product Product}, regardless of whether or not it
+        #     exists, a PERMISSION_DENIED error is returned.
+        #
+        #     If the {::Google::Cloud::Retail::V2::Product Product} to delete does not exist,
+        #     a NOT_FOUND error is returned.
+        class DeleteProductRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,85 @@
+# 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
+        # Metadata related to the progress of the Purge operation.
+        # This will be returned by the google.longrunning.Operation.metadata field.
+        class PurgeMetadata
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for PurgeUserEvents method.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The resource name of the catalog under which the events are
+        #     created. The format is
+        #     "projects/$\\{projectId}/locations/global/catalogs/$\\{catalogId}"
+        # @!attribute [rw] filter
+        #   @return [::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
+        #     eligible fields for filtering are:
+        #
+        #     * `eventType`: Double quoted
+        #     {::Google::Cloud::Retail::V2::UserEvent#event_type UserEvent.event_type} string.
+        #     * `eventTime`: in ISO 8601 "zulu" format.
+        #     * `visitorId`: Double quoted string. Specifying this will delete all
+        #       events associated with a visitor.
+        #     * `userId`: Double quoted string. Specifying this will delete all events
+        #       associated with a user.
+        #
+        #     Examples:
+        #
+        #     * Deleting all events in a time range:
+        #       `eventTime > "2012-04-23T18:25:43.511Z"
+        #       eventTime < "2012-04-23T18:30:43.511Z"`
+        #     * Deleting specific eventType in time range:
+        #       `eventTime > "2012-04-23T18:25:43.511Z" eventType = "detail-page-view"`
+        #     * Deleting all events for a specific visitor:
+        #       `visitorId = "visitor1024"`
+        #
+        #     The filtering fields are assumed to have an implicit AND.
+        # @!attribute [rw] force
+        #   @return [::Boolean]
+        #     Actually perform the purge.
+        #     If `force` is set to false, the method will return the expected purge count
+        #     without deleting any user events.
+        class PurgeUserEventsRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Response of the PurgeUserEventsRequest. If the long running operation is
+        # successfully done, then this message is returned by the
+        # google.longrunning.Operations.response field.
+        # @!attribute [rw] purged_events_count
+        #   @return [::Integer]
+        #     The total count of events purged as a result of the operation.
+        class PurgeUserEventsResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,238 @@
+# 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
+        # UserEvent captures all metadata information Retail API needs to know about
+        # how end users interact with customers' website.
+        # @!attribute [rw] event_type
+        #   @return [::String]
+        #     Required. User event type. Allowed values are:
+        #
+        #     * `add-to-cart`: Products being added to cart.
+        #     * `category-page-view`: Special pages such as sale or promotion pages
+        #       viewed.
+        #     * `detail-page-view`: Products detail page viewed.
+        #     * `home-page-view`: Homepage viewed.
+        #     * `purchase-complete`: User finishing a purchase.
+        #     * `search`: Product search.
+        #     * `shopping-cart-page-view`: User viewing a shopping cart.
+        # @!attribute [rw] visitor_id
+        #   @return [::String]
+        #     Required. A unique identifier for tracking visitors.
+        #
+        #     For example, this could be implemented with an HTTP cookie, which should be
+        #     able to uniquely identify a visitor on a single device. This unique
+        #     identifier should not change if the visitor log in/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.
+        # @!attribute [rw] event_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Only required for
+        #     {::Google::Cloud::Retail::V2::UserEventService::Client#import_user_events UserEventService.ImportUserEvents}
+        #     method. Timestamp of when the user event happened.
+        # @!attribute [rw] experiment_ids
+        #   @return [::Array<::String>]
+        #     A list of identifiers for the independent experiment groups this user event
+        #     belongs to. This is used to distinguish between user events associated with
+        #     different experiment setups (e.g. using Retail API, using different
+        #     recommendation models).
+        # @!attribute [rw] attribution_token
+        #   @return [::String]
+        #     Highly recommended for user events that are the result of
+        #     {::Google::Cloud::Retail::V2::PredictionService::Client#predict PredictionService.Predict}.
+        #     This field enables accurate attribution of recommendation model
+        #     performance.
+        #
+        #     The value must be a valid
+        #     {::Google::Cloud::Retail::V2::PredictResponse#attribution_token PredictResponse.attribution_token}
+        #     for user events that are the result of
+        #     {::Google::Cloud::Retail::V2::PredictionService::Client#predict PredictionService.Predict}.
+        #
+        #     This token enables us to accurately attribute page view or purchase back to
+        #     the event and the particular predict response containing this
+        #     clicked/purchased product. If user clicks on product K in the
+        #     recommendation results, pass
+        #     {::Google::Cloud::Retail::V2::PredictResponse#attribution_token PredictResponse.attribution_token}
+        #     as a URL parameter to product K's page. When recording events on product
+        #     K's page, log the
+        #     {::Google::Cloud::Retail::V2::PredictResponse#attribution_token PredictResponse.attribution_token}
+        #     to this field.
+        # @!attribute [rw] product_details
+        #   @return [::Array<::Google::Cloud::Retail::V2::ProductDetail>]
+        #     The main product details related to the event.
+        #
+        #     This field is required for the following event types:
+        #
+        #     * `add-to-cart`
+        #     * `detail-page-view`
+        #     * `purchase-complete`
+        #
+        #     In a `search` event, this field represents the products returned to the end
+        #     user on the current page (the end user may have not finished broswing the
+        #     whole page yet). When a new page is returned to the end user, after
+        #     pagination/filtering/ordering even for the same query, a new `search` event
+        #     with different
+        #     {::Google::Cloud::Retail::V2::UserEvent#product_details product_details} is
+        #     desired. The end user may have not finished broswing the whole page yet.
+        # @!attribute [rw] attributes
+        #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::Retail::V2::CustomAttribute}]
+        #     Extra user event features to include in the recommendation model.
+        #
+        #     The key must be a UTF-8 encoded string with a length limit of 5,000
+        #     characters. Otherwise, an INVALID_ARGUMENT error is returned.
+        #
+        #     For product recommendation, an example of extra user information is
+        #     traffic_channel, i.e. how user arrives at the site. Users can arrive
+        #     at the site by coming to the site directly, or coming through Google
+        #     search, and etc.
+        # @!attribute [rw] cart_id
+        #   @return [::String]
+        #     The id or name of the associated shopping cart. This id is used
+        #     to associate multiple items added or present in the cart before purchase.
+        #
+        #     This can only be set for `add-to-cart`, `purchase-complete`, or
+        #     `shopping-cart-page-view` events.
+        # @!attribute [rw] purchase_transaction
+        #   @return [::Google::Cloud::Retail::V2::PurchaseTransaction]
+        #     A transaction represents the entire purchase transaction.
+        #
+        #     Required for `purchase-complete` events. Other event types should not set
+        #     this field. Otherwise, an INVALID_ARGUMENT error is returned.
+        # @!attribute [rw] search_query
+        #   @return [::String]
+        #     The user's search query.
+        #
+        #     The value must be a UTF-8 encoded string with a length limit of 5,000
+        #     characters. Otherwise, an INVALID_ARGUMENT error is returned.
+        #
+        #     Required for `search` events. Other event types should not set this field.
+        #     Otherwise, an INVALID_ARGUMENT error is returned.
+        # @!attribute [rw] page_categories
+        #   @return [::Array<::String>]
+        #     The categories associated with a category page.
+        #
+        #     To represent full path of category, use '>' sign to separate different
+        #     hierarchies. If '>' is part of the category name, please replace it with
+        #     other character(s).
+        #
+        #     Category pages include special pages such as sales or promotions. For
+        #     instance, a special sale page may have the category hierarchy:
+        #     "pageCategories" : ["Sales > 2017 Black Friday Deals"].
+        #
+        #     Required for `category-page-view` events. Other event types should not set
+        #     this field. Otherwise, an INVALID_ARGUMENT error is returned.
+        # @!attribute [rw] user_info
+        #   @return [::Google::Cloud::Retail::V2::UserInfo]
+        #     User information.
+        # @!attribute [rw] uri
+        #   @return [::String]
+        #     Complete URL (window.location.href) of the user's current page.
+        #
+        #     When using the client side event reporting with JavaScript pixel and Google
+        #     Tag Manager, this value is filled in automatically. Maximum length 5,000
+        #     characters.
+        # @!attribute [rw] referrer_uri
+        #   @return [::String]
+        #     The referrer URL of the current page.
+        #
+        #     When using the client side event reporting with JavaScript pixel and Google
+        #     Tag Manager, this value is filled in automatically.
+        # @!attribute [rw] page_view_id
+        #   @return [::String]
+        #     A unique id of a web page view.
+        #
+        #     This should be kept the same for all user events triggered from the same
+        #     pageview. For example, an item detail page view could trigger multiple
+        #     events as the user is browsing the page. The `pageViewId` property should
+        #     be kept the same for all these events so that they can be grouped together
+        #     properly.
+        #
+        #     When using the client side event reporting with JavaScript pixel and Google
+        #     Tag Manager, this value is filled in automatically.
+        class UserEvent
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # @!attribute [rw] key
+          #   @return [::String]
+          # @!attribute [rw] value
+          #   @return [::Google::Cloud::Retail::V2::CustomAttribute]
+          class AttributesEntry
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+
+        # Detailed product information associated with a user event.
+        # @!attribute [rw] product
+        #   @return [::Google::Cloud::Retail::V2::Product]
+        #     Required. {::Google::Cloud::Retail::V2::Product Product} information.
+        #
+        #     Only {::Google::Cloud::Retail::V2::Product#id Product.id} field is used when
+        #     ingesting an event, all other product fields are ignored as we will look
+        #     them up from the catalog.
+        # @!attribute [rw] quantity
+        #   @return [::Google::Protobuf::Int32Value]
+        #     Quantity of the product associated with the user event.
+        #
+        #     For example, this field will be 2 if two products are added to the shopping
+        #     cart for `purchase-complete` event. Required for `add-to-cart` and
+        #     `purchase-complete` event types.
+        class ProductDetail
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # A transaction represents the entire purchase transaction.
+        # @!attribute [rw] id
+        #   @return [::String]
+        #     The transaction ID with a length limit of 128 characters.
+        # @!attribute [rw] revenue
+        #   @return [::Float]
+        #     Required. Total non-zero revenue or grand total associated with the
+        #     transaction. This value include shipping, tax, or other adjustments to
+        #     total revenue that you want to include as part of your revenue
+        #     calculations.
+        # @!attribute [rw] tax
+        #   @return [::Float]
+        #     All the taxes associated with the transaction.
+        # @!attribute [rw] cost
+        #   @return [::Float]
+        #     All the costs associated with the products. These can be manufacturing
+        #     costs, shipping expenses not borne by the end user, or any other costs,
+        #     such that:
+        #
+        #     * Profit = {::Google::Cloud::Retail::V2::PurchaseTransaction#revenue revenue} -
+        #     {::Google::Cloud::Retail::V2::PurchaseTransaction#tax tax} -
+        #     {::Google::Cloud::Retail::V2::PurchaseTransaction#cost cost}
+        # @!attribute [rw] currency_code
+        #   @return [::String]
+        #     Required. Currency code. Use three-character ISO-4217 code.
+        class PurchaseTransaction
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,114 @@
+# 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
+        # Request message for WriteUserEvent method.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The parent catalog resource name, such as
+        #     "projects/1234/locations/global/catalogs/default_catalog".
+        # @!attribute [rw] user_event
+        #   @return [::Google::Cloud::Retail::V2::UserEvent]
+        #     Required. User event to write.
+        class WriteUserEventRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for CollectUserEvent method.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The parent catalog name, such as
+        #     "projects/1234/locations/global/catalogs/default_catalog".
+        # @!attribute [rw] user_event
+        #   @return [::String]
+        #     Required. URL encoded UserEvent proto with a length limit of 2,000,000
+        #     characters.
+        # @!attribute [rw] uri
+        #   @return [::String]
+        #     The URL including cgi-parameters but excluding the hash fragment with a
+        #     length limit of 5,000 characters. This is often more useful than the
+        #     referer URL, because many browsers only send the domain for 3rd party
+        #     requests.
+        # @!attribute [rw] ets
+        #   @return [::Integer]
+        #     The event timestamp in milliseconds. This prevents browser caching of
+        #     otherwise identical get requests. The name is abbreviated to reduce the
+        #     payload bytes.
+        class CollectUserEventRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for RejoinUserEvents method.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The parent catalog resource name, such as
+        #     "projects/1234/locations/global/catalogs/default_catalog".
+        # @!attribute [rw] user_event_rejoin_scope
+        #   @return [::Google::Cloud::Retail::V2::RejoinUserEventsRequest::UserEventRejoinScope]
+        #     The type of the user event rejoin to define the scope and range of the user
+        #     events to be rejoined with the latest product catalog. Defaults to
+        #     USER_EVENT_REJOIN_SCOPE_UNSPECIFIED if this field is not set, or set to an
+        #     invalid integer value.
+        class RejoinUserEventsRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # The scope of user events to be rejoined with the latest product catalog.
+          # If the rejoining aims at reducing number of unjoined events, set
+          # UserEventRejoinScope to UNJOINED_EVENTS.
+          # If the rejoining aims at correcting product catalog information in joined
+          # events, set UserEventRejoinScope to JOINED_EVENTS.
+          # If all events needs to be rejoined, set UserEventRejoinScope to
+          # USER_EVENT_REJOIN_SCOPE_UNSPECIFIED.
+          module UserEventRejoinScope
+            # Rejoin all events with the latest product catalog, including both joined
+            # events and unjoined events.
+            USER_EVENT_REJOIN_SCOPE_UNSPECIFIED = 0
+
+            # Only rejoin joined events with the latest product catalog.
+            JOINED_EVENTS = 1
+
+            # Only rejoin unjoined events with the latest product catalog.
+            UNJOINED_EVENTS = 2
+          end
+        end
+
+        # Response message for RejoinUserEvents method.
+        # @!attribute [rw] rejoined_user_events_count
+        #   @return [::Integer]
+        #     Number of user events that were joined with latest product catalog.
+        class RejoinUserEventsResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Metadata for RejoinUserEvents method.
+        class RejoinUserEventsMetadata
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end