google-cloud-retail-v2 0.3.2 → 0.4.0

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

@@ -21,8 +21,79 @@ module Google
   module Cloud
     module Retail
       module V2
+        # An intended audience of the {::Google::Cloud::Retail::V2::Product Product} for
+        # whom it's sold.
+        # @!attribute [rw] genders
+        #   @return [::Array<::String>]
+        #     The genders of the audience. Strongly encouraged to use the standard
+        #     values: "male", "female", "unisex".
+        #
+        #     At most 5 values are allowed. Each value must be a UTF-8 encoded string
+        #     with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error
+        #     is returned.
+        #
+        #     Google Merchant Center property
+        #     [gender](https://support.google.com/merchants/answer/6324479). Schema.org
+        #     property
+        #     [Product.audience.suggestedGender](https://schema.org/suggestedGender).
+        # @!attribute [rw] age_groups
+        #   @return [::Array<::String>]
+        #     The age groups of the audience. Strongly encouraged to use the standard
+        #     values: "newborn" (up to 3 months old), "infant" (3–12 months old),
+        #     "toddler" (1–5 years old), "kids" (5–13 years old), "adult" (typically
+        #     teens or older).
+        #
+        #     At most 5 values are allowed. Each value must be a UTF-8 encoded string
+        #     with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error
+        #     is returned.
+        #
+        #     Google Merchant Center property
+        #     [age_group](https://support.google.com/merchants/answer/6324463).
+        #     Schema.org property
+        #     [Product.audience.suggestedMinAge](https://schema.org/suggestedMinAge) and
+        #     [Product.audience.suggestedMaxAge](https://schema.org/suggestedMaxAge).
+        class Audience
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The color information of a {::Google::Cloud::Retail::V2::Product Product}.
+        # @!attribute [rw] color_families
+        #   @return [::Array<::String>]
+        #     The standard color families. Strongly recommended to use the following
+        #     standard color groups: "Red", "Pink", "Orange", "Yellow", "Purple",
+        #     "Green", "Cyan", "Blue", "Brown", "White", "Gray", "Black" and
+        #     "Mixed". Normally it is expected to have only 1 color family. May consider
+        #     using single "Mixed" instead of multiple values.
+        #
+        #     A maximum of 5 values are allowed. Each value must be a UTF-8 encoded
+        #     string with a length limit of 128 characters. Otherwise, an
+        #     INVALID_ARGUMENT error is returned.
+        #
+        #     Google Merchant Center property
+        #     [color](https://support.google.com/merchants/answer/6324487). Schema.org
+        #     property [Product.color](https://schema.org/color).
+        # @!attribute [rw] colors
+        #   @return [::Array<::String>]
+        #     The color display names, which may be different from standard color family
+        #     names, such as the color aliases used in the website frontend. Normally
+        #     it is expected to have only 1 color. May consider using single "Mixed"
+        #     instead of multiple values.
+        #
+        #     A maximum of 5 colors are allowed. Each value must be a UTF-8 encoded
+        #     string with a length limit of 128 characters. Otherwise, an
+        #     INVALID_ARGUMENT error is returned.
+        #
+        #     Google Merchant Center property
+        #     [color](https://support.google.com/merchants/answer/6324487). Schema.org
+        #     property [Product.color](https://schema.org/color).
+        class ColorInfo
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
         # A custom attribute that is not explicitly modeled in
-        # {::Google::Cloud::Retail::V2::Product Product}].
+        # {::Google::Cloud::Retail::V2::Product Product}.
         # @!attribute [rw] text
         #   @return [::Array<::String>]
         #     The textual values of this custom attribute. For example, `["yellow",
@@ -46,11 +117,71 @@ module Google
         #     Exactly one of {::Google::Cloud::Retail::V2::CustomAttribute#text text} or
         #     {::Google::Cloud::Retail::V2::CustomAttribute#numbers numbers} should be set.
         #     Otherwise, an INVALID_ARGUMENT error is returned.
+        # @!attribute [rw] searchable
+        #   @return [::Boolean]
+        #     If true, custom attribute values are searchable by text queries in
+        #     {::Google::Cloud::Retail::V2::SearchService::Client#search SearchService.Search}.
+        #
+        #     This field is ignored in a {::Google::Cloud::Retail::V2::UserEvent UserEvent}.
+        #
+        #     Only set if type {::Google::Cloud::Retail::V2::CustomAttribute#text text} is
+        #     set. Otherwise, a INVALID_ARGUMENT error is returned.
+        # @!attribute [rw] indexable
+        #   @return [::Boolean]
+        #     If true, custom attribute values are indexed, so that it can be filtered,
+        #     faceted or boosted in
+        #     {::Google::Cloud::Retail::V2::SearchService::Client#search SearchService.Search}.
+        #
+        #     This field is ignored in a {::Google::Cloud::Retail::V2::UserEvent UserEvent}.
+        #
+        #     See {::Google::Cloud::Retail::V2::SearchRequest#filter SearchRequest.filter},
+        #     {::Google::Cloud::Retail::V2::SearchRequest#facet_specs SearchRequest.facet_specs}
+        #     and
+        #     {::Google::Cloud::Retail::V2::SearchRequest#boost_spec SearchRequest.boost_spec}
+        #     for more details.
         class CustomAttribute
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
+        # Fulfillment information, such as the store IDs for in-store pickup or region
+        # IDs for different shipping methods.
+        # @!attribute [rw] type
+        #   @return [::String]
+        #     The fulfillment type, including commonly used types (such as pickup in
+        #     store and same day delivery), and custom types. Customers have to map
+        #     custom types to their display names before rendering UI.
+        #
+        #     Supported values:
+        #
+        #     * "pickup-in-store"
+        #     * "ship-to-store"
+        #     * "same-day-delivery"
+        #     * "next-day-delivery"
+        #     * "custom-type-1"
+        #     * "custom-type-2"
+        #     * "custom-type-3"
+        #     * "custom-type-4"
+        #     * "custom-type-5"
+        #
+        #     If this field is set to an invalid value other than these, an
+        #     INVALID_ARGUMENT error is returned.
+        # @!attribute [rw] place_ids
+        #   @return [::Array<::String>]
+        #     The IDs for this {::Google::Cloud::Retail::V2::FulfillmentInfo#type type}, such
+        #     as the store IDs for
+        #     {::Google::Cloud::Retail::V2::FulfillmentInfo#type FulfillmentInfo.type.pickup-in-store}
+        #     or the region IDs for
+        #     {::Google::Cloud::Retail::V2::FulfillmentInfo#type FulfillmentInfo.type.same-day-delivery}.
+        #
+        #     A maximum of 2000 values are allowed. Each value must be a string with a
+        #     length limit of 10 characters, matching the pattern [a-zA-Z0-9_-]+, such as
+        #     "store1" or "REGION-2". Otherwise, an INVALID_ARGUMENT error is returned.
+        class FulfillmentInfo
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
         # {::Google::Cloud::Retail::V2::Product Product} thumbnail/detail image.
         # @!attribute [rw] uri
         #   @return [::String]
@@ -79,6 +210,24 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
+        # A floating point interval.
+        # @!attribute [rw] minimum
+        #   @return [::Float]
+        #     Inclusive lower bound.
+        # @!attribute [rw] exclusive_minimum
+        #   @return [::Float]
+        #     Exclusive lower bound.
+        # @!attribute [rw] maximum
+        #   @return [::Float]
+        #     Inclusive upper bound.
+        # @!attribute [rw] exclusive_maximum
+        #   @return [::Float]
+        #     Exclusive upper bound.
+        class Interval
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
         # The price information of a {::Google::Cloud::Retail::V2::Product Product}.
         # @!attribute [rw] currency_code
         #   @return [::String]
@@ -87,6 +236,13 @@ module Google
         #
         #     If this field is an unrecognizable currency code, an INVALID_ARGUMENT
         #     error is returned.
+        #
+        #     The {::Google::Cloud::Retail::V2::Product::Type::VARIANT Product.Type.VARIANT}
+        #     {::Google::Cloud::Retail::V2::Product Product}s with the same
+        #     {::Google::Cloud::Retail::V2::Product#primary_product_id Product.primary_product_id}
+        #     must share the same
+        #     {::Google::Cloud::Retail::V2::PriceInfo#currency_code currency_code}. Otherwise,
+        #     a FAILED_PRECONDITION error is returned.
         # @!attribute [rw] price
         #   @return [::Float]
         #     Price of the product.
@@ -108,9 +264,102 @@ module Google
         #
         #     Google Merchant Center property
         #     [cost_of_goods_sold](https://support.google.com/merchants/answer/9017895).
+        # @!attribute [rw] price_effective_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     The timestamp when the {::Google::Cloud::Retail::V2::PriceInfo#price price}
+        #     starts to be effective. This can be set as a future timestamp, and the
+        #     {::Google::Cloud::Retail::V2::PriceInfo#price price} is only used for search
+        #     after
+        #     {::Google::Cloud::Retail::V2::PriceInfo#price_effective_time price_effective_time}.
+        #     If so, the
+        #     {::Google::Cloud::Retail::V2::PriceInfo#original_price original_price} must be
+        #     set and {::Google::Cloud::Retail::V2::PriceInfo#original_price original_price}
+        #     is used before
+        #     {::Google::Cloud::Retail::V2::PriceInfo#price_effective_time price_effective_time}.
+        #
+        #     Do not set if {::Google::Cloud::Retail::V2::PriceInfo#price price} is always
+        #     effective because it will cause additional latency during search.
+        # @!attribute [rw] price_expire_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     The timestamp when the {::Google::Cloud::Retail::V2::PriceInfo#price price}
+        #     stops to be effective. The {::Google::Cloud::Retail::V2::PriceInfo#price price}
+        #     is used for search before
+        #     {::Google::Cloud::Retail::V2::PriceInfo#price_expire_time price_expire_time}. If
+        #     this field is set, the
+        #     {::Google::Cloud::Retail::V2::PriceInfo#original_price original_price} must be
+        #     set and {::Google::Cloud::Retail::V2::PriceInfo#original_price original_price}
+        #     is used after
+        #     {::Google::Cloud::Retail::V2::PriceInfo#price_expire_time price_expire_time}.
+        #
+        #     Do not set if {::Google::Cloud::Retail::V2::PriceInfo#price price} is always
+        #     effective because it will cause additional latency during search.
+        # @!attribute [r] price_range
+        #   @return [::Google::Cloud::Retail::V2::PriceInfo::PriceRange]
+        #     Output only. The price range of all the child
+        #     {::Google::Cloud::Retail::V2::Product::Type::VARIANT Product.Type.VARIANT}
+        #     {::Google::Cloud::Retail::V2::Product Product}s grouped together on the
+        #     {::Google::Cloud::Retail::V2::Product::Type::PRIMARY Product.Type.PRIMARY}
+        #     {::Google::Cloud::Retail::V2::Product Product}. Only populated for
+        #     {::Google::Cloud::Retail::V2::Product::Type::PRIMARY Product.Type.PRIMARY}
+        #     {::Google::Cloud::Retail::V2::Product Product}s.
+        #
+        #     Note: This field is OUTPUT_ONLY for
+        #     {::Google::Cloud::Retail::V2::ProductService::Client#get_product ProductService.GetProduct}.
+        #     Do not set this field in API requests.
         class PriceInfo
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # The price range of all
+          # {::Google::Cloud::Retail::V2::Product::Type::VARIANT variant}
+          # {::Google::Cloud::Retail::V2::Product Product} having the same
+          # {::Google::Cloud::Retail::V2::Product#primary_product_id Product.primary_product_id}.
+          # @!attribute [rw] price
+          #   @return [::Google::Cloud::Retail::V2::Interval]
+          #     The inclusive
+          #     {::Google::Cloud::Retail::V2::PriceInfo#price Product.pricing_info.price}
+          #     interval of all {::Google::Cloud::Retail::V2::Product::Type::VARIANT variant}
+          #     {::Google::Cloud::Retail::V2::Product Product} having the same
+          #     {::Google::Cloud::Retail::V2::Product#primary_product_id Product.primary_product_id}.
+          # @!attribute [rw] original_price
+          #   @return [::Google::Cloud::Retail::V2::Interval]
+          #     The inclusive
+          #     {::Google::Cloud::Retail::V2::PriceInfo#original_price Product.pricing_info.original_price}
+          #     internal of all {::Google::Cloud::Retail::V2::Product::Type::VARIANT variant}
+          #     {::Google::Cloud::Retail::V2::Product Product} having the same
+          #     {::Google::Cloud::Retail::V2::Product#primary_product_id Product.primary_product_id}.
+          class PriceRange
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+
+        # The rating of a {::Google::Cloud::Retail::V2::Product Product}.
+        # @!attribute [rw] rating_count
+        #   @return [::Integer]
+        #     The total number of ratings. This value is independent of the value of
+        #     {::Google::Cloud::Retail::V2::Rating#rating_histogram rating_histogram}.
+        #
+        #     This value must be nonnegative. Otherwise, an INVALID_ARGUMENT error is
+        #     returned.
+        # @!attribute [rw] average_rating
+        #   @return [::Float]
+        #     The average rating of the {::Google::Cloud::Retail::V2::Product Product}.
+        #
+        #     The rating is scaled at 1-5. Otherwise, an INVALID_ARGUMENT error is
+        #     returned.
+        # @!attribute [rw] rating_histogram
+        #   @return [::Array<::Integer>]
+        #     List of rating counts per rating value (index = rating - 1). The list is
+        #     empty if there is no rating. If the list is non-empty, its size is
+        #     always 5. Otherwise, an INVALID_ARGUMENT error is returned.
+        #
+        #     For example, [41, 14, 13, 47, 303]. It means that the
+        #     {::Google::Cloud::Retail::V2::Product Product} got 41 ratings with 1 star, 14
+        #     ratings with 2 star, and so on.
+        class Rating
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
         # Information of an end user.
@@ -123,8 +372,9 @@ module Google
         #     characters. Otherwise, an INVALID_ARGUMENT error is returned.
         # @!attribute [rw] ip_address
         #   @return [::String]
-        #     The end user's IP address. This field is used to extract location
-        #     information for personalization.
+        #     The end user's IP address. Required for getting
+        #     [SearchResponse.sponsored_results][google.cloud.retail.v2.SearchResponse.sponsored_results].
+        #     This field is used to extract location information for personalization.
         #
         #     This field must be either an IPv4 address (e.g. "104.133.9.80") or an IPv6
         #     address (e.g. "2001:0db8:85a3:0000:0000:8a2e:0370:7334"). Otherwise, an
@@ -137,7 +387,8 @@ module Google
         #     is set.
         # @!attribute [rw] user_agent
         #   @return [::String]
-        #     User agent as included in the HTTP header.
+        #     User agent as included in the HTTP header. Required for getting
+        #     [SearchResponse.sponsored_results][google.cloud.retail.v2.SearchResponse.sponsored_results].
         #
         #     The field must be a UTF-8 encoded string with a length limit of 1,000
         #     characters. Otherwise, an INVALID_ARGUMENT error is returned.
@@ -163,6 +414,23 @@ module Google
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
+
+        # Promotion information.
+        # @!attribute [rw] promotion_id
+        #   @return [::String]
+        #     ID of the promotion. For example, "free gift".
+        #
+        #     The value value must be a UTF-8 encoded string with a length limit of 128
+        #     characters, and match the pattern: [a-zA-Z][a-zA-Z0-9_]*. For example,
+        #     id0LikeThis or ID_1_LIKE_THIS. Otherwise, an INVALID_ARGUMENT error is
+        #     returned.
+        #
+        #     Google Merchant Center property
+        #     [promotion](https://support.google.com/merchants/answer/7050148).
+        class Promotion
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
       end
     end
   end

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

@@ -0,0 +1,162 @@
+# 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
+        # Auto-complete parameters.
+        # @!attribute [rw] catalog
+        #   @return [::String]
+        #     Required. Catalog for which the completion is performed.
+        #
+        #     Full resource name of catalog, such as
+        #     `projects/*/locations/global/catalogs/default_catalog`.
+        # @!attribute [rw] query
+        #   @return [::String]
+        #     Required. The query used to generate suggestions.
+        #
+        #     The maximum number of allowed characters is 255.
+        # @!attribute [rw] visitor_id
+        #   @return [::String]
+        #     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 logs in or 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] language_codes
+        #   @return [::Array<::String>]
+        #     The list of languages of the query. This is
+        #     the BCP-47 language code, such as "en-US" or "sr-Latn".
+        #     For more information, see
+        #     [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47).
+        #
+        #     The maximum number of allowed characters is 255.
+        #     Only "en-US" is currently supported.
+        # @!attribute [rw] device_type
+        #   @return [::String]
+        #     The device type context for completion suggestions.
+        #     It is useful to apply different suggestions on different device types, e.g.
+        #     DESKTOP, MOBILE. If it is empty, the suggestions are across all device
+        #     types.
+        #
+        #     Supported formats:
+        #
+        #     * UNKNOWN_DEVICE_TYPE
+        #
+        #     * DESKTOP
+        #
+        #     * MOBILE
+        #
+        #     * A customized string starts with OTHER_, e.g. OTHER_IPHONE.
+        # @!attribute [rw] dataset
+        #   @return [::String]
+        #     Determines which dataset to use for fetching completion. "user-data" will
+        #     use the imported dataset through
+        #     {::Google::Cloud::Retail::V2::CompletionService::Client#import_completion_data CompletionService.ImportCompletionData}.
+        #     "cloud-retail" will use the dataset generated by cloud retail based on user
+        #     events. If leave empty, it will use the "user-data".
+        #
+        #     Current supported values:
+        #
+        #     * user-data
+        #
+        #     * cloud-retail
+        #       This option is not automatically enabled. Before using cloud-retail,
+        #       contact retail-search-support@google.com first.
+        # @!attribute [rw] max_suggestions
+        #   @return [::Integer]
+        #     Completion max suggestions.
+        #
+        #     The maximum allowed max suggestions is 20. The default value is 20.
+        class CompleteQueryRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Response of the auto-complete query.
+        # @!attribute [rw] completion_results
+        #   @return [::Array<::Google::Cloud::Retail::V2::CompleteQueryResponse::CompletionResult>]
+        #     Results of the matching suggestions. The result list is ordered and the
+        #     first result is top suggestion.
+        # @!attribute [rw] attribution_token
+        #   @return [::String]
+        #     A unique complete token. This should be included in the
+        #     {::Google::Cloud::Retail::V2::SearchRequest SearchRequest} resulting from this
+        #     completion, which enables accurate attribution of complete model
+        #     performance.
+        # @!attribute [rw] recent_search_results
+        #   @return [::Array<::Google::Cloud::Retail::V2::CompleteQueryResponse::RecentSearchResult>]
+        #     Matched recent searches of this user. This field is a restricted feature.
+        #     Contact Retail Support (retail-search-support@google.com) if you are
+        #     interested in enabling it.
+        #
+        #     This feature is only available when
+        #     {::Google::Cloud::Retail::V2::CompleteQueryRequest#visitor_id CompleteQueryRequest.visitor_id}
+        #     field is set and {::Google::Cloud::Retail::V2::UserEvent UserEvent} is imported.
+        #     The recent searches satisfy the follow rules:
+        #      * They are ordered from latest to oldest.
+        #      * They are matched with
+        #      {::Google::Cloud::Retail::V2::CompleteQueryRequest#query CompleteQueryRequest.query}
+        #      case insensitively.
+        #      * They are transformed to lower cases.
+        #      * They are UTF-8 safe.
+        #
+        #     Recent searches are deduplicated. More recent searches will be reserved
+        #     when duplication happens.
+        class CompleteQueryResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Resource that represents completion results.
+          # @!attribute [rw] suggestion
+          #   @return [::String]
+          #     The suggestion for the query.
+          # @!attribute [rw] attributes
+          #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::Retail::V2::CustomAttribute}]
+          #     Additional custom attributes ingested through BigQuery.
+          class CompletionResult
+            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
+
+          # Recent search of this user.
+          # @!attribute [rw] recent_search
+          #   @return [::String]
+          #     The recent search query.
+          class RecentSearchResult
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+      end
+    end
+  end
+end