google-apis-retail_v2alpha 0.89.0 → 0.91.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: de351a4cde2fb82b4d68e56bc5f469ad8c46c96333e383077034e8e95b39ec4d
-  data.tar.gz: f2f70de17c05152cfb271775bf51ba0a3117cc2a414a64ee4a27202bd00f4ed5
+  metadata.gz: 626effe9f2ebae76599f28005ba979a3a6f31c00c46de63f8c0d46764bd69899
+  data.tar.gz: dedaaad92fdfb6a41e04118f8e7fde0836e06838e93dcde0f813777d66d327a1
 SHA512:
-  metadata.gz: 2e4a8f6477860f0b301e9d8e9999696d0f146bed594255f5dd866dbc3894fa29f55954a32ad33e8c21e11c594b950b9b326137a4140594528525c7c6106dd5bd
-  data.tar.gz: 1682c3fa9838907fb18ed9d6caf50109156b17071ea5ae44f6c0d70eff20cf41f80db6ef73a3010c6571743df748767f8b94ef985d8be1bd8c38cdc9416ff29e
+  metadata.gz: 3095cb59479d4f5ed8db8ed6dfa60d2c96d12e384659ae8c3e52bc4d3e42cd465703a28ede9b8ab050f299737a2586e183ed9373a287abe35f1c78b3e7163718
+  data.tar.gz: 1e6d42802b636bb7d81af2db008a00b54eb78ba08bcd4c2d3ba68519216ba235325e785528b49b68e0d9ffc36fdc3faecf475eeecff45a8495e299c29abb9956

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Release history for google-apis-retail_v2alpha
 
+### v0.91.0 (2023-12-17)
+
+* Regenerated from discovery document revision 20231207
+
+### v0.90.0 (2023-12-10)
+
+* Regenerated from discovery document revision 20231130
+
 ### v0.89.0 (2023-11-19)
 
 * Regenerated from discovery document revision 20231109

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

@@ -2417,6 +2417,73 @@ module Google
         end
       end
       
+      # Request message for the `ExportAnalyticsMetrics` method.
+      class GoogleCloudRetailV2alphaExportAnalyticsMetricsRequest
+        include Google::Apis::Core::Hashable
+      
+        # A filtering expression to specify restrictions on returned metrics. The
+        # expression is a sequence of terms. Each term applies a restriction to the
+        # returned metrics. Use this expression to restrict results to a specific time
+        # range. Currently we expect only one types of fields: * `timestamp`: This can
+        # be specified twice, once with a less than operator and once with a greater
+        # than operator. The `timestamp` restriction should result in one, contiguous,
+        # valid, `timestamp` range. Some examples of valid filters expressions: *
+        # Example 1: `timestamp > "2012-04-23T18:25:43.511Z" timestamp < "2012-04-23T18:
+        # 30:43.511Z"` * Example 2: `timestamp > "2012-04-23T18:25:43.511Z"`
+        # Corresponds to the JSON property `filter`
+        # @return [String]
+        attr_accessor :filter
+      
+        # The output configuration setting.
+        # Corresponds to the JSON property `outputConfig`
+        # @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaOutputConfig]
+        attr_accessor :output_config
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @filter = args[:filter] if args.key?(:filter)
+          @output_config = args[:output_config] if args.key?(:output_config)
+        end
+      end
+      
+      # Response of the ExportAnalyticsMetricsRequest. If the long running operation
+      # was successful, then this message is returned by the google.longrunning.
+      # Operations.response field if the operation was successful.
+      class GoogleCloudRetailV2alphaExportAnalyticsMetricsResponse
+        include Google::Apis::Core::Hashable
+      
+        # A sample of errors encountered while processing the request.
+        # Corresponds to the JSON property `errorSamples`
+        # @return [Array<Google::Apis::RetailV2alpha::GoogleRpcStatus>]
+        attr_accessor :error_samples
+      
+        # Configuration of destination for Export related errors.
+        # Corresponds to the JSON property `errorsConfig`
+        # @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaExportErrorsConfig]
+        attr_accessor :errors_config
+      
+        # Output result that stores the information about where the exported data is
+        # stored.
+        # Corresponds to the JSON property `outputResult`
+        # @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaOutputResult]
+        attr_accessor :output_result
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @error_samples = args[:error_samples] if args.key?(:error_samples)
+          @errors_config = args[:errors_config] if args.key?(:errors_config)
+          @output_result = args[:output_result] if args.key?(:output_result)
+        end
+      end
+      
       # Configuration of destination for Export related errors.
       class GoogleCloudRetailV2alphaExportErrorsConfig
         include Google::Apis::Core::Hashable
@@ -3892,6 +3959,87 @@ module Google
         end
       end
       
+      # The output configuration setting.
+      class GoogleCloudRetailV2alphaOutputConfig
+        include Google::Apis::Core::Hashable
+      
+        # The BigQuery output destination configuration.
+        # Corresponds to the JSON property `bigqueryDestination`
+        # @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaOutputConfigBigQueryDestination]
+        attr_accessor :bigquery_destination
+      
+        # The Google Cloud Storage output destination configuration.
+        # Corresponds to the JSON property `gcsDestination`
+        # @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaOutputConfigGcsDestination]
+        attr_accessor :gcs_destination
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @bigquery_destination = args[:bigquery_destination] if args.key?(:bigquery_destination)
+          @gcs_destination = args[:gcs_destination] if args.key?(:gcs_destination)
+        end
+      end
+      
+      # The BigQuery output destination configuration.
+      class GoogleCloudRetailV2alphaOutputConfigBigQueryDestination
+        include Google::Apis::Core::Hashable
+      
+        # Required. The ID of a BigQuery Dataset.
+        # Corresponds to the JSON property `datasetId`
+        # @return [String]
+        attr_accessor :dataset_id
+      
+        # Required. The prefix of exported BigQuery tables.
+        # Corresponds to the JSON property `tableIdPrefix`
+        # @return [String]
+        attr_accessor :table_id_prefix
+      
+        # Required. Describes the table type. The following values are supported: * `
+        # table`: A BigQuery native table. * `view`: A virtual table defined by a SQL
+        # query.
+        # Corresponds to the JSON property `tableType`
+        # @return [String]
+        attr_accessor :table_type
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @dataset_id = args[:dataset_id] if args.key?(:dataset_id)
+          @table_id_prefix = args[:table_id_prefix] if args.key?(:table_id_prefix)
+          @table_type = args[:table_type] if args.key?(:table_type)
+        end
+      end
+      
+      # The Google Cloud Storage output destination configuration.
+      class GoogleCloudRetailV2alphaOutputConfigGcsDestination
+        include Google::Apis::Core::Hashable
+      
+        # Required. The output uri prefix for saving output data to json files. Some
+        # mapping examples are as follows: output_uri_prefix sample output(assuming the
+        # object is foo.json) ======================== ==================================
+        # =========== gs://bucket/ gs://bucket/foo.json gs://bucket/folder/ gs://bucket/
+        # folder/foo.json gs://bucket/folder/item_ gs://bucket/folder/item_foo.json
+        # Corresponds to the JSON property `outputUriPrefix`
+        # @return [String]
+        attr_accessor :output_uri_prefix
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @output_uri_prefix = args[:output_uri_prefix] if args.key?(:output_uri_prefix)
+        end
+      end
+      
       # Output result that stores the information about where the exported data is
       # stored.
       class GoogleCloudRetailV2alphaOutputResult
@@ -4281,13 +4429,13 @@ module Google
         # 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
-        # returned. Corresponding properties: Google Merchant Center property
-        # google_product_category. Schema.org property [Product.category] (https://
-        # schema.org/category). [mc_google_product_category]: https://support.google.com/
-        # merchants/answer/6324436
+        # INVALID_ARGUMENT error is returned. At most 250 values are allowed per Product
+        # unless overridden via pantheon UI. Empty values are not allowed. Each value
+        # must be a UTF-8 encoded string with a length limit of 5,000 characters.
+        # Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties:
+        # Google Merchant Center property google_product_category. Schema.org property [
+        # Product.category] (https://schema.org/category). [mc_google_product_category]:
+        # https://support.google.com/merchants/answer/6324436
         # Corresponds to the JSON property `categories`
         # @return [Array<String>]
         attr_accessor :categories
@@ -4326,16 +4474,16 @@ module Google
         # @return [String]
         attr_accessor :description
       
-        # The timestamp when this product becomes unavailable for SearchService.Search.
-        # 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.
-        # Corresponding properties: Google Merchant Center property [expiration_date](
-        # https://support.google.com/merchants/answer/6324499).
+        # Note that this field is applied in the following ways: * If the Product is
+        # already expired when it is uploaded, this product is not indexed for search. *
+        # If the Product is not expired when it is uploaded, only the Type.PRIMARY's and
+        # Type.COLLECTION's expireTime is respected, and Type.VARIANT's expireTime is
+        # not used. In general, we suggest the users to delete the stale products
+        # explicitly, instead of using this field to determine staleness. expire_time
+        # must be later than available_time and publish_time, otherwise an
+        # INVALID_ARGUMENT error is thrown. Corresponding properties: Google Merchant
+        # Center property [expiration_date](https://support.google.com/merchants/answer/
+        # 6324499).
         # Corresponds to the JSON property `expireTime`
         # @return [String]
         attr_accessor :expire_time

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.89.0"
+      GEM_VERSION = "0.91.0"
 
       # Version of the code generator used to generate this client
       GENERATOR_VERSION = "0.12.0"
 
       # Revision of the discovery document this client was generated from
-      REVISION = "20231109"
+      REVISION = "20231207"
     end
   end
 end

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

@@ -478,6 +478,18 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class GoogleCloudRetailV2alphaExportAnalyticsMetricsRequest
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleCloudRetailV2alphaExportAnalyticsMetricsResponse
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class GoogleCloudRetailV2alphaExportErrorsConfig
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -724,6 +736,24 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class GoogleCloudRetailV2alphaOutputConfig
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleCloudRetailV2alphaOutputConfigBigQueryDestination
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleCloudRetailV2alphaOutputConfigGcsDestination
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class GoogleCloudRetailV2alphaOutputResult
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -2099,6 +2129,27 @@ module Google
         end
       end
       
+      class GoogleCloudRetailV2alphaExportAnalyticsMetricsRequest
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :filter, as: 'filter'
+          property :output_config, as: 'outputConfig', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaOutputConfig, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaOutputConfig::Representation
+      
+        end
+      end
+      
+      class GoogleCloudRetailV2alphaExportAnalyticsMetricsResponse
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          collection :error_samples, as: 'errorSamples', class: Google::Apis::RetailV2alpha::GoogleRpcStatus, decorator: Google::Apis::RetailV2alpha::GoogleRpcStatus::Representation
+      
+          property :errors_config, as: 'errorsConfig', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaExportErrorsConfig, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaExportErrorsConfig::Representation
+      
+          property :output_result, as: 'outputResult', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaOutputResult, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaOutputResult::Representation
+      
+        end
+      end
+      
       class GoogleCloudRetailV2alphaExportErrorsConfig
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -2504,6 +2555,32 @@ module Google
         end
       end
       
+      class GoogleCloudRetailV2alphaOutputConfig
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :bigquery_destination, as: 'bigqueryDestination', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaOutputConfigBigQueryDestination, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaOutputConfigBigQueryDestination::Representation
+      
+          property :gcs_destination, as: 'gcsDestination', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaOutputConfigGcsDestination, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaOutputConfigGcsDestination::Representation
+      
+        end
+      end
+      
+      class GoogleCloudRetailV2alphaOutputConfigBigQueryDestination
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :dataset_id, as: 'datasetId'
+          property :table_id_prefix, as: 'tableIdPrefix'
+          property :table_type, as: 'tableType'
+        end
+      end
+      
+      class GoogleCloudRetailV2alphaOutputConfigGcsDestination
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :output_uri_prefix, as: 'outputUriPrefix'
+        end
+      end
+      
       class GoogleCloudRetailV2alphaOutputResult
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation

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

@@ -306,6 +306,42 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
+        # Exports analytics metrics. `Operation.response` is of type `
+        # ExportAnalyticsMetricsResponse`. `Operation.metadata` is of type `
+        # ExportMetadata`.
+        # @param [String] catalog
+        #   Required. Full resource name of the parent catalog. Expected format: `projects/
+        #   */locations/*/catalogs/*`
+        # @param [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaExportAnalyticsMetricsRequest] google_cloud_retail_v2alpha_export_analytics_metrics_request_object
+        # @param [String] fields
+        #   Selector specifying which fields to include in a partial response.
+        # @param [String] quota_user
+        #   Available to use for quota purposes for server-side applications. Can be any
+        #   arbitrary string assigned to a user, but should not exceed 40 characters.
+        # @param [Google::Apis::RequestOptions] options
+        #   Request-specific options
+        #
+        # @yield [result, err] Result & error if block supplied
+        # @yieldparam result [Google::Apis::RetailV2alpha::GoogleLongrunningOperation] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::RetailV2alpha::GoogleLongrunningOperation]
+        #
+        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
+        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
+        # @raise [Google::Apis::AuthorizationError] Authorization is required
+        def export_project_location_catalog_analytics_metrics(catalog, google_cloud_retail_v2alpha_export_analytics_metrics_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:post, 'v2alpha/{+catalog}:exportAnalyticsMetrics', options)
+          command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaExportAnalyticsMetricsRequest::Representation
+          command.request_object = google_cloud_retail_v2alpha_export_analytics_metrics_request_object
+          command.response_representation = Google::Apis::RetailV2alpha::GoogleLongrunningOperation::Representation
+          command.response_class = Google::Apis::RetailV2alpha::GoogleLongrunningOperation
+          command.params['catalog'] = catalog unless catalog.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
         # Gets an AttributesConfig.
         # @param [String] name
         #   Required. Full AttributesConfig resource name. Format: `projects/`

metadata

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