google-apis-retail_v2 0.104.0 → 0.106.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5e4e020269c2fd9334adafc8ccf6a5acb7a16619d499d3849f81e2e541b7810f
-  data.tar.gz: e942faa1ecc147b8eb95feb629ca8e37a489c0ba58372c7c6c07fafd84363987
+  metadata.gz: bf0a4e16920e93322c8fc4f9b70dd31188f887482ba65a9f08fcb0c6278665e0
+  data.tar.gz: e6feffc94ad2da927cb4c6e1872c2839ec6a4132cb267be3f3518622967a32ac
 SHA512:
-  metadata.gz: f943a4ec4bce7c1aa82de4a691cd9c8ffcbb13664e1908b79408e8816df91b7e1e31ea999550c683a314d47b12153629afe9f3d6c171d368447a32e41d3168fe
-  data.tar.gz: 3ce303d8dc6ea42912f9cffaab9c14c0aa4c21a22e60760fe776731216b1975d99518946122e05f20a881d436a1fcf292f460f9d9535b05b2b1deeb6d9ed6ec7
+  metadata.gz: 3301fa6d84ee7635be9d846f72393fd97de2df27f5d031eb02778a3757acbb548d86b354f776a65d96ee5185da6bcb22add1e70fe600633b01a0b77b1cc0a98f
+  data.tar.gz: e9f0f3a4d00ada35399ae233c44c363a33c5913979863c3ff30048d5f320bc7703b07c903d1fedf765594e042527bcaf424275f398c34ae183065de62cf973cf

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Release history for google-apis-retail_v2
 
+### v0.106.0 (2024-11-24)
+
+* Regenerated from discovery document revision 20241114
+
+### v0.105.0 (2024-11-03)
+
+* Regenerated from discovery document revision 20241024
+
 ### v0.104.0 (2024-10-27)
 
 * Regenerated from discovery document revision 20241017

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

@@ -760,14 +760,13 @@ module Google
         # 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
-        # CatalogService.AddCatalogAttribute, CatalogService.ImportCatalogAttributes, or
-        # CatalogService.UpdateAttributesConfig APIs. This field is `False` for pre-
-        # loaded CatalogAttributes. Only pre-loaded catalog attributes that are neither
-        # in use by products nor predefined can be deleted. Catalog attributes that are
-        # either in use by products or are predefined attributes cannot be deleted;
-        # however, their configuration properties will reset to default values upon
-        # removal request. After catalog changes, it takes about 10 minutes for this
-        # field to update.
+        # CatalogService.AddCatalogAttribute or CatalogService.UpdateAttributesConfig
+        # APIs. This field is `False` for pre-loaded CatalogAttributes. Only pre-loaded
+        # catalog attributes that are neither in use by products nor predefined can be
+        # deleted. Catalog attributes that are either in use by products or are
+        # predefined attributes cannot be deleted; however, their configuration
+        # properties will reset to default values upon removal request. After catalog
+        # changes, it takes about 10 minutes for this field to update.
         # Corresponds to the JSON property `inUse`
         # @return [Boolean]
         attr_accessor :in_use
@@ -1577,7 +1576,7 @@ module Google
         end
       end
       
-      # Metadata for active A/B testing Experiment.
+      # Metadata for active A/B testing experiment.
       class GoogleCloudRetailV2ExperimentInfo
         include Google::Apis::Core::Hashable
       
@@ -1608,8 +1607,8 @@ module Google
       class GoogleCloudRetailV2ExperimentInfoServingConfigExperiment
         include Google::Apis::Core::Hashable
       
-        # The fully qualified resource name of the serving config Experiment.VariantArm.
-        # serving_config_id responsible for generating the search response. For example:
+        # The fully qualified resource name of the serving config `Experiment.VariantArm.
+        # serving_config_id` responsible for generating the search response. For example:
         # `projects/*/locations/*/catalogs/*/servingConfigs/*`.
         # Corresponds to the JSON property `experimentServingConfig`
         # @return [String]
@@ -2465,8 +2464,8 @@ module Google
       class GoogleCloudRetailV2LocalInventory
         include Google::Apis::Core::Hashable
       
-        # Additional local inventory attributes, for example, store name, promotion tags,
-        # etc. This field needs to pass all below criteria, otherwise an
+        # Optional. Additional local inventory attributes, for example, store name,
+        # promotion tags, etc. This field needs to pass all below criteria, otherwise an
         # INVALID_ARGUMENT error is returned: * At most 30 attributes are allowed. * The
         # key must be a UTF-8 encoded string with a length limit of 32 characters. * The
         # key must match the pattern: `a-zA-Z0-9*`. For example, key0LikeThis or
@@ -2479,7 +2478,20 @@ module Google
         # @return [Hash<String,Google::Apis::RetailV2::GoogleCloudRetailV2CustomAttribute>]
         attr_accessor :attributes
       
-        # Input only. Supported fulfillment types. Valid fulfillment type values include
+        # Optional. The availability of the Product at this place_id. Default to
+        # Availability.IN_STOCK. For primary products with variants set the availability
+        # of the primary as Availability.OUT_OF_STOCK and set the true availability at
+        # the variant level. This way the primary product will be considered "in stock"
+        # as long as it has at least one variant in stock. For primary products with no
+        # variants set the true availability at the primary level. Corresponding
+        # properties: Google Merchant Center property [availability](https://support.
+        # google.com/merchants/answer/6324448). Schema.org property [Offer.availability](
+        # https://schema.org/availability).
+        # Corresponds to the JSON property `availability`
+        # @return [String]
+        attr_accessor :availability
+      
+        # Optional. Supported fulfillment types. Valid fulfillment type values include
         # commonly used types (such as pickup in store and same day delivery), and
         # custom types. Customers have to map custom types to their display names before
         # rendering UI. Supported values: * "pickup-in-store" * "ship-to-store" * "same-
@@ -2491,7 +2503,7 @@ module Google
         # @return [Array<String>]
         attr_accessor :fulfillment_types
       
-        # The place ID for the current set of inventory information.
+        # Required. The place ID for the current set of inventory information.
         # Corresponds to the JSON property `placeId`
         # @return [String]
         attr_accessor :place_id
@@ -2508,6 +2520,7 @@ module Google
         # Update properties of this object
         def update!(**args)
           @attributes = args[:attributes] if args.key?(:attributes)
+          @availability = args[:availability] if args.key?(:availability)
           @fulfillment_types = args[:fulfillment_types] if args.key?(:fulfillment_types)
           @place_id = args[:place_id] if args.key?(:place_id)
           @price_info = args[:price_info] if args.key?(:price_info)
@@ -2840,6 +2853,52 @@ module Google
         end
       end
       
+      # Metadata for pinning to be returned in the response. This is used for
+      # distinguishing between applied vs dropped pins.
+      class GoogleCloudRetailV2PinControlMetadata
+        include Google::Apis::Core::Hashable
+      
+        # Map of all matched pins, keyed by pin position.
+        # Corresponds to the JSON property `allMatchedPins`
+        # @return [Hash<String,Google::Apis::RetailV2::GoogleCloudRetailV2PinControlMetadataProductPins>]
+        attr_accessor :all_matched_pins
+      
+        # Map of pins that were dropped due to overlap with other matching pins, keyed
+        # by pin position.
+        # Corresponds to the JSON property `droppedPins`
+        # @return [Hash<String,Google::Apis::RetailV2::GoogleCloudRetailV2PinControlMetadataProductPins>]
+        attr_accessor :dropped_pins
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @all_matched_pins = args[:all_matched_pins] if args.key?(:all_matched_pins)
+          @dropped_pins = args[:dropped_pins] if args.key?(:dropped_pins)
+        end
+      end
+      
+      # List of product ids which have associated pins.
+      class GoogleCloudRetailV2PinControlMetadataProductPins
+        include Google::Apis::Core::Hashable
+      
+        # List of product ids which have associated pins.
+        # Corresponds to the JSON property `productId`
+        # @return [Array<String>]
+        attr_accessor :product_id
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @product_id = args[:product_id] if args.key?(:product_id)
+        end
+      end
+      
       # Request message for Predict method.
       class GoogleCloudRetailV2PredictRequest
         include Google::Apis::Core::Hashable
@@ -5445,7 +5504,7 @@ module Google
         # @return [String]
         attr_accessor :corrected_query
       
-        # Metadata related to A/B testing Experiment associated with this response. Only
+        # Metadata related to A/B testing experiment associated with this response. Only
         # exists when an experiment is triggered.
         # Corresponds to the JSON property `experimentInfo`
         # @return [Array<Google::Apis::RetailV2::GoogleCloudRetailV2ExperimentInfo>]
@@ -5468,6 +5527,12 @@ module Google
         # @return [String]
         attr_accessor :next_page_token
       
+        # Metadata for pinning to be returned in the response. This is used for
+        # distinguishing between applied vs dropped pins.
+        # Corresponds to the JSON property `pinControlMetadata`
+        # @return [Google::Apis::RetailV2::GoogleCloudRetailV2PinControlMetadata]
+        attr_accessor :pin_control_metadata
+      
         # Information describing query expansion including whether expansion has
         # occurred.
         # Corresponds to the JSON property `queryExpansionInfo`
@@ -5513,6 +5578,7 @@ module Google
           @facets = args[:facets] if args.key?(:facets)
           @invalid_condition_boost_specs = args[:invalid_condition_boost_specs] if args.key?(:invalid_condition_boost_specs)
           @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
+          @pin_control_metadata = args[:pin_control_metadata] if args.key?(:pin_control_metadata)
           @query_expansion_info = args[:query_expansion_info] if args.key?(:query_expansion_info)
           @redirect_uri = args[:redirect_uri] if args.key?(:redirect_uri)
           @results = args[:results] if args.key?(:results)
@@ -6577,12 +6643,11 @@ module Google
         # @return [String]
         attr_accessor :ip_address
       
-        # User agent as included in the HTTP header. Required for getting SearchResponse.
-        # sponsored_results. The field must be a UTF-8 encoded string with a length
-        # limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned.
-        # This should not be set when using the client side event reporting with GTM or
-        # JavaScript tag in UserEventService.CollectUserEvent or if direct_user_request
-        # is set.
+        # User agent as included in the HTTP header. The field must be a UTF-8 encoded
+        # string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT
+        # error is returned. This should not be set when using the client side event
+        # reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or
+        # if direct_user_request is set.
         # Corresponds to the JSON property `userAgent`
         # @return [String]
         attr_accessor :user_agent

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

@@ -16,13 +16,13 @@ module Google
   module Apis
     module RetailV2
       # Version of the google-apis-retail_v2 gem
-      GEM_VERSION = "0.104.0"
+      GEM_VERSION = "0.106.0"
 
       # Version of the code generator used to generate this client
       GENERATOR_VERSION = "0.15.1"
 
       # Revision of the discovery document this client was generated from
-      REVISION = "20241017"
+      REVISION = "20241114"
     end
   end
 end

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

@@ -502,6 +502,18 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class GoogleCloudRetailV2PinControlMetadata
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleCloudRetailV2PinControlMetadataProductPins
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class GoogleCloudRetailV2PredictRequest
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -2190,6 +2202,7 @@ module Google
         class Representation < Google::Apis::Core::JsonRepresentation
           hash :attributes, as: 'attributes', class: Google::Apis::RetailV2::GoogleCloudRetailV2CustomAttribute, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2CustomAttribute::Representation
       
+          property :availability, as: 'availability'
           collection :fulfillment_types, as: 'fulfillmentTypes'
           property :place_id, as: 'placeId'
           property :price_info, as: 'priceInfo', class: Google::Apis::RetailV2::GoogleCloudRetailV2PriceInfo, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2PriceInfo::Representation
@@ -2284,6 +2297,23 @@ module Google
         end
       end
       
+      class GoogleCloudRetailV2PinControlMetadata
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          hash :all_matched_pins, as: 'allMatchedPins', class: Google::Apis::RetailV2::GoogleCloudRetailV2PinControlMetadataProductPins, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2PinControlMetadataProductPins::Representation
+      
+          hash :dropped_pins, as: 'droppedPins', class: Google::Apis::RetailV2::GoogleCloudRetailV2PinControlMetadataProductPins, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2PinControlMetadataProductPins::Representation
+      
+        end
+      end
+      
+      class GoogleCloudRetailV2PinControlMetadataProductPins
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          collection :product_id, as: 'productId'
+        end
+      end
+      
       class GoogleCloudRetailV2PredictRequest
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -2889,6 +2919,8 @@ module Google
           collection :invalid_condition_boost_specs, as: 'invalidConditionBoostSpecs', class: Google::Apis::RetailV2::GoogleCloudRetailV2SearchRequestBoostSpecConditionBoostSpec, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2SearchRequestBoostSpecConditionBoostSpec::Representation
       
           property :next_page_token, as: 'nextPageToken'
+          property :pin_control_metadata, as: 'pinControlMetadata', class: Google::Apis::RetailV2::GoogleCloudRetailV2PinControlMetadata, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2PinControlMetadata::Representation
+      
           property :query_expansion_info, as: 'queryExpansionInfo', class: Google::Apis::RetailV2::GoogleCloudRetailV2SearchResponseQueryExpansionInfo, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2SearchResponseQueryExpansionInfo::Representation
       
           property :redirect_uri, as: 'redirectUri'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-apis-retail_v2
 version: !ruby/object:Gem::Version
-  version: 0.104.0
+  version: 0.106.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-10-27 00:00:00.000000000 Z
+date: 2024-12-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_v2/CHANGELOG.md
-  documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2/v0.104.0
+  documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2/v0.106.0
   source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-retail_v2
 post_install_message: 
 rdoc_options: []
@@ -75,7 +75,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.21
+rubygems_version: 3.5.22
 signing_key: 
 specification_version: 4
 summary: Simple REST client for Vertex AI Search for Retail API V2