google-apis-retail_v2alpha 0.50.0 → 0.51.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d890c1a65e53a027afcd59800f3d47e4e6f818ca8dede7f80961898a042b4a23
-  data.tar.gz: e8f78f4aae8cb0f748030884adabdff2ada82bfbfa145733481925c417dc05ec
+  metadata.gz: 18dbc96cd791962636ccea2130f4c28457fb1bb7cfa739461f5a0ee32c37d713
+  data.tar.gz: 9e41bb871a70b49c21e5dba070f8bb58b1a915c82f1d169d5f83bbe099286e29
 SHA512:
-  metadata.gz: 771439e5fb82eed062625e28f92ecfc434ef8098a9f2d4605b6dfc4ced62a9a22375079195dee54dacdb7aa04d75de17f9e48b50bbe5a1edeca063fe00a48029
-  data.tar.gz: aee7cf4032cc22d6adf63b4feb85cd1af4336143b1a68e630342908e760d4f0b04f929c489a6d7b35a2295290d73e9b7756075b60f67960bf26f06761d338332
+  metadata.gz: a1519608bf99b6f015a25b68e92694fca58fb2ed8b232ea7bedc7c0235ff223211f55e45f5248a13c0a1b2b253e4768055387d3c3690c50f1c78b6cf030abbb4
+  data.tar.gz: 8a8018b93f65677f84779903983691dfeda63025474d7bdc2d11d158d699863faaaa7527a2e470e3d4461f70278aeb5efcb25d2abda21bdec47e28145be0cb50

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Release history for google-apis-retail_v2alpha
 
+### v0.51.0 (2022-08-03)
+
+* Regenerated from discovery document revision 20220729
+
 ### v0.50.0 (2022-07-26)
 
 * Regenerated from discovery document revision 20220722

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

@@ -960,6 +960,54 @@ module Google
         end
       end
       
+      # Request for CatalogService.BatchRemoveCatalogAttributes method.
+      class GoogleCloudRetailV2alphaBatchRemoveCatalogAttributesRequest
+        include Google::Apis::Core::Hashable
+      
+        # Required. The attribute name keys of the CatalogAttributes to delete. A
+        # maximum of 1000 catalog attributes can be deleted in a batch.
+        # Corresponds to the JSON property `attributeKeys`
+        # @return [Array<String>]
+        attr_accessor :attribute_keys
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @attribute_keys = args[:attribute_keys] if args.key?(:attribute_keys)
+        end
+      end
+      
+      # Response of the CatalogService.BatchRemoveCatalogAttributes.
+      class GoogleCloudRetailV2alphaBatchRemoveCatalogAttributesResponse
+        include Google::Apis::Core::Hashable
+      
+        # Catalog attributes that were deleted. Only attributes that are not in use by
+        # products 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.
+        # Corresponds to the JSON property `resetCatalogAttributes`
+        # @return [Array<String>]
+        attr_accessor :reset_catalog_attributes
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @deleted_catalog_attributes = args[:deleted_catalog_attributes] if args.key?(:deleted_catalog_attributes)
+          @reset_catalog_attributes = args[:reset_catalog_attributes] if args.key?(:reset_catalog_attributes)
+        end
+      end
+      
       # A BigQuery output result.
       class GoogleCloudRetailV2alphaBigQueryOutputResult
         include Google::Apis::Core::Hashable
@@ -996,12 +1044,11 @@ 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`: The schema is available here: https://support.google.com/
-        # analytics/answer/3437719. * `user_event_ga4`: This feature is in private
-        # preview. Please contact the support team for importing Google Analytics 4
-        # events. The schema is available here: https://support.google.com/analytics/
-        # answer/7029846. Supported values for auto-completion imports: * `suggestions` (
-        # default): One JSON completion suggestion per line. * `denylist`: One JSON deny
-        # suggestion per line. * `allowlist`: One JSON allow suggestion per line.
+        # analytics/answer/3437719. * `user_event_ga4`: The schema is available here:
+        # https://support.google.com/analytics/answer/7029846. Supported values for auto-
+        # completion imports: * `suggestions` (default): One JSON completion suggestion
+        # per line. * `denylist`: One JSON deny suggestion per line. * `allowlist`: One
+        # JSON allow suggestion per line.
         # Corresponds to the JSON property `dataSchema`
         # @return [String]
         attr_accessor :data_schema
@@ -1112,6 +1159,13 @@ module Google
         # @return [String]
         attr_accessor :dynamic_facetable_option
       
+        # 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.
+        # Corresponds to the JSON property `exactSearchableOption`
+        # @return [String]
+        attr_accessor :exact_searchable_option
+      
         # Output only. Indicates whether this attribute has been used by any products. `
         # True` if at least one Product is using this attribute in Product.attributes.
         # Otherwise, this field is `False`. CatalogAttribute can be pre-loaded by using
@@ -1173,6 +1227,7 @@ module Google
         # Update properties of this object
         def update!(**args)
           @dynamic_facetable_option = args[:dynamic_facetable_option] if args.key?(:dynamic_facetable_option)
+          @exact_searchable_option = args[:exact_searchable_option] if args.key?(:exact_searchable_option)
           @in_use = args[:in_use] if args.key?(:in_use)
           @indexable_option = args[:indexable_option] if args.key?(:indexable_option)
           @key = args[:key] if args.key?(:key)
@@ -1365,16 +1420,16 @@ module Google
         # @return [String]
         attr_accessor :matching_order
       
-        # The maximum number of autocomplete suggestions returned per term. The maximum
-        # allowed max suggestions is 20. Default value is 20. If left unset or set to 0,
-        # then will fallback to default value.
+        # The maximum number of autocomplete suggestions returned per term. Default
+        # value is 20. If left unset or set to 0, then will fallback to default value.
+        # Value range is 1 to 20.
         # Corresponds to the JSON property `maxSuggestions`
         # @return [Fixnum]
         attr_accessor :max_suggestions
       
         # The minimum number of characters needed to be typed in order to get
         # suggestions. Default value is 2. If left unset or set to 0, then will fallback
-        # to default value.
+        # to default value. Value range is 1 to 20.
         # Corresponds to the JSON property `minPrefixLength`
         # @return [Fixnum]
         attr_accessor :min_prefix_length
@@ -2052,6 +2107,11 @@ module Google
         # @return [Fixnum]
         attr_accessor :success_count
       
+        # Metadata related to transform user events operation.
+        # Corresponds to the JSON property `transformedUserEventsMetadata`
+        # @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaTransformedUserEventsMetadata]
+        attr_accessor :transformed_user_events_metadata
+      
         # Operation last update time. If the operation is done, this is also the finish
         # time.
         # Corresponds to the JSON property `updateTime`
@@ -2069,6 +2129,7 @@ module Google
           @notification_pubsub_topic = args[:notification_pubsub_topic] if args.key?(:notification_pubsub_topic)
           @request_id = args[:request_id] if args.key?(:request_id)
           @success_count = args[:success_count] if args.key?(:success_count)
+          @transformed_user_events_metadata = args[:transformed_user_events_metadata] if args.key?(:transformed_user_events_metadata)
           @update_time = args[:update_time] if args.key?(:update_time)
         end
       end
@@ -2091,11 +2152,9 @@ module Google
         # 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 both `cloud-retail-
-        # customer-data-access@system.gserviceaccount.com` and `service-@gcp-sa-retail.
-        # iam.gserviceaccount.com` have the `pubsub.topics.publish` IAM permission on
-        # the topic. Only supported when ImportProductsRequest.reconciliation_mode is
-        # set to `FULL`.
+        # 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
@@ -2557,8 +2616,8 @@ module Google
         attr_accessor :data_state
       
         # Required. The display name of the model. Should be human readable, used to
-        # display Recommendation Models in the Retail Pantheon Dashboard. UTF-8 encoded
-        # string with limit of 1024 characters.
+        # display Recommendation Models in the Retail Cloud Cosole Dashboard. UTF-8
+        # encoded string with limit of 1024 characters.
         # Corresponds to the JSON property `displayName`
         # @return [String]
         attr_accessor :display_name
@@ -3180,7 +3239,7 @@ module Google
       
         # The id of the collection members when type is Type.COLLECTION. Non-existent
         # product ids are allowed. The type of the members must be either Type.PRIMARY
-        # or Type.VARIANT otherwise and INVALID_ARGUMENT error is thrown. Should not set
+        # or Type.VARIANT otherwise an INVALID_ARGUMENT error is thrown. Should not set
         # it for other types. A maximum of 1000 values are allowed. Otherwise, an
         # INVALID_ARGUMENT error is return.
         # Corresponds to the JSON property `collectionMemberIds`
@@ -4967,6 +5026,13 @@ module Google
         # @return [Array<String>]
         attr_accessor :restricted_values
       
+        # Returns the min and max value for each numerical facet intervals. Ignored for
+        # textual facets.
+        # Corresponds to the JSON property `returnMinMax`
+        # @return [Boolean]
+        attr_accessor :return_min_max
+        alias_method :return_min_max?, :return_min_max
+      
         def initialize(**args)
            update!(**args)
         end
@@ -4981,6 +5047,7 @@ module Google
           @prefixes = args[:prefixes] if args.key?(:prefixes)
           @query = args[:query] if args.key?(:query)
           @restricted_values = args[:restricted_values] if args.key?(:restricted_values)
+          @return_min_max = args[:return_min_max] if args.key?(:return_min_max)
         end
       end
       
@@ -5183,6 +5250,18 @@ module Google
         # @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaInterval]
         attr_accessor :interval
       
+        # The maximum value in the FacetValue.interval. Only supported on numerical
+        # facets and returned if SearchRequest.FacetSpec.FacetKey.return_min_max is true.
+        # Corresponds to the JSON property `maxValue`
+        # @return [Float]
+        attr_accessor :max_value
+      
+        # The minimum value in the FacetValue.interval. Only supported on numerical
+        # facets and returned if SearchRequest.FacetSpec.FacetKey.return_min_max is true.
+        # Corresponds to the JSON property `minValue`
+        # @return [Float]
+        attr_accessor :min_value
+      
         # Text value of a facet, such as "Black" for facet "colorFamilies".
         # Corresponds to the JSON property `value`
         # @return [String]
@@ -5196,6 +5275,8 @@ module Google
         def update!(**args)
           @count = args[:count] if args.key?(:count)
           @interval = args[:interval] if args.key?(:interval)
+          @max_value = args[:max_value] if args.key?(:max_value)
+          @min_value = args[:min_value] if args.key?(:min_value)
           @value = args[:value] if args.key?(:value)
         end
       end
@@ -5251,6 +5332,15 @@ module Google
         # @return [Hash<String,String>]
         attr_accessor :matching_variant_fields
       
+        # Specifies previous events related to this product for this user based on
+        # UserEvent with same SearchRequest.visitor_id or UserInfo.user_id. This is set
+        # only when SearchRequest.PersonalizationSpec.mode is SearchRequest.
+        # PersonalizationSpec.Mode.AUTO. Possible values: * `purchased`: Indicates that
+        # this product has been purchased before.
+        # Corresponds to the JSON property `personalLabels`
+        # @return [Array<String>]
+        attr_accessor :personal_labels
+      
         # Product captures all metadata information of items to be recommended or
         # searched.
         # Corresponds to the JSON property `product`
@@ -5283,6 +5373,7 @@ module Google
           @id = args[:id] if args.key?(:id)
           @matching_variant_count = args[:matching_variant_count] if args.key?(:matching_variant_count)
           @matching_variant_fields = args[:matching_variant_fields] if args.key?(:matching_variant_fields)
+          @personal_labels = args[:personal_labels] if args.key?(:personal_labels)
           @product = args[:product] if args.key?(:product)
           @variant_rollup_values = args[:variant_rollup_values] if args.key?(:variant_rollup_values)
         end
@@ -5579,6 +5670,32 @@ module Google
         end
       end
       
+      # Metadata related to transform user events operation.
+      class GoogleCloudRetailV2alphaTransformedUserEventsMetadata
+        include Google::Apis::Core::Hashable
+      
+        # Count of entries in the source user events BigQuery table.
+        # Corresponds to the JSON property `sourceEventsCount`
+        # @return [Fixnum]
+        attr_accessor :source_events_count
+      
+        # Count of entries in the transformed user events BigQuery table, which could be
+        # different from the actually imported number of user events.
+        # Corresponds to the JSON property `transformedEventsCount`
+        # @return [Fixnum]
+        attr_accessor :transformed_events_count
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @source_events_count = args[:source_events_count] if args.key?(:source_events_count)
+          @transformed_events_count = args[:transformed_events_count] if args.key?(:transformed_events_count)
+        end
+      end
+      
       # Metadata associated with a tune operation.
       class GoogleCloudRetailV2alphaTuneModelMetadata
         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.50.0"
+      GEM_VERSION = "0.51.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 = "20220722"
+      REVISION = "20220729"
     end
   end
 end

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

@@ -244,6 +244,18 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class GoogleCloudRetailV2alphaBatchRemoveCatalogAttributesRequest
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleCloudRetailV2alphaBatchRemoveCatalogAttributesResponse
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class GoogleCloudRetailV2alphaBigQueryOutputResult
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -898,6 +910,12 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class GoogleCloudRetailV2alphaTransformedUserEventsMetadata
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class GoogleCloudRetailV2alphaTuneModelMetadata
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -1422,6 +1440,21 @@ module Google
         end
       end
       
+      class GoogleCloudRetailV2alphaBatchRemoveCatalogAttributesRequest
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          collection :attribute_keys, as: 'attributeKeys'
+        end
+      end
+      
+      class GoogleCloudRetailV2alphaBatchRemoveCatalogAttributesResponse
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          collection :deleted_catalog_attributes, as: 'deletedCatalogAttributes'
+          collection :reset_catalog_attributes, as: 'resetCatalogAttributes'
+        end
+      end
+      
       class GoogleCloudRetailV2alphaBigQueryOutputResult
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -1459,6 +1492,7 @@ module Google
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
           property :dynamic_facetable_option, as: 'dynamicFacetableOption'
+          property :exact_searchable_option, as: 'exactSearchableOption'
           property :in_use, as: 'inUse'
           property :indexable_option, as: 'indexableOption'
           property :key, as: 'key'
@@ -1702,6 +1736,8 @@ module Google
           property :notification_pubsub_topic, as: 'notificationPubsubTopic'
           property :request_id, as: 'requestId'
           property :success_count, :numeric_string => true, as: 'successCount'
+          property :transformed_user_events_metadata, as: 'transformedUserEventsMetadata', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaTransformedUserEventsMetadata, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaTransformedUserEventsMetadata::Representation
+      
           property :update_time, as: 'updateTime'
         end
       end
@@ -2388,6 +2424,7 @@ module Google
           collection :prefixes, as: 'prefixes'
           property :query, as: 'query'
           collection :restricted_values, as: 'restrictedValues'
+          property :return_min_max, as: 'returnMinMax'
         end
       end
       
@@ -2449,6 +2486,8 @@ module Google
           property :count, :numeric_string => true, as: 'count'
           property :interval, as: 'interval', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaInterval, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaInterval::Representation
       
+          property :max_value, as: 'maxValue'
+          property :min_value, as: 'minValue'
           property :value, as: 'value'
         end
       end
@@ -2467,6 +2506,7 @@ module Google
           property :id, as: 'id'
           property :matching_variant_count, as: 'matchingVariantCount'
           hash :matching_variant_fields, as: 'matchingVariantFields'
+          collection :personal_labels, as: 'personalLabels'
           property :product, as: 'product', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaProduct, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaProduct::Representation
       
           hash :variant_rollup_values, as: 'variantRollupValues'
@@ -2529,6 +2569,14 @@ module Google
         end
       end
       
+      class GoogleCloudRetailV2alphaTransformedUserEventsMetadata
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :source_events_count, :numeric_string => true, as: 'sourceEventsCount'
+          property :transformed_events_count, :numeric_string => true, as: 'transformedEventsCount'
+        end
+      end
+      
       class GoogleCloudRetailV2alphaTuneModelMetadata
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation

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

@@ -472,6 +472,41 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
+        # Removes all specified CatalogAttributes from the AttributesConfig.
+        # @param [String] attributes_config
+        #   Required. The attributes config resource shared by all catalog attributes
+        #   being deleted. Format: `projects/`project_number`/locations/`location_id`/
+        #   catalogs/`catalog_id`/attributesConfig`
+        # @param [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaBatchRemoveCatalogAttributesRequest] google_cloud_retail_v2alpha_batch_remove_catalog_attributes_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::GoogleCloudRetailV2alphaBatchRemoveCatalogAttributesResponse] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaBatchRemoveCatalogAttributesResponse]
+        #
+        # @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 batch_project_location_catalog_attributes_config_remove_catalog_attributes(attributes_config, google_cloud_retail_v2alpha_batch_remove_catalog_attributes_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:post, 'v2alpha/{+attributesConfig}:batchRemoveCatalogAttributes', options)
+          command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaBatchRemoveCatalogAttributesRequest::Representation
+          command.request_object = google_cloud_retail_v2alpha_batch_remove_catalog_attributes_request_object
+          command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaBatchRemoveCatalogAttributesResponse::Representation
+          command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaBatchRemoveCatalogAttributesResponse
+          command.params['attributesConfig'] = attributes_config unless attributes_config.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
         # Removes the specified CatalogAttribute from the AttributesConfig. If the
         # CatalogAttribute to remove does not exist, a NOT_FOUND error is returned.
         # @param [String] attributes_config

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-apis-retail_v2alpha
 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-01 00:00:00.000000000 Z
+date: 2022-08-08 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.50.0
+  documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2alpha/v0.51.0
   source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-retail_v2alpha
 post_install_message: 
 rdoc_options: []