google-apis-retail_v2alpha 0.20.0 → 0.24.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 81b33fcc38ddd550c3692293c10d9414f0cc3300ae70e825bf0f8da79cfdad95
-  data.tar.gz: c2d1dc89671d11118cf25e8595a6e70ea7dc3ffd4770ec28c723d2cd2e6bac82
+  metadata.gz: c597c7c3e4e8d54b6452442b40588729d9483d8543b1ed8da020684648ac3b96
+  data.tar.gz: 71ebf0a020be508646193baa196cd38d7c0e2b872e54d597d31646c72fc39a96
 SHA512:
-  metadata.gz: 5cb84361796d3c4fcca698eea982de98929d9750d18f220d4d7ab8a15c41966c3052636dfc0dae02e3716373aa222a712a85ed3373e2878cb6cc253c95afee7d
-  data.tar.gz: 001feb988f31d678c1b4732fd7200bf327e3254286bfd1882c27b89d7c447f0de664653c524a302aea8cfd7f5859f56fd20ebd1c341e847914320f1f90786948
+  metadata.gz: 35822cb95f7f558f0592e0a460648a2be658a4ff665247ebf7d5ae5e6edba422b931ebd1f87cf15d14b9e6efeb235690d4dff534049d451fb01b8cf012168c4a
+  data.tar.gz: 86bce977dc3a4b458fefd9e8ae6c06ac59464f9a581caf7f923896ee948cf25ff703897460bdc173350d15c534b87ff9a3ae8d8c7aa9636921359afe986f1f21

data/CHANGELOG.md

@@ -1,5 +1,21 @@
 # Release history for google-apis-retail_v2alpha
 
+### v0.24.0 (2021-12-16)
+
+* Regenerated from discovery document revision 20211210
+
+### v0.23.0 (2021-12-09)
+
+* Regenerated from discovery document revision 20211203
+
+### v0.22.0 (2021-11-17)
+
+* Regenerated from discovery document revision 20211116
+
+### v0.21.0 (2021-11-10)
+
+* Regenerated from discovery document revision 20211104
+
 ### v0.20.0 (2021-11-03)
 
 * Regenerated from discovery document revision 20211028

data/OVERVIEW.md

@@ -51,7 +51,7 @@ require "google/apis/retail_v2alpha"
 client = Google::Apis::RetailV2alpha::CloudRetailService.new
 
 # Authenticate calls
-client.authentication = # ... use the googleauth gem to create credentials
+client.authorization = # ... use the googleauth gem to create credentials
 ```
 
 See the class reference docs for information on the methods you can call from a client.

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

@@ -743,15 +743,15 @@ module Google
       
         # If set to true, and the Product is not found, the local inventory 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.
+        # 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
         alias_method :allow_missing?, :allow_missing
       
         # Required. A list of inventory information at difference places. Each place is
-        # identified by its place ID. At most 1000 inventories are allowed per request.
+        # identified by its place ID. At most 3000 inventories are allowed per request.
         # Corresponds to the JSON property `localInventories`
         # @return [Array<Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaLocalInventory>]
         attr_accessor :local_inventories
@@ -1122,9 +1122,8 @@ module Google
         alias_method :indexable?, :indexable
       
         # The numerical values of this custom attribute. For example, `[2.3, 15.4]` when
-        # the key is "lengths_cm". At most 400 values are allowed.Otherwise, an
-        # INVALID_ARGUMENT error is returned. Exactly one of text or numbers should be
-        # set. Otherwise, an INVALID_ARGUMENT error is returned.
+        # the key is "lengths_cm". Exactly one of text or numbers should be set.
+        # Otherwise, an INVALID_ARGUMENT error is returned.
         # Corresponds to the JSON property `numbers`
         # @return [Array<Float>]
         attr_accessor :numbers
@@ -1138,11 +1137,8 @@ module Google
         alias_method :searchable?, :searchable
       
         # The textual values of this custom attribute. For example, `["yellow", "green"]`
-        # when the key is "color". 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. Otherwise, an INVALID_ARGUMENT error is returned. Exactly one of
-        # text or numbers should be set. Otherwise, an INVALID_ARGUMENT error is
-        # returned.
+        # when the key is "color". 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
@@ -1309,6 +1305,8 @@ module Google
         # recommendations-ai/docs/upload-catalog#mc). Supported values for user events
         # imports: * `user_event` (default): One JSON UserEvent per line. * `
         # user_event_ga360`: Using https://support.google.com/analytics/answer/3437719.
+        # Supported values for control imports: * 'control' (default): One JSON Control
+        # per line.
         # Corresponds to the JSON property `dataSchema`
         # @return [String]
         attr_accessor :data_schema
@@ -1777,12 +1775,15 @@ module Google
         include Google::Apis::Core::Hashable
       
         # Additional local inventory attributes, for example, store name, promotion tags,
-        # etc. * At most 5 values are allowed. Otherwise, an INVALID_ARGUMENT error is
-        # returned. * The key must be a UTF-8 encoded string with a length limit of 10
-        # 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 10 UTF-8 characters.
+        # etc. This field needs to pass all below criteria, otherwise an
+        # INVALID_ARGUMENT error is returned: * At most 30 attributes are allowed. * The
+        # 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.
         # Corresponds to the JSON property `attributes`
         # @return [Hash<String,Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCustomAttribute>]
         attr_accessor :attributes
@@ -1826,13 +1827,21 @@ 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] 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
       
+        # Language of the title/description and other string attributes. Use language
+        # tags defined by BCP 47. ISO 639-1. This specifies the language of offers in
+        # Merchant Center that will be accepted. If empty no language filtering will be
+        # performed.
+        # Corresponds to the JSON property `languageCode`
+        # @return [String]
+        attr_accessor :language_code
+      
         # Required. The linked [Merchant center account id](https://developers.google.
         # com/shopping-content/guides/accountstatuses). The account must be a standalone
         # account or a sub-account of a MCA.
@@ -1840,6 +1849,14 @@ module Google
         # @return [Fixnum]
         attr_accessor :merchant_center_account_id
       
+        # Region code of offers to accept. 2-letter Uppercase ISO 3166-1 alpha-2 code.
+        # List of values can be found here under the `region` tag. [https://www.iana.org/
+        # assignments/language-subtag-registry/language-subtag-registry]. If left blank
+        # no region filtering will be performed. Ex. `US`.
+        # Corresponds to the JSON property `regionCode`
+        # @return [String]
+        attr_accessor :region_code
+      
         def initialize(**args)
            update!(**args)
         end
@@ -1848,7 +1865,9 @@ module Google
         def update!(**args)
           @branch_id = args[:branch_id] if args.key?(:branch_id)
           @destinations = args[:destinations] if args.key?(:destinations)
+          @language_code = args[:language_code] if args.key?(:language_code)
           @merchant_center_account_id = args[:merchant_center_account_id] if args.key?(:merchant_center_account_id)
+          @region_code = args[:region_code] if args.key?(:region_code)
         end
       end
       
@@ -2071,8 +2090,8 @@ module Google
         attr_accessor :original_price
       
         # Price of the product. Google Merchant Center property [price](https://support.
-        # google.com/merchants/answer/6324371). Schema.org property [Offer.
-        # priceSpecification](https://schema.org/priceSpecification).
+        # google.com/merchants/answer/6324371). Schema.org property [Offer.price](https:/
+        # /schema.org/price).
         # Corresponds to the JSON property `price`
         # @return [Float]
         attr_accessor :price
@@ -2160,7 +2179,10 @@ module Google
         # 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.
+        # `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.
         # Corresponds to the JSON property `attributes`
         # @return [Hash<String,Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCustomAttribute>]
         attr_accessor :attributes
@@ -2171,9 +2193,9 @@ module Google
         attr_accessor :audience
       
         # The online availability of the Product. Default to Availability.IN_STOCK.
-        # Google Merchant Center Property [availability](https://support.google.com/
-        # merchants/answer/6324448). Schema.org Property [Offer.availability](https://
-        # schema.org/availability).
+        # Corresponding properties: Google Merchant Center property [availability](https:
+        # //support.google.com/merchants/answer/6324448). Schema.org property [Offer.
+        # availability](https://schema.org/availability).
         # Corresponds to the JSON property `availability`
         # @return [String]
         attr_accessor :availability
@@ -2190,9 +2212,9 @@ module Google
       
         # The brands of the product. A maximum of 30 brands are allowed. Each brand must
         # be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise,
-        # an INVALID_ARGUMENT error is returned. Google Merchant Center property [brand](
-        # https://support.google.com/merchants/answer/6324351). Schema.org property [
-        # Product.brand](https://schema.org/brand).
+        # an INVALID_ARGUMENT error is returned. Corresponding properties: Google
+        # Merchant Center property [brand](https://support.google.com/merchants/answer/
+        # 6324351). Schema.org property [Product.brand](https://schema.org/brand).
         # Corresponds to the JSON property `brands`
         # @return [Array<String>]
         attr_accessor :brands
@@ -2209,10 +2231,10 @@ module Google
         # INVALID_ARGUMENT error is returned. At most 250 values are allowed per Product.
         # Empty values are not allowed. Each value must be a UTF-8 encoded string with
         # a length limit of 5,000 characters. Otherwise, an INVALID_ARGUMENT error is
-        # returned. Google Merchant Center property google_product_category. Schema.org
-        # property [Product.category] (https://schema.org/category). [
-        # mc_google_product_category]: https://support.google.com/merchants/answer/
-        # 6324436
+        # returned. Corresponding properties: Google Merchant Center property
+        # google_product_category. Schema.org property [Product.category] (https://
+        # schema.org/category). [mc_google_product_category]: https://support.google.com/
+        # merchants/answer/6324436
         # Corresponds to the JSON property `categories`
         # @return [Array<String>]
         attr_accessor :categories
@@ -2232,19 +2254,19 @@ module Google
         # The condition of the product. Strongly encouraged to use the standard values: "
         # new", "refurbished", "used". A maximum of 5 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 [condition](https://support.google.com/merchants/answer/
-        # 6324469). Schema.org property [Offer.itemCondition](https://schema.org/
-        # itemCondition).
+        # characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding
+        # properties: Google Merchant Center property [condition](https://support.google.
+        # com/merchants/answer/6324469). Schema.org property [Offer.itemCondition](https:
+        # //schema.org/itemCondition).
         # Corresponds to the JSON property `conditions`
         # @return [Array<String>]
         attr_accessor :conditions
       
         # Product description. This field must be a UTF-8 encoded string with a length
         # limit of 5,000 characters. Otherwise, an INVALID_ARGUMENT error is returned.
-        # Google Merchant Center property [description](https://support.google.com/
-        # merchants/answer/6324468). schema.org property [Product.description](https://
-        # schema.org/description).
+        # Corresponding properties: Google Merchant Center property [description](https:/
+        # /support.google.com/merchants/answer/6324468). Schema.org property [Product.
+        # description](https://schema.org/description).
         # Corresponds to the JSON property `description`
         # @return [String]
         attr_accessor :description
@@ -2254,8 +2276,8 @@ module Google
         # expire_time. However, the product can still be retrieved by ProductService.
         # 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).
+        # Corresponding properties: 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
@@ -2270,12 +2292,13 @@ 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. 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](
-        # https://schema.org/gtin13) or [Product.gtin14](https://schema.org/gtin14). If
-        # the value is not a valid GTIN, an INVALID_ARGUMENT error is returned.
+        # an INVALID_ARGUMENT error is returned. Corresponding properties: Google
+        # Merchant Center property [gtin](https://support.google.com/merchants/answer/
+        # 6324461). Schema.org property [Product.isbn](https://schema.org/isbn), [
+        # Product.gtin8](https://schema.org/gtin8), [Product.gtin12](https://schema.org/
+        # gtin12), [Product.gtin13](https://schema.org/gtin13), or [Product.gtin14](
+        # https://schema.org/gtin14). If the value is not a valid GTIN, an
+        # INVALID_ARGUMENT error is returned.
         # Corresponds to the JSON property `gtin`
         # @return [String]
         attr_accessor :gtin
@@ -2284,27 +2307,28 @@ module Google
         # example, this field is "id_1", if name is `projects/*/locations/global/
         # catalogs/default_catalog/branches/default_branch/products/id_1`. 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 [id](https://support.google.com/merchants/answer/6324405). Schema.org
-        # Property [Product.sku](https://schema.org/sku).
+        # Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties:
+        # Google Merchant Center property [id](https://support.google.com/merchants/
+        # answer/6324405). Schema.org property [Product.sku](https://schema.org/sku).
         # Corresponds to the JSON property `id`
         # @return [String]
         attr_accessor :id
       
         # Product images for the product.Highly recommended to put the main image to the
-        # first. A maximum of 300 images are allowed. Google Merchant Center property [
-        # image_link](https://support.google.com/merchants/answer/6324350). Schema.org
-        # property [Product.image](https://schema.org/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).
         # Corresponds to the JSON property `images`
         # @return [Array<Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaImage>]
         attr_accessor :images
       
         # Language of the title/description and other string attributes. Use language
-        # tags defined by BCP 47. For product prediction, this field is ignored and the
-        # model automatically detects the text language. The Product can include text in
-        # different languages, but duplicating Products to provide text in multiple
-        # languages can result in degraded model performance. For product search this
-        # field is in use. It defaults to "en-US" if unset.
+        # tags defined by [BCP 47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). For
+        # product prediction, this field is ignored and the model automatically detects
+        # the text language. The Product can include text in different languages, but
+        # duplicating Products to provide text in multiple languages can result in
+        # degraded model performance. For product search this field is in use. It
+        # defaults to "en-US" if unset.
         # Corresponds to the JSON property `languageCode`
         # @return [String]
         attr_accessor :language_code
@@ -2312,9 +2336,9 @@ module Google
         # 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/
-        # merchants/answer/6324410). Schema.org property [Product.material](https://
-        # schema.org/material).
+        # Corresponding properties: Google Merchant Center property [material](https://
+        # support.google.com/merchants/answer/6324410). Schema.org property [Product.
+        # material](https://schema.org/material).
         # Corresponds to the JSON property `materials`
         # @return [Array<String>]
         attr_accessor :materials
@@ -2328,9 +2352,10 @@ module Google
         # The pattern or graphic print of the product. For example, "striped", "polka
         # 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).
-        # Schema.org property [Product.pattern](https://schema.org/pattern).
+        # Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties:
+        # Google Merchant Center property [pattern](https://support.google.com/merchants/
+        # answer/6324483). Schema.org property [Product.pattern](https://schema.org/
+        # pattern).
         # Corresponds to the JSON property `patterns`
         # @return [Array<String>]
         attr_accessor :patterns
@@ -2345,10 +2370,9 @@ module Google
         # can only be empty or set to the same value as id. For VARIANT Products, this
         # field cannot be empty. A maximum of 2,000 products are allowed to share the
         # same Type.PRIMARY Product. Otherwise, an INVALID_ARGUMENT error is returned.
-        # Google Merchant Center Property [item_group_id](https://support.google.com/
-        # merchants/answer/6324507). Schema.org Property [Product.inProductGroupWithID](
-        # https://schema.org/inProductGroupWithID). This field must be enabled before it
-        # can be used. [Learn more](/recommendations-ai/docs/catalog#item-group-id).
+        # Corresponding properties: Google Merchant Center property [item_group_id](
+        # https://support.google.com/merchants/answer/6324507). Schema.org property [
+        # Product.inProductGroupWithID](https://schema.org/inProductGroupWithID).
         # Corresponds to the JSON property `primaryProductId`
         # @return [String]
         attr_accessor :primary_product_id
@@ -2397,10 +2421,11 @@ module Google
         # system and size type are empty, while size value is "32 inches". 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 [size](https://support.google.com/
-        # merchants/answer/6324492), [size_type](https://support.google.com/merchants/
-        # answer/6324497) and [size_system](https://support.google.com/merchants/answer/
-        # 6324502). Schema.org property [Product.size](https://schema.org/size).
+        # returned. Corresponding properties: Google Merchant Center property [size](
+        # https://support.google.com/merchants/answer/6324492), [size_type](https://
+        # support.google.com/merchants/answer/6324497), and [size_system](https://
+        # support.google.com/merchants/answer/6324502). Schema.org property [Product.
+        # size](https://schema.org/size).
         # Corresponds to the JSON property `sizes`
         # @return [Array<String>]
         attr_accessor :sizes
@@ -2409,17 +2434,18 @@ module Google
         # Product. This value must be a UTF-8 encoded string with a length limit of 1,
         # 000 characters. Otherwise, an INVALID_ARGUMENT error is returned. This tag can
         # be used for filtering recommendation results by passing the tag as part of the
-        # PredictRequest.filter. Google Merchant Center property [custom_label_0–4](
-        # https://support.google.com/merchants/answer/6324473).
+        # PredictRequest.filter. Corresponding properties: Google Merchant Center
+        # property [custom_label_0–4](https://support.google.com/merchants/answer/
+        # 6324473).
         # Corresponds to the JSON property `tags`
         # @return [Array<String>]
         attr_accessor :tags
       
         # Required. Product title. This field must be a UTF-8 encoded string with a
         # length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is
-        # returned. Google Merchant Center property [title](https://support.google.com/
-        # merchants/answer/6324415). Schema.org property [Product.name](https://schema.
-        # org/name).
+        # returned. Corresponding properties: Google Merchant Center property [title](
+        # https://support.google.com/merchants/answer/6324415). Schema.org property [
+        # Product.name](https://schema.org/name).
         # Corresponds to the JSON property `title`
         # @return [String]
         attr_accessor :title
@@ -2445,9 +2471,9 @@ module Google
         # recommended to provide a valid uri for the product, otherwise the service
         # performance could be significantly degraded. This field must be a UTF-8
         # encoded string with a length limit of 5,000 characters. Otherwise, an
-        # INVALID_ARGUMENT error is returned. Google Merchant Center property [link](
-        # https://support.google.com/merchants/answer/6324416). Schema.org property [
-        # Offer.url](https://schema.org/url).
+        # INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant
+        # Center property [link](https://support.google.com/merchants/answer/6324416).
+        # Schema.org property [Offer.url](https://schema.org/url).
         # Corresponds to the JSON property `uri`
         # @return [String]
         attr_accessor :uri
@@ -2589,15 +2615,15 @@ module Google
         include Google::Apis::Core::Hashable
       
         # The type of Products allowed to be ingested into the catalog. Acceptable
-        # values are: * `primary` (default): You can only ingest Product.Type.PRIMARY
-        # Products. This means Product.primary_product_id can only be empty or set to
-        # the same value as Product.id. * `variant`: You can only ingest Product.Type.
-        # VARIANT Products. This means Product.primary_product_id cannot be empty. If
-        # this field is set to an invalid value other than these, an INVALID_ARGUMENT
-        # error is returned. If this field is `variant` and
-        # merchant_center_product_id_field is `itemGroupId`, an INVALID_ARGUMENT error
-        # is returned. See [Using product levels](https://cloud.google.com/retail/
-        # recommendations-ai/docs/catalog#product-levels) for more details.
+        # values are: * `primary` (default): You can ingest Products of all types. When
+        # ingesting a Product, its type will default to Product.Type.PRIMARY if unset. *
+        # `variant`: You can only ingest Product.Type.VARIANT Products. This means
+        # Product.primary_product_id cannot be empty. If this field is set to an invalid
+        # value other than these, an INVALID_ARGUMENT error is returned. If this field
+        # is `variant` and merchant_center_product_id_field is `itemGroupId`, an
+        # INVALID_ARGUMENT error is returned. See [Using product levels](https://cloud.
+        # google.com/retail/recommendations-ai/docs/catalog#product-levels) for more
+        # details.
         # Corresponds to the JSON property `ingestionProductType`
         # @return [String]
         attr_accessor :ingestion_product_type
@@ -2973,7 +2999,7 @@ module Google
         attr_accessor :allow_missing
         alias_method :allow_missing?, :allow_missing
       
-        # Required. A list of place IDs to have their inventory deleted. At most 1000
+        # Required. A list of place IDs to have their inventory deleted. At most 3000
         # place IDs are allowed per request.
         # Corresponds to the JSON property `placeIds`
         # @return [Array<String>]
@@ -3132,24 +3158,26 @@ module Google
         # @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaUserInfo]
         attr_accessor :user_info
       
-        # 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 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 * inventory(place_id,price) *
-        # 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". *
+        # The keys to fetch and rollup the matching variant Products attributes,
+        # FulfillmentInfo or LocalInventorys attributes. The attributes from all the
+        # matching variant Products or LocalInventorys are merged and de-duplicated.
+        # Notice that rollup attributes will lead to extra query latency. Maximum number
+        # of keys is 30. 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 * variantId * inventory(place_id,price) * inventory(place_id,
+        # original_price) * inventory(place_id,attributes.key), where key is any key in
+        # the Product.inventories.attributes map. * 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". *
@@ -3163,9 +3191,9 @@ module Google
         # Required. 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.
+        # visitor logs in or out of the website. This should be the same identifier as
+        # UserEvent.visitor_id. The field must be a UTF-8 encoded string with a length
+        # limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.
         # Corresponds to the JSON property `visitorId`
         # @return [String]
         attr_accessor :visitor_id
@@ -3368,9 +3396,10 @@ module Google
         # colors" * "sizes" * "materials" * "patterns" * "conditions" * "attributes.key"
         # * "pickupInStore" * "shipToStore" * "sameDayDelivery" * "nextDayDelivery" * "
         # customFulfillment1" * "customFulfillment2" * "customFulfillment3" * "
-        # customFulfillment4" * "customFulfillment5" * numerical_field = * "price" * "
-        # discount" * "rating" * "ratingCount" * "attributes.key" * "inventory(place_id,
-        # price)"
+        # customFulfillment4" * "customFulfillment5" * "inventory(place_id,attributes.
+        # key)" * numerical_field = * "price" * "discount" * "rating" * "ratingCount" * "
+        # attributes.key" * "inventory(place_id,price)" * "inventory(place_id,
+        # original_price)" * "inventory(place_id,attributes.key)"
         # Corresponds to the JSON property `key`
         # @return [String]
         attr_accessor :key
@@ -3469,6 +3498,12 @@ module Google
       class GoogleCloudRetailV2alphaSearchResponse
         include Google::Apis::Core::Hashable
       
+        # The fully qualified resource name of applied [controls](https://cloud.google.
+        # com/retail/docs/serving-control-rules).
+        # Corresponds to the JSON property `appliedControls`
+        # @return [Array<String>]
+        attr_accessor :applied_controls
+      
         # A unique search token. This should be included in the UserEvent logs resulting
         # from this search, which enables accurate attribution of search model
         # performance.
@@ -3523,6 +3558,7 @@ module Google
       
         # Update properties of this object
         def update!(**args)
+          @applied_controls = args[:applied_controls] if args.key?(:applied_controls)
           @attribution_token = args[:attribution_token] if args.key?(:attribution_token)
           @corrected_query = args[:corrected_query] if args.key?(:corrected_query)
           @facets = args[:facets] if args.key?(:facets)
@@ -3748,10 +3784,9 @@ module Google
         # @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaProduct]
         attr_accessor :inventory
       
-        # Indicates which inventory fields in the provided Product to update. If not set
-        # or set with empty paths, all inventory fields will be updated. If an
-        # unsupported or unknown field is provided, an INVALID_ARGUMENT error is
-        # returned and the entire update will be ignored.
+        # Indicates which inventory fields in the provided Product to update. At least
+        # one field must be provided. If an unsupported or unknown field is provided, an
+        # INVALID_ARGUMENT error is returned and the entire update will be ignored.
         # Corresponds to the JSON property `setMask`
         # @return [String]
         attr_accessor :set_mask
@@ -3790,17 +3825,90 @@ module Google
         end
       end
       
+      # Metadata related to the progress of the SetLocalInventories operation.
+      # Currently empty because there is no meaningful metadata populated from the
+      # SetLocalInventories method.
+      class GoogleCloudRetailV2alphaSetLocalInventoriesMetadata
+        include Google::Apis::Core::Hashable
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+        end
+      end
+      
+      # Request message for SetLocalInventories method.
+      class GoogleCloudRetailV2alphaSetLocalInventoriesRequest
+        include Google::Apis::Core::Hashable
+      
+        # If set to true, and the Product is not found, the local inventory will still
+        # be processed and retained for at most 1 day and processed once 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
+        alias_method :allow_missing?, :allow_missing
+      
+        # A list of inventory information at difference places. Each place is identified
+        # by its place ID. For example, if `place1` and `place2` are stored, and this
+        # list is `[place1, place3]` with a fresher set timestamp, then the stored
+        # places will become `place1` and `place3`. An empty list removes all existing
+        # places with staler fields. At most 3000 inventories are allowed per request.
+        # Corresponds to the JSON property `localInventories`
+        # @return [Array<Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaLocalInventory>]
+        attr_accessor :local_inventories
+      
+        # The time when the inventory updates are issued. Used to prevent out-of-order
+        # updates on local inventory fields. If not provided, the internal system time
+        # will be used.
+        # Corresponds to the JSON property `setTime`
+        # @return [String]
+        attr_accessor :set_time
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @allow_missing = args[:allow_missing] if args.key?(:allow_missing)
+          @local_inventories = args[:local_inventories] if args.key?(:local_inventories)
+          @set_time = args[:set_time] if args.key?(:set_time)
+        end
+      end
+      
+      # Response of the SetLocalInventories API. Currently empty because there is no
+      # meaningful response populated from the SetLocalInventories method.
+      class GoogleCloudRetailV2alphaSetLocalInventoriesResponse
+        include Google::Apis::Core::Hashable
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+        end
+      end
+      
       # UserEvent captures all metadata information Retail API needs to know about how
       # end users interact with customers' website.
       class GoogleCloudRetailV2alphaUserEvent
         include Google::Apis::Core::Hashable
       
-        # Extra user event features to include in the recommendation model. The key must
-        # be a UTF-8 encoded string with a length limit of 5,000 characters. Otherwise,
-        # an INVALID_ARGUMENT error is returned. 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. 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.
         # Corresponds to the JSON property `attributes`
         # @return [Hash<String,Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCustomAttribute>]
         attr_accessor :attributes
@@ -3842,12 +3950,11 @@ module Google
       
         # Required. User event type. Allowed values are: * `add-to-cart`: Products being
         # added to cart. * `category-page-view`: Special pages such as sale or promotion
-        # pages viewed. * `completion`: Completion query result showed/clicked. * `
-        # detail-page-view`: Products detail page viewed. * `home-page-view`: Homepage
-        # viewed. * `promotion-offered`: Promotion is offered to a user. * `promotion-
-        # not-offered`: Promotion is not offered to a user. * `purchase-complete`: User
-        # finishing a purchase. * `search`: Product search. * `shopping-cart-page-view`:
-        # User viewing a shopping cart.
+        # pages viewed. * `detail-page-view`: Products detail page viewed. * `home-page-
+        # view`: Homepage viewed. * `promotion-offered`: Promotion is offered to a user.
+        # * `promotion-not-offered`: Promotion is not offered to a user. * `purchase-
+        # complete`: User finishing a purchase. * `search`: Product search. * `shopping-
+        # cart-page-view`: User viewing a shopping cart.
         # Corresponds to the JSON property `eventType`
         # @return [String]
         attr_accessor :event_type

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.20.0"
+      GEM_VERSION = "0.24.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 = "20211028"
+      REVISION = "20211210"
     end
   end
 end

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

@@ -634,6 +634,24 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class GoogleCloudRetailV2alphaSetLocalInventoriesMetadata
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleCloudRetailV2alphaSetLocalInventoriesRequest
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleCloudRetailV2alphaSetLocalInventoriesResponse
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class GoogleCloudRetailV2alphaUserEvent
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -1338,7 +1356,9 @@ module Google
         class Representation < Google::Apis::Core::JsonRepresentation
           property :branch_id, as: 'branchId'
           collection :destinations, as: 'destinations'
+          property :language_code, as: 'languageCode'
           property :merchant_center_account_id, :numeric_string => true, as: 'merchantCenterAccountId'
+          property :region_code, as: 'regionCode'
         end
       end
       
@@ -1691,6 +1711,7 @@ module Google
       class GoogleCloudRetailV2alphaSearchResponse
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
+          collection :applied_controls, as: 'appliedControls'
           property :attribution_token, as: 'attributionToken'
           property :corrected_query, as: 'correctedQuery'
           collection :facets, as: 'facets', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchResponseFacet, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchResponseFacet::Representation
@@ -1776,6 +1797,28 @@ module Google
         end
       end
       
+      class GoogleCloudRetailV2alphaSetLocalInventoriesMetadata
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+        end
+      end
+      
+      class GoogleCloudRetailV2alphaSetLocalInventoriesRequest
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :allow_missing, as: 'allowMissing'
+          collection :local_inventories, as: 'localInventories', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaLocalInventory, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaLocalInventory::Representation
+      
+          property :set_time, as: 'setTime'
+        end
+      end
+      
+      class GoogleCloudRetailV2alphaSetLocalInventoriesResponse
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+        end
+      end
+      
       class GoogleCloudRetailV2alphaUserEvent
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation

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

@@ -373,7 +373,7 @@ module Google
         # inventory information. If the request is valid, the update will be enqueued
         # and processed downstream. As a consequence, when a response is returned,
         # updates are not immediately manifested in the Product queried by GetProduct or
-        # ListProducts. Store inventory information can only be modified using this
+        # ListProducts. Local inventory information can only be modified using this
         # method. CreateProduct and UpdateProduct has no effect on local inventories.
         # This feature is only available for users who have Retail Search enabled.
         # Please submit a form [here](https://cloud.google.com/contact) to contact Cloud
@@ -729,7 +729,7 @@ module Google
         # removal timestamp. This process is asynchronous. If the request is valid, the
         # removal will be enqueued and processed downstream. As a consequence, when a
         # response is returned, removals are not immediately manifested in the Product
-        # queried by GetProduct or ListProducts. Store inventory information can only be
+        # queried by GetProduct or ListProducts. Local inventory information can only be
         # removed using this method. CreateProduct and UpdateProduct has no effect on
         # local inventories. This feature is only available for users who have Retail
         # Search enabled. Please submit a form [here](https://cloud.google.com/contact)
@@ -821,6 +821,59 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
+        # Set local inventory information for a Product with the provided list of places
+        # at a set timestamp. If a place in the provided list does not exist, the place
+        # will be created. If a place in the provided list already exists, it will be
+        # updated while respecting the last update timestamps of each inventory field.
+        # If an existing place is not in the provided list, it will be removed. This
+        # process is asynchronous. If the request is valid, the set operation will be
+        # enqueued and processed downstream. As a consequence, when a response is
+        # returned, set operations are not immediately manifested in the Product queried
+        # by GetProduct or ListProducts. When applying the set operation, this process
+        # takes a snapshot of currently existing places and their corresponding
+        # timestamps to determine the places to update. Avoid concurrent
+        # AddLocalInventories and RemoveLocalInventories calls, since they can introduce
+        # asynchronous updates that could be missed by the set operation. Local
+        # inventory information can only be updated with this method and other local
+        # inventory-specific methods. CreateProduct and UpdateProduct has no effect on
+        # local inventories. This feature 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] product
+        #   Required. Full resource name of Product, such as `projects/*/locations/global/
+        #   catalogs/default_catalog/branches/default_branch/products/some_product_id`. If
+        #   the caller does not have permission to access the Product, regardless of
+        #   whether or not it exists, a PERMISSION_DENIED error is returned.
+        # @param [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSetLocalInventoriesRequest] google_cloud_retail_v2alpha_set_local_inventories_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 set_project_location_catalog_branch_product_local_inventories(product, google_cloud_retail_v2alpha_set_local_inventories_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:post, 'v2alpha/{+product}:setLocalInventories', options)
+          command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSetLocalInventoriesRequest::Representation
+          command.request_object = google_cloud_retail_v2alpha_set_local_inventories_request_object
+          command.response_representation = Google::Apis::RetailV2alpha::GoogleLongrunningOperation::Representation
+          command.response_class = Google::Apis::RetailV2alpha::GoogleLongrunningOperation
+          command.params['product'] = product unless product.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
         # 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. Please submit a form [here](https://

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-apis-retail_v2alpha
 version: !ruby/object:Gem::Version
-  version: 0.20.0
+  version: 0.24.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-11-08 00:00:00.000000000 Z
+date: 2022-01-10 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.20.0
+  documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2alpha/v0.24.0
   source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-retail_v2alpha
 post_install_message: 
 rdoc_options: []
@@ -75,7 +75,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.17
+rubygems_version: 3.3.4
 signing_key: 
 specification_version: 4
 summary: Simple REST client for Retail API V2alpha