google-apis-retail_v2alpha 0.53.0 → 0.56.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 21b93df1e143e62ad68aaf507f3bd12656e2a5db1f4cc5a9fda9ee3e03cc2bb7
-  data.tar.gz: 809c137f35f36feae0a9e988caa7518399a4aa5bfe9009dab87c78a1a6babdb4
+  metadata.gz: 2b33836f3cf94e3635a5712ad26790d064c21e3665984409172e76ae3bb1c8c5
+  data.tar.gz: 745fc296d29777018c245ab31f2fec87f4e14e8dfeb56b419de6a033083f642a
 SHA512:
-  metadata.gz: d513e46213cdc51515262aaf664e9319d97ad4cdd49fb3afd517572138f2559a6428c2e2eb13ca1b6d9b12a88fbf1037d0df81264d5005a1b22c6f8c5998d476
-  data.tar.gz: 5ae30acff83cfd78f4b6eb545e75ae0867c50e08db663dffa294a7da0c5e46aa4342427a47cdc07aee12ab1680bf0a7770abaa8678362d4f11a39c39670fb2b0
+  metadata.gz: 1b778bc5f4d8bcf0046ff0cec27a9a5afe4f6fc7fb133299ebf2cc3a1a79c544a9a59cc363da0c40d2e813c7d8bbffc50279740f284dc4ca1c3a40037912205f
+  data.tar.gz: 869373e3bc1901c8ab126b15f82b63d471072021e5e3d0f525a95115471b8710186f62e67a7ed1d2495b5e506c09459b0317638782199a5ef70c426fea362d96

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Release history for google-apis-retail_v2alpha
 
+### v0.56.0 (2022-09-10)
+
+* Regenerated from discovery document revision 20220901
+
+### v0.55.0 (2022-08-31)
+
+* Regenerated from discovery document revision 20220825
+
+### v0.54.0 (2022-08-25)
+
+* Regenerated from discovery document revision 20220822
+
 ### v0.53.0 (2022-08-21)
 
 * Unspecified changes

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

@@ -531,7 +531,7 @@ module Google
         end
       end
       
-      # Metadata for RejoinUserEvents method.
+      # Metadata for `RejoinUserEvents` method.
       class GoogleCloudRetailV2RejoinUserEventsMetadata
         include Google::Apis::Core::Hashable
       
@@ -544,7 +544,7 @@ module Google
         end
       end
       
-      # Response message for RejoinUserEvents method.
+      # Response message for `RejoinUserEvents` method.
       class GoogleCloudRetailV2RejoinUserEventsResponse
         include Google::Apis::Core::Hashable
       
@@ -984,15 +984,15 @@ module Google
       class GoogleCloudRetailV2alphaBatchRemoveCatalogAttributesResponse
         include Google::Apis::Core::Hashable
       
-        # Catalog attributes that were deleted. Only attributes that are not in use by
-        # products can be deleted.
+        # Catalog attributes that were deleted. Only pre-loaded catalog attributes that
+        # are neither in use by products nor predefined can be deleted.
         # Corresponds to the JSON property `deletedCatalogAttributes`
         # @return [Array<String>]
         attr_accessor :deleted_catalog_attributes
       
-        # Catalog attributes that were reset. Attributes that are in use by products
-        # cannot be deleted, however their configuration properties will reset to
-        # default values upon removal request.
+        # Catalog attributes that were reset. Catalog attributes that are either in use
+        # by products or are predefined attributes cannot be deleted; however, their
+        # configuration properties will reset to default values upon removal request.
         # Corresponds to the JSON property `resetCatalogAttributes`
         # @return [Array<String>]
         attr_accessor :reset_catalog_attributes
@@ -1171,11 +1171,12 @@ module Google
         # Otherwise, this field is `False`. CatalogAttribute can be pre-loaded by using
         # CatalogService.AddCatalogAttribute, CatalogService.ImportCatalogAttributes, or
         # CatalogService.UpdateAttributesConfig APIs. This field is `False` for pre-
-        # loaded CatalogAttributes. Only pre-loaded CatalogAttributes that are neither
-        # in use by products nor predefined can be deleted. CatalogAttributes that are
-        # either in use by products or are predefined cannot be deleted; however, their
-        # configuration properties will reset to default values upon removal request.
-        # After catalog changes, it takes about 10 minutes for this field to update.
+        # loaded CatalogAttributes. Only pre-loaded catalog attributes that are neither
+        # in use by products nor predefined can be deleted. Catalog attributes that are
+        # either in use by products or are predefined attributes cannot be deleted;
+        # however, their configuration properties will reset to default values upon
+        # removal request. After catalog changes, it takes about 10 minutes for this
+        # field to update.
         # Corresponds to the JSON property `inUse`
         # @return [Boolean]
         attr_accessor :in_use
@@ -1562,8 +1563,8 @@ module Google
       
         # The value of the term to match on. Value cannot be empty. Value can have at
         # most 3 terms if specified as a partial match. Each space separated string is
-        # considered as one term. Example) "a b c" is 3 terms and allowed, " a b c d" is
-        # 4 terms and not allowed for partial match.
+        # considered as one term. For example, "a b c" is 3 terms and allowed, but " a b
+        # c d" is 4 terms and not allowed for a partial match.
         # Corresponds to the JSON property `value`
         # @return [String]
         attr_accessor :value
@@ -1605,14 +1606,14 @@ module Google
         end
       end
       
-      # Configures dynamic serving time metadata that is used to pre and post process
-      # search/recommendation model results.
+      # Configures dynamic metadata that can be linked to a ServingConfig and affect
+      # search or recommendation results at serving time.
       class GoogleCloudRetailV2alphaControl
         include Google::Apis::Core::Hashable
       
-        # Output only. List of serving configuration ids that that are associated with
-        # this control. Note the association is managed via the ServingConfig, this is
-        # an output only denormalizeed view. Assumed to be in the same catalog.
+        # Output only. List of serving configuration ids that are associated with this
+        # control in the same Catalog. Note the association is managed via the
+        # ServingConfig, this is an output only denormalized view.
         # Corresponds to the JSON property `associatedServingConfigIds`
         # @return [Array<String>]
         attr_accessor :associated_serving_config_ids
@@ -1636,13 +1637,21 @@ module Google
         attr_accessor :name
       
         # A rule is a condition-action pair * A condition defines when a rule is to be
-        # triggered. * An action specifies what occurs on that trigger. Currently only
-        # boost rules are supported. Currently only supported by the search endpoint.
+        # triggered. * An action specifies what occurs on that trigger. Currently rules
+        # only work for controls with SOLUTION_TYPE_SEARCH.
         # Corresponds to the JSON property `rule`
         # @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaRule]
         attr_accessor :rule
       
-        # Required. Immutable. The solution types that the serving config is used for.
+        # Specifies the use case for the control. Affects what condition fields can be
+        # set. Only settable by search controls. Will default to
+        # SEARCH_SOLUTION_USE_CASE_SEARCH if not specified. Currently only allow one
+        # search_solution_use_case per control.
+        # Corresponds to the JSON property `searchSolutionUseCase`
+        # @return [Array<String>]
+        attr_accessor :search_solution_use_case
+      
+        # Required. Immutable. The solution types that the control is used for.
         # Currently we support setting only one type of solution at creation time. Only `
         # SOLUTION_TYPE_SEARCH` value is supported at the moment. If no solution type is
         # provided at creation time, will default to SOLUTION_TYPE_SEARCH.
@@ -1661,6 +1670,7 @@ module Google
           @facet_spec = args[:facet_spec] if args.key?(:facet_spec)
           @name = args[:name] if args.key?(:name)
           @rule = args[:rule] if args.key?(:rule)
+          @search_solution_use_case = args[:search_solution_use_case] if args.key?(:search_solution_use_case)
           @solution_types = args[:solution_types] if args.key?(:solution_types)
         end
       end
@@ -1669,8 +1679,9 @@ module Google
       class GoogleCloudRetailV2alphaCreateModelMetadata
         include Google::Apis::Core::Hashable
       
-        # The resource name of the model that this create applies to. Format: projects/`
+        # The resource name of the model that this create applies to. Format: `projects/`
         # project_number`/locations/`location_id`/catalogs/`catalog_id`/models/`model_id`
+        # `
         # Corresponds to the JSON property `model`
         # @return [String]
         attr_accessor :model
@@ -1763,8 +1774,8 @@ module Google
         end
       end
       
-      # Metadata related to the progress of the Export operation. This will be
-      # returned by the google.longrunning.Operation.metadata field.
+      # Metadata related to the progress of the Export operation. This is returned by
+      # the google.longrunning.Operation.metadata field.
       class GoogleCloudRetailV2alphaExportMetadata
         include Google::Apis::Core::Hashable
       
@@ -2645,7 +2656,13 @@ module Google
         # ctr`, `cvr`, `revenue-per-order`. If not specified, we choose default based on
         # model type. Default depends on type of recommendation: `recommended-for-you` =>
         # `ctr` `others-you-may-like` => `ctr` `frequently-bought-together` => `
-        # revenue_per_order`
+        # revenue_per_order` This field together with optimization_objective describe
+        # model metadata to use to control model training and serving. See https://cloud.
+        # google.com/retail/docs/models for more details on what the model metadata
+        # control and which combination of parameters are valid. For invalid
+        # combinations of parameters (e.g. type = `frequently-bought-together` and
+        # optimization_objective = `ctr`), you receive an error 400 if you try to create/
+        # update a recommendation with this set of knobs.
         # Corresponds to the JSON property `optimizationObjective`
         # @return [String]
         attr_accessor :optimization_objective
@@ -2695,7 +2712,13 @@ module Google
         # Required. The type of model e.g. `home-page`. Currently supported values: `
         # recommended-for-you`, `others-you-may-like`, `frequently-bought-together`, `
         # page-optimization`, `similar-items`, `buy-it-again`, and `recently-viewed`(
-        # readonly value).
+        # readonly value). This field together with optimization_objective describe
+        # model metadata to use to control model training and serving. See https://cloud.
+        # google.com/retail/docs/models for more details on what the model metadata
+        # control and which combination of parameters are valid. For invalid
+        # combinations of parameters (e.g. type = `frequently-bought-together` and
+        # optimization_objective = `ctr`), you receive an error 400 if you try to create/
+        # update a recommendation with this set of knobs.
         # Corresponds to the JSON property `type`
         # @return [String]
         attr_accessor :type
@@ -3206,6 +3229,8 @@ module Google
         attr_accessor :available_quantity
       
         # The timestamp when this Product becomes available for SearchService.Search.
+        # Note that this is only applicable to Type.PRIMARY and Type.COLLECTION, and
+        # ignored for Type.VARIANT.
         # Corresponds to the JSON property `availableTime`
         # @return [String]
         attr_accessor :available_time
@@ -3223,11 +3248,11 @@ module Google
         # belonging to several parallel categories. Strongly recommended using the full
         # path for better search / recommendation quality. To represent full path of
         # category, use '>' sign to separate different hierarchies. If '>' is part of
-        # the category name, please replace it with other character(s). For example, if
-        # a shoes product belongs to both ["Shoes & Accessories" -> "Shoes"] and ["
-        # Sports & Fitness" -> "Athletic Clothing" -> "Shoes"], it could be represented
-        # as: "categories": [ "Shoes & Accessories > Shoes", "Sports & Fitness >
-        # Athletic Clothing > Shoes" ] Must be set for Type.PRIMARY Product otherwise an
+        # the category name, replace it with other character(s). For example, if a shoes
+        # product belongs to both ["Shoes & Accessories" -> "Shoes"] and ["Sports &
+        # Fitness" -> "Athletic Clothing" -> "Shoes"], it could be represented as: "
+        # categories": [ "Shoes & Accessories > Shoes", "Sports & Fitness > Athletic
+        # Clothing > Shoes" ] Must be set for Type.PRIMARY Product otherwise an
         # 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
@@ -3274,7 +3299,10 @@ module Google
         attr_accessor :description
       
         # The timestamp when this product becomes unavailable for SearchService.Search.
-        # If it is set, the Product is not available for SearchService.Search after
+        # Note that this is only applicable to Type.PRIMARY and Type.COLLECTION, and
+        # ignored for Type.VARIANT. In general, we suggest the users to delete the stale
+        # products explicitly, instead of using this field to determine staleness. 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. expire_time must be later than
         # available_time and publish_time, otherwise an INVALID_ARGUMENT error is thrown.
@@ -3335,6 +3363,14 @@ module Google
         # @return [String]
         attr_accessor :language_code
       
+        # Output only. A list of local inventories specific to different places. This is
+        # only available for users who have Retail Search enabled, and it can be managed
+        # by ProductService.AddLocalInventories and ProductService.
+        # RemoveLocalInventories APIs.
+        # Corresponds to the JSON property `localInventories`
+        # @return [Array<Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaLocalInventory>]
+        attr_accessor :local_inventories
+      
         # 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 200 characters. Otherwise, an INVALID_ARGUMENT error is returned.
@@ -3453,7 +3489,10 @@ module Google
         # @return [String]
         attr_accessor :title
       
-        # Input only. The TTL (time to live) of the product. If it is set, it must be a
+        # Input only. The TTL (time to live) of the product. Note that this is only
+        # applicable to Type.PRIMARY and Type.COLLECTION, and ignored for Type.VARIANT.
+        # In general, we suggest the users to delete the stale products explicitly,
+        # instead of using this field to determine staleness. If it is set, it must be a
         # non-negative value, and expire_time is set as current timestamp plus ttl. The
         # derived expire_time is returned in the output and ttl is left blank when
         # retrieving the Product. If it is set, the product is not available for
@@ -3513,6 +3552,7 @@ module Google
           @id = args[:id] if args.key?(:id)
           @images = args[:images] if args.key?(:images)
           @language_code = args[:language_code] if args.key?(:language_code)
+          @local_inventories = args[:local_inventories] if args.key?(:local_inventories)
           @materials = args[:materials] if args.key?(:materials)
           @name = args[:name] if args.key?(:name)
           @patterns = args[:patterns] if args.key?(:patterns)
@@ -3948,7 +3988,7 @@ module Google
         end
       end
       
-      # Metadata for RejoinUserEvents method.
+      # Metadata for `RejoinUserEvents` method.
       class GoogleCloudRetailV2alphaRejoinUserEventsMetadata
         include Google::Apis::Core::Hashable
       
@@ -3966,8 +4006,8 @@ module Google
         include Google::Apis::Core::Hashable
       
         # The type of the user event rejoin to define the scope and range of the user
-        # events to be rejoined with the latest product catalog. Defaults to
-        # USER_EVENT_REJOIN_SCOPE_UNSPECIFIED if this field is not set, or set to an
+        # events to be rejoined with the latest product catalog. Defaults to `
+        # USER_EVENT_REJOIN_SCOPE_UNSPECIFIED` if this field is not set, or set to an
         # invalid integer value.
         # Corresponds to the JSON property `userEventRejoinScope`
         # @return [String]
@@ -3983,7 +4023,7 @@ module Google
         end
       end
       
-      # Response message for RejoinUserEvents method.
+      # Response message for `RejoinUserEvents` method.
       class GoogleCloudRetailV2alphaRejoinUserEventsResponse
         include Google::Apis::Core::Hashable
       
@@ -4235,8 +4275,8 @@ module Google
       end
       
       # A rule is a condition-action pair * A condition defines when a rule is to be
-      # triggered. * An action specifies what occurs on that trigger. Currently only
-      # boost rules are supported. Currently only supported by the search endpoint.
+      # triggered. * An action specifies what occurs on that trigger. Currently rules
+      # only work for controls with SOLUTION_TYPE_SEARCH.
       class GoogleCloudRetailV2alphaRule
         include Google::Apis::Core::Hashable
       
@@ -4645,9 +4685,9 @@ module Google
         # navigation queries to achieve good search quality. The format should be the
         # same as UserEvent.page_categories; To represent full path of category, use '>'
         # sign to separate different hierarchies. If '>' is part of the category name,
-        # please replace it with other character(s). Category pages include special
-        # pages such as sales or promotions. For instance, a special sale page may have
-        # the category hierarchy: "pageCategories" : ["Sales > 2017 Black Friday Deals"].
+        # replace it with other character(s). Category pages include special pages such
+        # as sales or promotions. For instance, a special sale page may have the
+        # category hierarchy: "pageCategories" : ["Sales > 2017 Black Friday Deals"].
         # Corresponds to the JSON property `pageCategories`
         # @return [Array<String>]
         attr_accessor :page_categories
@@ -5382,9 +5422,7 @@ module Google
       end
       
       # Configures metadata that is used to generate serving time results (e.g. search
-      # results or recommendation predictions). The ServingConfig is passed in the
-      # search and predict request and together with the Catalog.default_branch,
-      # generates results.
+      # results or recommendation predictions).
       class GoogleCloudRetailV2alphaServingConfig
         include Google::Apis::Core::Hashable
       
@@ -5407,16 +5445,21 @@ module Google
         # @return [String]
         attr_accessor :display_name
       
-        # How much diversity to use in recommendation model results e.g. 'medium-
-        # diversity' or 'high-diversity'. Currently supported values: * 'no-diversity' *
-        # 'low-diversity' * 'medium-diversity' * 'high-diversity' * 'auto-diversity' If
+        # How much diversity to use in recommendation model results e.g. `medium-
+        # diversity` or `high-diversity`. Currently supported values: * `no-diversity` *
+        # `low-diversity` * `medium-diversity` * `high-diversity` * `auto-diversity` If
         # not specified, we choose default based on recommendation model type. Default
-        # value: 'no-diversity'. Can only be set if solution_types is
+        # value: `no-diversity`. Can only be set if solution_types is
         # SOLUTION_TYPE_RECOMMENDATION.
         # Corresponds to the JSON property `diversityLevel`
         # @return [String]
         attr_accessor :diversity_level
       
+        # What kind of diversity to use - data driven or rule based.
+        # Corresponds to the JSON property `diversityType`
+        # @return [String]
+        attr_accessor :diversity_type
+      
         # Condition do not associate specifications. If multiple do not associate
         # conditions match, all matching do not associate controls in the list will
         # execute. - Order does not matter. - Maximum number of specifications is 100.
@@ -5430,10 +5473,10 @@ module Google
         # @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchRequestDynamicFacetSpec]
         attr_accessor :dynamic_facet_spec
       
-        # Whether to add additional category filters on the 'similar-items' model. If
-        # not specified, we enable it by default. Allowed values are: * 'no-category-
-        # match': No additional filtering of original results from the model and the
-        # customer's filters. * 'relaxed-category-match': Only keep results with
+        # Whether to add additional category filters on the `similar-items` model. If
+        # not specified, we enable it by default. Allowed values are: * `no-category-
+        # match`: No additional filtering of original results from the model and the
+        # customer's filters. * `relaxed-category-match`: Only keep results with
         # categories that match at least one item categories in the PredictRequests's
         # context item. * If customer also sends filters in the PredictRequest, then the
         # results will satisfy both conditions (user given and category match). Can only
@@ -5467,7 +5510,7 @@ module Google
         # @return [Array<String>]
         attr_accessor :ignore_control_ids
       
-        # The id of the model to use at serving time. Currently only
+        # The id of the model in the same Catalog to use at serving time. Currently only
         # RecommendationModels are supported: https://cloud.google.com/retail/
         # recommendations-ai/docs/create-models Can be changed but only to a compatible
         # model (e.g. others-you-may-like CTR to others-you-may-like CVR). Required when
@@ -5491,13 +5534,18 @@ module Google
         # @return [Array<String>]
         attr_accessor :oneway_synonyms_control_ids
       
+        # The specification for personalization.
+        # Corresponds to the JSON property `personalizationSpec`
+        # @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchRequestPersonalizationSpec]
+        attr_accessor :personalization_spec
+      
         # How much price ranking we want in serving results. Price reranking causes
         # product items with a similar recommendation probability to be ordered by price,
         # with the highest-priced items first. This setting could result in a decrease
-        # in click-through and conversion rates. Allowed values are: * 'no-price-
-        # reranking' * 'low-price-raranking' * 'medium-price-reranking' * 'high-price-
-        # reranking' If not specified, we choose default based on model type. Default
-        # value: 'no-price-reranking'. Can only be set if solution_types is
+        # in click-through and conversion rates. Allowed values are: * `no-price-
+        # reranking` * `low-price-raranking` * `medium-price-reranking` * `high-price-
+        # reranking` If not specified, we choose default based on model type. Default
+        # value: `no-price-reranking`. Can only be set if solution_types is
         # SOLUTION_TYPE_RECOMMENDATION.
         # Corresponds to the JSON property `priceRerankingLevel`
         # @return [String]
@@ -5541,6 +5589,7 @@ module Google
           @boost_control_ids = args[:boost_control_ids] if args.key?(:boost_control_ids)
           @display_name = args[:display_name] if args.key?(:display_name)
           @diversity_level = args[:diversity_level] if args.key?(:diversity_level)
+          @diversity_type = args[:diversity_type] if args.key?(:diversity_type)
           @do_not_associate_control_ids = args[:do_not_associate_control_ids] if args.key?(:do_not_associate_control_ids)
           @dynamic_facet_spec = args[:dynamic_facet_spec] if args.key?(:dynamic_facet_spec)
           @enable_category_filter_level = args[:enable_category_filter_level] if args.key?(:enable_category_filter_level)
@@ -5550,6 +5599,7 @@ module Google
           @model_id = args[:model_id] if args.key?(:model_id)
           @name = args[:name] if args.key?(:name)
           @oneway_synonyms_control_ids = args[:oneway_synonyms_control_ids] if args.key?(:oneway_synonyms_control_ids)
+          @personalization_spec = args[:personalization_spec] if args.key?(:personalization_spec)
           @price_reranking_level = args[:price_reranking_level] if args.key?(:price_reranking_level)
           @redirect_control_ids = args[:redirect_control_ids] if args.key?(:redirect_control_ids)
           @replacement_control_ids = args[:replacement_control_ids] if args.key?(:replacement_control_ids)
@@ -5702,8 +5752,9 @@ module Google
       class GoogleCloudRetailV2alphaTuneModelMetadata
         include Google::Apis::Core::Hashable
       
-        # The resource name of the model that this tune applies to. Format: projects/`
+        # The resource name of the model that this tune applies to. Format: `projects/`
         # project_number`/locations/`location_id`/catalogs/`catalog_id`/models/`model_id`
+        # `
         # Corresponds to the JSON property `model`
         # @return [String]
         attr_accessor :model
@@ -5853,12 +5904,12 @@ module Google
       
         # The categories associated with a category page. To represent full path of
         # category, use '>' sign to separate different hierarchies. If '>' is part of
-        # the category name, please replace it with other character(s). Category pages
-        # include special pages such as sales or promotions. For instance, a special
-        # sale page may have the category hierarchy: "pageCategories" : ["Sales > 2017
-        # Black Friday Deals"]. Required for `category-page-view` events. At least one
-        # of search_query or page_categories is required for `search` events. Other
-        # event types should not set this field. Otherwise, an INVALID_ARGUMENT error is
+        # the category name, replace it with other character(s). Category pages include
+        # special pages such as sales or promotions. For instance, a special sale page
+        # may have the category hierarchy: "pageCategories" : ["Sales > 2017 Black
+        # Friday Deals"]. Required for `category-page-view` events. At least one of
+        # search_query or page_categories is required for `search` events. Other event
+        # types should not set this field. Otherwise, an INVALID_ARGUMENT error is
         # returned.
         # Corresponds to the JSON property `pageCategories`
         # @return [Array<String>]
@@ -6213,8 +6264,8 @@ module Google
         end
       end
       
-      # Metadata related to the progress of the Export operation. This will be
-      # returned by the google.longrunning.Operation.metadata field.
+      # Metadata related to the progress of the Export operation. This is returned by
+      # the google.longrunning.Operation.metadata field.
       class GoogleCloudRetailV2betaExportMetadata
         include Google::Apis::Core::Hashable
       
@@ -6517,7 +6568,7 @@ module Google
         end
       end
       
-      # Metadata for RejoinUserEvents method.
+      # Metadata for `RejoinUserEvents` method.
       class GoogleCloudRetailV2betaRejoinUserEventsMetadata
         include Google::Apis::Core::Hashable
       
@@ -6530,7 +6581,7 @@ module Google
         end
       end
       
-      # Response message for RejoinUserEvents method.
+      # Response message for `RejoinUserEvents` method.
       class GoogleCloudRetailV2betaRejoinUserEventsResponse
         include Google::Apis::Core::Hashable
       

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.53.0"
+      GEM_VERSION = "0.56.0"
 
       # Version of the code generator used to generate this client
       GENERATOR_VERSION = "0.9.0"
 
       # Revision of the discovery document this client was generated from
-      REVISION = "20220811"
+      REVISION = "20220901"
     end
   end
 end

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

@@ -1610,6 +1610,7 @@ module Google
           property :name, as: 'name'
           property :rule, as: 'rule', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaRule, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaRule::Representation
       
+          collection :search_solution_use_case, as: 'searchSolutionUseCase'
           collection :solution_types, as: 'solutionTypes'
         end
       end
@@ -2030,6 +2031,8 @@ module Google
           collection :images, as: 'images', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaImage, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaImage::Representation
       
           property :language_code, as: 'languageCode'
+          collection :local_inventories, as: 'localInventories', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaLocalInventory, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaLocalInventory::Representation
+      
           collection :materials, as: 'materials'
           property :name, as: 'name'
           collection :patterns, as: 'patterns'
@@ -2519,6 +2522,7 @@ module Google
           collection :boost_control_ids, as: 'boostControlIds'
           property :display_name, as: 'displayName'
           property :diversity_level, as: 'diversityLevel'
+          property :diversity_type, as: 'diversityType'
           collection :do_not_associate_control_ids, as: 'doNotAssociateControlIds'
           property :dynamic_facet_spec, as: 'dynamicFacetSpec', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchRequestDynamicFacetSpec, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchRequestDynamicFacetSpec::Representation
       
@@ -2529,6 +2533,8 @@ module Google
           property :model_id, as: 'modelId'
           property :name, as: 'name'
           collection :oneway_synonyms_control_ids, as: 'onewaySynonymsControlIds'
+          property :personalization_spec, as: 'personalizationSpec', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchRequestPersonalizationSpec, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchRequestPersonalizationSpec::Representation
+      
           property :price_reranking_level, as: 'priceRerankingLevel'
           collection :redirect_control_ids, as: 'redirectControlIds'
           collection :replacement_control_ids, as: 'replacementControlIds'

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

@@ -52,8 +52,8 @@ module Google
         end
         
         # Completes the specified prefix with keyword suggestions. This feature is only
-        # available for users who have Retail Search enabled. Please enable Retail
-        # Search on Cloud Console before using this feature.
+        # available for users who have Retail Search enabled. Enable Retail Search on
+        # Cloud Console before using this feature.
         # @param [String] catalog
         #   Required. Catalog for which the completion is performed. Full resource name of
         #   catalog, such as `projects/*/locations/global/catalogs/default_catalog`.
@@ -159,8 +159,8 @@ module Google
         
         # Gets a CompletionConfig.
         # @param [String] name
-        #   Required. Full CompletionConfig resource name. Format: projects/`
-        #   project_number`/locations/`location_id`/catalogs/`catalog_id`/completionConfig
+        #   Required. Full CompletionConfig resource name. Format: `projects/`
+        #   project_number`/locations/`location_id`/catalogs/`catalog_id`/completionConfig`
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
         # @param [String] quota_user
@@ -609,6 +609,37 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
+        # Gets the latest state of a long-running operation. Clients can use this method
+        # to poll the operation result at intervals as recommended by the API service.
+        # @param [String] name
+        #   The name of the operation resource.
+        # @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 get_project_location_catalog_branch_place_operation(name, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:get, 'v2alpha/{+name}', options)
+          command.response_representation = Google::Apis::RetailV2alpha::GoogleLongrunningOperation::Representation
+          command.response_class = Google::Apis::RetailV2alpha::GoogleLongrunningOperation
+          command.params['name'] = name unless name.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
         # Incrementally adds place IDs to Product.fulfillment_info.place_ids. This
         # process is asynchronous and does not require the Product to exist before
         # updating fulfillment information. If the request is valid, the update will be
@@ -619,8 +650,7 @@ module Google
         # return NOT_FOUND afterwards. If conflicting updates are issued, the Operations
         # associated with the stale updates will not be marked as done until being
         # obsolete. This feature is only available for users who have Retail Search
-        # enabled. Please enable Retail Search on Cloud Console before using this
-        # feature.
+        # enabled. Enable Retail Search on Cloud Console before using this feature.
         # @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
@@ -669,8 +699,8 @@ module Google
         # GetOperation API will return NOT_FOUND afterwards. If conflicting updates are
         # issued, the Operations associated with the stale updates will not be marked as
         # done until being obsolete. This feature is only available for users who have
-        # Retail Search enabled. Please enable Retail Search on Cloud Console before
-        # using this feature.
+        # Retail Search enabled. Enable Retail Search on Cloud Console before using this
+        # feature.
         # @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
@@ -1028,8 +1058,7 @@ module Google
         # return NOT_FOUND afterwards. If conflicting updates are issued, the Operations
         # associated with the stale updates will not be marked as done until being
         # obsolete. This feature is only available for users who have Retail Search
-        # enabled. Please enable Retail Search on Cloud Console before using this
-        # feature.
+        # enabled. Enable Retail Search on Cloud Console before using this feature.
         # @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
@@ -1076,8 +1105,8 @@ module Google
         # GetOperation API will return NOT_FOUND afterwards. If conflicting updates are
         # issued, the Operations associated with the stale updates will not be marked as
         # done until being obsolete. This feature is only available for users who have
-        # Retail Search enabled. Please enable Retail Search on Cloud Console before
-        # using this feature.
+        # Retail Search enabled. Enable Retail Search on Cloud Console before using this
+        # feature.
         # @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
@@ -1116,26 +1145,26 @@ module Google
         # Updates inventory information for a Product while respecting the last update
         # timestamps of each inventory field. This process is asynchronous and does not
         # require the Product to exist before updating fulfillment information. If the
-        # request is valid, the update will be enqueued and processed downstream. As a
+        # request is valid, the update is enqueued and processed downstream. As a
         # consequence, when a response is returned, updates are not immediately
         # manifested in the Product queried by ProductService.GetProduct or
         # ProductService.ListProducts. When inventory is updated with ProductService.
         # CreateProduct and ProductService.UpdateProduct, the specified inventory field
-        # value(s) will overwrite any existing value(s) while ignoring the last update
-        # time for this field. Furthermore, the last update time for the specified
-        # inventory fields will be overwritten to the time of the ProductService.
-        # CreateProduct or ProductService.UpdateProduct request. If no inventory fields
-        # are set in CreateProductRequest.product, then any pre-existing inventory
-        # information for this product will be used. If no inventory fields are set in
-        # SetInventoryRequest.set_mask, then any existing inventory information will be
-        # preserved. Pre-existing inventory information can only be updated with
-        # ProductService.SetInventory, ProductService.AddFulfillmentPlaces, and
-        # ProductService.RemoveFulfillmentPlaces. The returned Operations will be
-        # obsolete after 1 day, and GetOperation API will return NOT_FOUND afterwards.
-        # If conflicting updates are issued, the Operations associated with the stale
-        # updates will not be marked as done until being obsolete. This feature is only
-        # available for users who have Retail Search enabled. Please enable Retail
-        # Search on Cloud Console before using this feature.
+        # value(s) overwrite any existing value(s) while ignoring the last update time
+        # for this field. Furthermore, the last update times for the specified inventory
+        # fields are overwritten by the times of the ProductService.CreateProduct or
+        # ProductService.UpdateProduct request. If no inventory fields are set in
+        # CreateProductRequest.product, then any pre-existing inventory information for
+        # this product is used. If no inventory fields are set in SetInventoryRequest.
+        # set_mask, then any existing inventory information is preserved. Pre-existing
+        # inventory information can only be updated with ProductService.SetInventory,
+        # ProductService.AddFulfillmentPlaces, and ProductService.
+        # RemoveFulfillmentPlaces. The returned Operations is obsolete after one day,
+        # and the GetOperation API returns `NOT_FOUND` afterwards. If conflicting
+        # updates are issued, the Operations associated with the stale updates are not
+        # marked as done until they are obsolete. This feature is only available for
+        # users who have Retail Search enabled. Enable Retail Search on Cloud Console
+        # before using this feature.
         # @param [String] name
         #   Immutable. Full resource name of the product, such as `projects/*/locations/
         #   global/catalogs/default_catalog/branches/default_branch/products/product_id`.
@@ -1173,8 +1202,8 @@ module Google
         # asynchronous. Partial updating is not supported. The operation is successfully
         # finished only after the imported suggestions are indexed successfully and
         # ready for serving. The process takes hours. This feature is only available for
-        # users who have Retail Search enabled. Please enable Retail Search on Cloud
-        # Console before using this feature.
+        # users who have Retail Search enabled. Enable Retail Search on Cloud Console
+        # before using this feature.
         # @param [String] parent
         #   Required. The catalog which the suggestions dataset belongs to. Format: `
         #   projects/1234/locations/global/catalogs/default_catalog`.
@@ -1283,7 +1312,7 @@ module Google
         
         # Gets a Control.
         # @param [String] name
-        #   Required. The resource name of the Control to delete. Format: `projects/`
+        #   Required. The resource name of the Control to get. Format: `projects/`
         #   project_number`/locations/`location_id`/catalogs/`catalog_id`/controls/`
         #   control_id``
         # @param [String] fields
@@ -1313,7 +1342,7 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
-        # Lists all Controls linked to this catalog.
+        # Lists all Controls by their parent Catalog.
         # @param [String] parent
         #   Required. The catalog resource name. Format: `projects/`project_number`/
         #   locations/`location_id`/catalogs/`catalog_id``
@@ -1359,7 +1388,7 @@ module Google
         end
         
         # Updates a Control. Control cannot be set to a different oneof field, if so an
-        # INVALID_ARGUMENT is returned. If the Control to delete does not exist, a
+        # INVALID_ARGUMENT is returned. If the Control to update does not exist, a
         # NOT_FOUND error is returned.
         # @param [String] name
         #   Immutable. Fully qualified name `projects/*/locations/global/catalogs/*/
@@ -1401,8 +1430,8 @@ module Google
         
         # Creates a new model.
         # @param [String] parent
-        #   Required. The parent resource under which to create the model. Format:
-        #   projects/`project_number`/locations/`location_id`/catalogs/`catalog_id`
+        #   Required. The parent resource under which to create the model. Format: `
+        #   projects/`project_number`/locations/`location_id`/catalogs/`catalog_id``
         # @param [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaModel] google_cloud_retail_v2alpha_model_object
         # @param [Boolean] dry_run
         #   Optional. Whether to run a dry run to validate the request (without actually
@@ -1439,8 +1468,9 @@ module Google
         
         # Deletes an existing model.
         # @param [String] name
-        #   Required. The resource name of the Model to delete. Format: projects/`
+        #   Required. The resource name of the Model to delete. Format: `projects/`
         #   project_number`/locations/`location_id`/catalogs/`catalog_id`/models/`model_id`
+        #   `
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
         # @param [String] quota_user
@@ -1470,8 +1500,8 @@ module Google
         
         # Lists all the models linked to this event store.
         # @param [String] parent
-        #   Required. The parent for which to list models. Format: projects/`
-        #   project_number`/locations/`location_id`/catalogs/`catalog_id`
+        #   Required. The parent for which to list models. Format: `projects/`
+        #   project_number`/locations/`location_id`/catalogs/`catalog_id``
         # @param [Fixnum] page_size
         #   Optional. Maximum number of results to return. If unspecified, defaults to 50.
         #   Max allowed value is 1000.
@@ -1551,8 +1581,8 @@ module Google
         
         # Pauses the training of an existing model.
         # @param [String] name
-        #   Required. The name of the model to pause. Format: projects/`project_number`/
-        #   locations/`location_id`/catalogs/`catalog_id`/models/`model_id`
+        #   Required. The name of the model to pause. Format: `projects/`project_number`/
+        #   locations/`location_id`/catalogs/`catalog_id`/models/`model_id``
         # @param [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaPauseModelRequest] google_cloud_retail_v2alpha_pause_model_request_object
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
@@ -1585,8 +1615,8 @@ module Google
         
         # Resumes the training of an existing model.
         # @param [String] name
-        #   Required. The name of the model to resume. Format: projects/`project_number`/
-        #   locations/`location_id`/catalogs/`catalog_id`/models/`model_id`
+        #   Required. The name of the model to resume. Format: `projects/`project_number`/
+        #   locations/`location_id`/catalogs/`catalog_id`/models/`model_id``
         # @param [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaResumeModelRequest] google_cloud_retail_v2alpha_resume_model_request_object
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
@@ -1619,8 +1649,9 @@ module Google
         
         # Tunes an existing model.
         # @param [String] name
-        #   Required. The resource name of the model to tune. Format: projects/`
+        #   Required. The resource name of the model to tune. Format: `projects/`
         #   project_number`/locations/`location_id`/catalogs/`catalog_id`/models/`model_id`
+        #   `
         # @param [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaTuneModelRequest] google_cloud_retail_v2alpha_tune_model_request_object
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
@@ -1771,7 +1802,7 @@ module Google
         end
         
         # Performs a search. This feature is only available for users who have Retail
-        # Search enabled. Please enable Retail Search on Cloud Console before using this
+        # Search enabled. Enable Retail Search on Cloud Console before using this
         # feature.
         # @param [String] placement
         #   Required. The resource name of the Retail Search serving config, such as `
@@ -1817,9 +1848,9 @@ module Google
         # Returns a FAILED_PRECONDITION error if the addition could exceed maximum
         # number of control allowed for that type of control.
         # @param [String] serving_config
-        #   Required. The source ServingConfig resource name . Format: projects/`
+        #   Required. The source ServingConfig resource name . Format: `projects/`
         #   project_number`/locations/`location_id`/catalogs/`catalog_id`/servingConfigs/`
-        #   serving_config_id`
+        #   serving_config_id``
         # @param [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaAddControlRequest] google_cloud_retail_v2alpha_add_control_request_object
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
@@ -1893,9 +1924,9 @@ module Google
         # Deletes a ServingConfig. Returns a NotFound error if the ServingConfig does
         # not exist.
         # @param [String] name
-        #   Required. The resource name of the ServingConfig to delete. Format: projects/`
+        #   Required. The resource name of the ServingConfig to delete. Format: `projects/`
         #   project_number`/locations/`location_id`/catalogs/`catalog_id`/servingConfigs/`
-        #   serving_config_id`
+        #   serving_config_id``
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
         # @param [String] quota_user
@@ -1926,9 +1957,9 @@ module Google
         # Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not
         # exist.
         # @param [String] name
-        #   Required. The resource name of the ServingConfig to get. Format: projects/`
+        #   Required. The resource name of the ServingConfig to get. Format: `projects/`
         #   project_number`/locations/`location_id`/catalogs/`catalog_id`/servingConfigs/`
-        #   serving_config_id`
+        #   serving_config_id``
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
         # @param [String] quota_user
@@ -1958,8 +1989,8 @@ module Google
         
         # Lists all ServingConfigs linked to this catalog.
         # @param [String] parent
-        #   Required. The catalog resource name. Format: projects/`project_number`/
-        #   locations/`location_id`/catalogs/`catalog_id`
+        #   Required. The catalog resource name. Format: `projects/`project_number`/
+        #   locations/`location_id`/catalogs/`catalog_id``
         # @param [Fixnum] page_size
         #   Optional. Maximum number of results to return. If unspecified, defaults to 100.
         #   If a value greater than 100 is provided, at most 100 results are returned.
@@ -2080,9 +2111,9 @@ module Google
         # the ServingConfig. Returns a NOT_FOUND error if the Control is not enabled for
         # the ServingConfig.
         # @param [String] serving_config
-        #   Required. The source ServingConfig resource name . Format: projects/`
+        #   Required. The source ServingConfig resource name . Format: `projects/`
         #   project_number`/locations/`location_id`/catalogs/`catalog_id`/servingConfigs/`
-        #   serving_config_id`
+        #   serving_config_id``
         # @param [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaRemoveControlRequest] google_cloud_retail_v2alpha_remove_control_request_object
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
@@ -2114,7 +2145,7 @@ module Google
         end
         
         # Performs a search. This feature is only available for users who have Retail
-        # Search enabled. Please enable Retail Search on Cloud Console before using this
+        # Search enabled. Enable Retail Search on Cloud Console before using this
         # feature.
         # @param [String] placement
         #   Required. The resource name of the Retail Search serving config, such as `
@@ -2275,12 +2306,12 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
-        # Starts a user event rejoin operation with latest product catalog. Events will
-        # not be annotated with detailed product information if product is missing from
-        # the catalog at the time the user event is ingested, and these events are
-        # stored as unjoined events with a limited usage on training and serving. This
-        # method can be used to start a join operation on specified events with latest
-        # version of product catalog. It can also be used to correct events joined with
+        # Starts a user-event rejoin operation with latest product catalog. Events are
+        # not annotated with detailed product information for products that are missing
+        # from the catalog when the user event is ingested. These events are stored as
+        # unjoined events with limited usage on training and serving. You can use this
+        # method to start a join operation on specified events with the latest version
+        # of product catalog. You can also use this method to correct events joined with
         # the wrong product catalog. A rejoin operation can take hours or days to
         # complete.
         # @param [String] parent

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-apis-retail_v2alpha
 version: !ruby/object:Gem::Version
-  version: 0.53.0
+  version: 0.56.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-08-22 00:00:00.000000000 Z
+date: 2022-09-12 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.53.0
+  documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2alpha/v0.56.0
   source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-retail_v2alpha
 post_install_message: 
 rdoc_options: []