google-cloud-retail-v2 0.3.2 → 0.5.0

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

@@ -30,8 +30,11 @@ module Google
         #     * `add-to-cart`: Products being added to cart.
         #     * `category-page-view`: Special pages such as sale or promotion pages
         #       viewed.
+        #     * `completion`: Completion query result showed/clicked.
         #     * `detail-page-view`: Products detail page viewed.
         #     * `home-page-view`: Homepage viewed.
+        #     * `promotion-offered`: Promotion is offered to a user.
+        #     * `promotion-not-offered`: Promotion is not offered to a user.
         #     * `purchase-complete`: User finishing a purchase.
         #     * `search`: Product search.
         #     * `shopping-cart-page-view`: User viewing a shopping cart.
@@ -45,6 +48,21 @@ module Google
         #
         #     The field must be a UTF-8 encoded string with a length limit of 128
         #     characters. Otherwise, an INVALID_ARGUMENT error is returned.
+        #
+        #     The field should not contain PII or user-data. We recommend to use Google
+        #     Analystics [Client
+        #     ID](https://developers.google.com/analytics/devguides/collection/analyticsjs/field-reference#clientId)
+        #     for this field.
+        # @!attribute [rw] session_id
+        #   @return [::String]
+        #     A unique identifier for tracking a visitor session with a length limit of
+        #     128 bytes. A session is an aggregation of an end user behavior in a time
+        #     span.
+        #
+        #     A general guideline to populate the sesion_id:
+        #     1. If user has no activity for 30 min, a new session_id should be assigned.
+        #     2. The session_id should be unique across users, suggest use uuid or add
+        #     visitor_id as prefix.
         # @!attribute [rw] event_time
         #   @return [::Google::Protobuf::Timestamp]
         #     Only required for
@@ -67,6 +85,10 @@ module Google
         #     {::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}.
+        #     The value must be a valid
+        #     {::Google::Cloud::Retail::V2::SearchResponse#attribution_token SearchResponse.attribution_token}
+        #     for user events that are the result of
+        #     {::Google::Cloud::Retail::V2::SearchService::Client#search SearchService.Search}.
         #
         #     This token enables us to accurately attribute page view or purchase back to
         #     the event and the particular predict response containing this
@@ -94,6 +116,13 @@ module Google
         #     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] completion_detail
+        #   @return [::Google::Cloud::Retail::V2::CompletionDetail]
+        #     The main completion details related to the event.
+        #
+        #     In a `completion` event, this field represents the completions returned to
+        #     the end user and the clicked completion by the end user. In a `search`
+        #     event, it represents the search event happens after clicking completion.
         # @!attribute [rw] attributes
         #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::Retail::V2::CustomAttribute}]
         #     Extra user event features to include in the recommendation model.
@@ -122,11 +151,51 @@ module Google
         #   @return [::String]
         #     The user's search query.
         #
+        #     See {::Google::Cloud::Retail::V2::SearchRequest#query SearchRequest.query} for
+        #     definition.
+        #
         #     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.
+        #     At least one of
+        #     {::Google::Cloud::Retail::V2::UserEvent#search_query search_query} or
+        #     {::Google::Cloud::Retail::V2::UserEvent#page_categories page_categories} is
+        #     required for `search` events. Other event types should not set this field.
         #     Otherwise, an INVALID_ARGUMENT error is returned.
+        # @!attribute [rw] filter
+        #   @return [::String]
+        #     The filter syntax consists of an expression language for constructing a
+        #     predicate from one or more fields of the products being filtered.
+        #
+        #     See {::Google::Cloud::Retail::V2::SearchRequest#filter SearchRequest.filter} for
+        #     definition and syntax.
+        #
+        #     The value must be a UTF-8 encoded string with a length limit of 1,000
+        #     characters. Otherwise, an INVALID_ARGUMENT error is returned.
+        # @!attribute [rw] order_by
+        #   @return [::String]
+        #     The order in which products are returned.
+        #
+        #     See {::Google::Cloud::Retail::V2::SearchRequest#order_by SearchRequest.order_by}
+        #     for definition and syntax.
+        #
+        #     The value must be a UTF-8 encoded string with a length limit of 1,000
+        #     characters. Otherwise, an INVALID_ARGUMENT error is returned.
+        #
+        #     This can only be set for `search` events. Other event types should not set
+        #     this field. Otherwise, an INVALID_ARGUMENT error is returned.
+        # @!attribute [rw] offset
+        #   @return [::Integer]
+        #     An integer that specifies the current offset for pagination (the 0-indexed
+        #     starting location, amongst the products deemed by the API as relevant).
+        #
+        #     See {::Google::Cloud::Retail::V2::SearchRequest#offset SearchRequest.offset} for
+        #     definition.
+        #
+        #     If this field is negative, an INVALID_ARGUMENT is returned.
+        #
+        #     This can only be set 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.
@@ -139,8 +208,11 @@ module Google
         #     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.
+        #     Required for `category-page-view` events. At least one of
+        #     {::Google::Cloud::Retail::V2::UserEvent#search_query search_query} or
+        #     {::Google::Cloud::Retail::V2::UserEvent#page_categories page_categories} is
+        #     required for `search` 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.
@@ -188,9 +260,21 @@ module Google
         #   @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.
+        #     Required field(s):
+        #
+        #     * {::Google::Cloud::Retail::V2::Product#id Product.id}
+        #
+        #     Optional override field(s):
+        #
+        #     * {::Google::Cloud::Retail::V2::Product#price_info Product.price_info}
+        #
+        #     If any supported optional fields are provided, we will treat them as a full
+        #     override when looking up product information from the catalog. Thus, it is
+        #     important to ensure that the overriding fields are accurate and
+        #     complete.
+        #
+        #     All other product fields are ignored and instead populated via catalog
+        #     lookup after event ingestion.
         # @!attribute [rw] quantity
         #   @return [::Google::Protobuf::Int32Value]
         #     Quantity of the product associated with the user event.
@@ -203,6 +287,26 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
+        # Detailed completion information including completion attribution token and
+        # clicked completion info.
+        # @!attribute [rw] completion_attribution_token
+        #   @return [::String]
+        #     Completion attribution token in
+        #     {::Google::Cloud::Retail::V2::CompleteQueryResponse#attribution_token CompleteQueryResponse.attribution_token}.
+        # @!attribute [rw] selected_suggestion
+        #   @return [::String]
+        #     End user selected
+        #     {::Google::Cloud::Retail::V2::CompleteQueryResponse::CompletionResult#suggestion CompleteQueryResponse.CompletionResult.suggestion}.
+        # @!attribute [rw] selected_position
+        #   @return [::Integer]
+        #     End user selected
+        #     {::Google::Cloud::Retail::V2::CompleteQueryResponse::CompletionResult#suggestion CompleteQueryResponse.CompletionResult.suggestion}
+        #     position, starting from 0.
+        class CompletionDetail
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
         # A transaction represents the entire purchase transaction.
         # @!attribute [rw] id
         #   @return [::String]

data/proto_docs/google/type/date.rb

@@ -0,0 +1,53 @@
+# 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 Type
+    # Represents a whole or partial calendar date, such as a birthday. The time of
+    # day and time zone are either specified elsewhere or are insignificant. The
+    # date is relative to the Gregorian Calendar. This can represent one of the
+    # following:
+    #
+    # * A full date, with non-zero year, month, and day values
+    # * A month and day value, with a zero year, such as an anniversary
+    # * A year on its own, with zero month and day values
+    # * A year and month value, with a zero day, such as a credit card expiration
+    # date
+    #
+    # Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and
+    # `google.protobuf.Timestamp`.
+    # @!attribute [rw] year
+    #   @return [::Integer]
+    #     Year of the date. Must be from 1 to 9999, or 0 to specify a date without
+    #     a year.
+    # @!attribute [rw] month
+    #   @return [::Integer]
+    #     Month of a year. Must be from 1 to 12, or 0 to specify a year without a
+    #     month and day.
+    # @!attribute [rw] day
+    #   @return [::Integer]
+    #     Day of a month. Must be from 1 to 31 and valid for the year and month, or 0
+    #     to specify a year by itself or a year and month where the day isn't
+    #     significant.
+    class Date
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-retail-v2
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.5.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-07-12 00:00:00.000000000 Z
+date: 2021-08-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common
@@ -16,7 +16,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '0.7'
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '0.7'
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
@@ -180,6 +180,13 @@ files:
 - lib/google/cloud/retail/v2/catalog_service_pb.rb
 - lib/google/cloud/retail/v2/catalog_service_services_pb.rb
 - lib/google/cloud/retail/v2/common_pb.rb
+- lib/google/cloud/retail/v2/completion_service.rb
+- lib/google/cloud/retail/v2/completion_service/client.rb
+- lib/google/cloud/retail/v2/completion_service/credentials.rb
+- lib/google/cloud/retail/v2/completion_service/operations.rb
+- lib/google/cloud/retail/v2/completion_service/paths.rb
+- lib/google/cloud/retail/v2/completion_service_pb.rb
+- lib/google/cloud/retail/v2/completion_service_services_pb.rb
 - lib/google/cloud/retail/v2/import_config_pb.rb
 - lib/google/cloud/retail/v2/prediction_service.rb
 - lib/google/cloud/retail/v2/prediction_service/client.rb
@@ -196,6 +203,12 @@ files:
 - lib/google/cloud/retail/v2/product_service_pb.rb
 - lib/google/cloud/retail/v2/product_service_services_pb.rb
 - lib/google/cloud/retail/v2/purge_config_pb.rb
+- lib/google/cloud/retail/v2/search_service.rb
+- lib/google/cloud/retail/v2/search_service/client.rb
+- lib/google/cloud/retail/v2/search_service/credentials.rb
+- lib/google/cloud/retail/v2/search_service/paths.rb
+- lib/google/cloud/retail/v2/search_service_pb.rb
+- lib/google/cloud/retail/v2/search_service_services_pb.rb
 - lib/google/cloud/retail/v2/user_event_pb.rb
 - lib/google/cloud/retail/v2/user_event_service.rb
 - lib/google/cloud/retail/v2/user_event_service/client.rb
@@ -212,11 +225,13 @@ files:
 - proto_docs/google/cloud/retail/v2/catalog.rb
 - proto_docs/google/cloud/retail/v2/catalog_service.rb
 - proto_docs/google/cloud/retail/v2/common.rb
+- proto_docs/google/cloud/retail/v2/completion_service.rb
 - proto_docs/google/cloud/retail/v2/import_config.rb
 - proto_docs/google/cloud/retail/v2/prediction_service.rb
 - proto_docs/google/cloud/retail/v2/product.rb
 - proto_docs/google/cloud/retail/v2/product_service.rb
 - proto_docs/google/cloud/retail/v2/purge_config.rb
+- proto_docs/google/cloud/retail/v2/search_service.rb
 - proto_docs/google/cloud/retail/v2/user_event.rb
 - proto_docs/google/cloud/retail/v2/user_event_service.rb
 - proto_docs/google/longrunning/operations.rb
@@ -228,6 +243,7 @@ files:
 - proto_docs/google/protobuf/timestamp.rb
 - proto_docs/google/protobuf/wrappers.rb
 - proto_docs/google/rpc/status.rb
+- proto_docs/google/type/date.rb
 homepage: https://github.com/googleapis/google-cloud-ruby
 licenses:
 - Apache-2.0