google-cloud-retail-v2 0.10.0 → 0.12.0

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

@@ -0,0 +1,122 @@
+# frozen_string_literal: true
+
+# Copyright 2022 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 for CreateControl method.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. Full resource name of parent catalog. Format:
+        #     `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}`
+        # @!attribute [rw] control
+        #   @return [::Google::Cloud::Retail::V2::Control]
+        #     Required. The Control to create.
+        # @!attribute [rw] control_id
+        #   @return [::String]
+        #     Required. The ID to use for the Control, which will become the final
+        #     component of the Control's resource name.
+        #
+        #     This value should be 4-63 characters, and valid characters
+        #     are /[a-z][0-9]-_/.
+        class CreateControlRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request for UpdateControl method.
+        # @!attribute [rw] control
+        #   @return [::Google::Cloud::Retail::V2::Control]
+        #     Required. The Control to update.
+        # @!attribute [rw] update_mask
+        #   @return [::Google::Protobuf::FieldMask]
+        #     Indicates which fields in the provided
+        #     {::Google::Cloud::Retail::V2::Control Control} to update. The following are NOT
+        #     supported:
+        #
+        #     * {::Google::Cloud::Retail::V2::Control#name Control.name}
+        #
+        #     If not set or empty, all supported fields are updated.
+        class UpdateControlRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request for DeleteControl method.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The resource name of the Control to delete. Format:
+        #     `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/controls/{control_id}`
+        class DeleteControlRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request for GetControl method.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The resource name of the Control to get. Format:
+        #     `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/controls/{control_id}`
+        class GetControlRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request for ListControls method.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The catalog resource name. Format:
+        #     `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}`
+        # @!attribute [rw] page_size
+        #   @return [::Integer]
+        #     Optional. Maximum number of results to return. If unspecified, defaults
+        #     to 50. Max allowed value is 1000.
+        # @!attribute [rw] page_token
+        #   @return [::String]
+        #     Optional. A page token, received from a previous `ListControls` call.
+        #     Provide this to retrieve the subsequent page.
+        # @!attribute [rw] filter
+        #   @return [::String]
+        #     Optional. A filter to apply on the list results. Supported features:
+        #
+        #     * List all the products under the parent branch if
+        #     {::Google::Cloud::Retail::V2::ListControlsRequest#filter filter} is unset.
+        #     * List controls that are used in a single ServingConfig:
+        #         'serving_config = "boosted_home_page_cvr"'
+        class ListControlsRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Response for ListControls method.
+        # @!attribute [rw] controls
+        #   @return [::Array<::Google::Cloud::Retail::V2::Control>]
+        #     All the Controls for a given catalog.
+        # @!attribute [rw] next_page_token
+        #   @return [::String]
+        #     Pagination token, if not returned indicates the last page.
+        class ListControlsResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end

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

@@ -22,7 +22,6 @@ module Google
     module Retail
       module V2
         # Google Cloud Storage location for input content.
-        # format.
         # @!attribute [rw] input_uris
         #   @return [::Array<::String>]
         #     Required. Google Cloud Storage URIs to input files. URI can be up to
@@ -54,11 +53,13 @@ module Google
         #
         #     Supported values for control imports:
         #
-        #     * 'control' (default): One JSON [Control][] per line.
+        #     * `control` (default): One JSON {::Google::Cloud::Retail::V2::Control Control}
+        #     per line.
         #
         #     Supported values for catalog attribute imports:
         #
-        #     * 'catalog_attribute' (default): One CSV [CatalogAttribute][] per line.
+        #     * `catalog_attribute` (default): One CSV
+        #     {::Google::Cloud::Retail::V2::CatalogAttribute CatalogAttribute} per line.
         class GcsSource
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -69,9 +70,8 @@ module Google
         #   @return [::Google::Type::Date]
         #     BigQuery time partitioned table's _PARTITIONDATE in YYYY-MM-DD format.
         #
-        #     Only supported when
-        #     {::Google::Cloud::Retail::V2::ImportProductsRequest#reconciliation_mode ImportProductsRequest.reconciliation_mode}
-        #     is set to `FULL`.
+        #     Only supported in
+        #     {::Google::Cloud::Retail::V2::ImportProductsRequest ImportProductsRequest}.
         # @!attribute [rw] project_id
         #   @return [::String]
         #     The project ID (can be project # or ID) that the BigQuery source is in with
@@ -109,8 +109,7 @@ module Google
         #     * `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.
+        #     * `user_event_ga4`:
         #       The schema is available here:
         #       https://support.google.com/analytics/answer/7029846.
         #
@@ -148,7 +147,7 @@ module Google
         # @!attribute [rw] gcs_prefix
         #   @return [::String]
         #     Google Cloud Storage prefix for import errors. This must be an empty,
-        #     existing Cloud Storage directory. Import errors will be written to
+        #     existing Cloud Storage directory. Import errors are written to
         #     sharded files in this directory, one per line, as a JSON-encoded
         #     `google.rpc.Status` message.
         class ImportErrorsConfig
@@ -175,8 +174,8 @@ module Google
         #     The desired location of errors incurred during the Import.
         # @!attribute [rw] update_mask
         #   @return [::Google::Protobuf::FieldMask]
-        #     Indicates which fields in the provided imported 'products' to update. If
-        #     not set, will by default update all fields.
+        #     Indicates which fields in the provided imported `products` to update. If
+        #     not set, all fields are updated.
         # @!attribute [rw] reconciliation_mode
         #   @return [::Google::Cloud::Retail::V2::ImportProductsRequest::ReconciliationMode]
         #     The mode of reconciliation between existing products and the products to be
@@ -185,21 +184,16 @@ module Google
         # @!attribute [rw] notification_pubsub_topic
         #   @return [::String]
         #     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
+        #     when the import is finished, a notification is sent to
+        #     specified Pub/Sub topic. The message data is JSON string of a
         #     {::Google::Longrunning::Operation Operation}.
         #
         #     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}
-        #     is set to `FULL`.
+        #     Make sure that `service-<project
+        #     number>@gcp-sa-retail.iam.gserviceaccount.com` has the
+        #     `pubsub.topics.publish` IAM permission on the topic.
         class ImportProductsRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -215,15 +209,6 @@ 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 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.
             FULL = 2
           end
         end
@@ -256,8 +241,8 @@ module Google
         # @!attribute [rw] notification_pubsub_topic
         #   @return [::String]
         #     Pub/Sub topic 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
+        #     when the import is finished, a notification is sent to
+        #     specified Pub/Sub topic. The message data is JSON string of a
         #     {::Google::Longrunning::Operation Operation}.
         #     Format of the Pub/Sub topic is `projects/{project}/topics/{topic}`.
         class ImportCompletionDataRequest
@@ -308,7 +293,7 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
-        # Metadata related to the progress of the Import operation. This will be
+        # Metadata related to the progress of the Import operation. This is
         # returned by the google.longrunning.Operation.metadata field.
         # @!attribute [rw] create_time
         #   @return [::Google::Protobuf::Timestamp]
@@ -329,8 +314,8 @@ module Google
         # @!attribute [rw] notification_pubsub_topic
         #   @return [::String]
         #     Pub/Sub topic 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
+        #     when the import is finished, a notification is sent to
+        #     specified Pub/Sub topic. The message data is JSON string of a
         #     {::Google::Longrunning::Operation Operation}.
         #     Format of the Pub/Sub topic is `projects/{project}/topics/{topic}`.
         class ImportMetadata

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

@@ -33,7 +33,7 @@ module Google
         #     The ID of the Recommendations AI serving config or placement.
         #     Before you can request predictions from your model, you must create at
         #     least one serving config or placement for it. For more information, see
-        #     [Managing serving configurations]
+        #     [Manage serving configs]
         #     (https://cloud.google.com/retail/docs/manage-configs).
         #
         #     The full list of available serving configs can be seen at
@@ -88,12 +88,11 @@ module Google
         #      * filterOutOfStockItems  tag=(-"promotional")
         #      * filterOutOfStockItems
         #
-        #     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.
+        #     If your filter blocks all prediction results, the API will return *no*
+        #     results. If instead you want empty result sets to return generic
+        #     (unfiltered) popular products, set `strictFiltering` to False in
+        #     `PredictRequest.params`. Note that the API will never return items with
+        #     storageStatus of "EXPIRED" or "DELETED" regardless of filter choices.
         #
         #     If `filterSyntaxV2` is set to true under the `params` field, then
         #     attribute-based expressions are expected instead of the above described
@@ -120,7 +119,7 @@ module Google
         #     * `returnScore`: Boolean. If set to true, the prediction 'score'
         #        corresponding to each returned product will be set in the
         #        `results.metadata` field in the prediction response. The given
-        #        'score' indicates the probability of an product being clicked/purchased
+        #        'score' indicates the probability of a product being clicked/purchased
         #        given the user's context and history.
         #     * `strictFiltering`: Boolean. True by default. If set to false, the service
         #        will return generic (unfiltered) popular products instead of empty if

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

@@ -26,7 +26,13 @@ module Google
         # @!attribute [rw] expire_time
         #   @return [::Google::Protobuf::Timestamp]
         #     The timestamp when this product becomes unavailable for
-        #     {::Google::Cloud::Retail::V2::SearchService::Client#search SearchService.Search}.
+        #     {::Google::Cloud::Retail::V2::SearchService::Client#search SearchService.Search}. Note
+        #     that this is only applicable to
+        #     {::Google::Cloud::Retail::V2::Product::Type::PRIMARY Type.PRIMARY} and
+        #     {::Google::Cloud::Retail::V2::Product::Type::COLLECTION Type.COLLECTION}, and
+        #     ignored for {::Google::Cloud::Retail::V2::Product::Type::VARIANT Type.VARIANT}.
+        #     In general, we suggest the users to delete the stale products explicitly,
+        #     instead of using this field to determine staleness.
         #
         #     If it is set, the {::Google::Cloud::Retail::V2::Product Product} is not
         #     available for
@@ -46,7 +52,13 @@ module Google
         #     [expiration_date](https://support.google.com/merchants/answer/6324499).
         # @!attribute [rw] ttl
         #   @return [::Google::Protobuf::Duration]
-        #     Input only. The TTL (time to live) of the product.
+        #     Input only. The TTL (time to live) of the product. Note that this is only
+        #     applicable to {::Google::Cloud::Retail::V2::Product::Type::PRIMARY Type.PRIMARY}
+        #     and {::Google::Cloud::Retail::V2::Product::Type::COLLECTION Type.COLLECTION},
+        #     and ignored for
+        #     {::Google::Cloud::Retail::V2::Product::Type::VARIANT Type.VARIANT}. In general,
+        #     we suggest the users to delete the stale products explicitly, instead of
+        #     using this field to determine staleness.
         #
         #     If it is set, it must be a non-negative value, and
         #     {::Google::Cloud::Retail::V2::Product#expire_time expire_time} is set as
@@ -114,7 +126,7 @@ module Google
         #     Non-existent product ids are allowed.
         #     The {::Google::Cloud::Retail::V2::Product#type type} of the members must be
         #     either {::Google::Cloud::Retail::V2::Product::Type::PRIMARY Type.PRIMARY} or
-        #     {::Google::Cloud::Retail::V2::Product::Type::VARIANT Type.VARIANT} otherwise and
+        #     {::Google::Cloud::Retail::V2::Product::Type::VARIANT Type.VARIANT} otherwise an
         #     INVALID_ARGUMENT error is thrown. Should not set it for other types. A
         #     maximum of 1000 values are allowed. Otherwise, an INVALID_ARGUMENT error is
         #     return.
@@ -146,7 +158,7 @@ module Google
         #
         #
         #     To represent full path of category, use '>' sign to separate different
-        #     hierarchies. If '>' is part of the category name, please replace it with
+        #     hierarchies. If '>' is part of the category name, replace it with
         #     other character(s).
         #
         #     For example, if a shoes product belongs to both
@@ -276,7 +288,11 @@ module Google
         #   @return [::Google::Protobuf::Timestamp]
         #     The timestamp when this {::Google::Cloud::Retail::V2::Product Product} becomes
         #     available for
-        #     {::Google::Cloud::Retail::V2::SearchService::Client#search SearchService.Search}.
+        #     {::Google::Cloud::Retail::V2::SearchService::Client#search SearchService.Search}. Note
+        #     that this is only applicable to
+        #     {::Google::Cloud::Retail::V2::Product::Type::PRIMARY Type.PRIMARY} and
+        #     {::Google::Cloud::Retail::V2::Product::Type::COLLECTION Type.COLLECTION}, and
+        #     ignored for {::Google::Cloud::Retail::V2::Product::Type::VARIANT Type.VARIANT}.
         # @!attribute [rw] availability
         #   @return [::Google::Cloud::Retail::V2::Product::Availability]
         #     The online availability of the {::Google::Cloud::Retail::V2::Product Product}.
@@ -462,6 +478,8 @@ module Google
         #     Note: Returning more fields in
         #     {::Google::Cloud::Retail::V2::SearchResponse SearchResponse} can increase
         #     response payload size and serving latency.
+        #
+        #     This field is deprecated. Use the retrievable site-wide control instead.
         # @!attribute [r] variants
         #   @return [::Array<::Google::Cloud::Retail::V2::Product>]
         #     Output only. Product variants grouped together on primary product which
@@ -474,6 +492,16 @@ module Google
         #     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.
+        # @!attribute [r] local_inventories
+        #   @return [::Array<::Google::Cloud::Retail::V2::LocalInventory>]
+        #     Output only. A list of local inventories specific to different places.
+        #
+        #     This is only available for users who have Retail Search enabled, and it can
+        #     be managed by
+        #     {::Google::Cloud::Retail::V2::ProductService::Client#add_local_inventories ProductService.AddLocalInventories}
+        #     and
+        #     {::Google::Cloud::Retail::V2::ProductService::Client#remove_local_inventories ProductService.RemoveLocalInventories}
+        #     APIs.
         class Product
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods

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

@@ -29,7 +29,7 @@ module Google
         #     `projects/*/locations/global/catalogs/default_catalog/servingConfigs/default_serving_config`
         #     or the name of the legacy placement resource, such as
         #     `projects/*/locations/global/catalogs/default_catalog/placements/default_search`.
-        #     This field is used to identify the serving configuration name and the set
+        #     This field is used to identify the serving config name and the set
         #     of models that will be used to make the search.
         # @!attribute [rw] branch
         #   @return [::String]
@@ -138,7 +138,9 @@ module Google
         #     Boost specification to boost certain products. See more details at this
         #     [user guide](https://cloud.google.com/retail/docs/boosting).
         #
-        #     Notice that if both [ServingConfig.boost_control_ids][] and
+        #     Notice that if both
+        #     {::Google::Cloud::Retail::V2::ServingConfig#boost_control_ids ServingConfig.boost_control_ids}
+        #     and
         #     {::Google::Cloud::Retail::V2::SearchRequest#boost_spec SearchRequest.boost_spec}
         #     are set, the boost conditions from both places are evaluated. If a search
         #     request matches multiple boost conditions, the final boost score is equal
@@ -228,7 +230,7 @@ module Google
         #     {::Google::Cloud::Retail::V2::UserEvent#page_categories UserEvent.page_categories};
         #
         #     To represent full path of category, use '>' sign to separate different
-        #     hierarchies. If '>' is part of the category name, please replace it with
+        #     hierarchies. If '>' is part of the category name, replace it with
         #     other character(s).
         #
         #     Category pages include special pages such as sales or promotions. For
@@ -241,6 +243,15 @@ module Google
         # @!attribute [rw] personalization_spec
         #   @return [::Google::Cloud::Retail::V2::SearchRequest::PersonalizationSpec]
         #     The specification for personalization.
+        #
+        #     Notice that if both
+        #     {::Google::Cloud::Retail::V2::ServingConfig#personalization_spec ServingConfig.personalization_spec}
+        #     and
+        #     {::Google::Cloud::Retail::V2::SearchRequest#personalization_spec SearchRequest.personalization_spec}
+        #     are set.
+        #     {::Google::Cloud::Retail::V2::SearchRequest#personalization_spec SearchRequest.personalization_spec}
+        #     will override
+        #     {::Google::Cloud::Retail::V2::ServingConfig#personalization_spec ServingConfig.personalization_spec}.
         # @!attribute [rw] labels
         #   @return [::Google::Protobuf::Map{::String => ::String}]
         #     The labels applied to a resource must meet the following requirements:
@@ -275,7 +286,7 @@ module Google
           # @!attribute [rw] limit
           #   @return [::Integer]
           #     Maximum of facet values that should be returned for this facet. If
-          #     unspecified, defaults to 20. The maximum allowed value is 300. Values
+          #     unspecified, defaults to 50. The maximum allowed value is 300. Values
           #     above 300 will be coerced to 300.
           #
           #     If this field is negative, an INVALID_ARGUMENT is returned.
@@ -625,7 +636,8 @@ module Google
               # {::Google::Cloud::Retail::V2::SearchRequest::PersonalizationSpec::Mode::AUTO Mode.AUTO}.
               MODE_UNSPECIFIED = 0
 
-              # Let CRS decide whether to use personalization.
+              # Let CRS decide whether to use personalization based on quality of user
+              # event data.
               AUTO = 1
 
               # Disable personalization.
@@ -674,15 +686,20 @@ module Google
           # The search mode of each search request.
           module SearchMode
             # Default value. In this case both product search and faceted search will
-            # be performed. Both [SearchResponse.SearchResult] and
-            # [SearchResponse.Facet] will be returned.
+            # be performed. Both
+            # {::Google::Cloud::Retail::V2::SearchResponse::SearchResult SearchResponse.SearchResult}
+            # and {::Google::Cloud::Retail::V2::SearchResponse::Facet SearchResponse.Facet}
+            # will be returned.
             SEARCH_MODE_UNSPECIFIED = 0
 
             # Only product search will be performed. The faceted search will be
             # disabled.
             #
-            # Only [SearchResponse.SearchResult] will be returned.
-            # [SearchResponse.Facet] will not be returned, even if
+            # Only
+            # {::Google::Cloud::Retail::V2::SearchResponse::SearchResult SearchResponse.SearchResult}
+            # will be returned.
+            # {::Google::Cloud::Retail::V2::SearchResponse::Facet SearchResponse.Facet} will
+            # not be returned, even if
             # {::Google::Cloud::Retail::V2::SearchRequest#facet_specs SearchRequest.facet_specs}
             # or
             # {::Google::Cloud::Retail::V2::SearchRequest#dynamic_facet_spec SearchRequest.dynamic_facet_spec}
@@ -697,7 +714,9 @@ module Google
             # and
             # {::Google::Cloud::Retail::V2::SearchRequest#dynamic_facet_spec SearchRequest.dynamic_facet_spec}
             # should be set. Otherwise, an INVALID_ARGUMENT error is returned. Only
-            # [SearchResponse.Facet] will be returned. [SearchResponse.SearchResult]
+            # {::Google::Cloud::Retail::V2::SearchResponse::Facet SearchResponse.Facet} will
+            # be returned.
+            # {::Google::Cloud::Retail::V2::SearchResponse::SearchResult SearchResponse.SearchResult}
             # will not be returned.
             FACETED_SEARCH_ONLY = 2
           end
@@ -829,6 +848,21 @@ module Google
           #     {::Google::Protobuf::Value google.protobuf.Value}. For example,
           #     `{key: "pickupInStore.store1" value { number_value: 10 }}` means a there
           #     are 10 variants in this product are available in the store "store1".
+          # @!attribute [rw] personal_labels
+          #   @return [::Array<::String>]
+          #     Specifies previous events related to this product for this user based on
+          #     {::Google::Cloud::Retail::V2::UserEvent UserEvent} with same
+          #     {::Google::Cloud::Retail::V2::SearchRequest#visitor_id SearchRequest.visitor_id}
+          #     or {::Google::Cloud::Retail::V2::UserInfo#user_id UserInfo.user_id}.
+          #
+          #     This is set only when
+          #     {::Google::Cloud::Retail::V2::SearchRequest::PersonalizationSpec#mode SearchRequest.PersonalizationSpec.mode}
+          #     is
+          #     {::Google::Cloud::Retail::V2::SearchRequest::PersonalizationSpec::Mode::AUTO SearchRequest.PersonalizationSpec.Mode.AUTO}.
+          #
+          #     Possible values:
+          #
+          #     * `purchased`: Indicates that this product has been purchased before.
           class SearchResult
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods