google-apis-retail_v2alpha 0.72.0 → 0.73.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0826c11d9c669ef022a9f609f4721474fc17e61b935b3759a5fe790aaee9cc3b'
-  data.tar.gz: 94aba8656a48ec89ad0fe24e029eb5a99c9f8eadf4adf7c9d8f062c79304a4ec
+  metadata.gz: f4154c9d6ff1dd3590856310016be05564b099e9f3005f898b0b563b695270e6
+  data.tar.gz: f4442c982ac8612523538ca476b06f85f21e08fc9ad9aa30d9e2ebf133e6111c
 SHA512:
-  metadata.gz: b7ff53530df13273a950e8b576b0b70aecde4fc0e74c1cd5523773d9753c3063ee29ebfbefcbebd2abaae54474838eab76a97c09e3a9422943d59501486e6732
-  data.tar.gz: 2f9fea79c9a717b8897c0bd5a4b321c5c581ed66c8eeb95ec477925782adef3979cdb31f9be6930479f9c1ae36abb1d650d5c8b07d01a8b9b86c975b15be8e46
+  metadata.gz: a6ba8a7044e5ff19f5055f60e5256d1e93338778ed15c7d3cbf948324c7545cf2619715ae6f135a848d6a2ca60f7302bfddea45c73577229ee91ebe5512687f4
+  data.tar.gz: 11489b01710879077251c914ba43838331c11d986a6f140b3567f7a701309d07267e2e7e667a55e81e7fe7456e5b1971e579b634c89ecb7ee0e5e8986ab76c9b

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Release history for google-apis-retail_v2alpha
 
+### v0.73.0 (2023-04-23)
+
+* Regenerated from discovery document revision 20230413
+
 ### v0.72.0 (2023-03-26)
 
 * Regenerated from discovery document revision 20230321

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

@@ -1586,11 +1586,26 @@ module Google
         # @return [Hash<String,Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCustomAttribute>]
         attr_accessor :attributes
       
+        # Facet information for the suggestion term. Gives the number of items resulting
+        # from a search with this suggestion term for each facet. This is an
+        # experimental feature for limited customers. If you want to receive this facet
+        # information, reach out to the Retail support team.
+        # Corresponds to the JSON property `facets`
+        # @return [Array<Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchResponseFacet>]
+        attr_accessor :facets
+      
         # The suggestion for the query.
         # Corresponds to the JSON property `suggestion`
         # @return [String]
         attr_accessor :suggestion
       
+        # Total number of products associated with a search with this suggestion. This
+        # is an experimental feature for limited customers. If you want to receive this
+        # product count information, reach out to the Retail support team.
+        # Corresponds to the JSON property `totalProductCount`
+        # @return [Fixnum]
+        attr_accessor :total_product_count
+      
         def initialize(**args)
            update!(**args)
         end
@@ -1598,7 +1613,9 @@ module Google
         # Update properties of this object
         def update!(**args)
           @attributes = args[:attributes] if args.key?(:attributes)
+          @facets = args[:facets] if args.key?(:facets)
           @suggestion = args[:suggestion] if args.key?(:suggestion)
+          @total_product_count = args[:total_product_count] if args.key?(:total_product_count)
         end
       end
       
@@ -2040,9 +2057,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`
@@ -2055,7 +2072,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
@@ -2903,7 +2920,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
       
@@ -2961,7 +2978,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
@@ -5138,13 +5155,6 @@ module Google
       class GoogleCloudRetailV2alphaSearchRequest
         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::RetailV2alpha::GoogleCloudRetailV2alphaSearchRequestBoostSpec]
@@ -5173,8 +5183,16 @@ module Google
         # @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchRequestDynamicFacetSpec]
         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::RetailV2alpha::GoogleCloudRetailV2alphaSearchRequestFacetSpec>]
@@ -5221,7 +5239,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,
@@ -5334,11 +5352,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)
@@ -5539,13 +5557,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::RetailV2alpha::GoogleCloudRetailV2alphaInterval>]
         attr_accessor :intervals
@@ -6388,13 +6408,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`
@@ -6409,6 +6422,14 @@ module Google
         # @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCompletionDetail]
         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`
@@ -6562,9 +6583,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)
@@ -7145,7 +7166,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
       
@@ -7203,7 +7224,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_v2alpha/gem_version.rb

@@ -16,13 +16,13 @@ module Google
   module Apis
     module RetailV2alpha
       # Version of the google-apis-retail_v2alpha gem
-      GEM_VERSION = "0.72.0"
+      GEM_VERSION = "0.73.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_v2alpha/representations.rb

@@ -1722,7 +1722,10 @@ module Google
         class Representation < Google::Apis::Core::JsonRepresentation
           hash :attributes, as: 'attributes', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCustomAttribute, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCustomAttribute::Representation
       
+          collection :facets, as: 'facets', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchResponseFacet, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchResponseFacet::Representation
+      
           property :suggestion, as: 'suggestion'
+          property :total_product_count, as: 'totalProductCount'
         end
       end
       
@@ -1839,7 +1842,7 @@ module Google
       class GoogleCloudRetailV2alphaExperimentInfo
         # @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::RetailV2alpha::GoogleCloudRetailV2alphaExperimentInfoServingConfigExperiment, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaExperimentInfoServingConfigExperiment::Representation
       
         end
@@ -2621,13 +2624,13 @@ module Google
       class GoogleCloudRetailV2alphaSearchRequest
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
-          property :banner, as: 'banner'
           property :boost_spec, as: 'boostSpec', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchRequestBoostSpec, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchRequestBoostSpec::Representation
       
           property :branch, as: 'branch'
           property :canonical_filter, as: 'canonicalFilter'
           property :dynamic_facet_spec, as: 'dynamicFacetSpec', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchRequestDynamicFacetSpec, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchRequestDynamicFacetSpec::Representation
       
+          property :entity, as: 'entity'
           collection :facet_specs, as: 'facetSpecs', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchRequestFacetSpec, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchRequestFacetSpec::Representation
       
           property :filter, as: 'filter'
@@ -2883,10 +2886,10 @@ module Google
           hash :attributes, as: 'attributes', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCustomAttribute, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCustomAttribute::Representation
       
           property :attribution_token, as: 'attributionToken'
-          property :banner, as: 'banner'
           property :cart_id, as: 'cartId'
           property :completion_detail, as: 'completionDetail', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCompletionDetail, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCompletionDetail::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_v2alpha/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-
@@ -76,6 +74,11 @@ module Google
         # @param [Boolean] enable_attribute_suggestions
         #   If true, attribute suggestions are enabled and provided in response. This
         #   field is only available for "cloud-retail" dataset.
+        # @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
@@ -115,15 +118,15 @@ 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, enable_attribute_suggestions: 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, enable_attribute_suggestions: 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, 'v2alpha/{+catalog}:completeQuery', options)
           command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCompleteQueryResponse::Representation
           command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCompleteQueryResponse
           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['enableAttributeSuggestions'] = enable_attribute_suggestions unless enable_attribute_suggestions.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?
@@ -797,7 +800,7 @@ module Google
         #   Product.Type.PRIMARY Product with more than one variants. Otherwise, an
         #   INVALID_ARGUMENT error is returned. All inventory information for the named
         #   Product will be deleted.
-        # @param [Boolean] cascade_delete
+        # @param [Boolean] force
         #   This value only applies to the case when the target product is of type PRIMARY.
         #   When deleting a product of VARIANT/COLLECTION type, this value will be
         #   ignored. When set to true, the subsequent variant products will be deleted.
@@ -820,12 +823,12 @@ 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 delete_project_location_catalog_branch_product(name, cascade_delete: nil, fields: nil, quota_user: nil, options: nil, &block)
+        def delete_project_location_catalog_branch_product(name, force: nil, fields: nil, quota_user: nil, options: nil, &block)
           command = make_simple_command(:delete, 'v2alpha/{+name}', options)
           command.response_representation = Google::Apis::RetailV2alpha::GoogleProtobufEmpty::Representation
           command.response_class = Google::Apis::RetailV2alpha::GoogleProtobufEmpty
           command.params['name'] = name unless name.nil?
-          command.query['cascadeDelete'] = cascade_delete unless cascade_delete.nil?
+          command.query['force'] = force unless force.nil?
           command.query['fields'] = fields unless fields.nil?
           command.query['quotaUser'] = quota_user unless quota_user.nil?
           execute_or_queue_command(command, &block)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-apis-retail_v2alpha
 version: !ruby/object:Gem::Version
-  version: 0.72.0
+  version: 0.73.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_v2alpha/CHANGELOG.md
-  documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2alpha/v0.72.0
+  documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2alpha/v0.73.0
   source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-retail_v2alpha
 post_install_message: 
 rdoc_options: []