google-apis-retail_v2 0.50.0 → 0.51.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2a7e7c07cf5be1942d45cb5e033eb4c42c14ebcbd7f008b34c08b7c2ee2d7a94
-  data.tar.gz: dfd85f8cdbb4190eeed05ca1b1c602939fe3ed746c15af659d4d6facd264a63a
+  metadata.gz: 6708b55caac9e78939317b808b232c5ab2f6811e8e8b1613128ead69ae97bc6d
+  data.tar.gz: e31b5c96b7034af6615b9b6b6f0491f25b9b4662835727ed1acd872bc15b4190
 SHA512:
-  metadata.gz: 3b793cf5ca583fa4fca77799665dee6b3804302c6ae229b4a5dd0e3c10a7add736246a3f6d2487b536741b89ebdb19e57a91364f588086c1be4fc5aa2643b300
-  data.tar.gz: 60718937a303bd6a64b8c6a66623aa5f36f62a8448ccfc72c5e9a9a787359a2906315d7ac16ae0bece795b01c11acabe064085653a3c254c56a62f44c4beb8e4
+  metadata.gz: 85ceb1824c06e3b1d21f3e0c41adc6d7237419a72e71b09563c02e29c752ec1ccd3fba4782169e10e1cd56bf690d857c5e75db820a1a734ab014504ce70bde41
+  data.tar.gz: 9537b376e53d690e982b3814e97915b07e062742874a8f0edb668bc6c5075d4ffe2970335780dbe49120024a4ee4e31abf6f95bee912a48298d7a577cde67146

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Release history for google-apis-retail_v2
 
+### v0.51.0 (2022-08-20)
+
+* Unspecified changes
+
 ### v0.50.0 (2022-08-12)
 
 * Regenerated from discovery document revision 20220811

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

@@ -1093,7 +1093,7 @@ module Google
         end
       end
       
-      # Google Cloud Storage location for input content. format.
+      # Google Cloud Storage location for input content.
       class GoogleCloudRetailV2GcsSource
         include Google::Apis::Core::Hashable
       
@@ -1104,8 +1104,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. Supported values for catalog attribute imports: * 'catalog_attribute'
+        # Supported values for control imports: * `control` (default): One JSON Control
+        # per line. Supported values for catalog attribute imports: * `catalog_attribute`
         # (default): One CSV CatalogAttribute per line.
         # Corresponds to the JSON property `dataSchema`
         # @return [String]
@@ -1215,9 +1215,9 @@ module Google
         attr_accessor :input_config
       
         # Pub/Sub topic for receiving notification. If this field is set, when the
-        # import is finished, a notification will be sent to specified Pub/Sub topic.
-        # The message data will be JSON string of a Operation. Format of the Pub/Sub
-        # topic is `projects/`project`/topics/`topic``.
+        # import is finished, a notification is sent to specified Pub/Sub topic. The
+        # message data is JSON string of a Operation. Format of the Pub/Sub topic is `
+        # projects/`project`/topics/`topic``.
         # Corresponds to the JSON property `notificationPubsubTopic`
         # @return [String]
         attr_accessor :notification_pubsub_topic
@@ -1259,8 +1259,8 @@ module Google
         include Google::Apis::Core::Hashable
       
         # Google Cloud Storage prefix for import errors. This must be an empty, existing
-        # Cloud Storage directory. Import errors will be written to sharded files in
-        # this directory, one per line, as a JSON-encoded `google.rpc.Status` message.
+        # Cloud Storage directory. Import errors are written to sharded files in this
+        # directory, one per line, as a JSON-encoded `google.rpc.Status` message.
         # Corresponds to the JSON property `gcsPrefix`
         # @return [String]
         attr_accessor :gcs_prefix
@@ -1275,8 +1275,8 @@ module Google
         end
       end
       
-      # Metadata related to the progress of the Import operation. This will be
-      # returned by the google.longrunning.Operation.metadata field.
+      # Metadata related to the progress of the Import operation. This is returned by
+      # the google.longrunning.Operation.metadata field.
       class GoogleCloudRetailV2ImportMetadata
         include Google::Apis::Core::Hashable
       
@@ -1291,9 +1291,9 @@ module Google
         attr_accessor :failure_count
       
         # Pub/Sub topic for receiving notification. If this field is set, when the
-        # import is finished, a notification will be sent to specified Pub/Sub topic.
-        # The message data will be JSON string of a Operation. Format of the Pub/Sub
-        # topic is `projects/`project`/topics/`topic``.
+        # import is finished, a notification is sent to specified Pub/Sub topic. The
+        # message data is JSON string of a Operation. Format of the Pub/Sub topic is `
+        # projects/`project`/topics/`topic``.
         # Corresponds to the JSON property `notificationPubsubTopic`
         # @return [String]
         attr_accessor :notification_pubsub_topic
@@ -1344,12 +1344,12 @@ module Google
         attr_accessor :input_config
       
         # Full Pub/Sub topic name for receiving notification. If this field is set, when
-        # the import is finished, a notification will be sent to specified Pub/Sub topic.
-        # The message data will be JSON string of a Operation. Format of the Pub/Sub
-        # topic is `projects/`project`/topics/`topic``. It has to be within the same
-        # project as ImportProductsRequest.parent. Make sure that `service-@gcp-sa-
-        # retail.iam.gserviceaccount.com` has the `pubsub.topics.publish` IAM permission
-        # on the topic.
+        # the import is finished, a notification is sent to specified Pub/Sub topic. The
+        # message data is JSON string of a Operation. Format of the Pub/Sub topic is `
+        # projects/`project`/topics/`topic``. It has to be within the same project as
+        # ImportProductsRequest.parent. Make sure that `service-@gcp-sa-retail.iam.
+        # gserviceaccount.com` has the `pubsub.topics.publish` IAM permission on the
+        # topic.
         # Corresponds to the JSON property `notificationPubsubTopic`
         # @return [String]
         attr_accessor :notification_pubsub_topic
@@ -1365,8 +1365,8 @@ module Google
         # @return [String]
         attr_accessor :request_id
       
-        # Indicates which fields in the provided imported 'products' to update. If not
-        # set, will by default update all fields.
+        # Indicates which fields in the provided imported `products` to update. If not
+        # set, all fields are updated.
         # Corresponds to the JSON property `updateMask`
         # @return [String]
         attr_accessor :update_mask
@@ -2322,7 +2322,7 @@ module Google
         # @return [Google::Apis::RetailV2::GoogleCloudRetailV2BigQuerySource]
         attr_accessor :big_query_source
       
-        # Google Cloud Storage location for input content. format.
+        # Google Cloud Storage location for input content.
         # Corresponds to the JSON property `gcsSource`
         # @return [Google::Apis::RetailV2::GoogleCloudRetailV2GcsSource]
         attr_accessor :gcs_source
@@ -4003,7 +4003,7 @@ module Google
         # @return [Google::Apis::RetailV2::GoogleCloudRetailV2BigQuerySource]
         attr_accessor :big_query_source
       
-        # Google Cloud Storage location for input content. format.
+        # Google Cloud Storage location for input content.
         # Corresponds to the JSON property `gcsSource`
         # @return [Google::Apis::RetailV2::GoogleCloudRetailV2GcsSource]
         attr_accessor :gcs_source
@@ -4328,8 +4328,8 @@ module Google
         include Google::Apis::Core::Hashable
       
         # Google Cloud Storage prefix for import errors. This must be an empty, existing
-        # Cloud Storage directory. Import errors will be written to sharded files in
-        # this directory, one per line, as a JSON-encoded `google.rpc.Status` message.
+        # Cloud Storage directory. Import errors are written to sharded files in this
+        # directory, one per line, as a JSON-encoded `google.rpc.Status` message.
         # Corresponds to the JSON property `gcsPrefix`
         # @return [String]
         attr_accessor :gcs_prefix
@@ -4344,8 +4344,8 @@ module Google
         end
       end
       
-      # Metadata related to the progress of the Import operation. This will be
-      # returned by the google.longrunning.Operation.metadata field.
+      # Metadata related to the progress of the Import operation. This is returned by
+      # the google.longrunning.Operation.metadata field.
       class GoogleCloudRetailV2alphaImportMetadata
         include Google::Apis::Core::Hashable
       
@@ -4360,9 +4360,9 @@ module Google
         attr_accessor :failure_count
       
         # Pub/Sub topic for receiving notification. If this field is set, when the
-        # import is finished, a notification will be sent to specified Pub/Sub topic.
-        # The message data will be JSON string of a Operation. Format of the Pub/Sub
-        # topic is `projects/`project`/topics/`topic``.
+        # import is finished, a notification is sent to specified Pub/Sub topic. The
+        # message data is JSON string of a Operation. Format of the Pub/Sub topic is `
+        # projects/`project`/topics/`topic``.
         # Corresponds to the JSON property `notificationPubsubTopic`
         # @return [String]
         attr_accessor :notification_pubsub_topic
@@ -4467,7 +4467,7 @@ module Google
       
       # Metadata that describes the training and serving parameters of a Model. A
       # Model can be associated with a ServingConfig and then queried through the
-      # Predict api.
+      # Predict API.
       class GoogleCloudRetailV2alphaModel
         include Google::Apis::Core::Hashable
       
@@ -4476,23 +4476,23 @@ module Google
         # @return [String]
         attr_accessor :create_time
       
-        # Output only. The state of data requirements for this model: DATA_OK and
-        # DATA_ERROR. Recommendation model cannot be trained if the data is in
-        # DATA_ERROR state. Recommendation model can have DATA_ERROR state even if
-        # serving state is ACTIVE: models were trained successfully before, but cannot
+        # Output only. The state of data requirements for this model: `DATA_OK` and `
+        # DATA_ERROR`. Recommendation model cannot be trained if the data is in `
+        # DATA_ERROR` state. Recommendation model can have `DATA_ERROR` state even if
+        # serving state is `ACTIVE`: models were trained successfully before, but cannot
         # be refreshed because model no longer has sufficient data for training.
         # Corresponds to the JSON property `dataState`
         # @return [String]
         attr_accessor :data_state
       
         # Required. The display name of the model. Should be human readable, used to
-        # display Recommendation Models in the Retail Cloud Cosole Dashboard. UTF-8
+        # display Recommendation Models in the Retail Cloud Console Dashboard. UTF-8
         # encoded string with limit of 1024 characters.
         # Corresponds to the JSON property `displayName`
         # @return [String]
         attr_accessor :display_name
       
-        # Optional. If RECOMMENDATIONS_FILTERING_ENABLED, recommendation filtering by
+        # Optional. If `RECOMMENDATIONS_FILTERING_ENABLED`, recommendation filtering by
         # attributes is enabled for the model.
         # Corresponds to the JSON property `filteringOption`
         # @return [String]
@@ -4503,9 +4503,10 @@ module Google
         # @return [String]
         attr_accessor :last_tune_time
       
-        # Required. The fully qualified resource name of the model. Format: projects/`
+        # Required. The fully qualified resource name of the model. Format: `projects/`
         # project_number`/locations/`location_id`/catalogs/`catalog_id`/models/`model_id`
-        # catalog_id has char limit of 50. recommendation_model_id has char limit of 40.
+        # ` catalog_id has char limit of 50. recommendation_model_id has char limit of
+        # 40.
         # Corresponds to the JSON property `name`
         # @return [String]
         attr_accessor :name
@@ -4528,8 +4529,8 @@ module Google
         attr_accessor :page_optimization_config
       
         # Optional. The state of periodic tuning. The period we use is 3 months - to do
-        # a one-off tune earlier use the TuneModel method. Default value is
-        # PERIODIC_TUNING_ENABLED.
+        # a one-off tune earlier use the `TuneModel` method. Default value is `
+        # PERIODIC_TUNING_ENABLED`.
         # Corresponds to the JSON property `periodicTuningState`
         # @return [String]
         attr_accessor :periodic_tuning_state
@@ -4540,16 +4541,16 @@ module Google
         # @return [Array<Google::Apis::RetailV2::GoogleCloudRetailV2alphaModelServingConfigList>]
         attr_accessor :serving_config_lists
       
-        # Output only. The serving state of the model: ACTIVE, NOT_ACTIVE.
+        # Output only. The serving state of the model: `ACTIVE`, `NOT_ACTIVE`.
         # Corresponds to the JSON property `servingState`
         # @return [String]
         attr_accessor :serving_state
       
-        # Optional. The training state that the model is in (e.g. TRAINING or PAUSED).
-        # Since part of the cost of running the service is frequency of training - this
-        # can be used to determine when to train model in order to control cost. If not
-        # specified: the default value for CreateModel method is TRAINING. the default
-        # value for UpdateModel method is to keep the state the same as before.
+        # Optional. The training state that the model is in (e.g. `TRAINING` or `PAUSED`)
+        # . Since part of the cost of running the service is frequency of training -
+        # this can be used to determine when to train model in order to control cost. If
+        # not specified: the default value for `CreateModel` method is `TRAINING`. The
+        # default value for `UpdateModel` method is to keep the state the same as before.
         # Corresponds to the JSON property `trainingState`
         # @return [String]
         attr_accessor :training_state
@@ -4563,7 +4564,7 @@ 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', `recently-viewed`(
+        # page-optimization`, `similar-items`, `buy-it-again`, and `recently-viewed`(
         # readonly value).
         # Corresponds to the JSON property `type`
         # @return [String]
@@ -4648,9 +4649,10 @@ module Google
       class GoogleCloudRetailV2alphaModelPageOptimizationConfigCandidate
         include Google::Apis::Core::Hashable
       
-        # This has to be a valid ServingConfig identifier. e.g. for a ServingConfig with
-        # full name: `projects/*/locations/global/catalogs/default_catalog/
-        # servingConfigs/my_candidate_config` this would be 'my_candidate_config'
+        # This has to be a valid ServingConfig identifier. For example, for a
+        # ServingConfig with full name: `projects/*/locations/global/catalogs/
+        # default_catalog/servingConfigs/my_candidate_config`, this would be `
+        # my_candidate_config`.
         # Corresponds to the JSON property `servingConfigId`
         # @return [String]
         attr_accessor :serving_config_id
@@ -4697,13 +4699,13 @@ module Google
         end
       end
       
-      # Represents an ordered combination of valid serving configs, which / may be
-      # used for PAGE_OPTIMIZATION recommendations.
+      # Represents an ordered combination of valid serving configs, which can be used
+      # for `PAGE_OPTIMIZATION` recommendations.
       class GoogleCloudRetailV2alphaModelServingConfigList
         include Google::Apis::Core::Hashable
       
-        # Optional. A set of valid serving configs that may be used for
-        # PAGE_OPTIMIZATION.
+        # Optional. A set of valid serving configs that may be used for `
+        # PAGE_OPTIMIZATION`.
         # Corresponds to the JSON property `servingConfigIds`
         # @return [Array<String>]
         attr_accessor :serving_config_ids
@@ -5272,8 +5274,8 @@ module Google
         include Google::Apis::Core::Hashable
       
         # Google Cloud Storage prefix for import errors. This must be an empty, existing
-        # Cloud Storage directory. Import errors will be written to sharded files in
-        # this directory, one per line, as a JSON-encoded `google.rpc.Status` message.
+        # Cloud Storage directory. Import errors are written to sharded files in this
+        # directory, one per line, as a JSON-encoded `google.rpc.Status` message.
         # Corresponds to the JSON property `gcsPrefix`
         # @return [String]
         attr_accessor :gcs_prefix
@@ -5288,8 +5290,8 @@ module Google
         end
       end
       
-      # Metadata related to the progress of the Import operation. This will be
-      # returned by the google.longrunning.Operation.metadata field.
+      # Metadata related to the progress of the Import operation. This is returned by
+      # the google.longrunning.Operation.metadata field.
       class GoogleCloudRetailV2betaImportMetadata
         include Google::Apis::Core::Hashable
       
@@ -5304,9 +5306,9 @@ module Google
         attr_accessor :failure_count
       
         # Pub/Sub topic for receiving notification. If this field is set, when the
-        # import is finished, a notification will be sent to specified Pub/Sub topic.
-        # The message data will be JSON string of a Operation. Format of the Pub/Sub
-        # topic is `projects/`project`/topics/`topic``.
+        # import is finished, a notification is sent to specified Pub/Sub topic. The
+        # message data is JSON string of a Operation. Format of the Pub/Sub topic is `
+        # projects/`project`/topics/`topic``.
         # Corresponds to the JSON property `notificationPubsubTopic`
         # @return [String]
         attr_accessor :notification_pubsub_topic

data/lib/google/apis/retail_v2/gem_version.rb

@@ -16,7 +16,7 @@ module Google
   module Apis
     module RetailV2
       # Version of the google-apis-retail_v2 gem
-      GEM_VERSION = "0.50.0"
+      GEM_VERSION = "0.51.0"
 
       # Version of the code generator used to generate this client
       GENERATOR_VERSION = "0.9.0"

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

@@ -543,9 +543,13 @@ module Google
         # updating fulfillment information. If the request is valid, the update will be
         # enqueued and processed downstream. As a consequence, when a response is
         # returned, the added place IDs are not immediately manifested in the Product
-        # queried by ProductService.GetProduct or ProductService.ListProducts. This
-        # feature is only available for users who have Retail Search enabled. Please
-        # enable Retail Search on Cloud Console before using this feature.
+        # queried by ProductService.GetProduct or ProductService.ListProducts. 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.
         # @param [String] product
         #   Required. Full resource name of Product, such as `projects/*/locations/global/
         #   catalogs/default_catalog/branches/default_branch/products/some_product_id`. If
@@ -590,9 +594,12 @@ module Google
         # ProductService.GetProduct or ProductService.ListProducts. Local inventory
         # information can only be modified using this method. ProductService.
         # CreateProduct and ProductService.UpdateProduct has no effect on local
-        # inventories. This feature is only available for users who have Retail Search
-        # enabled. Please enable Retail Search on Cloud Console before using this
-        # feature.
+        # inventories. 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.
         # @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
@@ -898,9 +905,13 @@ module Google
         # updating fulfillment information. If the request is valid, the update will be
         # enqueued and processed downstream. As a consequence, when a response is
         # returned, the removed place IDs are not immediately manifested in the Product
-        # queried by ProductService.GetProduct or ProductService.ListProducts. This
-        # feature is only available for users who have Retail Search enabled. Please
-        # enable Retail Search on Cloud Console before using this feature.
+        # queried by ProductService.GetProduct or ProductService.ListProducts. 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.
         # @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
@@ -943,9 +954,12 @@ module Google
         # queried by ProductService.GetProduct or ProductService.ListProducts. Local
         # inventory information can only be removed using this method. ProductService.
         # CreateProduct and ProductService.UpdateProduct has no effect on local
-        # inventories. This feature is only available for users who have Retail Search
-        # enabled. Please enable Retail Search on Cloud Console before using this
-        # feature.
+        # inventories. 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.
         # @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
@@ -998,9 +1012,12 @@ module Google
         # 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. This feature is only available for
-        # users who have Retail Search enabled. Please enable Retail Search on Cloud
-        # Console before using this feature.
+        # 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.
         # @param [String] name
         #   Immutable. Full resource name of the product, such as `projects/*/locations/
         #   global/catalogs/default_catalog/branches/default_branch/products/product_id`.
@@ -1364,9 +1381,9 @@ module Google
         
         # Bulk import of User events. Request processing might be synchronous. Events
         # that already exist are skipped. Use this method for backfilling historical
-        # user events. Operation.response is of type ImportResponse. Note that it is
-        # possible for a subset of the items to be successfully inserted. Operation.
-        # metadata is of type ImportMetadata.
+        # user events. `Operation.response` is of type `ImportResponse`. Note that it is
+        # possible for a subset of the items to be successfully inserted. `Operation.
+        # metadata` is of type `ImportMetadata`.
         # @param [String] parent
         #   Required. `projects/1234/locations/global/catalogs/default_catalog`
         # @param [Google::Apis::RetailV2::GoogleCloudRetailV2ImportUserEventsRequest] google_cloud_retail_v2_import_user_events_request_object

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-apis-retail_v2
 version: !ruby/object:Gem::Version
-  version: 0.50.0
+  version: 0.51.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-08-15 00:00:00.000000000 Z
+date: 2022-08-22 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_v2/CHANGELOG.md
-  documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2/v0.50.0
+  documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2/v0.51.0
   source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-retail_v2
 post_install_message: 
 rdoc_options: []