google-apis-retail_v2 0.28.0 → 0.31.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 300ffa2560aad86e0f5783721309655a1afe52ec37d50f45698a3d9fcbb0d023
-  data.tar.gz: 5b77548ac25a18bcea4296878fbd720fb9a816c38f558f21448ccdbc0edda267
+  metadata.gz: e7026215dee691483ee2220eea2f1b0925c01316973a526ee493dddc65252ccc
+  data.tar.gz: 2a09466d24ed7c69217c82db15ec62af850dadc841e47b0257fd3a2441da5b66
 SHA512:
-  metadata.gz: 3ca5f224b3560132f6c139cd1393242eba1ea0fa6196d895dbd264652ac2ecba593cee943a44606e535bb01c1a6a507638992e475b83efcbb357b84160a036a9
-  data.tar.gz: 504198365b7dfdaeb4e31d104c75c0c04f2fbbe1374374c3c4af81a6c5fcce3049502028b375786f95eded5de0373b21f82d4285ded61fadd020fb88a190095a
+  metadata.gz: a648d9b561aa369bb0c0fdc189a64a95df5c205f35d3904e7e3b7c2391782d0b2bf8fdb653eb035b8ea4e066eefa00ab68b97de5f727106b01461275e8066ad8
+  data.tar.gz: 38c5765a7e13b5ce937559f351409a4e170bd4ed1f47ce29fdedfb25a26b92a5dd3b9a933ab9cb78afff6bd8891e9e6c1eabf60f0051b0ce77a0dc2c69bd2c9e

data/CHANGELOG.md

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

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

@@ -437,11 +437,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::RetailV2::GoogleTypeDate]
         attr_accessor :partition_date
@@ -719,8 +719,9 @@ module Google
         alias_method :searchable?, :searchable
       
         # The textual values of this custom attribute. For example, `["yellow", "green"]`
-        # when the key is "color". Exactly one of text or numbers should be set.
-        # Otherwise, an INVALID_ARGUMENT error is returned.
+        # when the key is "color". Empty string is not allowed. Otherwise, an
+        # INVALID_ARGUMENT error is returned. Exactly one of text or numbers should be
+        # set. Otherwise, an INVALID_ARGUMENT error is returned.
         # Corresponds to the JSON property `text`
         # @return [Array<String>]
         attr_accessor :text
@@ -846,7 +847,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 GoogleCloudRetailV2Image
         include Google::Apis::Core::Hashable
       
@@ -936,9 +940,9 @@ module Google
       class GoogleCloudRetailV2ImportErrorsConfig
         include Google::Apis::Core::Hashable
       
-        # Google Cloud Storage path for import errors. This must be an empty, existing
-        # Cloud Storage bucket. Import errors will be written to a file in this bucket,
-        # one per line, as a JSON-encoded `google.rpc.Status` message.
+        # Google Cloud Storage prefix for import errors. This must be an empty, existing
+        # Cloud Storage directory. Import errors will be written to sharded files in
+        # this directory, one per line, as a JSON-encoded `google.rpc.Status` message.
         # Corresponds to the JSON property `gcsPrefix`
         # @return [String]
         attr_accessor :gcs_prefix
@@ -1258,9 +1262,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
@@ -1531,9 +1537,9 @@ module Google
         # be a UTF-8 encoded string with a length limit of 128 characters. * For
         # indexable attribute, the key must match the pattern: `a-zA-Z0-9*`. For example,
         # `key0LikeThis` or `KEY_1_LIKE_THIS`. * 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.
+        # values are allowed. Empty values are not allowed. Each value must be a non-
+        # empty UTF-8 encoded string with a length limit of 256 characters. * For number
+        # attributes, at most 400 values are allowed.
         # Corresponds to the JSON property `attributes`
         # @return [Hash<String,Google::Apis::RetailV2::GoogleCloudRetailV2CustomAttribute>]
         attr_accessor :attributes
@@ -1667,7 +1673,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).
@@ -2341,12 +2347,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
@@ -3045,11 +3052,20 @@ module Google
         include Google::Apis::Core::Hashable
       
         # The final component of the resource name of a branch. This field must be one
-        # of "0", "1" or "2". Otherwise, an INVALID_ARGUMENT error is returned.
+        # of "0", "1" or "2". Otherwise, an INVALID_ARGUMENT error is returned. If there
+        # are no sufficient active products in the targeted branch and force is not set,
+        # a FAILED_PRECONDITION error is returned.
         # Corresponds to the JSON property `branchId`
         # @return [String]
         attr_accessor :branch_id
       
+        # If set to true, it permits switching to a branch with branch_id even if it has
+        # no sufficient active products.
+        # Corresponds to the JSON property `force`
+        # @return [Boolean]
+        attr_accessor :force
+        alias_method :force?, :force
+      
         # Some note on this request, this can be retrieved by CatalogService.
         # GetDefaultBranch before next valid default branch set occurs. This field must
         # be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise,
@@ -3065,6 +3081,7 @@ module Google
         # Update properties of this object
         def update!(**args)
           @branch_id = args[:branch_id] if args.key?(:branch_id)
+          @force = args[:force] if args.key?(:force)
           @note = args[:note] if args.key?(:note)
         end
       end
@@ -3149,15 +3166,21 @@ module Google
       class GoogleCloudRetailV2UserEvent
         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::RetailV2::GoogleCloudRetailV2CustomAttribute>]
         attr_accessor :attributes
@@ -3681,9 +3704,9 @@ module Google
       class GoogleCloudRetailV2alphaImportErrorsConfig
         include Google::Apis::Core::Hashable
       
-        # Google Cloud Storage path for import errors. This must be an empty, existing
-        # Cloud Storage bucket. Import errors will be written to a file in this bucket,
-        # one per line, as a JSON-encoded `google.rpc.Status` message.
+        # Google Cloud Storage prefix for import errors. This must be an empty, existing
+        # Cloud Storage directory. Import errors will be written to sharded files in
+        # this directory, one per line, as a JSON-encoded `google.rpc.Status` message.
         # Corresponds to the JSON property `gcsPrefix`
         # @return [String]
         attr_accessor :gcs_prefix
@@ -3828,6 +3851,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.
@@ -4151,9 +4242,9 @@ module Google
       class GoogleCloudRetailV2betaImportErrorsConfig
         include Google::Apis::Core::Hashable
       
-        # Google Cloud Storage path for import errors. This must be an empty, existing
-        # Cloud Storage bucket. Import errors will be written to a file in this bucket,
-        # one per line, as a JSON-encoded `google.rpc.Status` message.
+        # Google Cloud Storage prefix for import errors. This must be an empty, existing
+        # Cloud Storage directory. Import errors will be written to sharded files in
+        # this directory, one per line, as a JSON-encoded `google.rpc.Status` message.
         # Corresponds to the JSON property `gcsPrefix`
         # @return [String]
         attr_accessor :gcs_prefix
@@ -4582,11 +4673,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_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.28.0"
+      GEM_VERSION = "0.31.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 = "20220210"
+      REVISION = "20220310"
     end
   end
 end

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

@@ -580,6 +580,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
       
@@ -1508,6 +1520,7 @@ module Google
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
           property :branch_id, as: 'branchId'
+          property :force, as: 'force'
           property :note, as: 'note'
         end
       end
@@ -1718,6 +1731,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

data/lib/google/apis/retail_v2/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
@@ -682,7 +684,7 @@ module Google
         # CreateProduct or UpdateProduct request. If no inventory fields are set in
         # CreateProductRequest.product, then any pre-existing inventory information for
         # this product will be used. If no inventory fields are set in
-        # UpdateProductRequest.set_mask, then any existing inventory information will be
+        # SetInventoryRequest.set_mask, then any existing inventory information will be
         # preserved. Pre-existing inventory information can only be updated with
         # SetInventory, AddFulfillmentPlaces, and RemoveFulfillmentPlaces. This feature
         # is only available for users who have Retail Search enabled. Please submit a
@@ -1035,13 +1037,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_v2
 version: !ruby/object:Gem::Version
-  version: 0.28.0
+  version: 0.31.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-02-14 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_v2/CHANGELOG.md
-  documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2/v0.28.0
+  documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2/v0.31.0
   source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-retail_v2
 post_install_message: 
 rdoc_options: []