google-cloud-retail-v2 0.6.3 → 0.8.0

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

@@ -99,9 +99,8 @@ module Google
         #     The textual values of this custom attribute. For example, `["yellow",
         #     "green"]` when the key is "color".
         #
-        #     At most 400 values are allowed. Empty values are not allowed. Each value
-        #     must be a UTF-8 encoded string with a length limit of 256 characters.
-        #     Otherwise, an INVALID_ARGUMENT error is returned.
+        #     Empty string is not allowed. Otherwise, an INVALID_ARGUMENT error is
+        #     returned.
         #
         #     Exactly one of {::Google::Cloud::Retail::V2::CustomAttribute#text text} or
         #     {::Google::Cloud::Retail::V2::CustomAttribute#numbers numbers} should be set.
@@ -111,14 +110,17 @@ module Google
         #     The numerical values of this custom attribute. For example, `[2.3, 15.4]`
         #     when the key is "lengths_cm".
         #
-        #     At most 400 values are allowed.Otherwise, an INVALID_ARGUMENT error is
-        #     returned.
-        #
         #     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]
+        #     This field is normally ignored unless
+        #     [AttributesConfig.attribute_config_level][] of the
+        #     {::Google::Cloud::Retail::V2::Catalog Catalog} is set to the deprecated
+        #     'PRODUCT_LEVEL_ATTRIBUTE_CONFIG' mode. For information about product-level
+        #     attribute configuration, see [Configuration
+        #     modes](https://cloud.google.com/retail/docs/attribute-config#config-modes).
         #     If true, custom attribute values are searchable by text queries in
         #     {::Google::Cloud::Retail::V2::SearchService::Client#search SearchService.Search}.
         #
@@ -128,7 +130,13 @@ module Google
         #     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,
+        #     This field is normally ignored unless
+        #     [AttributesConfig.attribute_config_level][] of the
+        #     {::Google::Cloud::Retail::V2::Catalog Catalog} is set to the deprecated
+        #     'PRODUCT_LEVEL_ATTRIBUTE_CONFIG' mode. For information about product-level
+        #     attribute configuration, see [Configuration
+        #     modes](https://cloud.google.com/retail/docs/attribute-config#config-modes).
+        #     If true, custom attribute values are indexed, so that they can be filtered,
         #     faceted or boosted in
         #     {::Google::Cloud::Retail::V2::SearchService::Client#search SearchService.Search}.
         #
@@ -183,7 +191,10 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
-        # {::Google::Cloud::Retail::V2::Product Product} thumbnail/detail image.
+        # {::Google::Cloud::Retail::V2::Product Product} image. Recommendations AI and
+        # Retail Search do not use product images to improve prediction and search
+        # results. However, product images can be returned in results, and are shown in
+        # prediction or search previews in the console.
         # @!attribute [rw] uri
         #   @return [::String]
         #     Required. URI of the image.
@@ -250,11 +261,14 @@ module Google
         #
         #     Google Merchant Center property
         #     [price](https://support.google.com/merchants/answer/6324371). Schema.org
-        #     property [Offer.priceSpecification](https://schema.org/priceSpecification).
+        #     property [Offer.price](https://schema.org/price).
         # @!attribute [rw] original_price
         #   @return [::Float]
         #     Price of the product without any discount. If zero, by default set to be
-        #     the {::Google::Cloud::Retail::V2::PriceInfo#price price}.
+        #     the {::Google::Cloud::Retail::V2::PriceInfo#price price}. If set,
+        #     {::Google::Cloud::Retail::V2::PriceInfo#original_price original_price} should be
+        #     greater than or equal to {::Google::Cloud::Retail::V2::PriceInfo#price price},
+        #     otherwise an INVALID_ARGUMENT error is thrown.
         # @!attribute [rw] cost
         #   @return [::Float]
         #     The costs associated with the sale of a particular product. Used for gross
@@ -367,21 +381,30 @@ module Google
         # @!attribute [rw] user_id
         #   @return [::String]
         #     Highly recommended for logged-in users. Unique identifier for logged-in
-        #     user, such as a user name.
+        #     user, such as a user name. Don't set for anonymous users.
+        #
+        #     Always use a hashed value for this ID.
+        #
+        #     Don't set the field to the same fixed ID for different users. This mixes
+        #     the event history of those users together, which results in degraded
+        #     model quality.
         #
         #     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] ip_address
         #   @return [::String]
-        #     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.
+        #     The end user's IP address. 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
         #     INVALID_ARGUMENT error is returned.
         #
-        #     This should not be set when using the JavaScript tag in
+        #     This should not be set when:
+        #
+        #     * setting
+        #     {::Google::Cloud::Retail::V2::SearchRequest#user_info SearchRequest.user_info}.
+        #     * using the JavaScript tag in
         #     {::Google::Cloud::Retail::V2::UserEventService::Client#collect_user_event UserEventService.CollectUserEvent}
         #     or if
         #     {::Google::Cloud::Retail::V2::UserInfo#direct_user_request direct_user_request}
@@ -416,21 +439,73 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
-        # Promotion information.
-        # @!attribute [rw] promotion_id
+        # The inventory information at a place (e.g. a store) identified
+        # by a place ID.
+        # @!attribute [rw] place_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.
+        #     The place ID for the current set of inventory information.
+        # @!attribute [rw] price_info
+        #   @return [::Google::Cloud::Retail::V2::PriceInfo]
+        #     Product price and cost information.
         #
         #     Google Merchant Center property
-        #     [promotion](https://support.google.com/merchants/answer/7050148).
-        class Promotion
+        #     [price](https://support.google.com/merchants/answer/6324371).
+        # @!attribute [rw] attributes
+        #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::Retail::V2::CustomAttribute}]
+        #     Additional local inventory attributes, for example, store name, promotion
+        #     tags, etc.
+        #
+        #     This field needs to pass all below criteria, otherwise an INVALID_ARGUMENT
+        #     error is returned:
+        #
+        #     * At most 30 attributes are allowed.
+        #     * The key must be a UTF-8 encoded string with a length limit of 32
+        #       characters.
+        #     * The key must match the pattern: `[a-zA-Z0-9][a-zA-Z0-9_]*`. For example,
+        #       key0LikeThis or KEY_1_LIKE_THIS.
+        #     * The attribute values must be of the same type (text or number).
+        #     * Only 1 value is allowed for each attribute.
+        #     * For text values, the length limit is 256 UTF-8 characters.
+        #     * The attribute does not support search. The `searchable` field should be
+        #       unset or set to false.
+        #     * The max summed total bytes of custom attribute keys and values per
+        #       product is 5MiB.
+        # @!attribute [rw] fulfillment_types
+        #   @return [::Array<::String>]
+        #     Input only. Supported fulfillment types. Valid fulfillment type values
+        #     include 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.
+        #
+        #     All the elements must be distinct. Otherwise, an INVALID_ARGUMENT error is
+        #     returned.
+        class LocalInventory
           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
       end
     end

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

@@ -35,22 +35,21 @@ module Google
         #     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.
+        #     Required field. 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.
+        #     The language filters applied to the output suggestions. If set, it should
+        #     contain the language of the query. If not set, suggestions are returned
+        #     without considering language restrictions. 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 language codes is 3.
         # @!attribute [rw] device_type
         #   @return [::String]
         #     The device type context for completion suggestions.
@@ -79,9 +78,9 @@ module Google
         #
         #     * user-data
         #
-        #     * cloud-retail
-        #       This option requires additional allowlisting. Before using cloud-retail,
-        #       contact Cloud Retail support team first.
+        #     * cloud-retail:
+        #       This option requires enabling auto-learning function first. See
+        #       [guidelines](https://cloud.google.com/retail/docs/completion-overview#generated-completion-dataset).
         # @!attribute [rw] max_suggestions
         #   @return [::Integer]
         #     Completion max suggestions. If left unset or set to 0, then will fallback
@@ -102,9 +101,9 @@ module Google
         # @!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.
+        #     {::Google::Cloud::Retail::V2::UserEvent#completion_detail UserEvent.completion_detail}
+        #     for search events 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. The maximum number of recent searches
@@ -115,11 +114,15 @@ module Google
         #     {::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
@@ -134,7 +137,14 @@ module Google
           #     The suggestion for the query.
           # @!attribute [rw] attributes
           #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::Retail::V2::CustomAttribute}]
-          #     Additional custom attributes ingested through BigQuery.
+          #     Custom attributes for the suggestion term.
+          #
+          #     * For "user-data", the attributes are additional custom attributes
+          #     ingested through BigQuery.
+          #
+          #     * For "cloud-retail", the attributes are product attributes generated
+          #     by Cloud Retail. This is an experimental feature. Contact Retail Search
+          #     support team if you are interested in enabling it.
           class CompletionResult
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods

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

@@ -51,6 +51,14 @@ module Google
         #     {::Google::Cloud::Retail::V2::UserEvent UserEvent} per line.
         #     * `user_event_ga360`: Using
         #       https://support.google.com/analytics/answer/3437719.
+        #
+        #     Supported values for control imports:
+        #
+        #     * 'control' (default): One JSON [Control][] per line.
+        #
+        #     Supported values for catalog attribute imports:
+        #
+        #     * 'catalog_attribute' (default): One CSV [CatalogAttribute][] per line.
         class GcsSource
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -98,8 +106,19 @@ module Google
         #
         #     * `user_event` (default): One JSON
         #     {::Google::Cloud::Retail::V2::UserEvent UserEvent} per line.
-        #     * `user_event_ga360`: Using
+        #     * `user_event_ga360`:
+        #       The schema is available here:
         #       https://support.google.com/analytics/answer/3437719.
+        #     * `user_event_ga4`: This feature is in private preview. Please contact the
+        #       support team for importing Google Analytics 4 events.
+        #       The schema is available here:
+        #       https://support.google.com/analytics/answer/7029846.
+        #
+        #     Supported values for auto-completion imports:
+        #
+        #     * `suggestions` (default): One JSON completion suggestion per line.
+        #     * `denylist`:  One JSON deny suggestion per line.
+        #     * `allowlist`:  One JSON allow suggestion per line.
         class BigQuerySource
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -128,9 +147,9 @@ module Google
         # Configuration of destination for Import related errors.
         # @!attribute [rw] gcs_prefix
         #   @return [::String]
-        #     Google Cloud Storage path for import errors. This must be an empty,
-        #     existing Cloud Storage bucket. Import errors will be written to a file in
-        #     this bucket, one per line, as a JSON-encoded
+        #     Google Cloud Storage prefix for import errors. This must be an empty,
+        #     existing Cloud Storage directory. Import errors will be written to
+        #     sharded files in this directory, one per line, as a JSON-encoded
         #     `google.rpc.Status` message.
         class ImportErrorsConfig
           include ::Google::Protobuf::MessageExts
@@ -147,15 +166,7 @@ module Google
         #     If updateMask is specified, requires products.update permission.
         # @!attribute [rw] request_id
         #   @return [::String]
-        #     Unique identifier provided by client, within the ancestor
-        #     dataset scope. Ensures idempotency and used for request deduplication.
-        #     Server-generated if unspecified. Up to 128 characters long and must match
-        #     the pattern: `[a-zA-Z0-9_]+`. This is returned as [Operation.name][] in
-        #     {::Google::Cloud::Retail::V2::ImportMetadata ImportMetadata}.
-        #
-        #     Only supported when
-        #     {::Google::Cloud::Retail::V2::ImportProductsRequest#reconciliation_mode ImportProductsRequest.reconciliation_mode}
-        #     is set to `FULL`.
+        #     Deprecated. This field has no effect.
         # @!attribute [rw] input_config
         #   @return [::Google::Cloud::Retail::V2::ProductInputConfig]
         #     Required. The desired input location of the data.
@@ -173,11 +184,18 @@ module Google
         #     {::Google::Cloud::Retail::V2::ImportProductsRequest::ReconciliationMode::INCREMENTAL ReconciliationMode.INCREMENTAL}.
         # @!attribute [rw] notification_pubsub_topic
         #   @return [::String]
-        #     Pub/Sub topic for receiving notification. If this field is set,
+        #     Full Pub/Sub topic name for receiving notification. If this field is set,
         #     when the import is finished, a notification will be sent to
         #     specified Pub/Sub topic. The message data will be JSON string of a
         #     {::Google::Longrunning::Operation Operation}.
-        #     Format of the Pub/Sub topic is `projects/{project}/topics/{topic}`.
+        #
+        #     Format of the Pub/Sub topic is `projects/{project}/topics/{topic}`. It has
+        #     to be within the same project as
+        #     {::Google::Cloud::Retail::V2::ImportProductsRequest#parent ImportProductsRequest.parent}.
+        #     Make sure that both
+        #     `cloud-retail-customer-data-access@system.gserviceaccount.com` and
+        #     `service-<project number>@gcp-sa-retail.iam.gserviceaccount.com`
+        #     have the `pubsub.topics.publish` IAM permission on the topic.
         #
         #     Only supported when
         #     {::Google::Cloud::Retail::V2::ImportProductsRequest#reconciliation_mode ImportProductsRequest.reconciliation_mode}
@@ -198,16 +216,14 @@ module Google
             # Calculates diff and replaces the entire product dataset. Existing
             # products may be deleted if they are not present in the source location.
             #
-            # Can only be while using
-            # {::Google::Cloud::Retail::V2::BigQuerySource BigQuerySource}.
+            # Can only be set while using
+            # {::Google::Cloud::Retail::V2::BigQuerySource BigQuerySource}. And the BigQuery
+            # dataset must be created in the data location "us (multiple regions in
+            # United States)", otherwise a PERMISSION_DENIED error is thrown.
             #
             # Add the IAM permission "BigQuery Data Viewer" for
             # cloud-retail-customer-data-access@system.gserviceaccount.com before
             # using this feature otherwise an error is thrown.
-            #
-            # This feature is only available for users who have Retail Search enabled.
-            # Please submit a form [here](https://cloud.google.com/contact) to contact
-            # cloud sales if you are interested in using Retail Search.
             FULL = 2
           end
         end
@@ -309,8 +325,7 @@ module Google
         #     Count of entries that encountered errors while processing.
         # @!attribute [rw] request_id
         #   @return [::String]
-        #     Id of the request / operation. This is parroting back the requestId
-        #     that was passed in the request.
+        #     Deprecated. This field is never set.
         # @!attribute [rw] notification_pubsub_topic
         #   @return [::String]
         #     Pub/Sub topic for receiving notification. If this field is set,

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

@@ -39,6 +39,16 @@ module Google
         #     they took to trigger the predict request. Note that this user event detail
         #     won't be ingested to userEvent logs. Thus, a separate userEvent write
         #     request is required for event logging.
+        #
+        #     Don't set
+        #     {::Google::Cloud::Retail::V2::UserEvent#visitor_id UserEvent.visitor_id} or
+        #     {::Google::Cloud::Retail::V2::UserInfo#user_id UserInfo.user_id} to the same
+        #     fixed ID for different users. If you are trying to receive non-personalized
+        #     recommendations (not recommended; this can negatively impact model
+        #     performance), instead set
+        #     {::Google::Cloud::Retail::V2::UserEvent#visitor_id UserEvent.visitor_id} to a
+        #     random unique ID and leave
+        #     {::Google::Cloud::Retail::V2::UserInfo#user_id UserInfo.user_id} unset.
         # @!attribute [rw] page_size
         #   @return [::Integer]
         #     Maximum number of results to return per page. Set this property
@@ -73,9 +83,12 @@ module Google
         #      * filterOutOfStockItems  tag=(-"promotional")
         #      * filterOutOfStockItems
         #
-        #     If your filter blocks all prediction results, nothing will be returned. If
-        #     you want generic (unfiltered) popular products to be returned instead, set
-        #     `strictFiltering` to false in `PredictRequest.params`.
+        #     If your filter blocks all prediction results, the API will return generic
+        #     (unfiltered) popular products. If you only want results strictly matching
+        #     the filters, set `strictFiltering` to True in `PredictRequest.params` to
+        #     receive empty results instead.
+        #     Note that the API will never return items with storageStatus of "EXPIRED"
+        #     or "DELETED" regardless of filter choices.
         # @!attribute [rw] validate_only
         #   @return [::Boolean]
         #     Use validate only mode for this prediction query. If set to true, a
@@ -116,7 +129,7 @@ module Google
         #     * Each resource can have multiple labels, up to a maximum of 64.
         #     * Each label must be a key-value pair.
         #     * Keys have a minimum length of 1 character and a maximum length of 63
-        #       characters, and cannot be empty. Values can be empty, and have a maximum
+        #       characters and cannot be empty. Values can be empty and have a maximum
         #       length of 63 characters.
         #     * Keys and values can contain only lowercase letters, numeric characters,
         #       underscores, and dashes. All characters must use UTF-8 encoding, and
@@ -182,9 +195,9 @@ module Google
           #
           #     Possible values:
           #
-          #     * `product`: JSON representation of the product. Will be set if
+          #     * `product`: JSON representation of the product. Is set if
           #       `returnProduct` is set to true in `PredictRequest.params`.
-          #     * `score`: Prediction score in double value. Will be set if
+          #     * `score`: Prediction score in double value. Is set if
           #       `returnScore` is set to true in `PredictRequest.params`.
           class PredictionResult
             include ::Google::Protobuf::MessageExts