google-apis-retail_v2 0.69.0 → 0.71.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6ad77f2d05d615bfb7a3ef7767ff5e46b14d30f40d67078a3ac8b06b9ae1328e
-  data.tar.gz: 830ccb9adafd13220bf6ca3528409c4dc485f44f76c0a4dc51c91d46a2551f63
+  metadata.gz: b5abaae51c40aafdd4cb7896eebb193bc493871981e10862f09bb67ea6984560
+  data.tar.gz: f84164f162ed326430a1fec6b79ac7532a0e47b55037320ef9f167240a50d1f9
 SHA512:
-  metadata.gz: 59a21c3e22f066b01ccd1178d3c5a26623c69130c7432daf85468f7f564fec7d49d693b58da1b200f298b674304dcebf746afa8c07662a872e6577593c6aba1c
-  data.tar.gz: 13e4390249bda200000fe31abe1063a9029916a31be5e68d41f02d4c06025a645e9e3d314f945bfe35a0cabaf52144d4cce63d9c4747deddd669ab810e6ae130
+  metadata.gz: 97423beeea375718bad3d97cd745f0b0ce9cfe148b55866d9e59d242668a4cd8d5ee478770a32f172d233d15fdcb3e04ecf112c91fa4844bc9f7460fa349f4db
+  data.tar.gz: 7324b2b589f75875e0dca568087ebe83d3244f075fcf3bfd17244cfe4d345207c4f1d7c7b477525d86e4585abdd43defc8279f04d118c492f0665f63075455ab

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Release history for google-apis-retail_v2
 
+### v0.71.0 (2023-04-30)
+
+* Regenerated from discovery document revision 20230420
+
+### v0.70.0 (2023-04-23)
+
+* Regenerated from discovery document revision 20230413
+
 ### v0.69.0 (2023-03-26)
 
 * Regenerated from discovery document revision 20230321

data/lib/google/apis/retail_v2/classes.rb

@@ -820,8 +820,8 @@ module Google
         attr_accessor :completion_results
       
         # Matched recent searches of this user. The maximum number of recent searches is
-        # 10. This field is a restricted feature. Contact Retail Search support team if
-        # you are interested in enabling it. This feature is only available when
+        # 10. This field is a restricted feature. If you want to enable it, contact
+        # Retail Search support. This feature is only available when
         # CompleteQueryRequest.visitor_id field is set and UserEvent is imported. The
         # recent searches satisfy the follow rules: * They are ordered from latest to
         # oldest. * They are matched with CompleteQueryRequest.query case insensitively.
@@ -930,8 +930,8 @@ module Google
         attr_accessor :last_denylist_import_operation
       
         # Output only. Name of the LRO corresponding to the latest suggestion terms list
-        # import. Can use GetOperation API to retrieve the latest state of the Long
-        # Running Operation.
+        # import. Can use GetOperation API method to retrieve the latest state of the
+        # Long Running Operation.
         # Corresponds to the JSON property `lastSuggestionsImportOperation`
         # @return [String]
         attr_accessor :last_suggestions_import_operation
@@ -1271,16 +1271,16 @@ module Google
         end
       end
       
-      # Metadata for active A/B testing Experiments.
+      # Metadata for active A/B testing Experiment.
       class GoogleCloudRetailV2ExperimentInfo
         include Google::Apis::Core::Hashable
       
         # The fully qualified resource name of the experiment that provides the serving
         # config under test, should an active experiment exist. For example: `projects/*/
         # locations/global/catalogs/default_catalog/experiments/experiment_id`
-        # Corresponds to the JSON property `experimentName`
+        # Corresponds to the JSON property `experiment`
         # @return [String]
-        attr_accessor :experiment_name
+        attr_accessor :experiment
       
         # Metadata for active serving config A/B tests.
         # Corresponds to the JSON property `servingConfigExperiment`
@@ -1293,7 +1293,7 @@ module Google
       
         # Update properties of this object
         def update!(**args)
-          @experiment_name = args[:experiment_name] if args.key?(:experiment_name)
+          @experiment = args[:experiment] if args.key?(:experiment)
           @serving_config_experiment = args[:serving_config_experiment] if args.key?(:serving_config_experiment)
         end
       end
@@ -1617,9 +1617,11 @@ module Google
         # the import is finished, a notification is sent to specified Pub/Sub topic. The
         # message data is JSON string of a Operation. Format of the Pub/Sub topic is `
         # projects/`project`/topics/`topic``. It has to be within the same project as
-        # ImportProductsRequest.parent. Make sure that `service-@gcp-sa-retail.iam.
-        # gserviceaccount.com` has the `pubsub.topics.publish` IAM permission on the
-        # topic.
+        # ImportProductsRequest.parent. Make sure that both `cloud-retail-customer-data-
+        # access@system.gserviceaccount.com` and `service-@gcp-sa-retail.iam.
+        # gserviceaccount.com` have the `pubsub.topics.publish` IAM permission on the
+        # topic. Only supported when ImportProductsRequest.reconciliation_mode is set to
+        # `FULL`.
         # Corresponds to the JSON property `notificationPubsubTopic`
         # @return [String]
         attr_accessor :notification_pubsub_topic
@@ -1997,6 +1999,11 @@ module Google
         # @return [String]
         attr_accessor :last_tune_time
       
+        # Additional model features config.
+        # Corresponds to the JSON property `modelFeaturesConfig`
+        # @return [Google::Apis::RetailV2::GoogleCloudRetailV2ModelModelFeaturesConfig]
+        attr_accessor :model_features_config
+      
         # Required. The fully qualified resource name of the model. Format: `projects/`
         # project_number`/locations/`location_id`/catalogs/`catalog_id`/models/`model_id`
         # ` catalog_id has char limit of 50. recommendation_model_id has char limit of
@@ -2086,6 +2093,7 @@ module Google
           @display_name = args[:display_name] if args.key?(:display_name)
           @filtering_option = args[:filtering_option] if args.key?(:filtering_option)
           @last_tune_time = args[:last_tune_time] if args.key?(:last_tune_time)
+          @model_features_config = args[:model_features_config] if args.key?(:model_features_config)
           @name = args[:name] if args.key?(:name)
           @optimization_objective = args[:optimization_objective] if args.key?(:optimization_objective)
           @periodic_tuning_state = args[:periodic_tuning_state] if args.key?(:periodic_tuning_state)
@@ -2098,6 +2106,46 @@ module Google
         end
       end
       
+      # More configs of the frequently-bought-together model type.
+      class GoogleCloudRetailV2ModelFrequentlyBoughtTogetherFeaturesConfig
+        include Google::Apis::Core::Hashable
+      
+        # Optional. Specifies the context of the model when used in predict requests.
+        # Only settable for the `frequently-bought-together` type. Will default to
+        # MULTI_CONTEXT if not specified.
+        # Corresponds to the JSON property `contextProductsType`
+        # @return [String]
+        attr_accessor :context_products_type
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @context_products_type = args[:context_products_type] if args.key?(:context_products_type)
+        end
+      end
+      
+      # Additional model features config.
+      class GoogleCloudRetailV2ModelModelFeaturesConfig
+        include Google::Apis::Core::Hashable
+      
+        # More configs of the frequently-bought-together model type.
+        # Corresponds to the JSON property `frequentlyBoughtTogetherConfig`
+        # @return [Google::Apis::RetailV2::GoogleCloudRetailV2ModelFrequentlyBoughtTogetherFeaturesConfig]
+        attr_accessor :frequently_bought_together_config
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @frequently_bought_together_config = args[:frequently_bought_together_config] if args.key?(:frequently_bought_together_config)
+        end
+      end
+      
       # Represents an ordered combination of valid serving configs, which can be used
       # for `PAGE_OPTIMIZATION` recommendations.
       class GoogleCloudRetailV2ModelServingConfigList
@@ -3568,11 +3616,11 @@ module Google
         include Google::Apis::Core::Hashable
       
         # A filter to apply on the matching condition results. Supported features: *
-        # filter must be set. * Filter syntax is identical to SearchRequest.filter. See
-        # more details at the Retail Search [user guide](/retail/search/docs/filter-and-
-        # order#filter). * To filter products with product ID "product_1" or "product_2",
-        # and color "Red" or "Blue": *(id: ANY("product_1", "product_2")) * *AND * *(
-        # colorFamilies: ANY("Red", "Blue")) *
+        # filter must be set. * Filter syntax is identical to SearchRequest.filter. For
+        # more information, see [Filter](/retail/docs/filter-and-order#filter). * To
+        # filter products with product ID "product_1" or "product_2", and color "Red" or
+        # "Blue": *(id: ANY("product_1", "product_2")) * *AND * *(colorFamilies: ANY("
+        # Red", "Blue")) *
         # Corresponds to the JSON property `filter`
         # @return [String]
         attr_accessor :filter
@@ -3724,13 +3772,6 @@ module Google
       class GoogleCloudRetailV2SearchRequest
         include Google::Apis::Core::Hashable
       
-        # Represents the banner in request, for projects that combine banners. For
-        # example: a retailer can sell products under different banners like retailer-
-        # main, retailer-baby, retailer-meds, etc. under one project.
-        # Corresponds to the JSON property `banner`
-        # @return [String]
-        attr_accessor :banner
-      
         # Boost specification to boost certain items.
         # Corresponds to the JSON property `boostSpec`
         # @return [Google::Apis::RetailV2::GoogleCloudRetailV2SearchRequestBoostSpec]
@@ -3747,9 +3788,9 @@ module Google
         # checking any filters on the search page. The filter applied to every search
         # request when quality improvement such as query expansion is needed. For
         # example, if a query does not have enough results, an expanded query with
-        # SearchRequest.canonical_filter will be returned as a supplement of the
-        # original query. This field is strongly recommended to achieve high search
-        # quality. See SearchRequest.filter for more details about filter syntax.
+        # SearchRequest.canonical_filter is returned as a supplement of the original
+        # query. This field is strongly recommended to achieve high search quality. For
+        # more information about filter syntax, see SearchRequest.filter.
         # Corresponds to the JSON property `canonicalFilter`
         # @return [String]
         attr_accessor :canonical_filter
@@ -3759,8 +3800,16 @@ module Google
         # @return [Google::Apis::RetailV2::GoogleCloudRetailV2SearchRequestDynamicFacetSpec]
         attr_accessor :dynamic_facet_spec
       
+        # The entity for customers that may run multiple different entities, domains,
+        # sites or regions, for example, `Google US`, `Google Ads`, `Waymo`, `google.com`
+        # , `youtube.com`, etc. If this is set, it should be exactly matched with
+        # UserEvent.entity to get search results boosted by entity.
+        # Corresponds to the JSON property `entity`
+        # @return [String]
+        attr_accessor :entity
+      
         # Facet specifications for faceted search. If empty, no facets are returned. A
-        # maximum of 100 values are allowed. Otherwise, an INVALID_ARGUMENT error is
+        # maximum of 200 values are allowed. Otherwise, an INVALID_ARGUMENT error is
         # returned.
         # Corresponds to the JSON property `facetSpecs`
         # @return [Array<Google::Apis::RetailV2::GoogleCloudRetailV2SearchRequestFacetSpec>]
@@ -3768,8 +3817,8 @@ module Google
       
         # The filter syntax consists of an expression language for constructing a
         # predicate from one or more fields of the products being filtered. Filter
-        # expression is case-sensitive. See more details at this [user guide](https://
-        # cloud.google.com/retail/docs/filter-and-order#filter). If this field is
+        # expression is case-sensitive. For more information, see [Filter](https://cloud.
+        # google.com/retail/docs/filter-and-order#filter). If this field is
         # unrecognizable, an INVALID_ARGUMENT is returned.
         # Corresponds to the JSON property `filter`
         # @return [String]
@@ -3784,8 +3833,9 @@ module Google
         # UTF-8 encoding, and international characters are allowed. * The key portion of
         # a label must be unique. However, you can use the same key with multiple
         # resources. * Keys must start with a lowercase letter or international
-        # character. See [Google Cloud Document](https://cloud.google.com/resource-
-        # manager/docs/creating-managing-labels#requirements) for more details.
+        # character. For more information, see [Requirements for labels](https://cloud.
+        # google.com/resource-manager/docs/creating-managing-labels#requirements) in the
+        # Resource Manager documentation.
         # Corresponds to the JSON property `labels`
         # @return [Hash<String,String>]
         attr_accessor :labels
@@ -3800,14 +3850,14 @@ module Google
       
         # The order in which products are returned. Products can be ordered by a field
         # in an Product object. Leave it unset if ordered by relevance. OrderBy
-        # expression is case-sensitive. See more details at this [user guide](https://
-        # cloud.google.com/retail/docs/filter-and-order#order). If this field is
+        # expression is case-sensitive. For more information, see [Order](https://cloud.
+        # google.com/retail/docs/filter-and-order#order). If this field is
         # unrecognizable, an INVALID_ARGUMENT is returned.
         # Corresponds to the JSON property `orderBy`
         # @return [String]
         attr_accessor :order_by
       
-        # The categories associated with a category page. Required for category
+        # The categories associated with a category page. Must be set for category
         # navigation queries to achieve good search quality. The format should be the
         # same as UserEvent.page_categories; To represent full path of category, use '>'
         # sign to separate different hierarchies. If '>' is part of the category name,
@@ -3912,11 +3962,11 @@ module Google
       
         # Update properties of this object
         def update!(**args)
-          @banner = args[:banner] if args.key?(:banner)
           @boost_spec = args[:boost_spec] if args.key?(:boost_spec)
           @branch = args[:branch] if args.key?(:branch)
           @canonical_filter = args[:canonical_filter] if args.key?(:canonical_filter)
           @dynamic_facet_spec = args[:dynamic_facet_spec] if args.key?(:dynamic_facet_spec)
+          @entity = args[:entity] if args.key?(:entity)
           @facet_specs = args[:facet_specs] if args.key?(:facet_specs)
           @filter = args[:filter] if args.key?(:filter)
           @labels = args[:labels] if args.key?(:labels)
@@ -4030,23 +4080,22 @@ module Google
       
         # Enables dynamic position for this facet. If set to true, the position of this
         # facet among all facets in the response is determined by Google Retail Search.
-        # It will be ordered together with dynamic facets if dynamic facets is enabled.
-        # If set to false, the position of this facet in the response will be the same
-        # as in the request, and it will be ranked before the facets with dynamic
-        # position enable and all dynamic facets. For example, you may always want to
-        # have rating facet returned in the response, but it's not necessarily to always
-        # display the rating facet at the top. In that case, you can set
-        # enable_dynamic_position to true so that the position of rating facet in
-        # response will be determined by Google Retail Search. Another example, assuming
-        # you have the following facets in the request: * "rating",
-        # enable_dynamic_position = true * "price", enable_dynamic_position = false * "
-        # brands", enable_dynamic_position = false And also you have a dynamic facets
-        # enable, which will generate a facet 'gender'. Then the final order of the
-        # facets in the response can be ("price", "brands", "rating", "gender") or ("
-        # price", "brands", "gender", "rating") depends on how Google Retail Search
-        # orders "gender" and "rating" facets. However, notice that "price" and "brands"
-        # will always be ranked at 1st and 2nd position since their
-        # enable_dynamic_position are false.
+        # It is ordered together with dynamic facets if dynamic facets is enabled. If
+        # set to false, the position of this facet in the response is the same as in the
+        # request, and it is ranked before the facets with dynamic position enable and
+        # all dynamic facets. For example, you may always want to have rating facet
+        # returned in the response, but it's not necessarily to always display the
+        # rating facet at the top. In that case, you can set enable_dynamic_position to
+        # true so that the position of rating facet in response is determined by Google
+        # Retail Search. Another example, assuming you have the following facets in the
+        # request: * "rating", enable_dynamic_position = true * "price",
+        # enable_dynamic_position = false * "brands", enable_dynamic_position = false
+        # And also you have a dynamic facets enable, which generates a facet "gender".
+        # Then, the final order of the facets in the response can be ("price", "brands",
+        # "rating", "gender") or ("price", "brands", "gender", "rating") depends on how
+        # Google Retail Search orders "gender" and "rating" facets. However, notice that
+        # "price" and "brands" are always ranked at first and second position because
+        # their enable_dynamic_position values are false.
         # Corresponds to the JSON property `enableDynamicPosition`
         # @return [Boolean]
         attr_accessor :enable_dynamic_position
@@ -4110,19 +4159,21 @@ module Google
       
         # Only get facet values that contains the given strings. For example, suppose "
         # categories" has three values "Women > Shoe", "Women > Dress" and "Men > Shoe".
-        # If set "contains" to "Shoe", the "categories" facet will give only "Women >
-        # Shoe" and "Men > Shoe". Only supported on textual fields. Maximum is 10.
+        # If set "contains" to "Shoe", the "categories" facet gives only "Women > Shoe"
+        # and "Men > Shoe". Only supported on textual fields. Maximum is 10.
         # Corresponds to the JSON property `contains`
         # @return [Array<String>]
         attr_accessor :contains
       
-        # For all numerical facet keys that appear in the list of products from the
-        # catalog, the percentiles 0, 10, 30, 50, 70, 90 and 100 are computed from their
-        # distribution weekly. If the model assigns a high score to a numerical facet
-        # key and its intervals are not specified in the search request, these
-        # percentiles will become the bounds for its intervals and will be returned in
-        # the response. If the facet key intervals are specified in the request, then
-        # the specified intervals will be returned instead.
+        # Set only if values should be bucketized into intervals. Must be set for facets
+        # with numerical values. Must not be set for facet with text values. Maximum
+        # number of intervals is 40. For all numerical facet keys that appear in the
+        # list of products from the catalog, the percentiles 0, 10, 30, 50, 70, 90, and
+        # 100 are computed from their distribution weekly. If the model assigns a high
+        # score to a numerical facet key and its intervals are not specified in the
+        # search request, these percentiles become the bounds for its intervals and are
+        # returned in the response. If the facet key intervals are specified in the
+        # request, then the specified intervals are returned instead.
         # Corresponds to the JSON property `intervals`
         # @return [Array<Google::Apis::RetailV2::GoogleCloudRetailV2Interval>]
         attr_accessor :intervals
@@ -4156,7 +4207,7 @@ module Google
       
         # Only get facet values that start with the given string prefix. For example,
         # suppose "categories" has three values "Women > Shoe", "Women > Dress" and "Men
-        # > Shoe". If set "prefixes" to "Women", the "categories" facet will give only "
+        # > Shoe". If set "prefixes" to "Women", the "categories" facet gives only "
         # Women > Shoe" and "Women > Dress". Only supported on textual fields. Maximum
         # is 10.
         # Corresponds to the JSON property `prefixes`
@@ -4164,16 +4215,15 @@ module Google
         attr_accessor :prefixes
       
         # The query that is used to compute facet for the given facet key. When provided,
-        # it will override the default behavior of facet computation. The query syntax
-        # is the same as a filter expression. See SearchRequest.filter for detail syntax
+        # it overrides the default behavior of facet computation. The query syntax is
+        # the same as a filter expression. See SearchRequest.filter for detail syntax
         # and limitations. Notice that there is no limitation on FacetKey.key when query
-        # is specified. In the response, SearchResponse.Facet.values.value will be
-        # always "1" and SearchResponse.Facet.values.count will be the number of results
-        # that match the query. For example, you can set a customized facet for "
-        # shipToStore", where FacetKey.key is "customizedShipToStore", and FacetKey.
-        # query is "availability: ANY(\"IN_STOCK\") AND shipToStore: ANY(\"123\")". Then
-        # the facet will count the products that are both in stock and ship to store "
-        # 123".
+        # is specified. In the response, SearchResponse.Facet.values.value is always "1"
+        # and SearchResponse.Facet.values.count is the number of results that match the
+        # query. For example, you can set a customized facet for "shipToStore", where
+        # FacetKey.key is "customizedShipToStore", and FacetKey.query is "availability:
+        # ANY(\"IN_STOCK\") AND shipToStore: ANY(\"123\")". Then the facet counts the
+        # products that are both in stock and ship to store "123".
         # Corresponds to the JSON property `query`
         # @return [String]
         attr_accessor :query
@@ -4939,13 +4989,6 @@ module Google
         # @return [String]
         attr_accessor :attribution_token
       
-        # Represents the banner of the user event, for projects that combine banners.
-        # For example: retailer can have events from multiple banners like retailer-main,
-        # retailer-baby, retailer-meds, etc. under one project.
-        # Corresponds to the JSON property `banner`
-        # @return [String]
-        attr_accessor :banner
-      
         # The ID or name of the associated shopping cart. This ID is used to associate
         # multiple items added or present in the cart before purchase. This can only be
         # set for `add-to-cart`, `purchase-complete`, or `shopping-cart-page-view`
@@ -4960,6 +5003,14 @@ module Google
         # @return [Google::Apis::RetailV2::GoogleCloudRetailV2CompletionDetail]
         attr_accessor :completion_detail
       
+        # The entity for customers that may run multiple different entities, domains,
+        # sites or regions, for example, `Google US`, `Google Ads`, `Waymo`, `google.com`
+        # , `youtube.com`, etc. We recommend that you set this field to get better per-
+        # entity search, completion, and prediction results.
+        # Corresponds to the JSON property `entity`
+        # @return [String]
+        attr_accessor :entity
+      
         # Only required for UserEventService.ImportUserEvents method. Timestamp of when
         # the user event happened.
         # Corresponds to the JSON property `eventTime`
@@ -5113,9 +5164,9 @@ module Google
         def update!(**args)
           @attributes = args[:attributes] if args.key?(:attributes)
           @attribution_token = args[:attribution_token] if args.key?(:attribution_token)
-          @banner = args[:banner] if args.key?(:banner)
           @cart_id = args[:cart_id] if args.key?(:cart_id)
           @completion_detail = args[:completion_detail] if args.key?(:completion_detail)
+          @entity = args[:entity] if args.key?(:entity)
           @event_time = args[:event_time] if args.key?(:event_time)
           @event_type = args[:event_type] if args.key?(:event_type)
           @experiment_ids = args[:experiment_ids] if args.key?(:experiment_ids)
@@ -5702,7 +5753,7 @@ module Google
       
       # Represents a link between a Merchant Center account and a branch. Once a link
       # is established, products from the linked merchant center account will be
-      # streamed to the linked branch. LINT.IfChange(MerchantCenterAccountLink)
+      # streamed to the linked branch.
       class GoogleCloudRetailV2alphaMerchantCenterAccountLink
         include Google::Apis::Core::Hashable
       
@@ -5760,7 +5811,7 @@ module Google
         # @return [String]
         attr_accessor :name
       
-        # Output only. GCP project ID.
+        # Output only. Google Cloud project ID.
         # Corresponds to the JSON property `projectId`
         # @return [String]
         attr_accessor :project_id
@@ -5852,6 +5903,11 @@ module Google
         # @return [String]
         attr_accessor :last_tune_time
       
+        # Additional model features config.
+        # Corresponds to the JSON property `modelFeaturesConfig`
+        # @return [Google::Apis::RetailV2::GoogleCloudRetailV2alphaModelModelFeaturesConfig]
+        attr_accessor :model_features_config
+      
         # Required. The fully qualified resource name of the model. Format: `projects/`
         # project_number`/locations/`location_id`/catalogs/`catalog_id`/models/`model_id`
         # ` catalog_id has char limit of 50. recommendation_model_id has char limit of
@@ -5949,6 +6005,7 @@ module Google
           @display_name = args[:display_name] if args.key?(:display_name)
           @filtering_option = args[:filtering_option] if args.key?(:filtering_option)
           @last_tune_time = args[:last_tune_time] if args.key?(:last_tune_time)
+          @model_features_config = args[:model_features_config] if args.key?(:model_features_config)
           @name = args[:name] if args.key?(:name)
           @optimization_objective = args[:optimization_objective] if args.key?(:optimization_objective)
           @page_optimization_config = args[:page_optimization_config] if args.key?(:page_optimization_config)
@@ -5962,6 +6019,46 @@ module Google
         end
       end
       
+      # More configs of the frequently-bought-together model type.
+      class GoogleCloudRetailV2alphaModelFrequentlyBoughtTogetherFeaturesConfig
+        include Google::Apis::Core::Hashable
+      
+        # Optional. Specifies the context of the model when used in predict requests.
+        # Only settable for the `frequently-bought-together` type. Will default to
+        # MULTI_CONTEXT if not specified.
+        # Corresponds to the JSON property `contextProductsType`
+        # @return [String]
+        attr_accessor :context_products_type
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @context_products_type = args[:context_products_type] if args.key?(:context_products_type)
+        end
+      end
+      
+      # Additional model features config.
+      class GoogleCloudRetailV2alphaModelModelFeaturesConfig
+        include Google::Apis::Core::Hashable
+      
+        # More configs of the frequently-bought-together model type.
+        # Corresponds to the JSON property `frequentlyBoughtTogetherConfig`
+        # @return [Google::Apis::RetailV2::GoogleCloudRetailV2alphaModelFrequentlyBoughtTogetherFeaturesConfig]
+        attr_accessor :frequently_bought_together_config
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @frequently_bought_together_config = args[:frequently_bought_together_config] if args.key?(:frequently_bought_together_config)
+        end
+      end
+      
       # The PageOptimizationConfig for model training. This determines how many panels
       # to optimize for, and which serving configs to consider for each panel. The
       # purpose of this model is to optimize which ServingConfig to show on which
@@ -6844,7 +6941,7 @@ module Google
       
       # Represents a link between a Merchant Center account and a branch. Once a link
       # is established, products from the linked merchant center account will be
-      # streamed to the linked branch. LINT.IfChange(MerchantCenterAccountLink)
+      # streamed to the linked branch.
       class GoogleCloudRetailV2betaMerchantCenterAccountLink
         include Google::Apis::Core::Hashable
       
@@ -6902,7 +6999,7 @@ module Google
         # @return [String]
         attr_accessor :name
       
-        # Output only. GCP project ID.
+        # Output only. Google Cloud project ID.
         # Corresponds to the JSON property `projectId`
         # @return [String]
         attr_accessor :project_id
@@ -6994,6 +7091,11 @@ module Google
         # @return [String]
         attr_accessor :last_tune_time
       
+        # Additional model features config.
+        # Corresponds to the JSON property `modelFeaturesConfig`
+        # @return [Google::Apis::RetailV2::GoogleCloudRetailV2betaModelModelFeaturesConfig]
+        attr_accessor :model_features_config
+      
         # Required. The fully qualified resource name of the model. Format: `projects/`
         # project_number`/locations/`location_id`/catalogs/`catalog_id`/models/`model_id`
         # ` catalog_id has char limit of 50. recommendation_model_id has char limit of
@@ -7083,6 +7185,7 @@ module Google
           @display_name = args[:display_name] if args.key?(:display_name)
           @filtering_option = args[:filtering_option] if args.key?(:filtering_option)
           @last_tune_time = args[:last_tune_time] if args.key?(:last_tune_time)
+          @model_features_config = args[:model_features_config] if args.key?(:model_features_config)
           @name = args[:name] if args.key?(:name)
           @optimization_objective = args[:optimization_objective] if args.key?(:optimization_objective)
           @periodic_tuning_state = args[:periodic_tuning_state] if args.key?(:periodic_tuning_state)
@@ -7095,6 +7198,46 @@ module Google
         end
       end
       
+      # More configs of the frequently-bought-together model type.
+      class GoogleCloudRetailV2betaModelFrequentlyBoughtTogetherFeaturesConfig
+        include Google::Apis::Core::Hashable
+      
+        # Optional. Specifies the context of the model when used in predict requests.
+        # Only settable for the `frequently-bought-together` type. Will default to
+        # MULTI_CONTEXT if not specified.
+        # Corresponds to the JSON property `contextProductsType`
+        # @return [String]
+        attr_accessor :context_products_type
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @context_products_type = args[:context_products_type] if args.key?(:context_products_type)
+        end
+      end
+      
+      # Additional model features config.
+      class GoogleCloudRetailV2betaModelModelFeaturesConfig
+        include Google::Apis::Core::Hashable
+      
+        # More configs of the frequently-bought-together model type.
+        # Corresponds to the JSON property `frequentlyBoughtTogetherConfig`
+        # @return [Google::Apis::RetailV2::GoogleCloudRetailV2betaModelFrequentlyBoughtTogetherFeaturesConfig]
+        attr_accessor :frequently_bought_together_config
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @frequently_bought_together_config = args[:frequently_bought_together_config] if args.key?(:frequently_bought_together_config)
+        end
+      end
+      
       # Represents an ordered combination of valid serving configs, which can be used
       # for `PAGE_OPTIMIZATION` recommendations.
       class GoogleCloudRetailV2betaModelServingConfigList

data/lib/google/apis/retail_v2/gem_version.rb

@@ -16,13 +16,13 @@ module Google
   module Apis
     module RetailV2
       # Version of the google-apis-retail_v2 gem
-      GEM_VERSION = "0.69.0"
+      GEM_VERSION = "0.71.0"
 
       # Version of the code generator used to generate this client
       GENERATOR_VERSION = "0.12.0"
 
       # Revision of the discovery document this client was generated from
-      REVISION = "20230321"
+      REVISION = "20230420"
     end
   end
 end

data/lib/google/apis/retail_v2/representations.rb

@@ -352,6 +352,18 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class GoogleCloudRetailV2ModelFrequentlyBoughtTogetherFeaturesConfig
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleCloudRetailV2ModelModelFeaturesConfig
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class GoogleCloudRetailV2ModelServingConfigList
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -874,6 +886,18 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class GoogleCloudRetailV2alphaModelFrequentlyBoughtTogetherFeaturesConfig
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleCloudRetailV2alphaModelModelFeaturesConfig
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class GoogleCloudRetailV2alphaModelPageOptimizationConfig
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -1120,6 +1144,18 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class GoogleCloudRetailV2betaModelFrequentlyBoughtTogetherFeaturesConfig
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleCloudRetailV2betaModelModelFeaturesConfig
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class GoogleCloudRetailV2betaModelServingConfigList
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -1555,7 +1591,7 @@ module Google
       class GoogleCloudRetailV2ExperimentInfo
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
-          property :experiment_name, as: 'experimentName'
+          property :experiment, as: 'experiment'
           property :serving_config_experiment, as: 'servingConfigExperiment', class: Google::Apis::RetailV2::GoogleCloudRetailV2ExperimentInfoServingConfigExperiment, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2ExperimentInfoServingConfigExperiment::Representation
       
         end
@@ -1760,6 +1796,8 @@ module Google
           property :display_name, as: 'displayName'
           property :filtering_option, as: 'filteringOption'
           property :last_tune_time, as: 'lastTuneTime'
+          property :model_features_config, as: 'modelFeaturesConfig', class: Google::Apis::RetailV2::GoogleCloudRetailV2ModelModelFeaturesConfig, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2ModelModelFeaturesConfig::Representation
+      
           property :name, as: 'name'
           property :optimization_objective, as: 'optimizationObjective'
           property :periodic_tuning_state, as: 'periodicTuningState'
@@ -1773,6 +1811,21 @@ module Google
         end
       end
       
+      class GoogleCloudRetailV2ModelFrequentlyBoughtTogetherFeaturesConfig
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :context_products_type, as: 'contextProductsType'
+        end
+      end
+      
+      class GoogleCloudRetailV2ModelModelFeaturesConfig
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :frequently_bought_together_config, as: 'frequentlyBoughtTogetherConfig', class: Google::Apis::RetailV2::GoogleCloudRetailV2ModelFrequentlyBoughtTogetherFeaturesConfig, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2ModelFrequentlyBoughtTogetherFeaturesConfig::Representation
+      
+        end
+      end
+      
       class GoogleCloudRetailV2ModelServingConfigList
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -2160,13 +2213,13 @@ module Google
       class GoogleCloudRetailV2SearchRequest
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
-          property :banner, as: 'banner'
           property :boost_spec, as: 'boostSpec', class: Google::Apis::RetailV2::GoogleCloudRetailV2SearchRequestBoostSpec, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2SearchRequestBoostSpec::Representation
       
           property :branch, as: 'branch'
           property :canonical_filter, as: 'canonicalFilter'
           property :dynamic_facet_spec, as: 'dynamicFacetSpec', class: Google::Apis::RetailV2::GoogleCloudRetailV2SearchRequestDynamicFacetSpec, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2SearchRequestDynamicFacetSpec::Representation
       
+          property :entity, as: 'entity'
           collection :facet_specs, as: 'facetSpecs', class: Google::Apis::RetailV2::GoogleCloudRetailV2SearchRequestFacetSpec, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2SearchRequestFacetSpec::Representation
       
           property :filter, as: 'filter'
@@ -2413,10 +2466,10 @@ module Google
           hash :attributes, as: 'attributes', class: Google::Apis::RetailV2::GoogleCloudRetailV2CustomAttribute, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2CustomAttribute::Representation
       
           property :attribution_token, as: 'attributionToken'
-          property :banner, as: 'banner'
           property :cart_id, as: 'cartId'
           property :completion_detail, as: 'completionDetail', class: Google::Apis::RetailV2::GoogleCloudRetailV2CompletionDetail, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2CompletionDetail::Representation
       
+          property :entity, as: 'entity'
           property :event_time, as: 'eventTime'
           property :event_type, as: 'eventType'
           collection :experiment_ids, as: 'experimentIds'
@@ -2653,6 +2706,8 @@ module Google
           property :display_name, as: 'displayName'
           property :filtering_option, as: 'filteringOption'
           property :last_tune_time, as: 'lastTuneTime'
+          property :model_features_config, as: 'modelFeaturesConfig', class: Google::Apis::RetailV2::GoogleCloudRetailV2alphaModelModelFeaturesConfig, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2alphaModelModelFeaturesConfig::Representation
+      
           property :name, as: 'name'
           property :optimization_objective, as: 'optimizationObjective'
           property :page_optimization_config, as: 'pageOptimizationConfig', class: Google::Apis::RetailV2::GoogleCloudRetailV2alphaModelPageOptimizationConfig, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2alphaModelPageOptimizationConfig::Representation
@@ -2668,6 +2723,21 @@ module Google
         end
       end
       
+      class GoogleCloudRetailV2alphaModelFrequentlyBoughtTogetherFeaturesConfig
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :context_products_type, as: 'contextProductsType'
+        end
+      end
+      
+      class GoogleCloudRetailV2alphaModelModelFeaturesConfig
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :frequently_bought_together_config, as: 'frequentlyBoughtTogetherConfig', class: Google::Apis::RetailV2::GoogleCloudRetailV2alphaModelFrequentlyBoughtTogetherFeaturesConfig, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2alphaModelFrequentlyBoughtTogetherFeaturesConfig::Representation
+      
+        end
+      end
+      
       class GoogleCloudRetailV2alphaModelPageOptimizationConfig
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -2996,6 +3066,8 @@ module Google
           property :display_name, as: 'displayName'
           property :filtering_option, as: 'filteringOption'
           property :last_tune_time, as: 'lastTuneTime'
+          property :model_features_config, as: 'modelFeaturesConfig', class: Google::Apis::RetailV2::GoogleCloudRetailV2betaModelModelFeaturesConfig, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2betaModelModelFeaturesConfig::Representation
+      
           property :name, as: 'name'
           property :optimization_objective, as: 'optimizationObjective'
           property :periodic_tuning_state, as: 'periodicTuningState'
@@ -3009,6 +3081,21 @@ module Google
         end
       end
       
+      class GoogleCloudRetailV2betaModelFrequentlyBoughtTogetherFeaturesConfig
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :context_products_type, as: 'contextProductsType'
+        end
+      end
+      
+      class GoogleCloudRetailV2betaModelModelFeaturesConfig
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :frequently_bought_together_config, as: 'frequentlyBoughtTogetherConfig', class: Google::Apis::RetailV2::GoogleCloudRetailV2betaModelFrequentlyBoughtTogetherFeaturesConfig, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2betaModelFrequentlyBoughtTogetherFeaturesConfig::Representation
+      
+        end
+      end
+      
       class GoogleCloudRetailV2betaModelServingConfigList
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation

data/lib/google/apis/retail_v2/service.rb

@@ -57,8 +57,6 @@ module Google
         # @param [String] catalog
         #   Required. Catalog for which the completion is performed. Full resource name of
         #   catalog, such as `projects/*/locations/global/catalogs/default_catalog`.
-        # @param [String] banner
-        #   The banner context for completion suggestions.
         # @param [String] dataset
         #   Determines which dataset to use for fetching completion. "user-data" will use
         #   the imported dataset through CompletionService.ImportCompletionData. "cloud-
@@ -73,6 +71,11 @@ module Google
         #   types, e.g. `DESKTOP`, `MOBILE`. If it is empty, the suggestions are across
         #   all device types. Supported formats: * `UNKNOWN_DEVICE_TYPE` * `DESKTOP` * `
         #   MOBILE` * A customized string starts with `OTHER_`, e.g. `OTHER_IPHONE`.
+        # @param [String] entity
+        #   The entity for customers who run multiple entities, domains, sites, or regions,
+        #   for example, `Google US`, `Google Ads`, `Waymo`, `google.com`, `youtube.com`,
+        #   etc. If this is set, it must be an exact match with UserEvent.entity to get
+        #   per-entity autocomplete results.
         # @param [Array<String>, String] language_codes
         #   Note that this field applies for `user-data` dataset only. For requests with `
         #   cloud-retail` dataset, setting this field has no effect. The language filters
@@ -112,14 +115,14 @@ module Google
         # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
         # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
         # @raise [Google::Apis::AuthorizationError] Authorization is required
-        def complete_project_location_catalog_query(catalog, banner: nil, dataset: nil, device_type: nil, language_codes: nil, max_suggestions: nil, query: nil, visitor_id: nil, fields: nil, quota_user: nil, options: nil, &block)
+        def complete_project_location_catalog_query(catalog, dataset: nil, device_type: nil, entity: nil, language_codes: nil, max_suggestions: nil, query: nil, visitor_id: nil, fields: nil, quota_user: nil, options: nil, &block)
           command = make_simple_command(:get, 'v2/{+catalog}:completeQuery', options)
           command.response_representation = Google::Apis::RetailV2::GoogleCloudRetailV2CompleteQueryResponse::Representation
           command.response_class = Google::Apis::RetailV2::GoogleCloudRetailV2CompleteQueryResponse
           command.params['catalog'] = catalog unless catalog.nil?
-          command.query['banner'] = banner unless banner.nil?
           command.query['dataset'] = dataset unless dataset.nil?
           command.query['deviceType'] = device_type unless device_type.nil?
+          command.query['entity'] = entity unless entity.nil?
           command.query['languageCodes'] = language_codes unless language_codes.nil?
           command.query['maxSuggestions'] = max_suggestions unless max_suggestions.nil?
           command.query['query'] = query unless query.nil?
@@ -577,13 +580,13 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
-        # It is recommended to use the ProductService.AddLocalInventories method instead
-        # of ProductService.AddFulfillmentPlaces. ProductService.AddLocalInventories
-        # achieves the same results but provides more fine-grained control over
-        # ingesting local inventory data. Incrementally adds place IDs to Product.
-        # fulfillment_info.place_ids. This process is asynchronous and does not require
-        # the Product to exist before updating fulfillment information. If the request
-        # is valid, the update will be enqueued and processed downstream. As a
+        # We recommend that you use the ProductService.AddLocalInventories method
+        # instead of the ProductService.AddFulfillmentPlaces method. ProductService.
+        # AddLocalInventories achieves the same results but provides more fine-grained
+        # control over ingesting local inventory data. Incrementally adds place IDs to
+        # Product.fulfillment_info.place_ids. This process is asynchronous and does not
+        # require the Product to exist before updating fulfillment information. If the
+        # request is valid, the update will be enqueued and processed downstream. As a
         # consequence, when a response is returned, the added place IDs are not
         # immediately manifested in the Product queried by ProductService.GetProduct or
         # ProductService.ListProducts. The returned Operations will be obsolete after 1
@@ -938,8 +941,8 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
-        # It is recommended to use the ProductService.RemoveLocalInventories method
-        # instead of ProductService.RemoveFulfillmentPlaces. ProductService.
+        # We recommend that you use the ProductService.RemoveLocalInventories method
+        # instead of the ProductService.RemoveFulfillmentPlaces method. ProductService.
         # RemoveLocalInventories achieves the same results but provides more fine-
         # grained control over ingesting local inventory data. Incrementally removes
         # place IDs from a Product.fulfillment_info.place_ids. This process is
@@ -1724,7 +1727,7 @@ module Google
         #   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 config name and the set of models
-        #   that will be used to make the search.
+        #   that are used to make the search.
         # @param [Google::Apis::RetailV2::GoogleCloudRetailV2SearchRequest] google_cloud_retail_v2_search_request_object
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
@@ -2067,7 +2070,7 @@ module Google
         #   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 config name and the set of models
-        #   that will be used to make the search.
+        #   that are used to make the search.
         # @param [Google::Apis::RetailV2::GoogleCloudRetailV2SearchRequest] google_cloud_retail_v2_search_request_object
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-apis-retail_v2
 version: !ruby/object:Gem::Version
-  version: 0.69.0
+  version: 0.71.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-03-26 00:00:00.000000000 Z
+date: 2023-04-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-apis-core
@@ -58,7 +58,7 @@ licenses:
 metadata:
   bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
   changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-retail_v2/CHANGELOG.md
-  documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2/v0.69.0
+  documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2/v0.71.0
   source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-retail_v2
 post_install_message: 
 rdoc_options: []