google-apis-retail_v2 0.69.0 → 0.70.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6ad77f2d05d615bfb7a3ef7767ff5e46b14d30f40d67078a3ac8b06b9ae1328e
-  data.tar.gz: 830ccb9adafd13220bf6ca3528409c4dc485f44f76c0a4dc51c91d46a2551f63
+  metadata.gz: df11aab75082f77bca06d97bb654a36d867ec9b8b548487d958ede800e9931d2
+  data.tar.gz: 71746b24b8604e58342ce6529bc85d88628159da75221f8321dc48b2fe32c931
 SHA512:
-  metadata.gz: 59a21c3e22f066b01ccd1178d3c5a26623c69130c7432daf85468f7f564fec7d49d693b58da1b200f298b674304dcebf746afa8c07662a872e6577593c6aba1c
-  data.tar.gz: 13e4390249bda200000fe31abe1063a9029916a31be5e68d41f02d4c06025a645e9e3d314f945bfe35a0cabaf52144d4cce63d9c4747deddd669ab810e6ae130
+  metadata.gz: 3593693dccb0fca8c6cd85151ab97d0b51894c76e7d5eb5ed7eae1786b7ffed13355a00757f2cee4f0e8143a038b709f057d23ce8d70a1d810136a1e377b6ea0
+  data.tar.gz: 1a91555e35ad4f4ac489c49b52a42edcb1598c1b5c113bf296f11bb452e06afd6326a3b431cccad3c217fd5e3cf0a84548bd199418ced7adf4bc273b8078540e

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Release history for google-apis-retail_v2
 
+### 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

@@ -1278,9 +1278,9 @@ module Google
         # 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
@@ -3724,13 +3724,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]
@@ -3759,8 +3752,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>]
@@ -3807,7 +3808,7 @@ module Google
         # @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 +3913,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)
@@ -4116,13 +4117,15 @@ module Google
         # @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 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.
         # Corresponds to the JSON property `intervals`
         # @return [Array<Google::Apis::RetailV2::GoogleCloudRetailV2Interval>]
         attr_accessor :intervals
@@ -4939,13 +4942,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 +4956,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. It is recommended to 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 +5117,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 +5706,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 +5764,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
@@ -6844,7 +6848,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 +6906,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

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.70.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 = "20230413"
     end
   end
 end

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

@@ -1555,7 +1555,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
@@ -2160,13 +2160,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 +2413,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'

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 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 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?

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.70.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-03-26 00:00:00.000000000 Z
+date: 2023-04-23 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.70.0
   source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-retail_v2
 post_install_message: 
 rdoc_options: []