google-apis-retail_v2beta 0.29.0 → 0.32.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4728dc0b1ed77a4e3bf7d513cfb92adf723b47ef5ad8d703ee2bce8e55ae7e48
-  data.tar.gz: 5854f2bd791423414f15a7e488b15368532fdea6e47336dfcd8440d895a1f4bb
+  metadata.gz: 7ed1149501b935ac487adefb7ab20b4ba4be842671edb762d772258233a378c4
+  data.tar.gz: 2f01c3e3d04013b3da0dc447536886e67cf5f46edf74c99b28cbe1eaf503ac57
 SHA512:
-  metadata.gz: 041ebfef9f76cdaa823dea82e36064e78f22b1ba22e1105b2aa27c74d0e4b35bab1a9d1bca75b1ae73550bb66a7006e1653bd5519019608a58bb92cbf7cce380
-  data.tar.gz: a6e2a57b1d318f25cdd33ca116dc969acd5dfa0592a272906c4d7d3dcd56b7b9c7a393aed35fb1428101944f70efcb6351b52ccb5720d811cde30509df74e82c
+  metadata.gz: 3e0c7ae8e8663ca53776bc49fbff398103d6d028d77dd3d6c87019fa156991932d879cb1129e2a0f84e3661fc0ee5da94543128000d0169151dbba97a32dd3c4
+  data.tar.gz: baec49c4d331c7eb7f05f20cf5c54cceb382f671720512ef9c49dbce035cc6aeb05409cdae4e956fa0c7403edc14287752f28376d013faa187d725bcc93fa2c5

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Release history for google-apis-retail_v2beta
 
+### v0.32.0 (2022-03-16)
+
+* Regenerated from discovery document revision 20220310
+
+### v0.31.0 (2022-03-09)
+
+* Regenerated from discovery document revision 20220303
+
+### v0.30.0 (2022-03-04)
+
+* Regenerated from discovery document revision 20220224
+
 ### v0.29.0 (2022-02-24)
 
 * Regenerated from discovery document revision 20220217

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

@@ -950,6 +950,74 @@ module Google
         end
       end
       
+      # Metadata related to the progress of the PurgeProducts operation. This will be
+      # returned by the google.longrunning.Operation.metadata field.
+      class GoogleCloudRetailV2alphaPurgeProductsMetadata
+        include Google::Apis::Core::Hashable
+      
+        # Operation create time.
+        # Corresponds to the JSON property `createTime`
+        # @return [String]
+        attr_accessor :create_time
+      
+        # Count of entries that encountered errors while processing.
+        # Corresponds to the JSON property `failureCount`
+        # @return [Fixnum]
+        attr_accessor :failure_count
+      
+        # Count of entries that were deleted successfully.
+        # Corresponds to the JSON property `successCount`
+        # @return [Fixnum]
+        attr_accessor :success_count
+      
+        # Operation last update time. If the operation is done, this is also the finish
+        # time.
+        # Corresponds to the JSON property `updateTime`
+        # @return [String]
+        attr_accessor :update_time
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @create_time = args[:create_time] if args.key?(:create_time)
+          @failure_count = args[:failure_count] if args.key?(:failure_count)
+          @success_count = args[:success_count] if args.key?(:success_count)
+          @update_time = args[:update_time] if args.key?(:update_time)
+        end
+      end
+      
+      # Response of the PurgeProductsRequest. If the long running operation is
+      # successfully done, then this message is returned by the google.longrunning.
+      # Operations.response field.
+      class GoogleCloudRetailV2alphaPurgeProductsResponse
+        include Google::Apis::Core::Hashable
+      
+        # The total count of products purged as a result of the operation.
+        # Corresponds to the JSON property `purgeCount`
+        # @return [Fixnum]
+        attr_accessor :purge_count
+      
+        # A sample of the product names that will be deleted. Only populated if `force`
+        # is set to false. A max of 100 names will be returned and the names are chosen
+        # at random.
+        # Corresponds to the JSON property `purgeSample`
+        # @return [Array<String>]
+        attr_accessor :purge_sample
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @purge_count = args[:purge_count] if args.key?(:purge_count)
+          @purge_sample = args[:purge_sample] if args.key?(:purge_sample)
+        end
+      end
+      
       # Response of the PurgeUserEventsRequest. If the long running operation is
       # successfully done, then this message is returned by the google.longrunning.
       # Operations.response field.
@@ -1351,11 +1419,11 @@ module Google
         # Represents a whole or partial calendar date, such as a birthday. The time of
         # day and time zone are either specified elsewhere or are insignificant. The
         # date is relative to the Gregorian Calendar. This can represent one of the
-        # following: * A full date, with non-zero year, month, and day values * A month
-        # and day, with a zero year (e.g., an anniversary) * A year on its own, with a
-        # zero month and a zero day * A year and month, with a zero day (e.g., a credit
-        # card expiration date) Related types: * google.type.TimeOfDay * google.type.
-        # DateTime * google.protobuf.Timestamp
+        # following: * A full date, with non-zero year, month, and day values. * A month
+        # and day, with a zero year (for example, an anniversary). * A year on its own,
+        # with a zero month and a zero day. * A year and month, with a zero day (for
+        # example, a credit card expiration date). Related types: * google.type.
+        # TimeOfDay * google.type.DateTime * google.protobuf.Timestamp
         # Corresponds to the JSON property `partitionDate`
         # @return [Google::Apis::RetailV2beta::GoogleTypeDate]
         attr_accessor :partition_date
@@ -1438,8 +1506,11 @@ module Google
         # True` if at least one Product is using this attribute in Product.attributes.
         # Otherwise, this field is `False`. CatalogAttribute can be pre-loaded by using
         # AddCatalogAttribute, ImportCatalogAttributes, or UpdateAttributesConfig APIs.
-        # This field is `False` for pre-loaded CatalogAttributes. After catalog changes,
-        # it takes about 10 minutes for this field to update.
+        # This field is `False` for pre-loaded CatalogAttributes. Only CatalogAttributes
+        # that are not in use by products can be deleted. CatalogAttributes that are in
+        # use by products cannot be deleted; however, their configuration properties
+        # will reset to default values upon removal request. After catalog changes, it
+        # takes about 10 minutes for this field to update.
         # Corresponds to the JSON property `inUse`
         # @return [Boolean]
         attr_accessor :in_use
@@ -1791,9 +1862,18 @@ module Google
         # @return [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaRule]
         attr_accessor :rule
       
+        # Required. Specifies the use case for the control. Affects what condition
+        # fields can be set. Only settable by search controls. Will default to
+        # SEARCH_SOLUTION_USE_CASE_SEARCH if not specified. Currently only allow one
+        # search_solution_use_case per control.
+        # Corresponds to the JSON property `searchSolutionUseCase`
+        # @return [Array<String>]
+        attr_accessor :search_solution_use_case
+      
         # Required. Immutable. The solution types that the serving config is used for.
         # Currently we support setting only one type of solution at creation time. Only `
-        # SOLUTION_TYPE_SEARCH` value is supported at the moment.
+        # SOLUTION_TYPE_SEARCH` value is supported at the moment. If no solution type is
+        # provided at creation time, will default to SOLUTION_TYPE_SEARCH.
         # Corresponds to the JSON property `solutionTypes`
         # @return [Array<String>]
         attr_accessor :solution_types
@@ -1809,6 +1889,7 @@ module Google
           @facet_spec = args[:facet_spec] if args.key?(:facet_spec)
           @name = args[:name] if args.key?(:name)
           @rule = args[:rule] if args.key?(:rule)
+          @search_solution_use_case = args[:search_solution_use_case] if args.key?(:search_solution_use_case)
           @solution_types = args[:solution_types] if args.key?(:solution_types)
         end
       end
@@ -2076,7 +2157,10 @@ module Google
         end
       end
       
-      # Product thumbnail/detail image.
+      # 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.
       class GoogleCloudRetailV2betaImage
         include Google::Apis::Core::Hashable
       
@@ -2538,9 +2622,11 @@ module Google
         # do not have a stockState value of OUT_OF_STOCK. Examples: * tag=("Red" OR "
         # Blue") tag="New-Arrival" tag=(NOT "promotional") * filterOutOfStockItems tag=(-
         # "promotional") * filterOutOfStockItems If your filter blocks all prediction
-        # results, nothing will be returned. If you want generic (unfiltered) popular
-        # products to be returned instead, set `strictFiltering` to false in `
-        # PredictRequest.params`.
+        # results, the API will return generic (unfiltered) popular products. If you
+        # only want results strictly matching the filters, set `strictFiltering` to True
+        # in `PredictRequest.params` to receive empty results instead. Note that the API
+        # will never return items with storageStatus of "EXPIRED" or "DELETED"
+        # regardless of filter choices.
         # Corresponds to the JSON property `filter`
         # @return [String]
         attr_accessor :filter
@@ -2947,7 +3033,7 @@ module Google
         # @return [String]
         attr_accessor :id
       
-        # Product images for the product.Highly recommended to put the main image to the
+        # Product images for the product. We highly recommend putting the main image
         # first. A maximum of 300 images are allowed. Corresponding properties: Google
         # Merchant Center property [image_link](https://support.google.com/merchants/
         # answer/6324350). Schema.org property [Product.image](https://schema.org/image).
@@ -4015,12 +4101,13 @@ module Google
         # @return [String]
         attr_accessor :branch
       
-        # 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.
+        # The default filter that is applied when a user performs a search without
+        # 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.
         # Corresponds to the JSON property `canonicalFilter`
         # @return [String]
         attr_accessor :canonical_filter
@@ -5010,15 +5097,21 @@ module Google
       class GoogleCloudRetailV2betaUserEvent
         include Google::Apis::Core::Hashable
       
-        # Extra user event features to include in the recommendation model. This field
-        # needs to pass all below criteria, otherwise an INVALID_ARGUMENT error is
-        # returned: * The key must be a UTF-8 encoded string with a length limit of 5,
-        # 000 characters. * For text attributes, at most 400 values are allowed. Empty
-        # values are not allowed. Each value must be a UTF-8 encoded string with a
-        # length limit of 256 characters. * For number attributes, at most 400 values
-        # are allowed. For product recommendation, an example of extra user information
-        # is traffic_channel, i.e. how user arrives at the site. Users can arrive at the
-        # site by coming to the site directly, or coming through Google search, and etc.
+        # Extra user event features to include in the recommendation model. If you
+        # provide custom attributes for ingested user events, also include them in the
+        # user events that you associate with prediction requests. Custom attribute
+        # formatting must be consistent between imported events and events provided with
+        # prediction requests. This lets the Retail API use those custom attributes when
+        # training models and serving predictions, which helps improve recommendation
+        # quality. This field needs to pass all below criteria, otherwise an
+        # INVALID_ARGUMENT error is returned: * The key must be a UTF-8 encoded string
+        # with a length limit of 5,000 characters. * For text attributes, at most 400
+        # values are allowed. Empty values are not allowed. Each value must be a UTF-8
+        # encoded string with a length limit of 256 characters. * For number attributes,
+        # at most 400 values are allowed. For product recommendations, an example of
+        # extra user information is traffic_channel, which is how a user arrives at the
+        # site. Users can arrive at the site by coming to the site directly, coming
+        # through Google search, or in other ways.
         # Corresponds to the JSON property `attributes`
         # @return [Hash<String,Google::Apis::RetailV2beta::GoogleCloudRetailV2betaCustomAttribute>]
         attr_accessor :attributes
@@ -5503,11 +5596,11 @@ module Google
       # Represents a whole or partial calendar date, such as a birthday. The time of
       # day and time zone are either specified elsewhere or are insignificant. The
       # date is relative to the Gregorian Calendar. This can represent one of the
-      # following: * A full date, with non-zero year, month, and day values * A month
-      # and day, with a zero year (e.g., an anniversary) * A year on its own, with a
-      # zero month and a zero day * A year and month, with a zero day (e.g., a credit
-      # card expiration date) Related types: * google.type.TimeOfDay * google.type.
-      # DateTime * google.protobuf.Timestamp
+      # following: * A full date, with non-zero year, month, and day values. * A month
+      # and day, with a zero year (for example, an anniversary). * A year on its own,
+      # with a zero month and a zero day. * A year and month, with a zero day (for
+      # example, a credit card expiration date). Related types: * google.type.
+      # TimeOfDay * google.type.DateTime * google.protobuf.Timestamp
       class GoogleTypeDate
         include Google::Apis::Core::Hashable
       

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

@@ -16,13 +16,13 @@ module Google
   module Apis
     module RetailV2beta
       # Version of the google-apis-retail_v2beta gem
-      GEM_VERSION = "0.29.0"
+      GEM_VERSION = "0.32.0"
 
       # Version of the code generator used to generate this client
       GENERATOR_VERSION = "0.4.1"
 
       # Revision of the discovery document this client was generated from
-      REVISION = "20220217"
+      REVISION = "20220310"
     end
   end
 end

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

@@ -244,6 +244,18 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class GoogleCloudRetailV2alphaPurgeProductsMetadata
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleCloudRetailV2alphaPurgeProductsResponse
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class GoogleCloudRetailV2alphaPurgeUserEventsResponse
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -1230,6 +1242,24 @@ module Google
         end
       end
       
+      class GoogleCloudRetailV2alphaPurgeProductsMetadata
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :create_time, as: 'createTime'
+          property :failure_count, :numeric_string => true, as: 'failureCount'
+          property :success_count, :numeric_string => true, as: 'successCount'
+          property :update_time, as: 'updateTime'
+        end
+      end
+      
+      class GoogleCloudRetailV2alphaPurgeProductsResponse
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :purge_count, :numeric_string => true, as: 'purgeCount'
+          collection :purge_sample, as: 'purgeSample'
+        end
+      end
+      
       class GoogleCloudRetailV2alphaPurgeUserEventsResponse
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -1472,6 +1502,7 @@ module Google
           property :name, as: 'name'
           property :rule, as: 'rule', class: Google::Apis::RetailV2beta::GoogleCloudRetailV2betaRule, decorator: Google::Apis::RetailV2beta::GoogleCloudRetailV2betaRule::Representation
       
+          collection :search_solution_use_case, as: 'searchSolutionUseCase'
           collection :solution_types, as: 'solutionTypes'
         end
       end

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

@@ -72,10 +72,12 @@ module Google
         #   `UNKNOWN_DEVICE_TYPE` * `DESKTOP` * `MOBILE` * A customized string starts with
         #   `OTHER_`, e.g. `OTHER_IPHONE`.
         # @param [Array<String>, String] language_codes
-        #   The list of languages of the query. This is the BCP-47 language code, such as "
-        #   en-US" or "sr-Latn". For more information, see [Tags for Identifying Languages]
-        #   (https://tools.ietf.org/html/bcp47). The maximum number of allowed characters
-        #   is 255. Only "en-US" is currently supported.
+        #   The language filters applied to the output suggestions. If set, it should
+        #   contain the language of the query. If not set, suggestions are returned
+        #   without considering language restrictions. This is the BCP-47 language code,
+        #   such as "en-US" or "sr-Latn". For more information, see [Tags for Identifying
+        #   Languages](https://tools.ietf.org/html/bcp47). The maximum number of language
+        #   codes is 3.
         # @param [Fixnum] max_suggestions
         #   Completion max suggestions. If left unset or set to 0, then will fallback to
         #   the configured value CompletionConfig.max_suggestions. The maximum allowed max
@@ -84,12 +86,12 @@ module Google
         #   Required. The query used to generate suggestions. The maximum number of
         #   allowed characters is 255.
         # @param [String] visitor_id
-        #   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. The field must be a UTF-8 encoded
-        #   string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT
-        #   error is returned.
+        #   Required 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. The field must be a UTF-8
+        #   encoded string with a length limit of 128 characters. Otherwise, an
+        #   INVALID_ARGUMENT error is returned.
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
         # @param [String] quota_user
@@ -1669,13 +1671,14 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
-        # Triggers a user event rejoin operation with latest product catalog. Events
-        # will not be annotated with detailed product information if product is missing
-        # from the catalog at the time the user event is ingested, and these events are
+        # Starts a user event rejoin operation with latest product catalog. Events will
+        # not be annotated with detailed product information if product is missing from
+        # the catalog at the time the user event is ingested, and these events are
         # stored as unjoined events with a limited usage on training and serving. This
-        # API can be used to trigger a 'join' operation on specified events with latest
+        # method can be used to start a join operation on specified events with latest
         # version of product catalog. It can also be used to correct events joined with
-        # wrong product catalog.
+        # the wrong product catalog. A rejoin operation can take hours or days to
+        # complete.
         # @param [String] parent
         #   Required. The parent catalog resource name, such as `projects/1234/locations/
         #   global/catalogs/default_catalog`.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-apis-retail_v2beta
 version: !ruby/object:Gem::Version
-  version: 0.29.0
+  version: 0.32.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-02-28 00:00:00.000000000 Z
+date: 2022-03-21 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_v2beta/CHANGELOG.md
-  documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2beta/v0.29.0
+  documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2beta/v0.32.0
   source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-retail_v2beta
 post_install_message: 
 rdoc_options: []