google-apis-retail_v2alpha 0.62.0 → 0.64.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 91c2450428b993c1727730d9939d35b245490d3f03b21dd51b963deb3122d7b0
-  data.tar.gz: 0eb29571ed04ea1745d7add67dbcd05e92aa1adae528add992dd8ae3a379b35f
+  metadata.gz: 9e5a8a2b94813bb2357742dc85178052296ac328bb94c47bad434601bdcd6c80
+  data.tar.gz: 1631070e7fcf4c4ad4a02f7bcddadd9a28f8cb5b0f3cf2b694491df768594812
 SHA512:
-  metadata.gz: fc3b7da6b42f09e8055a75001beffd38b24d3b1d128309142c7698682b52406a276aea34dc874bd09d1dfaa047877afe31956d1c1f1c913dfe42f556844141f3
-  data.tar.gz: 44dc5fdc4cdcd3019e04462f7a1913217df91c984bb230e7036e59e90a6af4bec8abae35d323933c95898b7a4f09904674811b07d00e44f02690b9cec5c46f60
+  metadata.gz: 891fc0fd43e676611f2c635bebf69becc134eefd5ea2ba2e9284c674fbe2d08ac74ecc7f653bcde1a02ab3abd9748eee563cd877a45e36dc93f3d5dd2968a880
+  data.tar.gz: 9f13ab7aacab920efc78b6c554a2a319ac0e1089a84d0c115558c20aff82f3408497ab6f521354b37e5dad430a57d39e4bb4bcd1d10ebf17ed9162c8e5eb28ea

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Release history for google-apis-retail_v2alpha
 
+### v0.64.0 (2023-01-04)
+
+* Regenerated from discovery document revision 20230102
+
+### v0.63.0 (2022-12-05)
+
+* Regenerated from discovery document revision 20221130
+
 ### v0.62.0 (2022-11-09)
 
 * Regenerated from discovery document revision 20221107

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

@@ -1162,7 +1162,8 @@ module Google
       
         # If EXACT_SEARCHABLE_ENABLED, attribute values will be exact searchable. This
         # property only applies to textual custom attributes and requires indexable set
-        # to enabled to enable exact-searchable.
+        # to enabled to enable exact-searchable. If unset, the server behavior defaults
+        # to EXACT_SEARCHABLE_DISABLED.
         # Corresponds to the JSON property `exactSearchableOption`
         # @return [String]
         attr_accessor :exact_searchable_option
@@ -1195,7 +1196,9 @@ module Google
         # custom_attribute`, such as `attributes.xyz`. To be indexable, the attribute
         # name can contain only alpha-numeric characters and underscores. For example,
         # an attribute named `attributes.abc_xyz` can be indexed, but an attribute named
-        # `attributes.abc-xyz` cannot be indexed.
+        # `attributes.abc-xyz` cannot be indexed. For attributes whoes key start with `
+        # attributes.`, we refer them as custom attributes. Otherwise they are built-in
+        # attributes such as `color` and `brands`.
         # Corresponds to the JSON property `key`
         # @return [String]
         attr_accessor :key
@@ -1208,6 +1211,12 @@ module Google
         # @return [String]
         attr_accessor :recommendations_filtering_option
       
+        # If RETRIEVABLE_ENABLED, attribute values are retrievable in the search results.
+        # If unset, the server behavior defaults to RETRIEVABLE_DISABLED.
+        # Corresponds to the JSON property `retrievableOption`
+        # @return [String]
+        attr_accessor :retrievable_option
+      
         # When AttributesConfig.attribute_config_level is CATALOG_LEVEL_ATTRIBUTE_CONFIG,
         # if SEARCHABLE_ENABLED, attribute values are searchable by text queries in
         # SearchService.Search. If SEARCHABLE_ENABLED but attribute type is numerical,
@@ -1236,6 +1245,7 @@ module Google
           @indexable_option = args[:indexable_option] if args.key?(:indexable_option)
           @key = args[:key] if args.key?(:key)
           @recommendations_filtering_option = args[:recommendations_filtering_option] if args.key?(:recommendations_filtering_option)
+          @retrievable_option = args[:retrievable_option] if args.key?(:retrievable_option)
           @searchable_option = args[:searchable_option] if args.key?(:searchable_option)
           @type = args[:type] if args.key?(:type)
         end
@@ -1640,9 +1650,9 @@ module Google
       class GoogleCloudRetailV2alphaControl
         include Google::Apis::Core::Hashable
       
-        # 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.
+        # Output only. List of serving config 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
@@ -2752,8 +2762,8 @@ module Google
         attr_accessor :optimization_objective
       
         # The PageOptimizationConfig for model training. This determines how many panels
-        # to optimize for, and which serving configurations to consider for each panel.
-        # The purpose of this model is to optimize which ServingConfig to show on which
+        # to optimize for, and which serving configs to consider for each panel. The
+        # purpose of this model is to optimize which ServingConfig to show on which
         # panels in way that optimizes the visitors shopping journey.
         # Corresponds to the JSON property `pageOptimizationConfig`
         # @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaModelPageOptimizationConfig]
@@ -2795,14 +2805,14 @@ 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). 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.
+        # page-optimization`, `similar-items`, `buy-it-again`, `on-sale-items`, and `
+        # recently-viewed`(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
@@ -2839,8 +2849,8 @@ module Google
       end
       
       # The PageOptimizationConfig for model training. This determines how many panels
-      # to optimize for, and which serving configurations to consider for each panel.
-      # The purpose of this model is to optimize which ServingConfig to show on which
+      # to optimize for, and which serving configs to consider for each panel. The
+      # purpose of this model is to optimize which ServingConfig to show on which
       # panels in way that optimizes the visitors shopping journey.
       class GoogleCloudRetailV2alphaModelPageOptimizationConfig
         include Google::Apis::Core::Hashable
@@ -3538,7 +3548,8 @@ module Google
         # For Type.VARIANT, the following fields are always returned in by default: *
         # name * color_info The maximum number of paths is 30. Otherwise, an
         # INVALID_ARGUMENT error is returned. Note: Returning more fields in
-        # SearchResponse can increase response payload size and serving latency.
+        # SearchResponse can increase response payload size and serving latency. This
+        # field is deprecated. Use the retrievable site-wide control instead.
         # Corresponds to the JSON property `retrievableFields`
         # @return [String]
         attr_accessor :retrievable_fields
@@ -5546,7 +5557,8 @@ module Google
         # @return [String]
         attr_accessor :diversity_level
       
-        # What kind of diversity to use - data driven or rule based.
+        # What kind of diversity to use - data driven or rule based. If unset, the
+        # server behavior defaults to RULE_BASED_DIVERSITY.
         # Corresponds to the JSON property `diversityType`
         # @return [String]
         attr_accessor :diversity_type
@@ -5634,7 +5646,7 @@ module Google
         # 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` * `low-price-reranking` * `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.
@@ -6744,14 +6756,14 @@ 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). 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.
+        # page-optimization`, `similar-items`, `buy-it-again`, `on-sale-items`, and `
+        # recently-viewed`(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

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.62.0"
+      GEM_VERSION = "0.64.0"
 
       # Version of the code generator used to generate this client
       GENERATOR_VERSION = "0.11.0"
 
       # Revision of the discovery document this client was generated from
-      REVISION = "20221107"
+      REVISION = "20230102"
     end
   end
 end

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

@@ -1551,6 +1551,7 @@ module Google
           property :indexable_option, as: 'indexableOption'
           property :key, as: 'key'
           property :recommendations_filtering_option, as: 'recommendationsFilteringOption'
+          property :retrievable_option, as: 'retrievableOption'
           property :searchable_option, as: 'searchableOption'
           property :type, as: 'type'
         end

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

@@ -1771,10 +1771,10 @@ module Google
         #   the `servingConfigs` resource. `placements` is a legacy resource. The ID of
         #   the Recommendations AI serving config or placement. Before you can request
         #   predictions from your model, you must create at least one serving config or
-        #   placement for it. For more information, see [Managing serving configurations] (
-        #   https://cloud.google.com/retail/docs/manage-configs). The full list of
-        #   available serving configs can be seen at https://console.cloud.google.com/ai/
-        #   retail/catalogs/default_catalog/configs
+        #   placement for it. For more information, see [Manage serving configs] (https://
+        #   cloud.google.com/retail/docs/manage-configs). The full list of available
+        #   serving configs can be seen at https://console.cloud.google.com/ai/retail/
+        #   catalogs/default_catalog/configs
         # @param [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaPredictRequest] google_cloud_retail_v2alpha_predict_request_object
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
@@ -1813,8 +1813,8 @@ module Google
         #   projects/*/locations/global/catalogs/default_catalog/servingConfigs/
         #   default_serving_config` or the name of the legacy placement resource, such as `
         #   projects/*/locations/global/catalogs/default_catalog/placements/default_search`
-        #   . This field is used to identify the serving configuration name and the set of
-        #   models that will be used to make the search.
+        #   . This field is used to identify the serving config name and the set of models
+        #   that will be used to make the search.
         # @param [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchRequest] google_cloud_retail_v2alpha_search_request_object
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
@@ -2077,10 +2077,10 @@ module Google
         #   the `servingConfigs` resource. `placements` is a legacy resource. The ID of
         #   the Recommendations AI serving config or placement. Before you can request
         #   predictions from your model, you must create at least one serving config or
-        #   placement for it. For more information, see [Managing serving configurations] (
-        #   https://cloud.google.com/retail/docs/manage-configs). The full list of
-        #   available serving configs can be seen at https://console.cloud.google.com/ai/
-        #   retail/catalogs/default_catalog/configs
+        #   placement for it. For more information, see [Manage serving configs] (https://
+        #   cloud.google.com/retail/docs/manage-configs). The full list of available
+        #   serving configs can be seen at https://console.cloud.google.com/ai/retail/
+        #   catalogs/default_catalog/configs
         # @param [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaPredictRequest] google_cloud_retail_v2alpha_predict_request_object
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
@@ -2156,8 +2156,8 @@ module Google
         #   projects/*/locations/global/catalogs/default_catalog/servingConfigs/
         #   default_serving_config` or the name of the legacy placement resource, such as `
         #   projects/*/locations/global/catalogs/default_catalog/placements/default_search`
-        #   . This field is used to identify the serving configuration name and the set of
-        #   models that will be used to make the search.
+        #   . This field is used to identify the serving config name and the set of models
+        #   that will be used to make the search.
         # @param [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchRequest] google_cloud_retail_v2alpha_search_request_object
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
@@ -2201,7 +2201,7 @@ module Google
         #   payload bytes.
         # @param [String] prebuilt_rule
         #   The prebuilt rule name that can convert a specific type of raw_json. For
-        #   example: "default_schema/v1.0"
+        #   example: "ga4_bq" rule for the GA4 user event schema.
         # @param [String] raw_json
         #   An arbitrary serialized JSON string that contains necessary information that
         #   can comprise a user event. When this field is specified, the user_event field
@@ -2366,6 +2366,11 @@ module Google
         #   Required. The parent catalog resource name, such as `projects/1234/locations/
         #   global/catalogs/default_catalog`.
         # @param [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaUserEvent] google_cloud_retail_v2alpha_user_event_object
+        # @param [Boolean] write_async
+        #   If set to true, the user event will be written asynchronously after validation,
+        #   and the API will respond without waiting for the write. Therefore, silent
+        #   failures can occur even if the API returns success. In case of silent failures,
+        #   error messages can be found in Stackdriver logs.
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
         # @param [String] quota_user
@@ -2383,13 +2388,14 @@ module Google
         # @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 write_project_location_catalog_user_event(parent, google_cloud_retail_v2alpha_user_event_object = nil, fields: nil, quota_user: nil, options: nil, &block)
+        def write_project_location_catalog_user_event(parent, google_cloud_retail_v2alpha_user_event_object = nil, write_async: nil, fields: nil, quota_user: nil, options: nil, &block)
           command = make_simple_command(:post, 'v2alpha/{+parent}/userEvents:write', options)
           command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaUserEvent::Representation
           command.request_object = google_cloud_retail_v2alpha_user_event_object
           command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaUserEvent::Representation
           command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaUserEvent
           command.params['parent'] = parent unless parent.nil?
+          command.query['writeAsync'] = write_async unless write_async.nil?
           command.query['fields'] = fields unless fields.nil?
           command.query['quotaUser'] = quota_user unless quota_user.nil?
           execute_or_queue_command(command, &block)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-apis-retail_v2alpha
 version: !ruby/object:Gem::Version
-  version: 0.62.0
+  version: 0.64.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-11-14 00:00:00.000000000 Z
+date: 2023-01-04 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.62.0
+  documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2alpha/v0.64.0
   source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-retail_v2alpha
 post_install_message: 
 rdoc_options: []