google-apis-retail_v2alpha 0.13.0 → 0.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7eff994be02b1880715b24a8c7be2fdcfa6bafed959b5d299c1a86adac7e48ed
-  data.tar.gz: 3fc5c775d839cfed35349dd179405a564c9b85a251bb1c2c332a7500980131e8
+  metadata.gz: ebc5348a1550e8bab9415592500f3d695802bdf85145487e866beea54fbe1f88
+  data.tar.gz: 772a44e0ef905d9179381a8c58f2d3bae90bd0e50662935b3b28fb48d25fe8f9
 SHA512:
-  metadata.gz: 86279591044bf3a1087868a6a22c4206fcb7e6a0285700cb08b898778b80c44f5925fa802f5b3c28c6054838dec18e056e1b3d4b414915cc38b00ab566805903
-  data.tar.gz: 3bde47ac0ddf2778f156c0d1189af6d520a8db22fa3c6a2c9d30af42f04710235cbcd023f352457e248b1c38cd4362ebaf08e4e197cb68513ef7bafec08e501e
+  metadata.gz: b94beb2a88ad73b349a5b5e0ed3ac139100382e1809feb2c7dd71028676eb51104fe9b16ebb7605354f2cc343bebcbdf0aba6a677203bf647c840bfd49efaa2c
+  data.tar.gz: a3b7500ca53023d1125612220b2f3b1b27fc7917e77918a7bd98da3a24e2d455f8f2ea3a8433ef7e9f91582c9987825967c3921678c5a120647a176809565753

data/CHANGELOG.md

@@ -1,5 +1,21 @@
 # Release history for google-apis-retail_v2alpha
 
+### v0.17.0 (2021-10-05)
+
+* Regenerated from discovery document revision 20210930
+
+### v0.16.0 (2021-09-25)
+
+* Regenerated from discovery document revision 20210924
+
+### v0.15.0 (2021-09-08)
+
+* Regenerated from discovery document revision 20210906
+
+### v0.14.0 (2021-09-01)
+
+* Regenerated from discovery document revision 20210819
+
 ### v0.13.0 (2021-07-24)
 
 * Regenerated from discovery document revision 20210723

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

@@ -646,8 +646,8 @@ module Google
       
         # If set to true, and the Product is not found, the fulfillment information will
         # still be processed and retained for at most 1 day and processed once the
-        # Product is created. If set to false, an INVALID_ARGUMENT error is returned if
-        # the Product is not found.
+        # Product is created. If set to false, a NOT_FOUND error is returned if the
+        # Product is not found.
         # Corresponds to the JSON property `allowMissing`
         # @return [Boolean]
         attr_accessor :allow_missing
@@ -870,8 +870,8 @@ module Google
         # The color display names, which may be different from standard color family
         # names, such as the color aliases used in the website frontend. Normally it is
         # expected to have only 1 color. May consider using single "Mixed" instead of
-        # multiple values. A maximum of 5 colors are allowed. Each value must be a UTF-8
-        # encoded string with a length limit of 128 characters. Otherwise, an
+        # multiple values. A maximum of 25 colors are allowed. Each value must be a UTF-
+        # 8 encoded string with a length limit of 128 characters. Otherwise, an
         # INVALID_ARGUMENT error is returned. Google Merchant Center property [color](
         # https://support.google.com/merchants/answer/6324487). Schema.org property [
         # Product.color](https://schema.org/color).
@@ -907,9 +907,9 @@ module Google
         # @return [Array<Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCompleteQueryResponseCompletionResult>]
         attr_accessor :completion_results
       
-        # Matched recent searches of this user. This field is a restricted feature.
-        # Contact Retail Support (retail-search-support@google.com) if you are
-        # interested in enabling it. This feature is only available when
+        # Matched recent searches of this user. The maximum number of recent searches is
+        # 10. This field is a restricted feature. Contact Retail Search support team if
+        # you are interested in enabling it. This feature is only available when
         # CompleteQueryRequest.visitor_id field is set and UserEvent is imported. The
         # recent searches satisfy the follow rules: * They are ordered from latest to
         # oldest. * They are matched with CompleteQueryRequest.query case insensitively.
@@ -1080,6 +1080,20 @@ module Google
         end
       end
       
+      # Metadata related to the EnrollSolution method. This will be returned by the
+      # google.longrunning.Operation.metadata field.
+      class GoogleCloudRetailV2alphaEnrollSolutionMetadata
+        include Google::Apis::Core::Hashable
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+        end
+      end
+      
       # Configuration of destination for Export related errors.
       class GoogleCloudRetailV2alphaExportErrorsConfig
         include Google::Apis::Core::Hashable
@@ -1189,8 +1203,8 @@ module Google
       
         # The IDs for this type, such as the store IDs for FulfillmentInfo.type.pickup-
         # in-store or the region IDs for FulfillmentInfo.type.same-day-delivery. A
-        # maximum of 2000 values are allowed. Each value must be a string with a length
-        # limit of 10 characters, matching the pattern [a-zA-Z0-9_-]+, such as "store1"
+        # maximum of 3000 values are allowed. Each value must be a string with a length
+        # limit of 30 characters, matching the pattern [a-zA-Z0-9_-]+, such as "store1"
         # or "REGION-2". Otherwise, an INVALID_ARGUMENT error is returned.
         # Corresponds to the JSON property `placeIds`
         # @return [Array<String>]
@@ -1709,9 +1723,9 @@ module Google
       
         # String representing the destination to import for, all if left empty. List of
         # possible values can be found here. [https://support.google.com/merchants/
-        # answer/7501026?hl=en] List of allowed string values: "shopping-ads", "buy-on-
-        # google-listings", "display-ads", "local-inventory -ads", "free-listings", "
-        # free-local-listings" NOTE: The string values are case sensitive.
+        # answer/7501026] List of allowed string values: "shopping-ads", "buy-on-google-
+        # listings", "display-ads", "local-inventory -ads", "free-listings", "free-local-
+        # listings" NOTE: The string values are case sensitive.
         # Corresponds to the JSON property `destinations`
         # @return [Array<String>]
         attr_accessor :destinations
@@ -2040,12 +2054,10 @@ module Google
         # product, or age of a customer. For example: `` "vendor": `"text": ["vendor123",
         # "vendor456"]`, "lengths_cm": `"numbers":[2.3, 15.4]`, "heights_cm": `"numbers"
         # :[8.1, 6.4]` ``. This field needs to pass all below criteria, otherwise an
-        # INVALID_ARGUMENT error is returned: * Max entries count: 200 by default; 100
-        # for Type.VARIANT. * The key must be a UTF-8 encoded string with a length limit
-        # of 128 characters. * Max indexable entries count: 200 by default; 40 for Type.
-        # VARIANT. * Max searchable entries count: 30. * For indexable attribute, the
-        # key must match the pattern: a-zA-Z0-9*. For example, key0LikeThis or
-        # KEY_1_LIKE_THIS.
+        # INVALID_ARGUMENT error is returned: * Max entries count: 200. * The key must
+        # 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.
         # Corresponds to the JSON property `attributes`
         # @return [Hash<String,Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCustomAttribute>]
         attr_accessor :attributes
@@ -2137,8 +2149,10 @@ module Google
         # The timestamp when this product becomes unavailable for SearchService.Search.
         # If it is set, the Product is not available for SearchService.Search after
         # expire_time. However, the product can still be retrieved by ProductService.
-        # GetProduct and ProductService.ListProducts. Google Merchant Center property [
-        # expiration_date](https://support.google.com/merchants/answer/6324499).
+        # GetProduct and ProductService.ListProducts. expire_time must be later than
+        # available_time and publish_time, otherwise an INVALID_ARGUMENT error is thrown.
+        # Google Merchant Center property [expiration_date](https://support.google.com/
+        # merchants/answer/6324499).
         # Corresponds to the JSON property `expireTime`
         # @return [String]
         attr_accessor :expire_time
@@ -2152,7 +2166,8 @@ module Google
       
         # The Global Trade Item Number (GTIN) of the product. This field must be a UTF-8
         # encoded string with a length limit of 128 characters. Otherwise, an
-        # INVALID_ARGUMENT error is returned. Google Merchant Center property [gtin](
+        # INVALID_ARGUMENT error is returned. This field must be a Unigram. Otherwise,
+        # an INVALID_ARGUMENT error is returned. Google Merchant Center property [gtin](
         # https://support.google.com/merchants/answer/6324461). Schema.org property [
         # Product.isbn](https://schema.org/isbn) or [Product.gtin8](https://schema.org/
         # gtin8) or [Product.gtin12](https://schema.org/gtin12) or [Product.gtin13](
@@ -2191,7 +2206,7 @@ module Google
         # @return [String]
         attr_accessor :language_code
       
-        # The material of the product. For example, "leather", "wooden". A maximum of 5
+        # The material of the product. For example, "leather", "wooden". A maximum of 20
         # values are allowed. Each value must be a UTF-8 encoded string with a length
         # limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.
         # Google Merchant Center property [material](https://support.google.com/
@@ -2203,13 +2218,12 @@ module Google
       
         # Immutable. Full resource name of the product, such as `projects/*/locations/
         # global/catalogs/default_catalog/branches/default_branch/products/product_id`.
-        # The branch ID must be "default_branch".
         # Corresponds to the JSON property `name`
         # @return [String]
         attr_accessor :name
       
         # The pattern or graphic print of the product. For example, "striped", "polka
-        # dot", "paisley". A maximum of 5 values are allowed per Product. Each value
+        # dot", "paisley". A maximum of 20 values are allowed per Product. Each value
         # must be a UTF-8 encoded string with a length limit of 128 characters.
         # Otherwise, an INVALID_ARGUMENT error is returned. Google Merchant Center
         # property [pattern](https://support.google.com/merchants/answer/6324483).
@@ -2265,8 +2279,9 @@ module Google
         # attribute, as specified in attributes. For Type.PRIMARY and Type.COLLECTION,
         # the following fields are always returned in SearchResponse by default: * name
         # For Type.VARIANT, the following fields are always returned in by default: *
-        # name * color_info Maximum number of paths is 20. Otherwise, an
-        # INVALID_ARGUMENT error is returned.
+        # name * color_info Maximum number of paths is 30. Otherwise, an
+        # INVALID_ARGUMENT error is returned. Note: Returning more fields in
+        # SearchResponse may increase response payload size and serving latency.
         # Corresponds to the JSON property `retrievableFields`
         # @return [String]
         attr_accessor :retrievable_fields
@@ -2764,8 +2779,8 @@ module Google
       
         # If set to true, and the Product is not found, the fulfillment information will
         # still be processed and retained for at most 1 day and processed once the
-        # Product is created. If set to false, an INVALID_ARGUMENT error is returned if
-        # the Product is not found.
+        # Product is created. If set to false, a NOT_FOUND error is returned if the
+        # Product is not found.
         # Corresponds to the JSON property `allowMissing`
         # @return [Boolean]
         attr_accessor :allow_missing
@@ -2866,9 +2881,9 @@ module Google
       
         # The filter syntax consists of an expression language for constructing a
         # predicate from one or more fields of the products being filtered. Filter
-        # expression is case-sensitive. See more details at this [user guide](/retail/
-        # private/docs/filter-and-order#filter). If this field is unrecognizable, an
-        # INVALID_ARGUMENT is returned.
+        # expression is case-sensitive. See more details at this [user guide](https://
+        # cloud.google.com/retail/docs/filter-and-order#filter). If this field is
+        # unrecognizable, an INVALID_ARGUMENT is returned.
         # Corresponds to the JSON property `filter`
         # @return [String]
         attr_accessor :filter
@@ -2883,9 +2898,9 @@ module Google
       
         # The order in which products are returned. Products can be ordered by a field
         # in an Product object. Leave it unset if ordered by relevance. OrderBy
-        # expression is case-sensitive. See more details at this [user guide](/retail/
-        # private/docs/filter-and-order#order). If this field is unrecognizable, an
-        # INVALID_ARGUMENT is returned.
+        # expression is case-sensitive. See more details at this [user guide](https://
+        # cloud.google.com/retail/docs/filter-and-order#order). If this field is
+        # unrecognizable, an INVALID_ARGUMENT is returned.
         # Corresponds to the JSON property `orderBy`
         # @return [String]
         attr_accessor :order_by
@@ -2929,8 +2944,8 @@ module Google
       
         # The relevance threshold of the search results. Defaults to RelevanceThreshold.
         # HIGH, which means only the most relevant results are shown, and the least
-        # number of results are returned. See more details at this [user guide](/retail/
-        # private/docs/result-size#relevance_thresholding).
+        # number of results are returned. See more details at this [user guide](https://
+        # cloud.google.com/retail/docs/result-size#relevance_thresholding).
         # Corresponds to the JSON property `relevanceThreshold`
         # @return [String]
         attr_accessor :relevance_threshold
@@ -2943,25 +2958,25 @@ module Google
         # The keys to fetch and rollup the matching variant Products attributes. The
         # attributes from all the matching variant Products are merged and de-duplicated.
         # Notice that rollup variant Products attributes will lead to extra query
-        # latency. Maximum number of keys is 10. For Product.fulfillment_info, a
-        # fulfillment type and a fulfillment ID must be provided in the format of "
-        # fulfillmentType.filfillmentId". E.g., in "pickupInStore.store123", "
-        # pickupInStore" is fulfillment type and "store123" is the store ID. Supported
-        # keys are: * colorFamilies * price * originalPrice * discount * attributes.key,
-        # where key is any key in the Product.attributes map. * pickupInStore.id, where
-        # id is any FulfillmentInfo.ids for type FulfillmentInfo.Type.PICKUP_IN_STORE. *
-        # shipToStore.id, where id is any FulfillmentInfo.ids for type FulfillmentInfo.
-        # Type.SHIP_TO_STORE. * sameDayDelivery.id, where id is any FulfillmentInfo.ids
-        # for type FulfillmentInfo.Type.SAME_DAY_DELIVERY. * nextDayDelivery.id, where
-        # id is any FulfillmentInfo.ids for type FulfillmentInfo.Type.NEXT_DAY_DELIVERY.
-        # * customFulfillment1.id, where id is any FulfillmentInfo.ids for type
-        # FulfillmentInfo.Type.CUSTOM_TYPE_1. * customFulfillment2.id, where id is any
-        # FulfillmentInfo.ids for type FulfillmentInfo.Type.CUSTOM_TYPE_2. *
-        # customFulfillment3.id, where id is any FulfillmentInfo.ids for type
-        # FulfillmentInfo.Type.CUSTOM_TYPE_3. * customFulfillment4.id, where id is any
-        # FulfillmentInfo.ids for type FulfillmentInfo.Type.CUSTOM_TYPE_4. *
-        # customFulfillment5.id, where id is any FulfillmentInfo.ids for type
-        # FulfillmentInfo.Type.CUSTOM_TYPE_5. If this field is set to an invalid value
+        # latency. Maximum number of keys is 10. For FulfillmentInfo, a fulfillment type
+        # and a fulfillment ID must be provided in the format of "fulfillmentType.
+        # fulfillmentId". E.g., in "pickupInStore.store123", "pickupInStore" is
+        # fulfillment type and "store123" is the store ID. Supported keys are: *
+        # colorFamilies * price * originalPrice * discount * attributes.key, where key
+        # is any key in the Product.attributes map. * pickupInStore.id, where id is any
+        # FulfillmentInfo.place_ids for FulfillmentInfo.type "pickup-in-store". *
+        # shipToStore.id, where id is any FulfillmentInfo.place_ids for FulfillmentInfo.
+        # type "ship-to-store". * sameDayDelivery.id, where id is any FulfillmentInfo.
+        # place_ids for FulfillmentInfo.type "same-day-delivery". * nextDayDelivery.id,
+        # where id is any FulfillmentInfo.place_ids for FulfillmentInfo.type "next-day-
+        # delivery". * customFulfillment1.id, where id is any FulfillmentInfo.place_ids
+        # for FulfillmentInfo.type "custom-type-1". * customFulfillment2.id, where id is
+        # any FulfillmentInfo.place_ids for FulfillmentInfo.type "custom-type-2". *
+        # customFulfillment3.id, where id is any FulfillmentInfo.place_ids for
+        # FulfillmentInfo.type "custom-type-3". * customFulfillment4.id, where id is any
+        # FulfillmentInfo.place_ids for FulfillmentInfo.type "custom-type-4". *
+        # customFulfillment5.id, where id is any FulfillmentInfo.place_ids for
+        # FulfillmentInfo.type "custom-type-5". If this field is set to an invalid value
         # other than these, an INVALID_ARGUMENT error is returned.
         # Corresponds to the JSON property `variantRollupKeys`
         # @return [Array<String>]
@@ -3046,8 +3061,8 @@ module Google
         # An expression which specifies a boost condition. The syntax and supported
         # fields are the same as a filter expression. See SearchRequest.filter for
         # detail syntax and limitations. Examples: * To boost products with product ID "
-        # product_1" or "product_2", and color "Red" or "Blue": *(id: ANY("product_1", "
-        # product_2")) * *AND * *(colorFamilies: ANY("Red", "Blue")) *
+        # product_1" or "product_2", and color "Red" or "Blue": * (id: ANY("product_1", "
+        # product_2")) AND (colorFamilies: ANY("Red","Blue"))
         # Corresponds to the JSON property `condition`
         # @return [String]
         attr_accessor :condition
@@ -3169,33 +3184,13 @@ module Google
       
         # Required. Supported textual and numerical facet keys in Product object, over
         # which the facet values are computed. Facet key is case-sensitive. Allowed
-        # facet keys when FacetKey.query is not specified: * textual_field = *# The
-        # Product.brands. * "brands"; *# The Product.categories. * "categories"; *# The
-        # Audience.genders. * | "genders"; *# The Audience.age_groups. * | "ageGroups"; *
-        # # The Product.availability. Value is one of * *# "IN_STOCK", "OUT_OF_STOCK",
-        # PREORDER", "BACKORDER". * | "availability"; *# The ColorInfo.color_families. *
-        # | "colorFamilies"; *# The ColorInfo.colors. * | "colors"; *# The Product.sizes.
-        # * | "sizes"; *# The Product.materials. * | "materials"; *# The Product.
-        # patterns. * | "patterns"; *# The Product.conditions. * | "conditions"; *# The
-        # textual custom attribute in Product object. Key can * *# be any key in the
-        # Product.attributes map * *# if the attribute values are textual. * *# map. * |
-        # "attributes.key"; *# The FulfillmentInfo.ids for type *# FulfillmentInfo.Type.
-        # PICKUP_IN_STORE. * | "pickupInStore"; *# The FulfillmentInfo.ids for type *#
-        # FulfillmentInfo.Type.SHIP_TO_STORE. * | "shipToStore"; *# The FulfillmentInfo.
-        # ids for type *# FulfillmentInfo.Type.SAME_DAY_DELIVERY. * | "sameDayDelivery";
-        # *# The FulfillmentInfo.ids for type *# FulfillmentInfo.Type.NEXT_DAY_DELIVERY.
-        # * | "nextDayDelivery"; *# The FulfillmentInfo.ids for type *# FulfillmentInfo.
-        # Type.CUSTOM_TYPE_1. * | "customFulfillment1"; *# The FulfillmentInfo.ids for
-        # type *# FulfillmentInfo.Type.CUSTOM_TYPE_2. * | "customFulfillment2"; *# The
-        # FulfillmentInfo.ids for type *# FulfillmentInfo.Type.CUSTOM_TYPE_3. * | "
-        # customFulfillment3"; *# The FulfillmentInfo.ids for type *# FulfillmentInfo.
-        # Type.CUSTOM_TYPE_4. * | "customFulfillment4"; *# The FulfillmentInfo.ids for
-        # type *# FulfillmentInfo.Type.CUSTOM_TYPE_5. * | "customFulfillment5"; *
-        # numerical_field = *# The PriceInfo.price. * "price"; *# The discount. Computed
-        # by (original_price-price)/price * "discount"; *# The Rating.average_rating. * "
-        # rating"; *# The Rating.rating_count. * "ratingCount"; *# The numerical custom
-        # attribute in Product object. Key can * *# be any key in the Product.attributes
-        # map * *# if the attribute values are numerical. * | "attributes.key";
+        # facet keys when FacetKey.query is not specified: * textual_field = * "brands" *
+        # "categories" * "genders" * "ageGroups" * "availability" * "colorFamilies" * "
+        # colors" * "sizes" * "materials" * "patterns" * "conditions" * "attributes.key"
+        # * "pickupInStore" * "shipToStore" * "sameDayDelivery" * "nextDayDelivery" * "
+        # customFulfillment1" * "customFulfillment2" * "customFulfillment3" * "
+        # customFulfillment4" * "customFulfillment5" * numerical_field = * "price" * "
+        # discount" * "rating" * "ratingCount" * "attributes.key"
         # Corresponds to the JSON property `key`
         # @return [String]
         attr_accessor :key
@@ -3205,7 +3200,7 @@ module Google
         # which means order by Facet.FacetValue.value descending. Only applies to
         # textual facets. If not set, textual values are sorted in [natural order](https:
         # //en.wikipedia.org/wiki/Natural_sort_order); numerical intervals are sorted in
-        # the order given by FacetSpec.FacetKey.intervals; FulfillmentInfo.ids are
+        # the order given by FacetSpec.FacetKey.intervals; FulfillmentInfo.place_ids are
         # sorted in the order given by FacetSpec.FacetKey.restricted_values.
         # Corresponds to the JSON property `orderBy`
         # @return [String]
@@ -3271,6 +3266,14 @@ module Google
         # @return [String]
         attr_accessor :condition
       
+        # Whether to pin unexpanded results. If this field is set to true, unexpanded
+        # products are always at the top of the search results, followed by the expanded
+        # results.
+        # Corresponds to the JSON property `pinUnexpandedResults`
+        # @return [Boolean]
+        attr_accessor :pin_unexpanded_results
+        alias_method :pin_unexpanded_results?, :pin_unexpanded_results
+      
         def initialize(**args)
            update!(**args)
         end
@@ -3278,6 +3281,7 @@ module Google
         # Update properties of this object
         def update!(**args)
           @condition = args[:condition] if args.key?(:condition)
+          @pin_unexpanded_results = args[:pin_unexpanded_results] if args.key?(:pin_unexpanded_results)
         end
       end
       
@@ -3424,6 +3428,12 @@ module Google
         attr_accessor :expanded_query
         alias_method :expanded_query?, :expanded_query
       
+        # Number of pinned results. This field will only be set when expansion happens
+        # and SearchRequest.QueryExpansionSpec.pin_unexpanded_results is set to true.
+        # Corresponds to the JSON property `pinnedResultCount`
+        # @return [Fixnum]
+        attr_accessor :pinned_result_count
+      
         def initialize(**args)
            update!(**args)
         end
@@ -3431,6 +3441,7 @@ module Google
         # Update properties of this object
         def update!(**args)
           @expanded_query = args[:expanded_query] if args.key?(:expanded_query)
+          @pinned_result_count = args[:pinned_result_count] if args.key?(:pinned_result_count)
         end
       end
       
@@ -3472,10 +3483,10 @@ module Google
         # protobuf.ListValue. For example, if there are two variants with colors "red"
         # and "blue", the rollup values are ` key: "colorFamilies" value ` list_value `
         # values ` string_value: "red" ` values ` string_value: "blue" ` ` ` ` For
-        # Product.fulfillment_info, the rollup values is a double value with type google.
-        # protobuf.Value. For example, `key: "pickupInStore.store1" value ` number_value:
-        # 10 `` means a there are 10 variants in this product are available in the
-        # store "store1".
+        # FulfillmentInfo, the rollup values is a double value with type google.protobuf.
+        # Value. For example, ``key: "pickupInStore.store1" value ` number_value: 10 ```
+        # means a there are 10 variants in this product are available in the store "
+        # store1".
         # Corresponds to the JSON property `variantRollupValues`
         # @return [Hash<String,Object>]
         attr_accessor :variant_rollup_values
@@ -3544,8 +3555,8 @@ module Google
       
         # If set to true, and the Product with name Product.name is not found, the
         # inventory update will still be processed and retained for at most 1 day until
-        # the Product is created. If set to false, an INVALID_ARGUMENT error is returned
-        # if the Product is not found.
+        # the Product is created. If set to false, a NOT_FOUND error is returned if the
+        # Product is not found.
         # Corresponds to the JSON property `allowMissing`
         # @return [Boolean]
         attr_accessor :allow_missing
@@ -3629,7 +3640,7 @@ module Google
         # @return [String]
         attr_accessor :attribution_token
       
-        # The id or name of the associated shopping cart. This id is used to associate
+        # 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`
         # events.
@@ -3710,7 +3721,7 @@ module Google
         # @return [Array<String>]
         attr_accessor :page_categories
       
-        # A unique id of a web page view. This should be kept the same for all user
+        # A unique ID of a web page view. This should be kept the same for all user
         # events triggered from the same pageview. For example, an item detail page view
         # could trigger multiple events as the user is browsing the page. The `
         # pageViewId` property should be kept the same for all these events so that they
@@ -3724,11 +3735,11 @@ module Google
         # The main product details related to the event. This field is required for the
         # following event types: * `add-to-cart` * `detail-page-view` * `purchase-
         # complete` In a `search` event, this field represents the products returned to
-        # the end user on the current page (the end user may have not finished broswing
+        # the end user on the current page (the end user may have not finished browsing
         # the whole page yet). When a new page is returned to the end user, after
         # pagination/filtering/ordering even for the same query, a new `search` event
         # with different product_details is desired. The end user may have not finished
-        # broswing the whole page yet.
+        # browsing the whole page yet.
         # Corresponds to the JSON property `productDetails`
         # @return [Array<Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaProductDetail>]
         attr_accessor :product_details

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.13.0"
+      GEM_VERSION = "0.17.0"
 
       # Version of the code generator used to generate this client
       GENERATOR_VERSION = "0.4.0"
 
       # Revision of the discovery document this client was generated from
-      REVISION = "20210723"
+      REVISION = "20210930"
     end
   end
 end

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

@@ -238,6 +238,12 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class GoogleCloudRetailV2alphaEnrollSolutionMetadata
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class GoogleCloudRetailV2alphaExportErrorsConfig
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -1077,6 +1083,12 @@ module Google
         end
       end
       
+      class GoogleCloudRetailV2alphaEnrollSolutionMetadata
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+        end
+      end
+      
       class GoogleCloudRetailV2alphaExportErrorsConfig
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -1586,6 +1598,7 @@ module Google
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
           property :condition, as: 'condition'
+          property :pin_unexpanded_results, as: 'pinUnexpandedResults'
         end
       end
       
@@ -1630,6 +1643,7 @@ module Google
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
           property :expanded_query, as: 'expandedQuery'
+          property :pinned_result_count, :numeric_string => true, as: 'pinnedResultCount'
         end
       end
       

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

@@ -52,18 +52,19 @@ module Google
         end
         
         # Completes the specified prefix with keyword suggestions. This feature is only
-        # available for users who have Retail Search enabled. Contact Retail Support (
-        # retail-search-support@google.com) if you are interested in using Retail Search.
+        # available for users who have Retail Search enabled. Please submit a form [here]
+        # (https://cloud.google.com/contact) to contact cloud sales if you are
+        # interested in using Retail Search.
         # @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] dataset
         #   Determines which dataset to use for fetching completion. "user-data" will use
-        #   the imported dataset through ImportCompletionData. "cloud-retail" will use the
-        #   dataset generated by cloud retail based on user events. If leave empty, it
-        #   will use the "user-data". Current supported values: * user-data * cloud-retail
-        #   This option is not automatically enabled. Before using cloud-retail, contact
-        #   retail-search-support@google.com first.
+        #   the imported dataset through CompletionService.ImportCompletionData. "cloud-
+        #   retail" will use the dataset generated by cloud retail based on user events.
+        #   If leave empty, it will use the "user-data". Current supported values: * user-
+        #   data * cloud-retail This option requires additional allowlisting. Before using
+        #   cloud-retail, contact Cloud Retail support team first.
         # @param [String] device_type
         #   The device type context for completion suggestions. It is useful to apply
         #   different suggestions on different device types, e.g. DESKTOP, MOBILE. If it
@@ -76,8 +77,9 @@ module Google
         #   (https://tools.ietf.org/html/bcp47). The maximum number of allowed characters
         #   is 255. Only "en-US" is currently supported.
         # @param [Fixnum] max_suggestions
-        #   Completion max suggestions. The maximum allowed max suggestions is 20. The
-        #   default value is 20.
+        #   Completion max suggestions. If left unset or set to 0, then will fallback to
+        #   the configured value CompletionConfig.max_suggestions. The maximum allowed max
+        #   suggestions is 20. If it is set higher, it will be capped by 20.
         # @param [String] query
         #   Required. The query used to generate suggestions. The maximum number of
         #   allowed characters is 255.
@@ -123,8 +125,9 @@ module Google
         
         # Get which branch is currently default branch set by CatalogService.
         # SetDefaultBranch method under a specified parent catalog. This feature is only
-        # available for users who have Retail Search enabled. Contact Retail Support (
-        # retail-search-support@google.com) if you are interested in using Retail Search.
+        # available for users who have Retail Search enabled. Please submit a form [here]
+        # (https://cloud.google.com/contact) to contact cloud sales if you are
+        # interested in using Retail Search.
         # @param [String] catalog
         #   The parent catalog resource name, such as `projects/*/locations/global/
         #   catalogs/default_catalog`.
@@ -254,8 +257,8 @@ module Google
         # SearchService will only return product IDs from branch `newBranch` (if branch
         # is not explicitly set). * UserEventService will only join events with products
         # from branch `newBranch`. This feature is only available for users who have
-        # Retail Search enabled. Contact Retail Support (retail-search-support@google.
-        # com) if you are interested in using Retail Search.
+        # Retail Search enabled. Please submit a form [here](https://cloud.google.com/
+        # contact) to contact cloud sales if you are interested in using Retail Search.
         # @param [String] catalog
         #   Full resource name of the catalog, such as `projects/*/locations/global/
         #   catalogs/default_catalog`.
@@ -326,8 +329,9 @@ module Google
         # enqueued and processed downstream. As a consequence, when a response is
         # returned, the added place IDs are not immediately manifested in the Product
         # queried by GetProduct or ListProducts. This feature is only available for
-        # users who have Retail Search enabled. Contact Retail Support (retail-search-
-        # support@google.com) if you are interested in using Retail Search.
+        # users who have Retail Search enabled. Please submit a form [here](https://
+        # cloud.google.com/contact) to contact cloud sales if you are interested in
+        # using Retail Search.
         # @param [String] product
         #   Required. Full resource name of Product, such as `projects/*/locations/global/
         #   catalogs/default_catalog/branches/default_branch/products/some_product_id`. If
@@ -590,7 +594,6 @@ module Google
         # @param [String] name
         #   Immutable. Full resource name of the product, such as `projects/*/locations/
         #   global/catalogs/default_catalog/branches/default_branch/products/product_id`.
-        #   The branch ID must be "default_branch".
         # @param [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaProduct] google_cloud_retail_v2alpha_product_object
         # @param [Boolean] allow_missing
         #   If set to true, and the Product is not found, a new Product will be created.
@@ -638,8 +641,9 @@ module Google
         # enqueued and processed downstream. As a consequence, when a response is
         # returned, the removed place IDs are not immediately manifested in the Product
         # queried by GetProduct or ListProducts. This feature is only available for
-        # users who have Retail Search enabled. Contact Retail Support (retail-search-
-        # support@google.com) if you are interested in using Retail Search.
+        # users who have Retail Search enabled. Please submit a form [here](https://
+        # cloud.google.com/contact) to contact cloud sales if you are interested in
+        # using Retail Search.
         # @param [String] product
         #   Required. Full resource name of Product, such as `projects/*/locations/global/
         #   catalogs/default_catalog/branches/default_branch/products/some_product_id`. If
@@ -691,13 +695,12 @@ module Google
         # UpdateProductRequest.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. Contact Retail
-        # Support (retail-search-support@google.com) if you are interested in using
-        # Retail Search.
+        # is only available for users who have Retail Search enabled. Please submit a
+        # form [here](https://cloud.google.com/contact) to contact cloud sales if you
+        # are interested in using Retail Search.
         # @param [String] name
         #   Immutable. Full resource name of the product, such as `projects/*/locations/
         #   global/catalogs/default_catalog/branches/default_branch/products/product_id`.
-        #   The branch ID must be "default_branch".
         # @param [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSetInventoryRequest] google_cloud_retail_v2alpha_set_inventory_request_object
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
@@ -730,8 +733,9 @@ module Google
         
         # Bulk import of processed completion dataset. Request processing may be
         # synchronous. Partial updating is not supported. This feature is only available
-        # for users who have Retail Search enabled. Contact Retail Support (retail-
-        # search-support@google.com) if you are interested in using Retail Search.
+        # for users who have Retail Search enabled. Please submit a form [here](https://
+        # cloud.google.com/contact) to contact cloud sales if you are interested in
+        # using Retail Search.
         # @param [String] parent
         #   Required. The catalog which the suggestions dataset belongs to. Format: `
         #   projects/1234/locations/global/catalogs/default_catalog`.
@@ -882,8 +886,8 @@ module Google
         end
         
         # Performs a search. This feature is only available for users who have Retail
-        # Search enabled. Contact Retail Support (retail-search-support@google.com) if
-        # you are interested in using Retail Search.
+        # Search enabled. Please submit a form [here](https://cloud.google.com/contact)
+        # to contact cloud sales if you are interested in using Retail Search.
         # @param [String] placement
         #   Required. The resource name of the search engine placement, such as `projects/*
         #   /locations/global/catalogs/default_catalog/placements/default_search`. This

data/lib/google/apis/retail_v2alpha.rb

@@ -31,7 +31,7 @@ module Google
       # This is NOT the gem version.
       VERSION = 'V2alpha'
 
-      # See, edit, configure, and delete your Google Cloud Platform data
+      # See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account.
       AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-apis-retail_v2alpha
 version: !ruby/object:Gem::Version
-  version: 0.13.0
+  version: 0.17.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-07-26 00:00:00.000000000 Z
+date: 2021-10-11 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/master/generated/google-apis-retail_v2alpha/CHANGELOG.md
-  documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2alpha/v0.13.0
+  documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2alpha/v0.17.0
   source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/master/generated/google-apis-retail_v2alpha
 post_install_message: 
 rdoc_options: []