google-cloud-retail-v2 2.0.0 → 2.1.0

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

@@ -88,53 +88,59 @@ module Google
         #   @return [::Google::Cloud::Retail::V2::Rule::BoostAction]
         #     A boost action.
         #
-        #     Note: The following fields are mutually exclusive: `boost_action`, `redirect_action`, `oneway_synonyms_action`, `do_not_associate_action`, `replacement_action`, `ignore_action`, `filter_action`, `twoway_synonyms_action`, `force_return_facet_action`, `remove_facet_action`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+        #     Note: The following fields are mutually exclusive: `boost_action`, `redirect_action`, `oneway_synonyms_action`, `do_not_associate_action`, `replacement_action`, `ignore_action`, `filter_action`, `twoway_synonyms_action`, `force_return_facet_action`, `remove_facet_action`, `pin_action`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [rw] redirect_action
         #   @return [::Google::Cloud::Retail::V2::Rule::RedirectAction]
         #     Redirects a shopper to a specific page.
         #
-        #     Note: The following fields are mutually exclusive: `redirect_action`, `boost_action`, `oneway_synonyms_action`, `do_not_associate_action`, `replacement_action`, `ignore_action`, `filter_action`, `twoway_synonyms_action`, `force_return_facet_action`, `remove_facet_action`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+        #     Note: The following fields are mutually exclusive: `redirect_action`, `boost_action`, `oneway_synonyms_action`, `do_not_associate_action`, `replacement_action`, `ignore_action`, `filter_action`, `twoway_synonyms_action`, `force_return_facet_action`, `remove_facet_action`, `pin_action`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [rw] oneway_synonyms_action
         #   @return [::Google::Cloud::Retail::V2::Rule::OnewaySynonymsAction]
         #     Treats specific term as a synonym with a group of terms.
         #     Group of terms will not be treated as synonyms with the specific term.
         #
-        #     Note: The following fields are mutually exclusive: `oneway_synonyms_action`, `boost_action`, `redirect_action`, `do_not_associate_action`, `replacement_action`, `ignore_action`, `filter_action`, `twoway_synonyms_action`, `force_return_facet_action`, `remove_facet_action`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+        #     Note: The following fields are mutually exclusive: `oneway_synonyms_action`, `boost_action`, `redirect_action`, `do_not_associate_action`, `replacement_action`, `ignore_action`, `filter_action`, `twoway_synonyms_action`, `force_return_facet_action`, `remove_facet_action`, `pin_action`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [rw] do_not_associate_action
         #   @return [::Google::Cloud::Retail::V2::Rule::DoNotAssociateAction]
         #     Prevents term from being associated with other terms.
         #
-        #     Note: The following fields are mutually exclusive: `do_not_associate_action`, `boost_action`, `redirect_action`, `oneway_synonyms_action`, `replacement_action`, `ignore_action`, `filter_action`, `twoway_synonyms_action`, `force_return_facet_action`, `remove_facet_action`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+        #     Note: The following fields are mutually exclusive: `do_not_associate_action`, `boost_action`, `redirect_action`, `oneway_synonyms_action`, `replacement_action`, `ignore_action`, `filter_action`, `twoway_synonyms_action`, `force_return_facet_action`, `remove_facet_action`, `pin_action`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [rw] replacement_action
         #   @return [::Google::Cloud::Retail::V2::Rule::ReplacementAction]
         #     Replaces specific terms in the query.
         #
-        #     Note: The following fields are mutually exclusive: `replacement_action`, `boost_action`, `redirect_action`, `oneway_synonyms_action`, `do_not_associate_action`, `ignore_action`, `filter_action`, `twoway_synonyms_action`, `force_return_facet_action`, `remove_facet_action`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+        #     Note: The following fields are mutually exclusive: `replacement_action`, `boost_action`, `redirect_action`, `oneway_synonyms_action`, `do_not_associate_action`, `ignore_action`, `filter_action`, `twoway_synonyms_action`, `force_return_facet_action`, `remove_facet_action`, `pin_action`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [rw] ignore_action
         #   @return [::Google::Cloud::Retail::V2::Rule::IgnoreAction]
         #     Ignores specific terms from query during search.
         #
-        #     Note: The following fields are mutually exclusive: `ignore_action`, `boost_action`, `redirect_action`, `oneway_synonyms_action`, `do_not_associate_action`, `replacement_action`, `filter_action`, `twoway_synonyms_action`, `force_return_facet_action`, `remove_facet_action`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+        #     Note: The following fields are mutually exclusive: `ignore_action`, `boost_action`, `redirect_action`, `oneway_synonyms_action`, `do_not_associate_action`, `replacement_action`, `filter_action`, `twoway_synonyms_action`, `force_return_facet_action`, `remove_facet_action`, `pin_action`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [rw] filter_action
         #   @return [::Google::Cloud::Retail::V2::Rule::FilterAction]
         #     Filters results.
         #
-        #     Note: The following fields are mutually exclusive: `filter_action`, `boost_action`, `redirect_action`, `oneway_synonyms_action`, `do_not_associate_action`, `replacement_action`, `ignore_action`, `twoway_synonyms_action`, `force_return_facet_action`, `remove_facet_action`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+        #     Note: The following fields are mutually exclusive: `filter_action`, `boost_action`, `redirect_action`, `oneway_synonyms_action`, `do_not_associate_action`, `replacement_action`, `ignore_action`, `twoway_synonyms_action`, `force_return_facet_action`, `remove_facet_action`, `pin_action`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [rw] twoway_synonyms_action
         #   @return [::Google::Cloud::Retail::V2::Rule::TwowaySynonymsAction]
         #     Treats a set of terms as synonyms of one another.
         #
-        #     Note: The following fields are mutually exclusive: `twoway_synonyms_action`, `boost_action`, `redirect_action`, `oneway_synonyms_action`, `do_not_associate_action`, `replacement_action`, `ignore_action`, `filter_action`, `force_return_facet_action`, `remove_facet_action`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+        #     Note: The following fields are mutually exclusive: `twoway_synonyms_action`, `boost_action`, `redirect_action`, `oneway_synonyms_action`, `do_not_associate_action`, `replacement_action`, `ignore_action`, `filter_action`, `force_return_facet_action`, `remove_facet_action`, `pin_action`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [rw] force_return_facet_action
         #   @return [::Google::Cloud::Retail::V2::Rule::ForceReturnFacetAction]
         #     Force returns an attribute as a facet in the request.
         #
-        #     Note: The following fields are mutually exclusive: `force_return_facet_action`, `boost_action`, `redirect_action`, `oneway_synonyms_action`, `do_not_associate_action`, `replacement_action`, `ignore_action`, `filter_action`, `twoway_synonyms_action`, `remove_facet_action`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+        #     Note: The following fields are mutually exclusive: `force_return_facet_action`, `boost_action`, `redirect_action`, `oneway_synonyms_action`, `do_not_associate_action`, `replacement_action`, `ignore_action`, `filter_action`, `twoway_synonyms_action`, `remove_facet_action`, `pin_action`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [rw] remove_facet_action
         #   @return [::Google::Cloud::Retail::V2::Rule::RemoveFacetAction]
         #     Remove an attribute as a facet in the request (if present).
         #
-        #     Note: The following fields are mutually exclusive: `remove_facet_action`, `boost_action`, `redirect_action`, `oneway_synonyms_action`, `do_not_associate_action`, `replacement_action`, `ignore_action`, `filter_action`, `twoway_synonyms_action`, `force_return_facet_action`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+        #     Note: The following fields are mutually exclusive: `remove_facet_action`, `boost_action`, `redirect_action`, `oneway_synonyms_action`, `do_not_associate_action`, `replacement_action`, `ignore_action`, `filter_action`, `twoway_synonyms_action`, `force_return_facet_action`, `pin_action`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+        # @!attribute [rw] pin_action
+        #   @return [::Google::Cloud::Retail::V2::Rule::PinAction]
+        #     Pins one or more specified products to a specific position in the
+        #     results.
+        #
+        #     Note: The following fields are mutually exclusive: `pin_action`, `boost_action`, `redirect_action`, `oneway_synonyms_action`, `do_not_associate_action`, `replacement_action`, `ignore_action`, `filter_action`, `twoway_synonyms_action`, `force_return_facet_action`, `remove_facet_action`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [rw] condition
         #   @return [::Google::Cloud::Retail::V2::Condition]
         #     Required. The condition that triggers the rule.
@@ -403,6 +409,60 @@ module Google
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods
           end
+
+          # Pins one or more specified products to a specific position in the
+          # results.
+          #
+          # * Rule Condition:
+          #   Must specify non-empty
+          #   {::Google::Cloud::Retail::V2::Condition#query_terms Condition.query_terms}
+          #   (for search only) or
+          #   {::Google::Cloud::Retail::V2::Condition#page_categories Condition.page_categories}
+          #   (for browse only), but can't specify both.
+          #
+          # * Action Input: mapping of `[pin_position, product_id]` pairs (pin position
+          # uses 1-based indexing).
+          #
+          # * Action Result: Will pin products with matching ids to the position
+          # specified in the final result order.
+          #
+          # Example: Suppose the query is `shoes`, the
+          # {::Google::Cloud::Retail::V2::Condition#query_terms Condition.query_terms} is
+          # `shoes` and the pin_map has `{1, "pid1"}`, then product with `pid1` will be
+          # pinned to the top position in the final results.
+          #
+          # If multiple PinActions are matched to a single request the actions will
+          # be processed from most to least recently updated.
+          #
+          # Pins to positions larger than the max allowed page size of 120 are not
+          # allowed.
+          # @!attribute [rw] pin_map
+          #   @return [::Google::Protobuf::Map{::Integer => ::String}]
+          #     Required. A map of positions to product_ids.
+          #
+          #     Partial matches per action are allowed, if a certain position in the map
+          #     is already filled that `[position, product_id]` pair will be ignored
+          #     but the rest may still be applied. This case will only occur if multiple
+          #     pin actions are matched to a single request, as the map guarantees that
+          #     pin positions are unique within the same action.
+          #
+          #     Duplicate product_ids are not permitted within a single pin map.
+          #
+          #     The max size of this map is 120, equivalent to the max [request page
+          #     size](https://cloud.google.com/retail/docs/reference/rest/v2/projects.locations.catalogs.placements/search#request-body).
+          class PinAction
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # @!attribute [rw] key
+            #   @return [::Integer]
+            # @!attribute [rw] value
+            #   @return [::String]
+            class PinMapEntry
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+          end
         end
 
         # An intended audience of the {::Google::Cloud::Retail::V2::Product Product} for
@@ -446,9 +506,9 @@ module Google
         #   @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.
+        #     "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
@@ -457,6 +517,10 @@ module Google
         #     Google Merchant Center property
         #     [color](https://support.google.com/merchants/answer/6324487). Schema.org
         #     property [Product.color](https://schema.org/color).
+        #
+        #     The colorFamilies field as a system attribute is not a required field but
+        #     strongly recommended to be specified. Google Search models treat this field
+        #     as more important than a custom product attribute when specified.
         # @!attribute [rw] colors
         #   @return [::Array<::String>]
         #     The color display names, which may be different from standard color family
@@ -578,9 +642,10 @@ module Google
         end
 
         # {::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.
+        # Retail Search use product images to improve prediction and search results.
+        # Product images can be returned in results, and are shown in prediction or
+        # search previews in the console. Please try to provide correct product images
+        # and avoid using images with size too small.
         # @!attribute [rw] uri
         #   @return [::String]
         #     Required. URI of the image.
@@ -805,9 +870,7 @@ module Google
         #     is set.
         # @!attribute [rw] user_agent
         #   @return [::String]
-        #     User agent as included in the HTTP header. Required for getting
-        #     [SearchResponse.sponsored_results][google.cloud.retail.v2.SearchResponse.sponsored_results].
-        #
+        #     User agent as included in the HTTP header.
         #     The field must be a UTF-8 encoded string with a length limit of 1,000
         #     characters. Otherwise, an INVALID_ARGUMENT error is returned.
         #
@@ -837,17 +900,17 @@ module Google
         # by a place ID.
         # @!attribute [rw] place_id
         #   @return [::String]
-        #     The place ID for the current set of inventory information.
+        #     Optional. 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.
+        #     Optional. Product price and cost information.
         #
         #     Google Merchant Center property
         #     [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.
+        #     Optional. 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:
@@ -866,7 +929,7 @@ module Google
         #       product is 5MiB.
         # @!attribute [rw] fulfillment_types
         #   @return [::Array<::String>]
-        #     Input only. Supported fulfillment types. Valid fulfillment type values
+        #     Optional. 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.
@@ -902,6 +965,47 @@ module Google
           end
         end
 
+        # Metadata for pinning to be returned in the response.
+        # This is used for distinguishing between applied vs dropped pins.
+        # @!attribute [rw] all_matched_pins
+        #   @return [::Google::Protobuf::Map{::Integer => ::Google::Cloud::Retail::V2::PinControlMetadata::ProductPins}]
+        #     Map of all matched pins, keyed by pin position.
+        # @!attribute [rw] dropped_pins
+        #   @return [::Google::Protobuf::Map{::Integer => ::Google::Cloud::Retail::V2::PinControlMetadata::ProductPins}]
+        #     Map of pins that were dropped due to overlap with other matching pins,
+        #     keyed by pin position.
+        class PinControlMetadata
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # List of product ids which have associated pins.
+          # @!attribute [rw] product_id
+          #   @return [::Array<::String>]
+          #     List of product ids which have associated pins.
+          class ProductPins
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # @!attribute [rw] key
+          #   @return [::Integer]
+          # @!attribute [rw] value
+          #   @return [::Google::Cloud::Retail::V2::PinControlMetadata::ProductPins]
+          class AllMatchedPinsEntry
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # @!attribute [rw] key
+          #   @return [::Integer]
+          # @!attribute [rw] value
+          #   @return [::Google::Cloud::Retail::V2::PinControlMetadata::ProductPins]
+          class DroppedPinsEntry
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+
         # At which level we offer configuration for attributes.
         module AttributeConfigLevel
           # Value used when unset. In this case, server behavior defaults to
@@ -913,7 +1017,7 @@ module Google
           PRODUCT_LEVEL_ATTRIBUTE_CONFIG = 1
 
           # At this level, we honor the attribute configurations set in
-          # [CatalogConfig.attribute_configs][].
+          # `CatalogConfig.attribute_configs`.
           CATALOG_LEVEL_ATTRIBUTE_CONFIG = 2
         end
 

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

@@ -35,7 +35,7 @@ module Google
         #     The maximum number of allowed characters is 255.
         # @!attribute [rw] visitor_id
         #   @return [::String]
-        #     Required field. A unique identifier for tracking visitors. For example,
+        #     Recommended 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.
@@ -74,10 +74,11 @@ module Google
         # @!attribute [rw] dataset
         #   @return [::String]
         #     Determines which dataset to use for fetching completion. "user-data" will
-        #     use the imported dataset through
+        #     use the dataset imported 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".
+        #     `cloud-retail` will use the dataset generated by Cloud Retail based on user
+        #     events. If left empty, completions will be fetched from the `user-data`
+        #     dataset.
         #
         #     Current supported values:
         #
@@ -98,7 +99,7 @@ module Google
         #   @return [::Boolean]
         #     If true, attribute suggestions are enabled and provided in the response.
         #
-        #     This field is only available for the "cloud-retail" dataset.
+        #     This field is only available for the `cloud-retail` dataset.
         # @!attribute [rw] entity
         #   @return [::String]
         #     The entity for customers who run multiple entities, domains, sites, or
@@ -106,7 +107,12 @@ module Google
         #     `google.com`, `youtube.com`, etc.
         #     If this is set, it must be an exact match with
         #     {::Google::Cloud::Retail::V2::UserEvent#entity UserEvent.entity} to get
-        #     per-entity autocomplete results.
+        #     per-entity autocomplete results. This field will be applied to
+        #     `completion_results` only. It has no effect on the `attribute_results`.
+        #     Also, this entity should be limited to 256 characters, if too long, it will
+        #     be truncated to 256 characters in both generation and serving time, and may
+        #     lead to mis-match. To ensure it works, please set the entity with string
+        #     within 256 characters.
         class CompleteQueryRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -150,7 +156,7 @@ module Google
         # @!attribute [rw] attribute_results
         #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::Retail::V2::CompleteQueryResponse::AttributeResult}]
         #     A map of matched attribute suggestions. This field is only available for
-        #     "cloud-retail" dataset.
+        #     `cloud-retail` dataset.
         #
         #     Current supported keys:
         #
@@ -169,10 +175,10 @@ module Google
           #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::Retail::V2::CustomAttribute}]
           #     Custom attributes for the suggestion term.
           #
-          #     * For "user-data", the attributes are additional custom attributes
+          #     * For `user-data`, the attributes are additional custom attributes
           #     ingested through BigQuery.
           #
-          #     * For "cloud-retail", the attributes are product attributes generated
+          #     * For `cloud-retail`, the attributes are product attributes generated
           #     by Cloud Retail. It requires
           #     {::Google::Cloud::Retail::V2::UserEvent#product_details UserEvent.product_details}
           #     is imported properly.
@@ -201,9 +207,9 @@ module Google
           end
 
           # Resource that represents attribute results.
-          # The list of suggestions for the attribute.
           # @!attribute [rw] suggestions
           #   @return [::Array<::String>]
+          #     The list of suggestions for the attribute.
           class AttributeResult
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods

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

@@ -69,9 +69,6 @@ module Google
         # @!attribute [rw] partition_date
         #   @return [::Google::Type::Date]
         #     BigQuery time partitioned table's _PARTITIONDATE in YYYY-MM-DD format.
-        #
-        #     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

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

@@ -70,7 +70,6 @@ module Google
         #     `frequently-bought-together`, `page-optimization`, `similar-items`,
         #     `buy-it-again`, `on-sale-items`, and `recently-viewed`(readonly value).
         #
-        #
         #     This field together with
         #     {::Google::Cloud::Retail::V2::Model#optimization_objective optimization_objective}
         #     describe model metadata to use to control model training and serving.

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

@@ -487,7 +487,6 @@ module Google
         #     * {::Google::Cloud::Retail::V2::Product#name name}
         #     * {::Google::Cloud::Retail::V2::Product#color_info color_info}
         #
-        #
         #     Note: Returning more fields in
         #     {::Google::Cloud::Retail::V2::SearchResponse SearchResponse} can increase
         #     response payload size and serving latency.

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

@@ -338,6 +338,27 @@ module Google
         # @!attribute [rw] tile_navigation_spec
         #   @return [::Google::Cloud::Retail::V2::SearchRequest::TileNavigationSpec]
         #     Optional. This field specifies tile navigation related parameters.
+        # @!attribute [rw] language_code
+        #   @return [::String]
+        #     Optional. The BCP-47 language code, such as "en-US" or "sr-Latn"
+        #     [list](https://www.unicode.org/cldr/charts/46/summary/root.html). For more
+        #     information, see [Standardized codes](https://google.aip.dev/143). This
+        #     field helps to better interpret the query. If a value isn't specified, the
+        #     query language code is automatically detected, which may not be accurate.
+        # @!attribute [rw] region_code
+        #   @return [::String]
+        #     Optional. The Unicode country/region code (CLDR) of a location, such as
+        #     "US" and "419"
+        #     [list](https://www.unicode.org/cldr/charts/46/supplemental/territory_information.html).
+        #     For more information, see [Standardized codes](https://google.aip.dev/143).
+        #     If set, then results will be boosted based on the region_code provided.
+        # @!attribute [rw] place_id
+        #   @return [::String]
+        #     Optional. An id corresponding to a place, such as a store id or region id.
+        #     When specified, we use the price from the local inventory with the matching
+        #     product's
+        #     {::Google::Cloud::Retail::V2::LocalInventory#place_id LocalInventory.place_id}
+        #     for revenue optimization.
         class SearchRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -357,7 +378,6 @@ module Google
           #   @return [::Array<::String>]
           #     List of keys to exclude when faceting.
           #
-          #
           #     By default,
           #     {::Google::Cloud::Retail::V2::SearchRequest::FacetSpec::FacetKey#key FacetKey.key}
           #     is not excluded from the filter unless it is listed in this field.
@@ -606,7 +626,7 @@ module Google
           # @!attribute [rw] condition_boost_specs
           #   @return [::Array<::Google::Cloud::Retail::V2::SearchRequest::BoostSpec::ConditionBoostSpec>]
           #     Condition boost specifications. If a product matches multiple conditions
-          #     in the specifictions, boost scores from these specifications are all
+          #     in the specifications, boost scores from these specifications are all
           #     applied and combined in a non-linear way. Maximum number of
           #     specifications is 20.
           # @!attribute [rw] skip_boost_spec_validation
@@ -813,9 +833,14 @@ module Google
           #     navigation.
           # @!attribute [rw] applied_tiles
           #   @return [::Array<::Google::Cloud::Retail::V2::Tile>]
-          #     This field specifies the tiles which are already clicked in client side.
-          #     NOTE: This field is not being used for filtering search products. Client
-          #     side should also put all the applied tiles in
+          #     This optional field specifies the tiles which are already clicked in
+          #     client side. While the feature works without this field set, particularly
+          #     for an initial query, it is highly recommended to set this field because
+          #     it can improve the quality of the search response and removes possible
+          #     duplicate tiles.
+          #
+          #     NOTE: This field is not being used for filtering search
+          #     products. Client side should also put all the applied tiles in
           #     {::Google::Cloud::Retail::V2::SearchRequest#filter SearchRequest.filter}.
           class TileNavigationSpec
             include ::Google::Protobuf::MessageExts
@@ -915,6 +940,14 @@ module Google
         #   @return [::Array<::String>]
         #     The fully qualified resource name of applied
         #     [controls](https://cloud.google.com/retail/docs/serving-control-rules).
+        # @!attribute [rw] pin_control_metadata
+        #   @return [::Google::Cloud::Retail::V2::PinControlMetadata]
+        #     Metadata for pin controls which were applicable to the request.
+        #     This contains two map fields, one for all matched pins and one for pins
+        #     which were matched but not applied.
+        #
+        #     The two maps are keyed by pin position, and the values are the product ids
+        #     which were matched to that pin.
         # @!attribute [rw] invalid_condition_boost_specs
         #   @return [::Array<::Google::Cloud::Retail::V2::SearchRequest::BoostSpec::ConditionBoostSpec>]
         #     The invalid
@@ -922,7 +955,7 @@ module Google
         #     that are not applied during serving.
         # @!attribute [rw] experiment_info
         #   @return [::Array<::Google::Cloud::Retail::V2::ExperimentInfo>]
-        #     Metadata related to A/B testing [Experiment][] associated with this
+        #     Metadata related to A/B testing experiment associated with this
         #     response. Only exists when an experiment is triggered.
         # @!attribute [rw] conversational_search_result
         #   @return [::Google::Cloud::Retail::V2::SearchResponse::ConversationalSearchResult]
@@ -1186,7 +1219,7 @@ module Google
           end
         end
 
-        # Metadata for active A/B testing [Experiment][].
+        # Metadata for active A/B testing experiment.
         # @!attribute [rw] serving_config_experiment
         #   @return [::Google::Cloud::Retail::V2::ExperimentInfo::ServingConfigExperiment]
         #     A/B test between existing Cloud Retail Search
@@ -1210,7 +1243,7 @@ module Google
           # @!attribute [rw] experiment_serving_config
           #   @return [::String]
           #     The fully qualified resource name of the serving config
-          #     [Experiment.VariantArm.serving_config_id][] responsible for generating
+          #     `Experiment.VariantArm.serving_config_id` responsible for generating
           #     the search response. For example:
           #     `projects/*/locations/*/catalogs/*/servingConfigs/*`.
           class ServingConfigExperiment

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

@@ -44,7 +44,7 @@ module Google
         #
         #     Required when
         #     {::Google::Cloud::Retail::V2::ServingConfig#solution_types solution_types} is
-        #     [SOLUTION_TYPE_RECOMMENDATION][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_RECOMMENDATION].
+        #     {::Google::Cloud::Retail::V2::SolutionType::SOLUTION_TYPE_RECOMMENDATION SOLUTION_TYPE_RECOMMENDATION}.
         # @!attribute [rw] price_reranking_level
         #   @return [::String]
         #     How much price ranking we want in serving results.
@@ -64,7 +64,7 @@ module Google
         #
         #     Can only be set if
         #     {::Google::Cloud::Retail::V2::ServingConfig#solution_types solution_types} is
-        #     [SOLUTION_TYPE_RECOMMENDATION][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_RECOMMENDATION].
+        #     {::Google::Cloud::Retail::V2::SolutionType::SOLUTION_TYPE_RECOMMENDATION SOLUTION_TYPE_RECOMMENDATION}.
         # @!attribute [rw] facet_control_ids
         #   @return [::Array<::String>]
         #     Facet specifications for faceted search. If empty, no facets are returned.
@@ -77,7 +77,7 @@ module Google
         #
         #     Can only be set if
         #     {::Google::Cloud::Retail::V2::ServingConfig#solution_types solution_types} is
-        #     [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].
+        #     {::Google::Cloud::Retail::V2::SolutionType::SOLUTION_TYPE_SEARCH SOLUTION_TYPE_SEARCH}.
         # @!attribute [rw] dynamic_facet_spec
         #   @return [::Google::Cloud::Retail::V2::SearchRequest::DynamicFacetSpec]
         #     The specification for dynamically generated facets. Notice that only
@@ -85,7 +85,7 @@ module Google
         #
         #     Can only be set if
         #     {::Google::Cloud::Retail::V2::ServingConfig#solution_types solution_types} is
-        #     [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].
+        #     {::Google::Cloud::Retail::V2::SolutionType::SOLUTION_TYPE_SEARCH SOLUTION_TYPE_SEARCH}.
         # @!attribute [rw] boost_control_ids
         #   @return [::Array<::String>]
         #     Condition boost specifications. If a product matches multiple conditions
@@ -103,7 +103,7 @@ module Google
         #
         #     Can only be set if
         #     {::Google::Cloud::Retail::V2::ServingConfig#solution_types solution_types} is
-        #     [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].
+        #     {::Google::Cloud::Retail::V2::SolutionType::SOLUTION_TYPE_SEARCH SOLUTION_TYPE_SEARCH}.
         # @!attribute [rw] filter_control_ids
         #   @return [::Array<::String>]
         #     Condition filter specifications. If a product matches multiple conditions
@@ -113,7 +113,7 @@ module Google
         #
         #     Can only be set if
         #     {::Google::Cloud::Retail::V2::ServingConfig#solution_types solution_types} is
-        #     [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].
+        #     {::Google::Cloud::Retail::V2::SolutionType::SOLUTION_TYPE_SEARCH SOLUTION_TYPE_SEARCH}.
         # @!attribute [rw] redirect_control_ids
         #   @return [::Array<::String>]
         #     Condition redirect specifications. Only the first triggered redirect action
@@ -122,7 +122,7 @@ module Google
         #
         #     Can only be set if
         #     {::Google::Cloud::Retail::V2::ServingConfig#solution_types solution_types} is
-        #     [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].
+        #     {::Google::Cloud::Retail::V2::SolutionType::SOLUTION_TYPE_SEARCH SOLUTION_TYPE_SEARCH}.
         # @!attribute [rw] twoway_synonyms_control_ids
         #   @return [::Array<::String>]
         #     Condition synonyms specifications. If multiple syonyms conditions match,
@@ -132,7 +132,7 @@ module Google
         #
         #     Can only be set if
         #     {::Google::Cloud::Retail::V2::ServingConfig#solution_types solution_types} is
-        #     [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].
+        #     {::Google::Cloud::Retail::V2::SolutionType::SOLUTION_TYPE_SEARCH SOLUTION_TYPE_SEARCH}.
         # @!attribute [rw] oneway_synonyms_control_ids
         #   @return [::Array<::String>]
         #     Condition oneway synonyms specifications. If multiple oneway synonyms
@@ -142,7 +142,7 @@ module Google
         #
         #     Can only be set if
         #     {::Google::Cloud::Retail::V2::ServingConfig#solution_types solution_types} is
-        #     [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].
+        #     {::Google::Cloud::Retail::V2::SolutionType::SOLUTION_TYPE_SEARCH SOLUTION_TYPE_SEARCH}.
         # @!attribute [rw] do_not_associate_control_ids
         #   @return [::Array<::String>]
         #     Condition do not associate specifications. If multiple do not associate
@@ -153,7 +153,7 @@ module Google
         #
         #     Can only be set if
         #     {::Google::Cloud::Retail::V2::ServingConfig#solution_types solution_types} is
-        #     [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].
+        #     {::Google::Cloud::Retail::V2::SolutionType::SOLUTION_TYPE_SEARCH SOLUTION_TYPE_SEARCH}.
         # @!attribute [rw] replacement_control_ids
         #   @return [::Array<::String>]
         #     Condition replacement specifications.
@@ -163,7 +163,7 @@ module Google
         #
         #     Can only be set if
         #     {::Google::Cloud::Retail::V2::ServingConfig#solution_types solution_types} is
-        #     [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].
+        #     {::Google::Cloud::Retail::V2::SolutionType::SOLUTION_TYPE_SEARCH SOLUTION_TYPE_SEARCH}.
         # @!attribute [rw] ignore_control_ids
         #   @return [::Array<::String>]
         #     Condition ignore specifications. If multiple ignore
@@ -174,7 +174,7 @@ module Google
         #
         #     Can only be set if
         #     {::Google::Cloud::Retail::V2::ServingConfig#solution_types solution_types} is
-        #     [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].
+        #     {::Google::Cloud::Retail::V2::SolutionType::SOLUTION_TYPE_SEARCH SOLUTION_TYPE_SEARCH}.
         # @!attribute [rw] diversity_level
         #   @return [::String]
         #     How much diversity to use in recommendation model results e.g.
@@ -191,7 +191,7 @@ module Google
         #
         #     Can only be set if
         #     {::Google::Cloud::Retail::V2::ServingConfig#solution_types solution_types} is
-        #     [SOLUTION_TYPE_RECOMMENDATION][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_RECOMMENDATION].
+        #     {::Google::Cloud::Retail::V2::SolutionType::SOLUTION_TYPE_RECOMMENDATION SOLUTION_TYPE_RECOMMENDATION}.
         # @!attribute [rw] diversity_type
         #   @return [::Google::Cloud::Retail::V2::ServingConfig::DiversityType]
         #     What kind of diversity to use - data driven or rule based. If unset, the
@@ -212,7 +212,7 @@ module Google
         #
         #     Can only be set if
         #     {::Google::Cloud::Retail::V2::ServingConfig#solution_types solution_types} is
-        #     [SOLUTION_TYPE_RECOMMENDATION][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_RECOMMENDATION].
+        #     {::Google::Cloud::Retail::V2::SolutionType::SOLUTION_TYPE_RECOMMENDATION SOLUTION_TYPE_RECOMMENDATION}.
         # @!attribute [rw] ignore_recs_denylist
         #   @return [::Boolean]
         #     When the flag is enabled, the products in the denylist will not be filtered
@@ -223,7 +223,7 @@ module Google
         #
         #     Can only be set if
         #     {::Google::Cloud::Retail::V2::ServingConfig#solution_types solution_types} is
-        #     [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_SEARCH].
+        #     {::Google::Cloud::Retail::V2::SolutionType::SOLUTION_TYPE_SEARCH SOLUTION_TYPE_SEARCH}.
         #
         #     Notice that if both
         #     {::Google::Cloud::Retail::V2::ServingConfig#personalization_spec ServingConfig.personalization_spec}

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

@@ -33,8 +33,6 @@ module Google
         #       viewed.
         #     * `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.