google-apis-retail_v2alpha 0.32.0 → 0.33.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b8f924967f8b766a58754b7d1ccc3595971b65f718056048c78c38dc9fbe6a5e
-  data.tar.gz: 791e94ff6a65503f21d744b484177ab537f5244340a94e651409e36a0a9e4577
+  metadata.gz: 28c4b9d5bc9ab2434afee8a37fc05065f33e4c1f877cdbc49c66842ce818531d
+  data.tar.gz: 586c391c1b0770ee1add05161217fa51b71fe15949f03c489c0d15a1cd861ffd
 SHA512:
-  metadata.gz: 2bbf179ac2a176dabde0c4f8a56f2a76775bd92423286ab1bc6cdbf58572164cceeada2dd67b06d479e3eb16e450ad3e3f7297845f682bf92b1790121951763e
-  data.tar.gz: 6a68d68ef8ca196bedb13a310df75e08d1684302235e74cebb58e10e0ccc075abcc19481dff48f4abe6c626cbbf002227602d020923a56436888913c8aa2520e
+  metadata.gz: 8c6f8ac592b5a64f5ddd5611412c337c6230aa21dd2e03613ff379f286a7dd7bae87131dad3a07fa0ffcf180381e99f46d34c3490587c921f2353044bfe5fa0a
+  data.tar.gz: 7a129795a38abcc73706846069990a9bae357a873e339f907ec2d75b82b53f156476b25092bf345a931d4501491f3a9d349087a3486c027910ef9661881614b3

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Release history for google-apis-retail_v2alpha
 
+### v0.33.0 (2022-03-16)
+
+* Regenerated from discovery document revision 20220310
+
 ### v0.32.0 (2022-03-09)
 
 * Regenerated from discovery document revision 20220303

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

@@ -1382,6 +1382,14 @@ module Google
         # @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaRule]
         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. If no solution type is
@@ -1401,6 +1409,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
@@ -1668,7 +1677,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 GoogleCloudRetailV2alphaImage
         include Google::Apis::Core::Hashable
       
@@ -2133,10 +2145,10 @@ module Google
         # key must be a UTF-8 encoded string with a length limit of 32 characters. * The
         # key must match the pattern: `a-zA-Z0-9*`. For example, key0LikeThis or
         # KEY_1_LIKE_THIS. * The attribute values must be of the same type (text or
-        # number). * The max number of values per attribute is 10. * For text values,
-        # the length limit is 256 UTF-8 characters. * The attribute does not support
-        # search. The `searchable` field should be unset or set to false. * The max
-        # summed total bytes of custom attribute keys and values per product is 5MiB.
+        # number). * Only 1 value is allowed for each attribute. * For text values, the
+        # length limit is 256 UTF-8 characters. * The attribute does not support search.
+        # The `searchable` field should be unset or set to false. * The max summed total
+        # bytes of custom attribute keys and values per product is 5MiB.
         # Corresponds to the JSON property `attributes`
         # @return [Hash<String,Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCustomAttribute>]
         attr_accessor :attributes
@@ -2260,9 +2272,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
@@ -2669,7 +2683,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).
@@ -3093,6 +3107,115 @@ 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
+      
+      # Request message for PurgeProducts method.
+      class GoogleCloudRetailV2alphaPurgeProductsRequest
+        include Google::Apis::Core::Hashable
+      
+        # Required. The filter string to specify the products to be deleted with a
+        # length limit of 5,000 characters. Empty string filter is not allowed. "*"
+        # implies delete all items in a branch. The eligible fields for filtering are: *
+        # `availability`: Double quoted Product.availability string. * `create_time` :
+        # in ISO 8601 "zulu" format. Supported syntax: * Comparators (">", "<", ">=", "<=
+        # ", "="). Examples: * create_time <= "2015-02-13T17:05:46Z" * availability = "
+        # IN_STOCK” * Conjunctions ("AND") Examples: * create_time <= "2015-02-13T17:05:
+        # 46Z" AND availability = "PREORDER" * Disjunctions ("OR") Examples: *
+        # create_time <= "2015-02-13T17:05:46Z" OR availability = "IN_STOCK" * Can
+        # support nested queries. Examples: * (create_time <= "2015-02-13T17:05:46Z" AND
+        # availability = "PREORDER") OR (create_time >= "2015-02-14T13:03:32Z" AND
+        # availability = "IN_STOCK") * Filter Limits: * Filter should not contain more
+        # than 6 conditions. * Max nesting depth should not exceed 2 levels. Examples
+        # queries: * Delete back order products created before a timestamp. create_time <
+        # = "2015-02-13T17:05:46Z" OR availability = "BACKORDER”
+        # Corresponds to the JSON property `filter`
+        # @return [String]
+        attr_accessor :filter
+      
+        # Actually perform the purge. If `force` is set to false, the method will return
+        # the expected purge count without deleting any products.
+        # Corresponds to the JSON property `force`
+        # @return [Boolean]
+        attr_accessor :force
+        alias_method :force?, :force
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @filter = args[:filter] if args.key?(:filter)
+          @force = args[:force] if args.key?(:force)
+        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
+      
       # Request message for PurgeUserEvents method.
       class GoogleCloudRetailV2alphaPurgeUserEventsRequest
         include Google::Apis::Core::Hashable
@@ -3804,12 +3927,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
@@ -4808,15 +4932,21 @@ module Google
       class GoogleCloudRetailV2alphaUserEvent
         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::RetailV2alpha::GoogleCloudRetailV2alphaCustomAttribute>]
         attr_accessor :attributes

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.32.0"
+      GEM_VERSION = "0.33.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 = "20220303"
+      REVISION = "20220310"
     end
   end
 end

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

@@ -526,6 +526,24 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class GoogleCloudRetailV2alphaPurgeProductsMetadata
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleCloudRetailV2alphaPurgeProductsRequest
+        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 GoogleCloudRetailV2alphaPurgeUserEventsRequest
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -1349,6 +1367,7 @@ module Google
           property :name, as: 'name'
           property :rule, as: 'rule', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaRule, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaRule::Representation
       
+          collection :search_solution_use_case, as: 'searchSolutionUseCase'
           collection :solution_types, as: 'solutionTypes'
         end
       end
@@ -1757,6 +1776,32 @@ 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 GoogleCloudRetailV2alphaPurgeProductsRequest
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :filter, as: 'filter'
+          property :force, as: 'force'
+        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 GoogleCloudRetailV2alphaPurgeUserEventsRequest
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation

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

@@ -86,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
@@ -860,6 +860,47 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
+        # Permanently deletes all selected Products under a branch. This process is
+        # asynchronous. If the request is valid, the removal will be enqueued and
+        # processed offline. Depending on the number of Products, this operation could
+        # take hours to complete. Before the operation completes, some Products may
+        # still be returned by GetProduct or ListProducts. Depending on the number of
+        # Products, this operation could take hours to complete. To get a sample of
+        # Products that would be deleted, set PurgeProductsRequest.force to false.
+        # @param [String] parent
+        #   Required. The resource name of the branch under which the products are created.
+        #   The format is `projects/$`projectId`/locations/global/catalogs/$`catalogId`/
+        #   branches/$`branchId``
+        # @param [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaPurgeProductsRequest] google_cloud_retail_v2alpha_purge_products_request_object
+        # @param [String] fields
+        #   Selector specifying which fields to include in a partial response.
+        # @param [String] quota_user
+        #   Available to use for quota purposes for server-side applications. Can be any
+        #   arbitrary string assigned to a user, but should not exceed 40 characters.
+        # @param [Google::Apis::RequestOptions] options
+        #   Request-specific options
+        #
+        # @yield [result, err] Result & error if block supplied
+        # @yieldparam result [Google::Apis::RetailV2alpha::GoogleLongrunningOperation] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::RetailV2alpha::GoogleLongrunningOperation]
+        #
+        # @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 purge_project_location_catalog_branch_product(parent, google_cloud_retail_v2alpha_purge_products_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:post, 'v2alpha/{+parent}/products:purge', options)
+          command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaPurgeProductsRequest::Representation
+          command.request_object = google_cloud_retail_v2alpha_purge_products_request_object
+          command.response_representation = Google::Apis::RetailV2alpha::GoogleLongrunningOperation::Representation
+          command.response_class = Google::Apis::RetailV2alpha::GoogleLongrunningOperation
+          command.params['parent'] = parent unless parent.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
         # Incrementally removes place IDs from a 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
@@ -1766,13 +1807,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_v2alpha
 version: !ruby/object:Gem::Version
-  version: 0.32.0
+  version: 0.33.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-03-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_v2alpha/CHANGELOG.md
-  documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2alpha/v0.32.0
+  documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2alpha/v0.33.0
   source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-retail_v2alpha
 post_install_message: 
 rdoc_options: []